Makito X4 Encoder

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

Admin

Operator

Guest/User


General

audenc

check mark

check mark

"get" only

Manage encoder audio acquisition settings, including starting and stopping encoding of the audio input.

essence

check mark

check mark

"get" only

Manage ST 2110 media essences on the encoder.

leds

check mark

check mark

"get" only

Initiate blinking of the Status and TX LEDs on the Makito X4 face-plate in order to help locate the device.

metadata

check mark

check mark

"get" only

Manage metadata sources to capture metadata (either KLV or CoT) and then incorporate data information within the MPEG Transport Stream.

passthrough

check mark

check mark

"get" only

On encoders with a serial port, enable bi-directional serial passthrough for controlling serially attached devices.

rtsp

check mark

check mark

"get" only

Manage rtsp settings.

session

check mark

check mark

"get" only

Manage SAP multicast advertising sessions.

snapshot

check mark

check mark

"get" only

Take and manage snapshots from video received on a video encoder

stream

check mark

check mark

"get" only

Create and manage audio/video streams.

temperature

check mark

check mark

check mark

Display the current temperature of the unit.

videnc

check mark

check mark

"get" only

Manage video encoding parameters, including starting and stopping encoding of the video input.

vidin

check mark

check mark

"get" only

View and manage video input settings.

Administration Commands

Command

Role

Description


Admin

Operator

Guest


Network and Management

config

check mark

check mark

"list" only

Manage configurations on the Makito X4.

date

check mark

check mark

check mark

Display the current date.

dtconfig

check mark

cross mark

cross mark

Set the date and time on the encoder.

ethercfg

check mark

cross mark

cross mark

View, manually control, and save the Ethernet configuration parameters.

haiversion

check mark

check mark

check mark

Display the Firmware Build ID, Build Time, and serial number for the Makito X4.

ipconfig

check mark

cross mark

cross mark

View and set the parameters that specify the networking context for the Makito X4, including the IP settings, hostname, and DNS.

ipv6config

check mark

cross mark

cross mark

View and set the parameters that specify the IPv6 network configuration.

license

check mark

cross mark

cross mark

Manage licensed features.

nmcfg

check mark

cross mark

cross mark

Used by system administrators or GUI/Web interface applications in the configuration of SNMP for the Makito X4.

package

check mark

cross mark

cross mark

View and manage software packages, including firmware upgrades.

passwd

check mark

operator password only

user password only

Change the password for a user account.

personality

check mark

cross mark

cross mark

Switch the Makito X4 personality between SDI, SQD, Defense, and ST 2110 input.

reboot

check mark

cross mark

cross mark

Halt and restart the Makito X4.

routes

check mark

cross mark

cross mark

Manage configured static routes.

sanitize

check mark

cross mark

cross mark

Wipe out all non-volatile memory on a Makito X Series device. 

service

check mark

cross mark

cross mark

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

system_snapshot.sh

check mark

check mark

check mark

Take a system snapshot for the purpose of troubleshooting, which may be forwarded to Haivision Technical Support if you are requesting technical support.

tzconfig

check mark

cross mark

cross mark

Configure the timezone on the encoder.

Security

account

check mark

cross mark

cross mark

Use to manage user accounts for the encoder.

audit

check mark

cross mark

cross mark

Use to enable remote logging of security and administrative events and configure the remote audit (syslog) server connection.

banner

check mark

cross mark

cross mark

Use to manage the Advisory Notice and Consent Banner.

certificate

check mark

cross mark

cross mark

Use to manage the TLS certificates for the Web interface HTTPS server and the secured TLS connection to the remote audit server.

messages

check mark

cross mark

cross mark

Use to view and manage administrative login messages.

policy

check mark

cross mark

cross mark

Use to manage security policy settings.

pubkey

check mark

check mark

check mark

Use to manage the user's own authorized SSH public keys.


Access

Command

Role

Admin

Operator

Guest

Web access

check mark

check mark

check mark

Telnet to/from encoder

check mark

check mark

check mark

Serial access to encoder

check mark

check mark

check mark

Other Commands and Utilities

Command

Role

Description

Admin

Operator

Guest


iperf

check mark

cross mark

cross mark

Measure and tune network performance.

ping

check mark

check mark

check mark

Send packets to network hosts to test a network connection.

tcpdump

check mark

cross mark

cross mark

Display TCP/IP and other packets being transmitted or received over a network interface.

traceroute

check mark

check mark

check mark

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.