Skip to main content

Command Summary and Access Control

The Makito X4 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 X4, 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


AdminOperatorGuest/User
General
audenc

Yes

Yes

"get" only

Manage encoder audio acquisition settings, including starting and stopping encoding of the audio input.
essenceYesYes"get" onlyManage ST 2110 media essences on the encoder.
leds

Yes

Yes

"get" onlyInitiate blinking of the Status and TX LEDs on the Makito X4 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.
passthroughYesYes"get" onlyOn encoders with a serial port, enable bi-directional serial passthrough for controlling serially attached devices.
rtspYesYes"get" onlyManage rtsp settings.
session

Yes

Yes

"get" only

Manage SAP multicast advertising sessions.
snapshotYesYes"get" onlyTake and manage snapshots from video received on a  video encoder . 

stream

Yes

Yes

"get" only

Create and manage audio/video streams.

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.

Administration Commands

Command

Role

Description


Admin

Operator

Guest


Network and Management
config

Yes

Yes

"list" only

Manage configurations on the Makito X4.
date

Yes

Yes

Yes

Display the current date.

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 X4.

ipconfig

Yes

View and set the parameters that specify the networking context for the Makito X4, 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 X4.

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.
personalityYesSwitch the Makito X4 personality between SDI, SQD, Defense, and ST 2110 input.

reboot

Yes

Halt and restart the Makito X4.
routes

Yes

Manage configured static routes.
sanitizeYesWipe out all non-volatile memory on a Makito X Series device. 

service

Yes

Enable and disable network services, including HTTP, SNMP, SSH , and Telnet.

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.

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 Commands and Utilities

Command

Role

Description


Admin

Operator

Guest


iperf

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 X4, see Role-based Authorization.

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.