The Makito X1 CLI commands are divided in two main groups: operation and administration:
-
Operation Commands are used to manage the Audio/Video data path, processing, and features, including audio/video/metadata content selection, audio/video encoding, H.264 and HEVC streaming. Operation command effects are immediate but not persistent (i.e., between reboots) unless the current operating configuration is explicitly saved (using the config command).
-
Administration Commands address the security and network configuration. Their effects are persistent but not always immediate; some require system reboot to take effect.
Note
A warning appears when you sign in or out of a Makito X1, or reboot, when the current configuration has not been saved in a preset. See (1.3 2) config.
Expand the sections below to view a list of CLI commands and other functionalities supported by the system, the privileges for each role, and their descriptions.
Operation Commands
|
Command |
Role |
Description |
||
|---|---|---|---|---|
|
|
Admin |
Operator |
Guest |
|
|
General |
||||
|
Yes |
Yes |
"get" only |
Manage encoder audio acquisition settings, including starting and stopping encoding of the audio input. |
|
|
Yes |
Yes |
"get" only |
Control the behavior of the Status LED (on the Makito X1 face-plate) at startup. |
|
|
Yes |
Yes |
"get" only |
Manage metadata sources to capture metadata (either KLV or CoT) and then incorporate data information within the MPEG Transport Stream. |
|
|
Yes |
Yes |
"get" only |
On encoders with a serial port, enable bi-directional serial passthrough for controlling serially attached devices. |
|
|
Yes |
Yes |
"get" only |
Manage rtsp settings. |
|
|
Yes |
Yes |
"get" only |
Manage SAP multicast advertising sessions. |
|
|
Yes |
Yes |
"get" only |
Create and manage audio/video streams. |
|
|
Yes |
Yes |
Yes |
Display the current temperature of the unit. |
|
|
Yes |
Yes |
"get" only |
Manage video encoding parameters, including starting and stopping encoding of the video input. |
|
|
Yes |
Yes |
"get" only |
View and manage video input settings. |
|
Administration Commands
|
Command |
Role |
Description |
||
|---|---|---|---|---|
|
|
Admin |
Operator |
Guest |
|
|
Network and Management |
||||
|
Yes |
Yes |
"list" only |
Manage configurations on the Makito X. |
|
|
Yes |
Yes |
Yes |
Display the current date. |
|
|
Yes |
— |
— |
Set the date and time on the encoder. |
|
|
Yes |
— |
— |
Pair and unpair the Makito X with/from a Haivision EMS (Element Management System). |
|
|
Yes |
— |
— |
View, manually control, and save the Ethernet configuration parameters. |
|
|
Yes |
Yes |
Yes |
Display the Firmware Build ID, Build Time, and serial number for the Makito X. |
|
|
Yes |
— |
— |
View and set the parameters that specify the networking context for the Makito X, including the IP settings, hostname, and DNS. |
|
|
Yes |
— |
— |
View and set the parameters that specify the IPv6 network configuration. |
|
|
Yes |
— |
— |
Manage licensed features. |
|
|
Yes |
— |
— |
Used by system administrators or GUI/Web interface applications in the configuration of SNMP for the Makito X. |
|
|
Yes |
— |
— |
View and manage software packages, including firmware upgrades. |
|
|
Yes |
operator password only |
user password only |
Change the password for a user account. |
|
|
Yes |
— |
— |
Halt and restart the Makito X. |
|
|
Yes |
— |
— |
Enable and disable network services, including HTTP, SNMP, SSH, and Telnet. |
|
|
Yes |
Yes |
Yes |
Take a system snapshot for the purpose of troubleshooting, which may be forwarded to Haivision Technical Support if you are requesting technical support. |
|
|
Yes |
— |
— |
Configure the timezone on the encoder. |
|
|
Security |
||||
|
Yes |
— |
— |
Use to manage user accounts for the encoder. |
|
|
Yes |
— |
— |
Use to enable remote logging of security and administrative events and configure the remote audit (syslog) server connection. |
|
|
Yes |
— |
— |
Use to manage the Advisory Notice and Consent Banner. |
|
|
Yes |
— |
— |
Use to manage the TLS certificates for the Web interface HTTPS server and the secured TLS connection to the remote audit server. |
|
|
Yes |
— |
— |
Use to view and manage administrative login messages. |
|
|
Yes |
— |
— |
Use to manage security policy settings. |
|
|
Yes |
Yes |
Yes |
Use to manage the user's own authorized SSH public keys. |
|
Access
|
Command |
Role |
||
|---|---|---|---|
|
|
Admin |
Operator |
Guest |
|
Web access |
Yes |
Yes |
Yes |
|
Telnet to/from encoder |
Yes |
Yes |
Yes |
|
Serial access to encoder |
Yes |
Yes |
Yes |
Other/Utilities
|
Command |
Role |
Description |
||
|---|---|---|---|---|
|
|
Admin |
Operator |
Guest |
|
|
iperf |
Yes |
Yes |
Yes |
Measure and tune network performance. |
|
ping |
Yes |
Yes |
Yes |
Send packets to network hosts to test a network connection. |
|
tcpdump |
Yes |
— |
— |
Display TCP/IP and other packets being transmitted or received over a network interface. |
|
traceroute |
Yes |
Yes |
Yes |
Display the route (path) and measure transit delays of packets across an IP network. |
For an overview of system access control on the Makito X1, see (1.3 2) Role-based Authorization.