CLI Reference - PRELIMINARY¶

Navigating the CLI Hierarchy¶

The CLI is organized hierarchically, and provides help and shortcuts for ease of use. It is comprised of levels, with each level having a group of commands for a specific purpose.

Root Level Commands¶

The command line is started at the root (top) level. At the root level, you see the basic command prompt >.

Type ? to view the root level commands.

Command	Description
`config`	Enters the configuration level
`documentation`	Writes the CLI documentation to the console output
`file system`	Enters the file system level
`help`	Writes the shortcut keys to the console output
`status`	Enters the status level
`tlog`	Writes the trouble log to the command line output
`xml`	Enters the XML level
`exit`	Stops the command line. Press any key to start it again.

Command Levels¶

To navigate to a different command level, enter the command name at the prompt:

>config <enter>

The command level displays before the prompt:

config>

To navigate up one level, type exit or the abbreviation ex.

What you type	Result
`help`	Type this at the root level to view the editing and shortcut keys.
`?`	View the list of commands for that level.
`*`	View available commands and help explanations for the current level.
`show`	View the current configuration for that level.
`exit`	Exit and return to one level higher. At the root level, this command stops the command line. Press any key to start the command line again.
`<command-name>`	Enter the command level for that command.
Abbreviations	Type the first few letters of the command and press Enter. For example, enter `co` for `config`.
Autofill	Type the first few letters of a command and then press the Tab key to run through the possible commands.

Editing and Shortcut Keys¶

At the root level, type help to view the editing and shortcut keys for the CLI.

<tab>          fill in possible command
<enter>        run command as edited
*<enter>       show help on matching commands
?              list matching commands
<left arrow>   move cursor left
<right arrow>  move cursor right
<up arrow>     previous command
<down arrow>   later command
<backspace>    delete to left
<delete>       delete to left
<Paste XML>    import configuration

<control>                          <escape>
---------------------------------  ----------------------------------
a  move cursor to begin of line    b        move cursor backward word
d  delete character under cursor   f        move cursor forward word
e  move cursor to end of line      [A       previous command
k  delete to end of line           [B       later command
l  redraw line                     [C       move cursor right
r  redraw line                     [D       move cursor left
u  delete to begin of line         <escape> delete word to left
w  delete word to left

(Root) level¶

config¶

Enters the configuration level.

documentation¶

Dumps help for CLI commands.

file system¶

Enters the file system level.

help¶

Displays command line interface help.

status¶

Enters the status level.

tlog¶

Displays Trouble Log; stop with any character.

xml¶

Enters the XML level.

exit¶

Invites power down if Command Line is a Power Enabled Application.

Config level¶

exit¶

Returns to the root Command level.

write¶

Writes any unsaved configuration.

Clock¶

Enters the "config Clock" Command level.

These settings pertain to the Clock settings for keeping time.

CPM¶

Enters the "config CPM" Command level.

These settings pertain to the Configurable Pin Manager (CPM).

NOTE: Changes may take effect immediately or require reboot, so you should reboot after changing CPM Role configurations.

Ethernet¶

Enters the "config Ethernet" Command level.

These settings pertain to the Ethernet link in the device. Changes take effect immediately. After saving the changes, re-establish any connections to the Ethernet link.

HTTP Server¶

Enters the "config HTTP Server" Command level.

Interface¶

Enters the "config Interface" Command level.

These settings pertain to the Network Interface on the device. To see the effect of these selections after a reboot, view the corresponding Status. Changes will take effect after reboot or wake from standby.

Line <instance>¶

Enters the selected "config Line" Command level.

<instance> may be "1", "Virtual_1" or "Virtual_2".

These settings pertain to the Serial Line. Changes take effect immediately.

User <instance>¶

Enters the selected "config User" Command level.

Creates <instance> if it does not already exist.

These settings pertain to each User on the device.

AES Credential <instance>¶

Enters the selected "config AES Credential" Command level.

Creates <instance> if it does not already exist.

Each AES Credential holds a secret Encrypt Key and Decrypt Key for secure communication.

CLI Server¶

Enters the "config CLI Server" Command level.

These settings pertain to the CLI Server. Changes take effect immediately.

Discovery¶

Enters the selected "config Discovery" Command level.

These settings pertain to Discovery. Changes take effect immediately.

Query Port is a Lantronix discovery protocol server. It implements a simple proprietary discovery service on port 0x77FE (30718).

MACH10¶

Enters the "config MACH10" Command level.

Modem Emulation <instance>¶

Enters the selected "config Modem Emulation" Command level.

<instance> may be "1", "Virtual_1" or "Virtual_2".

Connections can be initiated and accepted using Modem "AT" commands incoming from the Serial Line.

Monitor¶

Enters the "config Monitor" Command level.

NTP¶

Enters the "config NTP" Command level.

These configurables are for Simple NTP (SNTP).

TLS Credential <instance>¶

Enters the selected "config TLS Credential" Command level.

Creates <instance> if it does not already exist.

Manages certificates for TLS clients and servers.

NOTE: Minimum accepted RSA key size is 2048 bits.

Tunnel <instance>¶

Enters the selected "config Tunnel" Command level.

<instance> may be "1", "Virtual_1" or "Virtual_2".

Custom <instance>¶

Enters the selected "config Custom" Command level.

Creates <instance> if it does not already exist.

User custom configuration values are stored under this group.

Config Clock level¶

These settings pertain to the Clock settings for keeping time.

show¶

Shows current configuration.

write¶

Writes any unsaved configuration.

exit¶

Returns to the previous level.

Source <value>¶

Source may be "Manual" or "NTP".

UTC Offset <value>¶

UTC Offset is allowed to have negative values.

UTC Offset has units of minutes.

UTC Offset must be in the range of -1440 to 1440, and be a multiple of 15 minutes.

Lists of common time zones and corresponding UTC Offset can be found at several websites, including "http://www.iana.org/time-zones".

Config CPM level¶

These settings pertain to the Configurable Pin Manager (CPM).

NOTE: Changes may take effect immediately or require reboot, so you should reboot after changing CPM Role configurations.

show¶

Shows current configuration.

write¶

Writes any unsaved configuration.

exit¶

Returns to the previous level.

Role <instance>¶

Enters the selected "config CPM Role" Command level.

"Factory Defaults" active for timed interval will reset configuration to factory defaults."

"HTTP Server Trigger" turns on HTTP Server if Mode is "Triggered".

"Line 1 DSR" read by application.

"Line 1 DTR" set by application.

"Line 1 Flow.CTS" allows send if Flow Control is "Hardware".

"Line 1 Flow.RTS" active says can receive if Flow Control is "Hardware".

"User Data Updated" is active when user data changes, till Acknowledge action.

Config CPM Role level¶

"Factory Defaults" active for timed interval will reset configuration to factory defaults.

"HTTP Server Trigger" turns on HTTP Server if Mode is "Triggered".

"Line 1 DSR" read by application.

"Line 1 DTR" set by application.

"Line 1 Flow.CTS" allows send if Flow Control is "Hardware".

"Line 1 Flow.RTS" active says can receive if Flow Control is "Hardware".

"User Data Updated" is active when user data changes, till Acknowledge action.

show¶

Shows current configuration.

write¶

Writes any unsaved configuration.

exit¶

Returns to the previous level.

CP <value>¶

Blank the value for "<No CP Selected>".

This is the number of the Configurable Pin (CP) assigned to the role.

State <value>¶

State may be "Enabled" or "Disabled".

"Enabled" allows the application to use the designated Configurable Pin.

Note that some Roles (those containing a ".") are bundled into a group. Enabling / Disabling any one of them also Enables / Disables the rest of the Roles in the same Group.

Assert <value>¶

Assert may be "High" or "Low".

Assert reflects the logical polarity of this Configurable Pin.

"High" means that a logical "1" corresponds to a voltage high condition on the pin.

"Low" means that a logical "1" corresponds to a voltage low condition on the pin.

Mode <value>¶

Mode may be "Push-Pull" or "Weak Pullup".

For a high impedance input, select "Push-Pull".

5-Volt tolerance NOTE: In order to sustain a voltage higher than VDD+0.3, the Mode must be set to "Push-Pull".

Config Ethernet level¶

These settings pertain to the Ethernet link in the device. Changes take effect immediately. After saving the changes, re-establish any connections to the Ethernet link.

show¶

Shows current configuration.

write¶

Writes any unsaved configuration.

exit¶

Returns to the previous level.

PHY Address <value>¶

No help available.

Speed <value>¶

Speed may be "Auto", "10" or "100".

Duplex <value>¶

Duplex may be "Half" or "Full".

MDIO Logging <value>¶

MDIO Logging may be "Enabled" or "Disabled".

Config HTTP Server level¶

show¶

Shows current configuration.

write¶

Writes any unsaved configuration.

exit¶

Returns to the previous level.

Mode <value>¶

Mode may be "Disabled", "Enabled" or "Triggered".

"Disabled" prevents HTTP from operating on any port.

"Enabled" allows the HTTP Server to operate.

"Triggered" waits for CPM Role "HTTP Server Trigger" to become active. Then the HTTP Server stays up indefinitely.

Port <value>¶

Enter 0 for "<None>".

The default Port can be overridden.

Secure Port <value>¶

Enter 0 for "<None>".

The default Secure Port (TLS) can be overridden.

Secure Credential <value>¶

Secure Credential may contain up to 30 characters.

The Secure Credential specifies the name of the TLS Server Credential to be used for the secure connection.

Authentication Timeout <value>¶

Authentication Timeout has units of minutes, hours, and/or days.

The Authentication Timeout applies only if Digest authentication is being used.

Inactivity Timeout <value>¶

Inactivity Timeout has units of seconds, minutes, and/or hours.

The Inactivity Timeout applies only if the Application "HTTP Server" is enabled in the Power settings.

The HTTP Server will hold power on this long after it completes a request.

Security¶

Enters the "config HTTP Server Security" Command level.

These settings pertain to the HTTP Server Security. Changes take effect immediately.

Config HTTP Server Security level¶

These settings pertain to the HTTP Server Security. Changes take effect immediately.

show¶

Shows current configuration.

write¶

Writes any unsaved configuration.

exit¶

Returns to the previous level.

Access Control <instance>¶

Enters the selected "config HTTP Server Security Access Control" Command level.

<instance> may range from 1 to 5.

Config HTTP Server Security Access Control level¶

<instance> may range from 1 to 5.

show¶

Shows current configuration.

write¶

Writes any unsaved configuration.

exit¶

Returns to the previous level.

URI <value>¶

URI may contain up to 255 characters.

The HTTP Server can be configured with many different authentication directives. The authentication is hierarchical in that any URI can be given an authentication directive in order to override a parent URI authentication directive.

The URI must begin with /.

For example, create URI "/Welcome", then place your "hello.html" file in directory "/http/Welcome/", finally point your browser to "<device IP address>/Welcome/hello.html" to experiment with the authorization levels.

The following URIs are built in to the server:

"/ajax" Web Manager

"/fs" File System Web API

"/logout" Digest authentication

"/mux_http" Mux HTTP listener

"/tlog" Trouble log

"/upgrade" Firmware Upgrade

AuthType <value>¶

AuthType may be "None", "Basic", "Digest", "TLS", "TLS Basic" or "TLS Digest".

"None" requires no authentication.

"Basic" encodes passwords using Base64.

"Digest" hashes passwords using MD5.

"TLS" encrypts data but has no password.

"TLS Basic" encrypts data and encodes passwords using Base64.

"TLS Digest" encrypts data and hashes passwords using MD5.

User Level <value>¶

User Level may be "User", "Tech", "Admin" or "None".

"User" provides access to all users.

"Tech" provides users with Privilege "Tech" access only if one or more of their Zones are configured here. Users with Privilege "Admin" also have access.

"Admin" provides access only to users with Privilege "Admin".

"None" provides access to no users.

Zones <value>¶

Zones may contain combinations of "A", "B", "C", "D" or "E".

Select the Zones to be provided Tech access to this URI.

The meaning of the zones is determined by how you define them here. For example, say you define zones A and B via Access Controls:

/Toasters Tech A
/Blenders Tech B

Then over in Users you may reference zones:

admin Admin (has access to everything)
barry Tech A (has access to Toasters)
cindy Tech B (has access to Blenders)
david Tech A B (has access to Toasters and Blenders)
edwin User (has access to neither)

Config Interface level¶

These settings pertain to the Network Interface on the device. To see the effect of these selections after a reboot, view the corresponding Status. Changes will take effect after reboot or wake from standby.

show¶

Shows current configuration.

write¶

Writes any unsaved configuration.

exit¶

Returns to the previous level.

State <value>¶

State may be "Enabled" or "Disabled".

"Enabled" allows the Interface to operate.

DHCP Client <value>¶

DHCP Client may be "Enabled" or "Disabled".

When "Enabled", any configured IP Address or Default Gateway will be ignored. DHCP Client will auto-discover and eclipse those configuration items. Hostname is sent to the remote DHCP Server and may figure into the address assignment.

When DHCP Client fails to discover an IP Address, a new address will automatically be generated using AutoIP. This address will be within the 169.254.x.x space.

This setting is not applicable to ap0.

IP Address <value>¶

IP Address may contain up to 31 characters.

IP Address may be entered alone, in CIDR form, or with an explicit mask: 192.168.1.1 (default mask) 192.168.1.1/24 (CIDR) 192.168.1.1 255.255.255.0 (explicit mask)

The IP Address will be displayed always in CIDR, the canonical form.

Default Gateway <value>¶

Default Gateway may contain up to 15 characters.

The Default Gateway is used only if DHCP Client is disabled, and provides the IP Address of the router.

This setting is not applicable to ap0.

Hostname <value>¶

Hostname may contain up to 63 characters.

Hostname must begin with a letter or number, continue with letter, number, or hyphen, and must end with a letter or number.

If DHCP Client is "Enabled", the Hostname is sent to the remote DHCP Server and may figure into the address assignment.

This setting is not applicable to ap0.

Primary DNS <value>¶

Primary DNS may contain up to 15 characters.

The Primary DNS is the first choice when performing a Domain Name lookup.

This setting is not applicable to ap0.

Secondary DNS <value>¶

Secondary DNS may contain up to 15 characters.

The Secondary DNS is the second choice when performing a Domain Name lookup.

This setting is not applicable to ap0.

MSS <value>¶

MSS has units of bytes.

The Maximum Segment Size (MSS) applies to TCP connections on the Interface. This can be useful to avoid fragmentation over the network, which may be required because this device does not perform reassembly.

Config Line level¶

<instance> may be "1", "Virtual_1" or "Virtual_2".

These settings pertain to the Serial Line. Changes take effect immediately.

show¶

Shows current configuration.

write¶

Writes any unsaved configuration.

exit¶

Returns to the previous level.

Name <value>¶

Name may contain up to 25 characters.

The Name is for display purposes only.

Interface <value>¶

Interface may be "RS232", "RS485 Half-Duplex" or "RS485 Full-Duplex".

Tx to Rx delay <value>¶

Tx to Rx delay has units of milliseconds.

The Tx to Rx delay can be specified for the RS485 Half-Duplex (2 wire) mode. This is the delay after sending the last character out the wire, before switching to receive mode.

State <value>¶

State may be "Enabled" or "Disabled".

"Enabled" allows the Serial Line to operate.

Protocol <value>¶

Protocol may be "Command Line", "MACH10 Command Interface", "Modem Emulation", "Monitor", "Mux", "None", "Trouble Log" or "Tunnel".

Protocol selects the application to connect to the Line.

"Command Line" sets up a user interface containing commands to show device status and to change configuration. Simply paste in XML configuration to apply its settings to the device.

"MACH10 Command Interface" provides a command interface to the MACH10 serial API.

"Modem Emulation" implements legacy AT commands.

"Monitor" captures selected data.

"Mux" provides commands for sending / receiving data on multiple network connections.

"None" enables Line action commands.

"Trouble Log" sets up an output-only message log on the device.

"Tunnel" sets up the Line to work with the Tunnel application. See the Tunnel configuration options for details.

Baud Rate <value>¶

Baud Rate has units of bits per second.

When specifying a Custom baud rate in the Web Manager, select 'Custom' from the drop down list and then enter the desired rate in the text box.

Parity <value>¶

Parity may be "None", "Even" or "Odd".

Data Bits <value>¶

Data Bits may be "7" or "8".

Stop Bits <value>¶

Stop Bits may be "1" or "2".

Flow Control <value>¶

Flow Control may be "None", "Hardware" or "Software".

Xon Char <value>¶

Xon Char may contain one byte.

A control character <control>J, for example, counts as one.

A control character can be input in alternate forms:

\17 (decimal)
0x11 (hexadecimal)
<control>Q (control)

Xoff Char <value>¶

Xoff Char may contain one byte.

A control character <control>J, for example, counts as one.

A control character can be input in alternate forms:

\17 (decimal)
0x11 (hexadecimal)
<control>Q (control)

Gap Timer <value>¶

Gap Timer has units of milliseconds.

Blank the value for "<Four Character Periods>".

The driver forwards received serial bytes after the Gap Timer delay from the last character received. By default, the delay is four character periods at the current baud rate (minimum 1 ms).

Threshold <value>¶

Threshold has units of bytes.

The driver will forward received characters after Threshold bytes have been received.

Push <value>¶

Push may contain up to 2 bytes.

A control character <control>J, for example, counts as one.

If defined, the driver will forward received characters after the Push sequence of characters is received.

Config User level¶

These settings pertain to each User on the device.

show¶

Shows current configuration.

write¶

Writes any unsaved configuration.

exit¶

Returns to the previous level.

delete¶

Deletes this User.

Password¶

Password may contain up to 32 characters.

The CLI will prompt "Enter Password: ". The value will not be echoed.

Privilege <value>¶

Privilege may be "User", "Tech" or "Admin".

Sets the user Privilege which governs what they can do.

"User" has access only to areas with User Level set to "User".

"Tech" has access only to areas with User Level set to "User" or with User Level set to "Tech" within the designated Zones.

"Admin" has access to all except areas with User Level set to "None".

Zones <value>¶

Zones may contain combinations of "A", "B", "C", "D" or "E".

Zones designate areas that a "Tech" has access to.

The meaning of the zones is determined by how you define them over in HTTP Server Security Access Controls. For example, say you define zones A and B via Access Controls:

/Toasters Tech A
/Blenders Tech B

Then here you may reference zones:

admin Admin (has access to everything)
barry Tech A (has access to Toasters)
cindy Tech B (has access to Blenders)
david Tech A B (has access to Toasters and Blenders)
edwin User (has access to neither)

Config AES Credential level¶

Each AES Credential holds a secret Encrypt Key and Decrypt Key for secure communication.

show¶

Shows current configuration.

write¶

Writes any unsaved configuration.

exit¶

Returns to the previous level.

delete¶

Deletes this AES Credential.

Encrypt Key <value>¶

Encrypt Key may contain up to 32 bytes.

The Encrypt Key is used for encrypting outgoing data.

The Key is 16, 24, or 32 bytes in length. Any Key entered that is less than one of these is padded with zeroes. A byte specification comprises two nibble specifications with no intervening space. A nibble specification is a single digit from 0 to 9 or from "a" to "f" (representing 10 through 15). Example Hexadecimal key: 12 34 56 78 9a bc de f0 01 02 03 04 05 06 07 08

To remove the Key, set it blank.

Note that the Key is a shared secret so it must be known by both sides of the connection and kept secret.

Decrypt Key <value>¶

Decrypt Key may contain up to 32 bytes.

The Decrypt Key is used for decrypting incoming data.

The Key is 16, 24, or 32 bytes in length. Any Key entered that is less than one of these is padded with zeroes. A byte specification comprises two nibble specifications with no intervening space. A nibble specification is a single digit from 0 to 9 or from "a" to "f" (representing 10 through 15). Example Hexadecimal key: 12 34 56 78 9a bc de f0 01 02 03 04 05 06 07 08

To remove the Key, set it blank.

Note that the Key is a shared secret so it must be known by both sides of the connection and kept secret.

Config CLI Server level¶

These settings pertain to the CLI Server. Changes take effect immediately.

show¶

Shows current configuration.

write¶

Writes any unsaved configuration.

exit¶

Returns to the previous level.

Inactivity Timeout <value>¶

Inactivity Timeout has units of minutes, and/or hours.

Enter 0 for "<None>".

After this time period with no activity, the CLI Server will close the connection.

Telnet¶

Enters the "config CLI Server Telnet" Command level.

Config CLI Server Telnet level¶

show¶

Shows current configuration.

write¶

Writes any unsaved configuration.

exit¶

State <value>¶

State may be "Enabled" or "Disabled".

"Enabled" allows the device to be discovered.

"Disabled" prevents discovery from finding the device.

Config MACH10 level¶

write¶

Writes any unsaved configuration.

exit¶

Returns to the previous level.

Device¶

Enters the "config Mach10 Device" Command level.

These settings pertain to the MACH10 management platform.

Line <instance>¶

Enters the selected "config MACH10 Line" Command level.

<instance> may be "1", "Virtual_1" or "Virtual_2".

These settings pertain to the MACH10 management platform.

Config MACH10 Device level¶

These settings pertain to the MACH10 management platform.

show¶

Shows current configuration.

write¶

Writes any unsaved configuration.

exit¶

Returns to the previous level.

State <value>¶

State may be "Enabled" or "Disabled".

Status Update Interval <value>¶

Status Update Interval has units of minutes, hours, and/or days.

The Status Update Interval is the period of time that MACH10 waits between updating device status to the cloud.

The Status Update Interval can be configured between 1 minute and 1 day (1440 minutes).

Content Check Interval <value>¶

Content Check Interval has units of hours, and/or days.

The Content Check Interval is the period of time that MACH10 waits between checking the cloud for updates to firmware and configuration.

The Content Check Interval can be configured between 1 hour and 90 days (2160 hours).

Apply Firmware Updates <value>¶

Apply Firmware Updates may be "Enabled" or "Disabled".

Apply Configuration Updates <value>¶

Apply Configuration Updates may be "Never", "If Unchanged" or "Always".

If the If Unchanged option is selected, configuration updates will only be applied if the current configuration has not been locally modified.

Reboot After Configuration Update <value>¶

Reboot After Configuration Update may be "Enabled" or "Disabled".

If enabled, this setting will automatically reboot after a successful configuration upgrade.

The device will always reboot after a successful firmware upgrade.

Device Name <value>¶

Device Name may contain up to 63 characters.

The Device Name must be at least 2 characters long, and may contain alphanumeric, hyphen, or underscore characters (A-Z,a-z,0-9,-,_) only. The first and last characters must be alphanumeric.

Device Description <value>¶

Device Description may contain up to 63 characters.

The Device Description is optional.

Additional Logging <value>¶

Additional Logging may be "Enabled" or "Disabled".

When enabled, MACH10 will provide more information in the Trouble Log.

Active Connection <value>¶

Active Connection may be "1" or "2".

The Active Connection specifies which connection parameters will be used in communication with the cloud.

Connection <instance>¶

Enters the selected "config Mach10 Device Connection" Command level.

<instance> may range from 1 to 2.

The Connections define the parameters to use in communication with the cloud.

Up to 2 Connections can be defined, with the Active Connection selecting which will be used.

Config Mach10 Device Connection level¶

<instance> may range from 1 to 2.

The Connections define the parameters to use in communication with the cloud.

Up to 2 Connections can be defined, with the Active Connection selecting which will be used.

show¶

Shows current configuration.

write¶

Writes any unsaved configuration.

exit¶

Returns to the previous level.

Domain <value>¶

Domain may contain up to 63 characters.

The Domain specifies the MACH10 cloud host.

Local Port <value>¶

Blank the value for "<Random>".

The Local Port is random by default but can be overridden here.

Note: If you have bridging enabled, you will need to specify a non-random value here in order for MACH10 to operate correctly.

MQTT State¶

MQTT State may be "Enabled" or "Disabled".

This controls whether MACH10 will use MQTT to communicate with the cloud.

Note: MQTT requires a persistent connection.

MQTT Domain <value>¶

MQTT Domain may contain up to 63 characters.

The MQTT Domain specifies the MACH10 MQTT cloud host.

MQTT Local Port <value>¶

Blank the value for "<Random>".

The MQTT Local Port is random by default but can be overridden here.

Note: If you have bridging enabled, you will need to specify a non-random value here in order for MACH10 to operate correctly.

Config MACH10 Line level¶

<instance> may be "1", "Virtual_1" or "Virtual_2".

These settings pertain to the MACH10 managment platform.

show¶

Shows current configuration.

write¶

Writes any unsaved configuration.

exit¶

Returns to the previous level.

State <value>¶

State may be "Enabled" or "Disabled".

Project Tag <value>¶

Project Tag may contain up to 63 characters.

Status Update Interval <value>¶

Status Update Interval has units of minutes, hours, and/or days.

The Status Update Interval is the period of time that MACH10 waits between updating device status to the cloud.

The Status Update Interval can be configured between 1 minute and 1 day (1440 minutes).

Content Check Interval <value>¶

Content Check Interval has units of hours, and/or days.

The Content Check Interval is the period of time that MACH10 waits between checking the cloud for updates to firmware and configuration.

The Content Check Interval can be configured between 1 hour and 90 days (2160 hours).

Config Modem Emulation level¶

<instance> may be "1", "Virtual_1" or "Virtual_2".

Connections can be initiated and accepted using Modem "AT" commands incoming from the Serial Line.

show¶

Shows current configuration.

write¶

Writes any unsaved configuration.

exit¶

Returns to the previous level.

Listen Port <value>¶

Blank the value for "<None>".

Specify a Listen Port to accept connections on.

Connect Local Port <value>¶

Blank the value for "<Random>".

Optionally specify a Connect Local Port for ATD connections. Note that this is necessary for operation while bridging.

Echo Pluses <value>¶

Echo Pluses may be "Enabled" or "Disabled".

"Enabled" means pluses will be echoed back during a "pause +++ pause" escape sequence on the Serial Line.

Echo Commands <value>¶

Echo Commands may be "Enabled" or "Disabled".

"Enabled" (ATE1) means characters read on the Serial Line will be echoed while the Line is in Modem Command Mode.

Verbose Response <value>¶

Verbose Response may be "Enabled" or "Disabled".

"Enabled" (ATQ0) means Modem Response Codes are sent out on the Serial Line.

Response Type <value>¶

Response Type may be "Text" or "Numeric".

Either "Text" (ATV1) or "Numeric" (ATV0) representation for the Modem Response Codes are sent out on the Serial Line.

Error Unknown Commands <value>¶

Error Unknown Commands may be "Enabled" or "Disabled".

"Enabled" (ATU0) means ERROR is returned on the Serial Line for unrecognized AT commands.

"Disabled" (ATU1) means OK is returned for unrecognized AT commands.

Incoming Connection <value>¶

Incoming Connection may be "Disabled", "Automatic" or "Manual".

"Disabled" (ATS0=0) will refuse to answer.

"Automatic" (ATS0=1) will answer immediately.

"Manual" (ATS0=2 or higher) may be answered via the ATA command after an incoming RING.

Connect String <value>¶

Connect String may contain up to 30 characters.

The Connect String is a customized string that is sent to the Serial Line with the CONNECT Modem Response Code.

Display Remote IP <value>¶

Display Remote IP may be "Enabled" or "Disabled".

"Enabled" means the incoming RING sent on the Serial Line is followed by the IP address of the caller.

Config Monitor level¶

write¶

Writes any unsaved configuration.

exit¶

Returns to the previous level.

Initialization¶

Enters the "config Monitor Initialization" Command level.

These settings pertain to Monitor Initialization in the device.

Monitor will process any initialization message before it starts polling or process any control message. Response captured during initialization will be overwritten by any poll or control response.

Control¶

Enters the "config Monitor Control" Command level.

These settings pertain to Monitor Control in the device.

Control Message will be processed after receiving status action Send. Response will overwrite any response captured during initialization or poll. Response must be read before sending another status action Send or buffer will be reset.

Poll¶

Enters the "config Monitor Poll" Command level.

These settings pertain to Monitor Poll in the device.

Poll Message will be processed periodically. Response will overwrite any response captured during initialization or poll.

Filter¶

Enters the "config Monitor Filter" Command level.

These settings pertain to Monitor Filter in the device.

Filter settings will be applied to all received response. Filter results can be used to feed another filter or use as Data Reference.

Data¶

Enters the "config Monitor Data" Command level.

These settings pertain to Monitor Data in the device.

Data configured here will be accessible through the status of Monitor.

Config Monitor Initialization level¶

These settings pertain to Monitor Initialization in the device.

Monitor will process any initialization message before it starts polling or process any control message. Response captured during initialization will be overwritten by any poll or control response.

show¶

Shows current configuration.

write¶

Writes any unsaved configuration.

exit¶

Returns to the previous level.

Initial Delay <value>¶

Initial Delay has units of milliseconds.

Sets Initial Delay waited before monitor start processing any initialization message.

Message <instance>¶

Enters the selected "config Monitor Initialization Message" Command level.

<instance> may range from 1 to 4.

Config Monitor Initialization Message level¶

<instance> may range from 1 to 4.

show¶

Shows current configuration.

write¶

Writes any unsaved configuration.

exit¶

Returns to the previous level.

Command <value>¶

Command may contain up to 32 bytes.

Sets the Command in binary format.

Binary format takes printable characters (e.g. 'abc' for characters 'a', 'b' and 'c') or binary string (e.g. [0xa, 0xd] for line feed and carriage return).

End Character <value>¶

End Character may contain one byte.

A control character <control>J, for example, counts as one.

A control character can be input in alternate forms:

\17 (decimal)
0x11 (hexadecimal)
<control>Q (control)

Sets the End Character to indicate end of response.

Response is ended by any configured End Character, Length OR Timeout.

Length <value>¶

Length has units of bytes.

Sets the Length of response.

Response is ended by any configured End Character, Length OR Timeout.

Timeout <value>¶

Timeout has units of milliseconds.

Blank the value for "<Minimum>".

Sets the Timeout to receive response.

Response is ended by any configured End Character, Length OR Timeout.

Config Monitor Control level¶

These settings pertain to Monitor Control in the device.

Control Message will be processed after receiving status action Send. Response will overwrite any response captured during initialization or poll. Response must be read before sending another status action Send or buffer will be reset.

show¶

Shows current configuration.

write¶

Writes any unsaved configuration.

exit¶

Returns to the previous level.

Message <instance>¶

Enters the selected "config Monitor Control Message" Command level.

<instance> may range from 1 to 4.

Config Monitor Control Message level¶

<instance> may range from 1 to 4.

show¶

Shows current configuration.

write¶

Writes any unsaved configuration.

exit¶

Returns to the previous level.

Command <value>¶

Command may contain up to 32 bytes.

Sets the Command in binary format.

Binary format takes printable characters (e.g. 'abc' for characters 'a', 'b' and 'c') or binary string (e.g. [0xa, 0xd] for line feed and carriage return).

End Character <value>¶

End Character may contain one byte.

A control character <control>J, for example, counts as one.

A control character can be input in alternate forms:

\17 (decimal)
0x11 (hexadecimal)
<control>Q (control)

Sets the End Character to indicate end of response.

Response is ended by any configured End Character, Length OR Timeout.

Length <value>¶

Length has units of bytes.

Sets the Length of response.

Response is ended by any configured End Character, Length OR Timeout.

Timeout <value>¶

Timeout has units of milliseconds.

Blank the value for "<Minimum>".

Sets the Timeout to receive response.

Response is ended by any configured End Character, Length OR Timeout.

Config Monitor Poll level¶

These settings pertain to Monitor Poll in the device.

Poll Message will be processed periodically. Response will overwrite any response captured during initialization or poll.

show¶

Shows current configuration.

write¶

Writes any unsaved configuration.

exit¶

Returns to the previous level.

Message <instance>¶

Enters the selected "config Monitor Poll Message" Command level.

<instance> may range from 1 to 4.

Delay <value>¶

Delay has units of seconds, minutes, hours, and/or days.

Sets Delay waited before monitor starts processing all poll messages again. 0 means poll messages are sent only once.

Config Monitor Poll Message level¶

<instance> may range from 1 to 4.

show¶

Shows current configuration.

write¶

Writes any unsaved configuration.

exit¶

Returns to the previous level.

Command <value>¶

Command may contain up to 32 bytes.

Sets the Command in binary format.

Binary format takes printable characters (e.g. 'abc' for characters 'a', 'b' and 'c') or binary string (e.g. [0xa, 0xd] for line feed and carriage return).

End Character <value>¶

End Character may contain one byte.

A control character <control>J, for example, counts as one.

A control character can be input in alternate forms:

\17 (decimal)
0x11 (hexadecimal)
<control>Q (control)

Sets the End Character to indicate end of response.

Response is ended by any configured End Character, Length OR Timeout.

Length <value>¶

Length has units of bytes.

Sets the Length of response.

Response is ended by any configured End Character, Length OR Timeout.

Timeout <value>¶

Timeout has units of milliseconds.

Blank the value for "<Minimum>".

Sets the Timeout to receive response.

Response is ended by any configured End Character, Length OR Timeout.

Config Monitor Filter level¶

These settings pertain to Monitor Filter in the device.

Filter settings will be applied to all received response. Filter results can be used to feed another filter or use as Data Reference.

show¶

Shows current configuration.

write¶

Writes any unsaved configuration.

exit¶

Returns to the previous level.

Rule <instance>¶

Enters the selected "config Monitor Filter Rule" Command level.

<instance> may range from 1 to 4.

Config Monitor Filter Rule level¶

<instance> may range from 1 to 4.

show¶

Shows current configuration.

write¶

Writes any unsaved configuration.

exit¶

Returns to the previous level.

Source <value>¶

Source may contain up to 6 characters.

Sets the Source in dot number format.

Source defines the input of a filter. E.g. If the source of this Filter is the second trunk of data created by filter 1, Source must be set to "1.2". A Source of "0" indicates the raw response.

Dot number format could be "0" or two numbers separated by a dot (e.g. "1.2").

Mode <value>¶

Mode may be "All", "Delimiters" or "Binary".

"All" makes filter ouput to be a duplicate of input.

"Delimiters" filter breaks input up to 8 trunks separated by Binary String. Each trunk will not contain the delimiters.

"Binary" filter breaks input into 3 trunks according to Offset and Length.

Delimiter <instance>¶

Enters the selected "config Monitor Filter Rule Delimiter" Command level.

<instance> may range from 1 to 2.

Start Index <value>¶

Sets Start Index to indicate when Delimiters filter starts breaking input into trunks.

Offset <value>¶

Offset has units of bytes.

Sets Offset for the size of the first trunk of data created by Binary Filter.

Length <value>¶

Length has units of bytes.

Sets Length for the size of the second trunk of data created by Binary Filter. The third trunk of data created by Binary Filter will contain the rest of input.

Config Monitor Filter Rule Delimiter level¶

<instance> may range from 1 to 2.

show¶

Shows current configuration.

write¶

Writes any unsaved configuration.

exit¶

Returns to the previous level.

Binary String <value>¶

Binary String may contain up to 6 bytes.

Sets Binary String delimiter in binary format.

Delimiters break input up to 8 trunks separated by (but not containing) delimiters. A delimiter is recognized if any of the Binary String is completely matched.

Binary format takes printable characters (e.g. 'abc' for characters 'a', 'b' and 'c') or binary string (e.g. [0xa, 0xd] for line feed and carriage return).

Config Monitor Data level¶

These settings pertain to Monitor Data in the device.

Data configured here will be accessible through the status of Monitor.

show¶

Shows current configuration.

write¶

Writes any unsaved configuration.

exit¶

Returns to the previous level.

Selector <instance>¶

Enters the selected "config Monitor Data Selector" Command level.

<instance> may range from 1 to 8.

Config Monitor Data Selector level¶

<instance> may range from 1 to 8.

show¶

Shows current configuration.

write¶

Writes any unsaved configuration.

exit¶

Returns to the previous level.

Name <value>¶

Name may contain up to 16 characters.

Sets Name to enable the data selector.

Response <value>¶

Blank the value for "<None>".

Sets Response instance to select the source of data. Response instance corresponds to Poll or Control Message instance.

Reference <value>¶

Reference may contain up to 6 characters.

Sets the Reference in dot number format.

Reference selects the output of Monitor Filter. E.g. If data should select the second trunk of data created by filter 1, Reference must be set to "1.2". A Reference of "0" indicates the raw response.

Dot number format could be "0" or two numbers separated by a dot (e.g. "1.2").

Config NTP level¶

These configurables are for Simple NTP (SNTP).

show¶

Shows current configuration.

write¶

Writes any unsaved configuration.

exit¶

Returns to the previous level.

Server Hostname <value>¶

Server Hostname may contain up to 128 characters.

The Server Hostname is the name or IP address of an NTP server.

Sync Time <value>¶

Sync Time has units of seconds, minutes, and/or hours.

The NTP client waits Sync Time after successful update before querying again.

Config TLS Credential level¶

Manages certificates for TLS clients and servers.

NOTE: Minimum accepted RSA key size is 2048 bits.

show¶

Shows current configuration.

write¶

Writes any unsaved configuration.

exit¶

Returns to the previous level.

delete¶

Deletes this TLS Credential.

Protocols <value>¶

Protocols may contain combinations of "TLS1.0", "TLS1.1" or "TLS1.2".

However only these combinations are accepted:

TLS1.0
TLS1.1
TLS1.2
TLS1.1, TLS1.2
TLS1.0, TLS1.1, TLS1.2

Private Key¶

Private Key may contain up to 4000 characters.

The CLI will prompt "Enter Private Key, <escape> terminates: ". The value will not be echoed.

The Private Key is input and stored in PEM format.

Certificate¶

Certificate may contain up to 4000 characters.

The CLI will prompt "Enter Certificate, <escape> terminates: ". The value will not be echoed.

The Certificate is input and stored in PEM format.

Higher Authority <instance>¶

Enters the selected "config TLS Credential Higher Authority" Command level.

<instance> may range from 1 to 3.

Trusted Authority <instance>¶

Enters the selected "config TLS Credential Trusted Authority" Command level.

<instance> may range from 1 to 5.

Config TLS Credential Higher Authority level¶

<instance> may range from 1 to 3.

show¶

Shows current configuration.

write¶

Writes any unsaved configuration.

exit¶

Returns to the previous level.

Certificate¶

Certificate may contain up to 4000 characters.

The CLI will prompt "Enter Certificate, <escape> terminates: ". The value will not be echoed.

The Certificate is input and stored in PEM format.

When an incoming connection is attempted, the TLS Server will present Higher Authority certificates in its signing chain.

Config TLS Credential Trusted Authority level¶

<instance> may range from 1 to 5.

show¶

Shows current configuration.

write¶

Writes any unsaved configuration.

exit¶

Returns to the previous level.

Certificate¶

Certificate may contain up to 4000 characters.

The CLI will prompt "Enter Certificate, <escape> terminates: ". The value will not be echoed.

The Certificate is input and stored in PEM format.

TLS Client will accept a server presenting any of these Trusted Authority certificates.

Mutual Authentication
If any Trusted Authority certificate is present, TLS Server will require clients to match; otherwise clients are unrestricted.

Config Tunnel level¶

<instance> may be "1", "Virtual_1" or "Virtual_2".

write¶

Writes any unsaved configuration.

exit¶

Returns to the previous level.

Accept¶

Enters the "config Tunnel Accept" Command level.

Tunnel Accept controls how a tunnel behaves when a connection attempt originates from the network.

Line¶

Enters the "config Tunnel Line" Command level.

The Line Configuration applies to the Serial Line interface.

Connect¶

Enters the "config Tunnel Connect" Command level.

Tunnel Connect controls how a tunnel behaves when a connection attempt originates locally.

Disconnect¶

Enters the "config Tunnel Disconnect" Command level.

These settings relate to Disconnecting a Tunnel.

Packing¶

Enters the "config Tunnel Packing" Command level.

When Tunneling, instead of sending data on the network immediately after being read on the Serial Line, the data can be Packed (queued) and sent in larger chunks.

Config Tunnel Accept level¶

Tunnel Accept controls how a tunnel behaves when a connection attempt originates from the network.

show¶

Shows current configuration.

write¶

Writes any unsaved configuration.

exit¶

Returns to the previous level.

Mode <value>¶

Mode may be "Disable", "Always", "Any Character", "Start Character" or "Modem Control Asserted".

An Accept Tunnel can be started in a number of ways, according to its Mode:

"Disabled": never started.

"Always": always started.

"Any Character": started when any character is read on the Serial Line.

"Start Character": started when the Start Character is read on the Serial Line.

"Modem Control Asserted": started when the Modem Control pin is asserted on the Serial Line.

Local Port <value>¶

Blank the value for "<None>".

Local Port is required for the Tunnel to accept a connection.

Protocol <value>¶

Protocol may be "TCP", "TCP AES" or "TLS".

Credential <value>¶

Credential may contain up to 30 characters.

The Credential named here must belong to the selected Protocol.

Configure the named Credential on its seperate page. A Credential typically contains whatever keys, certificates, passwords, or usernames that are required for connection using the selected Protocol.

Start Character <value>¶

Start Character may contain one byte.

A control character <control>J, for example, counts as one.

A control character can be input in alternate forms:

\17 (decimal)
0x11 (hexadecimal)
<control>Q (control)

When the Start Character is received on the Serial Line, it enables the tunnel to listen for a network connection.

Flush Start Character <value>¶

Flush Start Character may be "Enabled" or "Disabled".

"Enabled" prevents forwarding of a start character from the Line into the network.

"Disabled" allows forwarding of a start character from the Line into the network.

Flush Line <value>¶

Flush Line may be "Enabled" or "Disabled".

Flush Line applies at the time when a connection is accepted from the network.

"Enabled" means any buffered characters from the Serial Line will be discarded when a connection is accepted.

"Disabled" means any characters received on the Serial Line will be buffered and sent after a connection is accepted.

Block Line <value>¶

Block Line may be "Enabled" or "Disabled".

"Enabled" (the debug setting) means incoming characters from the Serial Line will NOT be forwarded to the network. Instead, they will be buffered and will eventually flow off the Serial Line if hardware or software flow control is configured.

"Disabled" (the normal setting) means incoming characters from the Serial Line are sent on into the network. Any buffered characters are sent first.

Block Network <value>¶

Block Network may be "Enabled" or "Disabled".

"Enabled" (the debug setting) means incoming characters from the network will NOT be forwarded to the Serial Line. Instead, they will be buffered and will eventually flow off the network side.

"Disabled" (the normal setting) means incoming characters from the network are sent on into the Serial Line. Any buffered characters are sent first.

Password¶

Password may contain up to 31 characters.

The CLI will prompt "Enter Password: ". The value will not be echoed.

The Password must contain only alphanumeric characters and punctuation. When set, clients must send the correct password string to the unit within 30 seconds from opening network connection in order to enable data transmission. The password sent to the unit must be terminated with one of the following:

0A (Line Feed)
00 (Null)
0D 0A (Carriage Return / Line Feed)
0D 00 (Carriage Return / Null)

If Prompt for Password is "Enabled", the user will be prompted for the password upon connection.

Prompt for Password <value>¶

Prompt for Password may be "Enabled" or "Disabled".

Config Tunnel Line level¶

The Line Configuration applies to the Serial Line interface.

show¶

Shows current configuration.

write¶

Writes any unsaved configuration.

exit¶

Returns to the previous level.

DTR <value>¶

DTR may be "Asserted while connected", "Continuously asserted" or "Unasserted".

The DTR options select the conditions in which the Data Terminal Ready control signal on the Serial Line is asserted.

"Asserted while connected" causes DTR to be asserted whenever either a connect or an accept mode tunnel connection is active.

Config Tunnel Connect level¶

Tunnel Connect controls how a tunnel behaves when a connection attempt originates locally.

show¶

Shows current configuration.

write¶

Writes any unsaved configuration.

exit¶

Returns to the previous level.

Mode <value>¶

Mode may be "Disable", "Always", "Any Character", "Start Character" or "Modem Control Asserted".

A Connect Tunnel can be started in a number of ways, according to its Mode:

"Disabled": never started.

"Always": always started.

"Any Character": started when any character is read on the Serial Line.

"Start Character": started when the Start Character is read on the Serial Line.

"Modem Control Asserted": started when the Modem Control pin is asserted on the Serial Line.

Start Character <value>¶

Start Character may contain one byte.

A control character <control>J, for example, counts as one.

A control character can be input in alternate forms:

\17 (decimal)
0x11 (hexadecimal)
<control>Q (control)

When the Start Character is received on the Serial Line, it connects the tunnel.

Flush Start Character <value>¶

Flush Start Character may be "Enabled" or "Disabled".

"Enabled" prevents forwarding of a start character from the Line into the network.

"Disabled" allows forwarding of a start character from the Line into the network.

Local Port <value>¶

Blank the value for "<Random>".

The Local Port is by default random but can be overridden.

Host <instance>¶

Enters the selected "config Tunnel Connect Host" Command level.

<instance> may range from 1 to 2.

Connections <value>¶

Connections may be "Sequential", "Simultaneous" or "Round-Robin".

Connections controls how multiple hosts shall be used with a Connect Tunnel.

"Sequential" means the tunnel will start with host 1 and attempt each host in sequence until a connection is accepted.

"Simultaneous" means the tunnel will connect to all of the hosts that accept a connection.

"Round-Robin" means the tunnel connection attempts start with the host after whichever host had previously connected.

Reconnect Time <value>¶

Reconnect Time has units of seconds, minutes, and/or hours.

The Reconnect Time specifies how long to wait before trying to reconnect to the remote host after a previous attempt failed or the connection was closed.

Blank the display field to restore the default.

Flush Line <value>¶

Flush Line may be "Enabled" or "Disabled".

Flush Line applies at the time when a connection is established to the network.

"Enabled" means any buffered characters from the Serial Line will be discarded when a connection is established.

"Disabled" means any characters received on the Serial Line will be buffered and sent after a connection is established.

Block Line <value>¶

Block Line may be "Enabled" or "Disabled".

"Enabled" (the debug setting) means incoming characters from the Serial Line will NOT be forwarded to the network. Instead, they will be buffered and will eventually flow off the Serial Line if hardware or software flow control is configured.

"Disabled" (the normal setting) means incoming characters from the Serial Line are sent on into the network. Any buffered characters are sent first.

Block Network <value>¶

Block Network may be "Enabled" or "Disabled".

"Enabled" (the debug setting) means incoming characters from the network will NOT be forwarded to the Serial Line. Instead, they will be buffered and will eventually flow off the network side.

"Disabled" (the normal setting) means incoming characters from the network are sent on into the Serial Line. Any buffered characters are sent first.

Config Tunnel Connect Host level¶

<instance> may range from 1 to 2.

show¶

Shows current configuration.

write¶

Writes any unsaved configuration.

exit¶

Returns to the previous level.

Address <value>¶

Address may contain up to 50 characters.

The Host Address is required to enable a Connect Tunnel.

It designates the address of the remote host to connect to.

Either a DNS address or an IP address may be provided.

If your Protocol is UDP based and you want to listen rather than connect: Leave Host Port set to <None> and set Host Address to the Interface name you want to listen to ("ap0" or "wlan0").

Port <value>¶

Blank the value for "<None>".

The Host Port is required to enable a Connect Tunnel.

It designates the TCP or UDP port on the remote host to connect to.

Protocol <value>¶

Protocol may be "TCP", "TCP AES", "TLS" or "UDP".

Credential <value>¶

Credential may contain up to 30 characters.

The Credential named here must belong to the selected Protocol.

Configure the named Credential on its seperate page. A Credential typically contains whatever keys, certificates, passwords, or usernames that are required for connection using the selected Protocol.

Initial Send <value>¶

Initial Send may contain up to 32 characters.

The Initial Send string, if present, is sent out the network before any other data when the connection is established.

Reception <value>¶

Reception may be "Restricted" or "Unrestricted".

"Restricted" will discard any received UDP packets whose from address and port do not match the designated Host Address and Port. In UDP listen mode, the remote address and port of the first received packet are taken as designated until the socket is closed.

"Unrestricted" accepts any UDP packets directed to the Local Port regardless of where they came from.

Config Tunnel Disconnect level¶

These settings relate to Disconnecting a Tunnel.

show¶

Shows current configuration.

write¶

Writes any unsaved configuration.

exit¶

Returns to the previous level.

Stop Character <value>¶

Stop Character may contain one byte.

A control character <control>J, for example, counts as one.

A control character can be input in alternate forms:

\17 (decimal)
0x11 (hexadecimal)
<control>Q (control)

When the Stop Character is received on the Serial Line, it disconnects the tunnel.

Disable the Stop Character by blanking the field to set it to <None>.

Flush Stop Character <value>¶

Flush Stop Character may be "Enabled" or "Disabled".

"Enabled" prevents forwarding of a stop character from the Line into the network.

"Disabled" allows forwarding of a stop character from the Line into the network.

Modem Control <value>¶

Modem Control may be "Enabled" or "Disabled".

"Enabled" means disconnect when the Modem Control pin is not asserted on the Serial Line.

Timeout <value>¶

Timeout has units of milliseconds.

Blank the value for "<Disabled>".

Timeout enables disconnect after the tunnel is idle for a specified number of milliseconds.

Flush Line <value>¶

Flush Line may be "Enabled" or "Disabled".

"Enabled" means flush the Serial Line when the Tunnel is disconnected.

Config Tunnel Packing level¶

When Tunneling, instead of sending data on the network immediately after being read on the Serial Line, the data can be Packed (queued) and sent in larger chunks.

show¶

Shows current configuration.

write¶

Writes any unsaved configuration.

exit¶

Returns to the previous level.

Mode <value>¶

Mode may be "Disable", "Timeout" or "Send Character".

"Disable" means data is not packed.

"Timeout" means data is sent only after a timeout occurs.

"Send Character" means data is sent when the Send Character is read on the Serial Line.

Timeout <value>¶

Timeout has units of milliseconds.

If the oldest byte of queued data has been waiting for Timeout milliseconds, the queued data will be sent on the network immediately.

Threshold <value>¶

Threshold has units of bytes.

If the number of bytes of queued data reaches the Threshold, the queued data will be sent on the network immediately.

Send Character <value>¶

Send Character may contain one byte.

A control character <control>J, for example, counts as one.

A control character can be input in alternate forms:

\17 (decimal)
0x11 (hexadecimal)
<control>Q (control)

If used, the Send Character is a single printable character or a control character that, when read on the Serial Line, forces the queued data to be sent on the network immediately.

Flush Send Character <value>¶

Flush Send Character may be "Enabled" or "Disabled".

"Enabled" means the Send Character will NOT be sent from the Serial Line to the network.

"Disabled" means the Send Character WILL be forwarded from the Serial Line to the network.

Trailing Character <value>¶

Trailing Character may contain one byte.

A control character <control>J, for example, counts as one.

A control character can be input in alternate forms:

\17 (decimal)
0x11 (hexadecimal)
<control>Q (control)

The Trailing Character is an optional single printable character or control character that is injected into the outgoing data stream right after the Send Character.

Disable the Trailing Character by blanking the field to set it to <None>.

Config Custom level¶

User custom configuration values are stored under this group.

show¶

Shows current configuration.

write¶

Writes any unsaved configuration.

exit¶

Returns to the previous level.

delete¶

Deletes this Custom.

Item <instance>¶

Enters the selected "config Custom Item" Command level.

Creates <instance> if it does not already exist.

Config Custom Item level¶

show¶

Shows current configuration.

write¶

Writes any unsaved configuration.

exit¶

Returns to the previous level.

delete¶

Deletes this Custom Item.

Value <value>¶

Value may contain up to 63 characters.

Sets a custom configurable text Value of an Item. The Item <instance> is the name of this value.

File System level¶

stat [file]¶

Displays file or file system statistics

cat <file>¶

Displays file

cd <path>¶

Changes current directory

cp <source> <destination>¶

Copies a file

hexdump <file>¶

Displays file in hexadecimal format

ls [path]¶

Lists files and directories in specified directory

mkdir <directory>¶

Creates a directory

mv <source> <destination>¶

Renames a file or directory

pwd¶

Prints current working directory

rm <file>¶

Removes a file

rmdir <directory>¶

Removes a directory

tree [path]¶

Shows all files and directories from specified directory down

upload [-a] <filename>¶

Uploads file over CLI; -a appends to existing file

exit¶

Returns to the root Command level.

Status level¶

exit¶

Returns to the root Command level.

Clock¶

Enters the "status Clock" Command level.

This shows the current time.

If the time source is "Manual", the time can be set here as well.

CPM¶

Enters the "status CPM" Command level.

Device¶

Enters the "status Device" Command level.

This displays the current status of the Device.

Diagnostics¶

Enters the "status Diagnostics" Command level.

Ethernet¶

Enters the "status Ethernet" Command level.

This shows status of an Ethernet link on the device.

File System¶

Enters the "status File System" Command level.

This displays various statistics and current usage information of the flash File System.

HTTP Server¶

Enters the "status HTTP Server" Command level.

This displays the current status for the HTTP Server.

Interface¶

Enters the "status Interface" Command level.

This shows the status of the network Interface on the device.

When DHCP fails to discover an IP Address, a new address will automatically be generated using AutoIP. This address will be within the 169.254.x.x space.

Line <instance>¶

Enters the selected "status Line" Command level.

<instance> may be "1", "Virtual_1" or "Virtual_2".

This displays the current status and various statistics for the Serial Line.

CLI Server¶

Enters the "status CLI Server" Command level.

This displays current status for the CLI Server.

Discovery¶

Enters the "status Discovery" Command level.

This shows statistics for the Discovery service on the selected Interface.

MACH10¶

Enters the "status MACH10" Command level.

This shows the MACH10 status, including the last time that the status was updated, the last time that MACH10 checked for updates to configuration and firmware, and what updates are available.

Modem Emulation <instance>¶

Enters the selected "status Modem Emulation" Command level.

<instance> may be "1", "Virtual_1" or "Virtual_2".

This displays the current Modem Emulation Status.

Though settings are initialized according to their configuration, they may be changed by "AT" commands over the Serial Line.

Monitor¶

Enters the "status Monitor" Command level.

This displays the current status for Monitor.

NTP¶

Enters the "status NTP" Command level.

This shows statistics from the last successful NTP server synchronization.

TLS Credential <instance>¶

Enters the selected "status TLS Credential" Command level.

SMTP¶

Enters the "status SMTP" Command level.

This displays the SMTP Status.

Tunnel <instance>¶

Enters the selected "status Tunnel" Command level.

<instance> may be "1", "Virtual_1" or "Virtual_2".

This displays all the Tunnel Status both as an Aggregate and broken down by active Accept and Connect tunnels.

Custom¶

Enters the "status Custom" Command level.

Changes counts the number of times any custom group is saved.

Status Clock level¶

This shows the current time.

If the time source is "Manual", the time can be set here as well.

auto show¶

Shows and updates current status every second. Press any key to stop.

show¶

Shows current status.

exit¶

Returns to the previous level.

Current Time <value>¶

The format for setting time is YYYY-MM-DD hh:mm:ss, where the hours are in 24-hour format.

Status CPM level¶

exit¶

Returns to the previous level.

CPs¶

Enters the "status CPM CPs" Command level.

This displays the current status of the Configurable Pins.

It also allows control of Configurable Pins that are not active in a Group.

Roles¶

Enters the "status CPM Roles" Command level.

This displays the current status of the Configurable Pin Roles.

Status CPM CPs level¶

This displays the current status of the Configurable Pins.

It also allows control of Configurable Pins that are not active in a Group.

auto show¶

Shows and updates current status every second. Press any key to stop.

show¶

Shows current status.

exit¶

Returns to the previous level.

CP <instance>¶

Enters the selected "status CPM CPs CP" Command level.

<instance> may range from 1 to 3.

Status CPM CPs CP level¶

<instance> may range from 1 to 3.

auto show¶

Shows and updates current status every second. Press any key to stop.

show¶

Shows current status.

exit¶

Returns to the previous level.

Usage <value>¶

<value> may be "Input", "Output" or "Unused".

Assert <value>¶

<value> may be "High" or "Low".

Assert reflects the logical polarity of this Configurable Pin.

"High" means that a logical "1" corresponds to a voltage high condition on the pin.

"Low" means that a logical "1" corresponds to a voltage low condition on the pin.

Mode <value>¶

<value> may be "Push-Pull" or "Weak Pullup".

5-Volt tolerance NOTE: In order to sustain a voltage higher than VDD+0.3, the Mode must be set to "Push-Pull".

Value <value>¶

<value> may be "0" or "1".

Value is the logical value of the Configurable Pin. Its polarity depends on Assert.

"1" represents the "Asserted" state, "0" represents "Not asserted".

Status CPM Roles level¶

This displays the current status of the Configurable Pin Roles.

auto show¶

Shows and updates current status every second. Press any key to stop.

show¶

Shows current status.

exit¶

Returns to the previous level.

Role <instance>¶

Enters the selected "status CPM Roles Role" Command level.

"HTTP Server Trigger" turns on HTTP Server if Mode is "Triggered".

"Line 1 DSR" read by application.

"Line 1 DTR" set by application.

"Line 1 Flow.CTS" allows send if Flow Control is "Hardware".

"Line 1 Flow.RTS" active says can receive if Flow Control is "Hardware".

"User Data Updated" is active when user data changes, till Acknowledge action.

Status CPM Roles Role level¶

"HTTP Server Trigger" turns on HTTP Server if Mode is "Triggered".

"Line 1 DSR" read by application.

"Line 1 DTR" set by application.

"Line 1 Flow.CTS" allows send if Flow Control is "Hardware".

"Line 1 Flow.RTS" active says can receive if Flow Control is "Hardware".

"User Data Updated" is active when user data changes, till Acknowledge action.

auto show¶

Shows and updates current status every second. Press any key to stop.

show¶

Shows current status.

exit¶

Returns to the previous level.

State <value>¶

<value> may be "Inactive" or "Active".

If an input role has no CP assigned, the State may be manipulated via the CLI or Web Manager.

Status Device level¶

This displays the current status of the Device.

auto show¶

Shows and updates current status every second. Press any key to stop.

show¶

Shows current status.

exit¶

Returns to the previous level.

Save¶

The Save action works like the "write" command. Any cached configuration changes are committed, so they will apply after a reboot.

Without a Save, any cached configuration changes are lost after a reboot.

Reboot¶

The Reboot action shuts the device down and restarts it. Any cached configuration changes (those which have not been saved) are lost.

Factory Defaults¶

The Factory Defaults action restores the device configuration as it came from the factory. Any user changes to configuration are lost.

Status Diagnostics level¶

exit¶

Returns to the previous level.

Buffer Pools¶

Enters the "status Diagnostics Buffer Pools" Command level.

This displays information for each Buffer Pool.

Total is the number of buffers allocated to the pool.

Free is the remaining number of buffers available in the pool.

Hardware¶

Enters the "status Diagnostics Hardware" Command level.

This displays Hardware identification and capabilities.

Heap¶

Enters the "status Diagnostics Heap" Command level.

This displays Heap usage, state, and statistics.

IP Sockets¶

Enters the "status Diagnostics IP Sockets" Command level.

This displays information for each IP Socket.

Modules¶

Enters the "status Diagnostics Modules" Command level.

This displays Modules present on the device and their static memory usage.

Ping¶

Enters the "status Diagnostics Ping" Command level.

Threads¶

Enters the "status Diagnostics Threads" Command level.

This displays current existing Threads and their stack usage.

Status Diagnostics Buffer Pools level¶

This displays information for each Buffer Pool.

Total is the number of buffers allocated to the pool.

Free is the remaining number of buffers available in the pool.

auto show¶

Shows and updates current status every second. Press any key to stop.

show¶

Shows current status.

exit¶

Returns to the previous level.

Buffer Pool <instance>¶

Enters the selected "status Diagnostics Buffer Pools Buffer Pool" Command level.

Returns to the previous level.

IP Socket <instance>¶

Enters the selected "status Diagnostics IP Sockets IP Socket" Command level.

<instance> may range from 1 to 50.

Status Diagnostics IP Sockets IP Socket level¶

<instance> may range from 1 to 50.

auto show¶

Shows and updates current status every second. Press any key to stop.

show¶

Shows current status.

exit¶

Returns to the previous level.

Status Diagnostics Modules level¶

This displays Modules present on the device and their static memory usage.

auto show¶

auto show¶

Shows and updates current status every second. Press any key to stop.

show¶

Shows current status.

exit¶

Returns to the previous level.

Thread <instance>¶

Enters the selected "status Diagnostics Threads Thread" Command level.

Status Diagnostics Threads Thread level¶

auto show¶

Shows and updates current status every second. Press any key to stop.

show¶

Shows current status.

exit¶

Returns to the previous level.

Status Ethernet level¶

This shows status of an Ethernet link on the device.

auto show¶

Shows and updates current status every second. Press any key to stop.

show¶

Status File System level¶

This displays various statistics and current usage information of the flash File System.

auto show¶

Shows and updates current status every second. Press any key to stop.

show¶

Shows current status.

exit¶

Returns to the previous level.

Compact¶

Compact reorganizes data on the flash file system, recovering dirty space. File data is retained. Note that this happens automatically when attempting to write and no clean space is available, but dirty space is.

Format¶

Status Line Receiver level¶

auto show¶

Shows and updates current status every second. Press any key to stop.

show¶

Shows current status.

exit¶

Returns to the previous level.

Receive¶

The Receive action picks up characters from the Line.

First it must successfully open the Line; select Line Protocol of "None" so it may open it successfully.

Hex Receive¶

The Hex Receive action picks up bytes from the Line.

First it must successfully open the Line; select Line Protocol of "None" so it may open it successfully.

Status Line Transmitter level¶

auto show¶

Shows and updates current status every second. Press any key to stop.

show¶

Shows current status.

exit¶

Returns to the previous level.

Transmit <value>¶

The Transmit action sends characters to the Line.

First it must successfully open the Line; select Line Protocol of "None" so it may open it successfully.

Hex Transmit <value>¶

The Hex Transmit action sends bytes to the Line.

First it must successfully open the Line; select Line Protocol of "None" so it may open it successfully.

Status Line Signals level¶

auto show¶

Shows and updates current status every second. Press any key to stop.

show¶

Shows current status.

exit¶

Returns to the previous level.

Status Line Settings level¶

auto show¶

Shows and updates current status every second. Press any key to stop.

show¶

Shows current status.

exit¶

Returns to the previous level.

Status CLI Server level¶

This displays current status for the CLI Server.

auto show¶

Shows and updates current status every second. Press any key to stop.

show¶

Shows current status.

exit¶

Returns to the previous level.

Telnet¶

Enters the "status CLI Server Telnet" Command level.

Status CLI Server Telnet level¶

auto show¶

Shows and updates current status every second. Press any key to stop.

show¶

Shows current status.

exit¶

auto show¶

Shows and updates current status every second. Press any key to stop.

show¶

Shows current status.

exit¶

Returns to the previous level.

Status Modem Emulation Current Connection level¶

auto show¶

Shows and updates current status every second. Press any key to stop.

show¶

Shows current status.

exit¶

Returns to the previous level.

Kill¶

The Kill action manually disconnects an active Modem Emulation connection.

Status Monitor level¶

This displays the current status for Monitor.

auto show¶

Shows and updates current status every second. Press any key to stop.

show¶

Send¶

The Send action causes the device to send the associated control message.

Status NTP level¶

This shows statistics from the last successful NTP server synchronization.

auto show¶

Shows and updates current status every second. Press any key to stop.

show¶

Shows current status.

exit¶

Returns to the previous level.

Sync¶

The Sync action requests immediate clock synchronization with the NTP server.

Status TLS Credential level¶

auto show¶

Shows and updates current status every second. Press any key to stop.

show¶

Shows current status.

exit¶

Status SMTP level¶

This displays the SMTP Status.

exit¶

Returns to the previous level.

Send <value>¶

The Send action is not available to the web API.

Example usage follows:

Send <ssl server hostname> <username> <password> <from mail address> <first recipient mail address> [optional second recipient mail address] [...] <-- Empty line ends recipient list <subject> <first line of body> [optional second line of body] [...] <-- Empty line ends body

Status Tunnel level¶

<instance> may be "1", "Virtual_1" or "Virtual_2".

This displays all the Tunnel Status both as an Aggregate and broken down by active Accept and Connect tunnels.

auto show¶

Shows and updates current status every second. Press any key to stop.

show¶

Shows current status.

exit¶

Returns to the previous level.

Aggregate¶

Enters the "status Tunnel Aggregate" Command level.

Current Connection <instance>¶

Enters the selected "status Tunnel Current Connection" Command level.

Possible instance names are "Accept" and "Connect <n>", where <n> is the Host number, for example "Connect 1".

Returns to the previous level.

Acknowledge¶

The Acknowledge action deasserts the "User Data Updated" CP until the next configuration change.

XML level¶

action documentation¶

Dumps help for product actions.

documentation¶

Dumps help for product configurables.

xcr dump [group-list]¶

Dumps all XML configuration; stop with any character. Secret fields are shown without their values.

xcr settings [group-list]¶

Dumps only non-default XML configuration; stop with any character. Secret fields are shown without their values.

xsr dump [group-list]¶

Dumps XML status; stop with any character.

exit¶

Returns to the root Command level.

CLI Reference - PRELIMINARY¶

Navigating the CLI Hierarchy¶

Root Level Commands¶

Command Levels¶

Navigation Tips¶

Editing and Shortcut Keys¶

(Root) level¶

config¶

documentation¶

file system¶

help¶

status¶

tlog¶

xml¶

exit¶

Config level¶

exit¶

write¶

Clock¶

CPM¶

Ethernet¶

HTTP Server¶

Interface¶

Line <instance>¶

User <instance>¶

AES Credential <instance>¶

CLI Server¶

Discovery¶

MACH10¶

Modem Emulation <instance>¶

Monitor¶

NTP¶

TLS Credential <instance>¶

Tunnel <instance>¶

Custom <instance>¶

Config Clock level¶

show¶

write¶

exit¶

Source <value>¶

UTC Offset <value>¶

Config CPM level¶

show¶

write¶

exit¶

Role <instance>¶

Config CPM Role level¶

show¶

write¶

exit¶

CP <value>¶

State <value>¶

Assert <value>¶

Mode <value>¶

Config Ethernet level¶

show¶

write¶

exit¶

PHY Address <value>¶

Speed <value>¶

Duplex <value>¶

MDIO Logging <value>¶

Config HTTP Server level¶

show¶

write¶

exit¶

Mode <value>¶

Port <value>¶

Secure Port <value>¶

Secure Credential <value>¶

Authentication Timeout <value>¶

Inactivity Timeout <value>¶

Security¶

Config HTTP Server Security level¶

show¶

write¶

exit¶

Access Control <instance>¶

Config HTTP Server Security Access Control level¶

show¶