The Makito X 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, logo, audio/video encoding, H.264 streaming, and image snapshots. 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 X, or reboot, when the current configuration has not been saved in a preset. See config.
Below is 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 |
Initiate blinking of the Status and TX LEDs on the Makito X face-plate in order to help locate the device. |
|
|
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 |
Enable bi-directional serial passthrough for controlling serially attached devices such as PTZ controlled cameras. |
|
|
Yes |
Yes |
"get" only |
Manage recording of streams, including starting and stopping recording. |
|
|
Yes |
Yes |
"get" only |
Enhance the quality of the encoded video for a region within the video frame (i.e., a region of interest). |
|
|
Yes |
Yes |
"get" only |
Manage SAP multicast advertising sessions. |
|
|
Yes |
Yes |
"get" only |
Create and manage audio/video streams. |
|
|
Yes |
Yes |
"get" only |
Manage audio talkback settings to allow two-way audio communication using the encoder's Audio Output. |
|
|
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. |
|
|
Media |
||||
|
Yes |
Yes |
"get" and "list" only |
Manage logo overlays (i.e., a graphic file to display as a logo overlay in the encoded video). |
|
|
Yes |
Yes |
— |
Convert a graphic file to Haivision's overlay image format (.oly) in order to display the image as a logo overlay. |
|
|
Yes |
Yes |
— |
Convert a static picture into a file containing an encoded single H.264 GOP sequence. This is required in order to configure a Makito X stream with a static image that will replace the "real" video stream when streaming is paused. |
|
|
Yes |
Yes |
"get" and "list" only |
Take and manage snapshots from the video input. |
|
|
Yes |
Yes |
"list" only |
Manage still image files on the Makito X file system. Static images are used to replace the "real" video stream when streaming is paused. |
|
Administration Commands
|
Command |
Role |
Description |
||
|---|---|---|---|---|
|
Admin |
Operator |
Guest |
|
|
|
Network and Management |
||||
|
Yes |
— |
— |
Perform Built-in self-tests (BIST) and Power-ON Selftests (POST). |
|
|
Yes |
Yes |
"list" only |
Manage configurations on the Makito X. |
|
|
Yes |
Yes |
Yes |
Display the current date. |
|
|
Yes |
Yes |
"get" only |
(with storage only) Manage recording export destinations. |
|
|
Yes |
— |
— |
Set the date and time on the encoder. |
|
|
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 |
Yes |
"get" only |
(Makito X DVI systems only) Manage HDCP settings. |
|
|
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 |
— |
— |
(Makito XR only) Set the personality to either the two or four-port variant (X2R or X4R). |
|
|
Yes |
— |
— |
Halt and restart the Makito X. |
|
|
Yes |
— |
— |
Enable and disable network services, including EMS, HTTP, ONVIF, passthrough, RTSP, SNMP, SSH, Talkback, Telnet, and VF. |
|
|
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. |
|
|
Storage |
||||
|
Yes |
— |
— |
Set an NFS mount point on the Makito X. |
|
|
Yes |
Yes |
— |
Manage storage devices on the Makito X with Storage dual-height model. |
|
|
Yes |
Yes |
— |
Use to manage the export of files from 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 X, see Role-based Authorization.