Command Summary and Access Control

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
audenc	Yes	Yes	"get" only	Manage encoder audio acquisition settings, including starting and stopping encoding of the audio input.
leds	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.
metadata	Yes	Yes	"get" only	Manage metadata sources to capture metadata (either KLV or CoT) and then incorporate data information within the MPEG Transport Stream.
passthrough	Yes	Yes	"get" only	Enable bi-directional serial passthrough for controlling serially attached devices such as PTZ controlled cameras.
record	Yes	Yes	"get" only	Manage recording of streams, including starting and stopping recording.
roi	Yes	Yes	"get" only	Enhance the quality of the encoded video for a region within the video frame (i.e., a region of interest).
session	Yes	Yes	"get" only	Manage SAP multicast advertising sessions.
stream	Yes	Yes	"get" only	Create and manage audio/video streams.
talkback	Yes	Yes	"get" only	Manage audio talkback settings to allow two-way audio communication using the encoder's Audio Output.
temperature	Yes	Yes	Yes	Display the current temperature of the unit.
videnc	Yes	Yes	"get" only	Manage video encoding parameters, including starting and stopping encoding of the video input.
vidin	Yes	Yes	"get" only	View and manage video input settings.
Media
logo	Yes	Yes	"get" and "list" only	Manage logo overlays (i.e., a graphic file to display as a logo overlay in the encoded video).
mklogo	Yes	Yes	—	Convert a graphic file to Haivision's overlay image format (.oly) in order to display the image as a logo overlay.
mkstill	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.
snapshot	Yes	Yes	"get" and "list" only	Take and manage snapshots from the video input.
still	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
bist	Yes	—	—	Perform Built-in self-tests (BIST) and Power-ON Selftests (POST).
config	Yes	Yes	"list" only	Manage configurations on the Makito X.
date	Yes	Yes	Yes	Display the current date.
dest	Yes	Yes	"get" only	(with storage only) Manage recording export destinations.
dtconfig	Yes	—	—	Set the date and time on the encoder.
ethercfg	Yes	—	—	View, manually control, and save the Ethernet configuration parameters.
haiversion	Yes	Yes	Yes	Display the Firmware Build ID, Build Time, and serial number for the Makito X.
hdcp	Yes	Yes	"get" only	(Makito X DVI systems only) Manage HDCP settings.
ipconfig	Yes	—	—	View and set the parameters that specify the networking context for the Makito X, including the IP settings, hostname, and DNS.
ipv6config	Yes	—	—	View and set the parameters that specify the IPv6 network configuration.
license	Yes	—	—	Manage licensed features.
nmcfg	Yes	—	—	Used by system administrators or GUI/Web interface applications in the configuration of SNMP for the Makito X.
package	Yes	—	—	View and manage software packages, including firmware upgrades.
passwd	Yes	operator password only	user password only	Change the password for a user account.
personality	Yes	—	—	(Makito XR only) Set the personality to either the two or four-port variant (X2R or X4R).
reboot	Yes	—	—	Halt and restart the Makito X.
service	Yes	—	—	Enable and disable network services, including EMS, HTTP, ONVIF, passthrough, RTSP, SNMP, SSH, Talkback, Telnet, and VF.
system_snapshot.sh	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.
tzconfig	Yes	—	—	Configure the timezone on the encoder.
Storage
nas	Yes	—	—	Set an NFS mount point on the Makito X.
storage	Yes	Yes	—	Manage storage devices on the Makito X with Storage dual-height model.
transfer	Yes	Yes	—	Use to manage the export of files from the encoder.
Security
account	Yes	—	—	Use to manage user accounts for the encoder.
audit	Yes	—	—	Use to enable remote logging of security and administrative events and configure the remote audit ( syslog ) server connection.
banner	Yes	—	—	Use to manage the Advisory Notice and Consent Banner.
certificate	Yes	—	—	Use to manage the TLS certificates for the Web interface HTTPS server and the secured TLS connection to the remote audit server.
messages	Yes	—	—	Use to view and manage administrative login messages.
policy	Yes	—	—	Use to manage security policy settings.
pubkey	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.