Lantronix MatchPort b/g Pro Command Reference Manual
  1. Manuals
  2. Brands
  3. Lantronix Manuals
  4. Server
  5. MatchPort b/g Pro
  6. Command reference manual

Lantronix MatchPort b/g Pro Command Reference Manual

Embedded device server
Hide thumbs Also See for MatchPort b/g Pro:
Table of Contents

Advertisement

Quick Links

Download this manual
MatchPort
b/g Pro
Embedded Device Server

Command Reference

Part Number 900-534
Revision D May 2013

Advertisement

Table of Contents
loading
Need help?

Need help?

Do you have a question about the MatchPort b/g Pro and is the answer not in the manual?

Questions and answers

Subscribe to Our Youtube Channel

Related Manuals for Lantronix MatchPort b/g Pro

Summary of Contents for Lantronix MatchPort b/g Pro

  • Page 1: Command Reference

    MatchPort b/g Pro Embedded Device Server Command Reference Part Number 900-534 Revision D May 2013...

  • Page 2: Copyright And Trademark

    Copyright and Trademark © 2013 Lantronix, Inc. All rights reserved. No part of the contents of this book may be transmitted or reproduced in any form or by any means without the written permission of Lantronix. MatchPort® and Lantronix® are registered trademarks of Lantronix, Inc. in the United States and other countries.

  • Page 3: Table Of Contents

    Table of Contents List of Figures _____________________________________________________________ 4 List of Tables ______________________________________________________________ 5 1: About This Guide Chapter Summaries ________________________________________________________ 6 Conventions ______________________________________________________________ 6 Additional Documentation ____________________________________________________ 7 2: Overview XML Architecture and Device Control ___________________________________________ 8 Command Line Interface _____________________________________________________ 8 3: Command Line Interface Configuration Using Telnet ___________________________________________________ 9 Configuration Using Serial Ports _______________________________________________ 9...

  • Page 4: List Of Figures

    List of Figures Figure 3-1 CLI Level Hierarchy ______________________________________________________ 12 Figure 3-2 Login Level Commands ___________________________________________________ 13 Figure 3-3 Enable Level Commands__________________________________________________ 13 Figure 4-1 DTD for XCRs __________________________________________________________ 14 Figure 4-2 XML Example __________________________________________________________ 15 Figure 4-3 XML Group Example _____________________________________________________ 16 Figure 4-4 XML Example of Multiple Named Values _____________________________________ 16 Figure 4-5 XML Example of Multiple Items _____________________________________________ 17 Figure 4-6 XML Example with Multiple Groups _________________________________________ 17...

  • Page 5: List Of Tables

    List of Tables Table 4-8 XCR Groups ____________________________________________________________ 20 Table 4-9 XSR Groups and Items ____________________________________________________ 33 Table 5-1 Commands and Levels ____________________________________________________ 47 MatchPort® b/g Pro Embedded Device Server Command Reference...

  • Page 6: 1: About This Guide

    MatchPort b/g Pro. Chapter 4: Configuration Using XML Lists XCR groups and items and describes how to use XCRs to configure the MatchPort b/g Pro. Chapter 5: Commands and Levels Provides an index of the CLI Command Hierarchy with hyperlinks to the corresponding command details.

  • Page 7: Additional Documentation

    Document Description MatchPort b/g Pro Embedded Describes how to configure and use the MatchPort b/g Pro Device Server User Guide MatchPort b/g Pro Embedded Contains information about the MatchPort b/g Pro hardware, the Device Server Integration Guide MatchPort b/g Pro demonstration board, and integrating MatchPort into your product.

  • Page 8: 2: Overview

    Overview Evolution OS® software is the Lantronix® cutting-edge operating system that supports three convenient configuration methods: Web Manager, Command Line Interface (CLI), and Extensible Markup Language (XML). For more information about the Web Manager, see the MatchPort b/g Pro User Guide at the Lantronix website.

  • Page 9: 3: Command Line Interface

    2. Type cmd in the dialog box and press OK. 3. Type telnet x.x.x.x (x.x.x.x is the IP address). The MatchPort b/g Pro is online when the command prompt (>) displays. You are at the root level of the CLI.

  • Page 10: Navigating The Cli Hierarchy

    3: Command Line Interface To configure the Lantronix device server locally using a serial port, connect a terminal or a PC running a terminal emulation program to one of the device server's serial ports. Configure the terminal for 9600 baud, 8-bit, no parity, 1 stop bit, and no flow control.

  • Page 11: Using Keyboard Shortcuts And Cli

    "tunnel" level, and network specific status and configuration commands are found under the "configuration" level. An overview of the levels in the MatchPort b/g Pro is presented in Figure 3-1.

  • Page 12: Figure 3-1 Cli Level Hierarchy

    3: Command Line Interface Figure 3-1 CLI Level Hierarchy configure (login) enable bridge device email telnet <number> diagnostics filesystem line <line> verbosity <number> host <number> http client icmp server ethernet if 1 link wireless if 2 tunnel link <line> accept ip filter cp output <number>...

  • Page 13: Figure 3-2 Login Level Commands

    <host> > To configure the MatchPort b/g Pro, you must be in the enable level and any of its sub-levels. Figure 3-3 shows the enable level commands. Figure 3-3 Enable Level Commands >enable...

  • Page 14: 4: Configuration Using Xml

    Configuration Using XML The MatchPort® b/g Pro embedded device server provides an Extensible Markup Language (XML) interface that you can use to configure device server devices. Every configuration setting that can be issued from the device server Web Manager and CLI can be specified using XML. The device server can import and export configuration settings as an XML document known as an XML Configuration Record (XCR).

  • Page 15: Quick Tour Of Xml Syntax

     name listed in the Web Manager XCR groups or with the “xcr list” CLI command. See the MatchPort b/g Pro User Guide for more information about the Web Manager XCR groups. An empty or missing <value> element in each present <configgroup> clears the ...

  • Page 16: Record, Group, Item, And Value Tags

    4: Configuration Using XML Record, Group, Item, and Value Tags A <configgroup> is a logical grouping of configuration parameters and must contain one or more <configitem> elements. It must have a name attribute and may have an instance attribute. A <configitem> is a specific grouping of configuration parameters relevant to its parent group. An item takes the name attribute and must contain one or more value elements.

  • Page 17: Importing And Exporting An Xml Configuration File

    Filesystem—XCRs can be saved to the device server file system and imported or accessed as  needed. See Best Practices or the Filesystem Browser section in the MatchPort b/g Pro User Guide. CLI—XCRs can be imported (captured) or exported (dumped) directly to a Telnet, SSH, or ...

  • Page 18: Best Practices

    4: Configuration Using XML settings specified. This can be done on any level, including the root. Special tags in the XML allow for providing root and enable level passwords so that this can also be done at the password prompt. Web browser—Web Manager can be used to import and export an XCR to the device server ...

  • Page 19: Exporting

    4: Configuration Using XML The following syntax can be used to export configurations to a file on the device server’s file system: xcr export <file> xcr export <file> <groups and/or group:instances> The same guidelines above regarding importing configurations also apply to exporting configurations.

  • Page 20: Xml Configuration Groups

    </configgroup> XML Configuration Groups Table 4-8 lists the MatchPort b/g Pro XCR groups in alphabetical order. This table indicates the various group items, as well as some possible value names and options. Note: Any instance of &#60; in the table may be read as < (the html encoded form for less than) and any instance of &#62;...
  • Page 21 4: Configuration Using XML Group Name Group Item Value Name Value Options Additional Information cli (continued) quit connect line Accepts text containing control characters, for example, &#60;control&#62; A represents control-A Default: <control>L inactivity timeout Default: 15 &#60;None&#62;, minutes cp group state enable Changes state of...
  • Page 22 4: Configuration Using XML Group Name Group Item Value Name Value Options Additional Information email priority urgent, high, normal, Default: normal (Attribute of low, very low “instance” is a group number.) (continued) trigger value ethernet speed auto, 10, 100 Default: auto (Attribute of duplex auto, half, full...
  • Page 23 4: Configuration Using XML Group Name Group Item Value Name Value Options Additional Information http server log format Default: %h %t (continued) "%r" %s %B "%{Referer}i" "%{User-Agent}i" authentication timeout Default: 30 minutes icmp state enable, disable Default: enable interface bootp enable, disable Default: disable (Attribute of...
  • Page 24 4: Configuration Using XML Group Name Group Item Value Name Value Options Additional Information ip filter delete entries enable, disable If enabled, deletes any existing entries before adding “filter entry”. filter delete ip address Deletes a specific IP filter entry. net mask Deletes a specific IP filter entry.
  • Page 25 4: Configuration Using XML Group Name Group Item Value Name Value Options Additional Information modbus tcp server state enable, disable Default: disable additional port &#60;None&#62;, ... Default: <None> response timeout Default: 3000 milliseconds trace input enable, disable Default: disable power state enable, disable management...
  • Page 26 4: Configuration Using XML Group Name Group Item Value Name Value Options Additional Information snmp state enable, disable Default: enable read community Value is SECRET, hidden from user view. Default: public write community Value is SECRET, hidden from user view. Default: private system contact system name...
  • Page 27 4: Configuration Using XML Group Name Group Item Value Name Value Options Additional Information ssh server host rsa keys public key private key host dsa keys public key private key delete authorized users authorized user delete name authorized user password (Attribute of “instance”...
  • Page 28 4: Configuration Using XML Group Name Group Item Value Name Value Options Additional Information tcp (continued) max retrans max retrans syn ack send data telnet state enable, disable Default: enable port Default: 23 max sessions Default: 3 terminal terminal type Default: (Attribute of UNKNOWN...
  • Page 29 4: Configuration Using XML Group Name Group Item Value Name Value Options Additional Information tunnel accept block serial enable, disable Default: disable (Attribute of block network enable, disable Default: disable “instance” is a password password Value is SECRET, number.) hidden from user (continued) view.
  • Page 30 4: Configuration Using XML Group Name Group Item Value Name Value Options Additional Information tunnel connect email connect &#60;None&#62;, ... Default: <None> (Attribute of email disconnect &#60;None&#62;, ... Default: <None> “instance” is a cp output goup connection value, number.) disconnection value (continued) tunnel stop character...
  • Page 31 4: Configuration Using XML Group Name Group Item Value Name Value Options Additional Information tunnel serial asserted while Default: asserted (Attribute of connected, while connected “instance” is a continuously number.) asserted, unasserted, truport state enable, disable default: disable wlan choice default_infrastructur e_profile (Attribute of an “instance”...
  • Page 32 4: Configuration Using XML Group Name Group Item Value Name Value Options Additional Information wlan security suite profile(Attribute key type of an “instance” passphrase is “default_ adhoc_profile” or wep authentication “default_infrastru wep key size cture_profile”) (continued) wep tx key index wep key 1 wep key 2 wep key 3...

  • Page 33: Xml Status Record Groups And Items

    4: Configuration Using XML XML Status Record Groups and Items Table 4-9 lists the supported XML Status Record (XSR) groups and items. These groups and items show the status of the device in XML form and can only be exported. The XSR schema differs slightly from the XCR groups and items in that the XSR allows groups within groups.
  • Page 34 4: Configuration Using XML Group Name Item Name Value Name Valid Values ethernet driver buffer headers total (Within group “buffer pool”.) free used max used cluster pool cluster size total free used max used filesystem filesystem size available space clean space dirty space file and dir space used data space used...
  • Page 35 4: Configuration Using XML Group Name Item Name Value Name Valid Values status running inactive connections rejected accepted last client ip address port hardware type speed memory flash size ram size http state enabled disabled logging entries bytes http log entry (Attribute of “instance”...
  • Page 36 4: Configuration Using XML Group Name Item Name Value Name Valid Values icmp messages messages discarded errors destination unreachable time exceeded messages parameter problems source quench requests redirects ping requests ping replies timestamp requests timestamp replies address mask requests address mask replies messages messages discarded errors...
  • Page 37 4: Configuration Using XML Group Name Item Name Value Name Valid Values interface generic status no link (Attribute of “instance” is link up “eth0”.) disabled unknown errors (error text) none ethernet (Present only for speed eth0.) duplex full half encapsulation ARPA type ARPA...
  • Page 38 4: Configuration Using XML Group Name Item Name Value Name Valid Values interface transmit octets (Attribute of “instance” is unicast “eth0”.) (Continued.) non unicast discards errors broadcast packets multicast packets filtered packets deferred multiple retries one retry underflows late collisions retry errors carrier lost errors receive...
  • Page 39 4: Configuration Using XML Group Name Item Name Value Name Valid Values interface receives (Attribute of an “instance” is header errors “wlan0”) (continued) address errors unknown protocols discarded delivered requests discards discards no route reassembly timeout needed success failures ip sockets ip socket protocol rx queue...
  • Page 40 4: Configuration Using XML Group Name Item Name Value Name Valid Values line receiver bytes (Attribute of “instance” is a breaks number.) parity errors framing errors overrun errors no receive buffer errors queued bytes flow control stop transmitter bytes breaks queued bytes flow control stop...
  • Page 41 4: Configuration Using XML Group Name Item Name Value Name Valid Values line (With no instance.) flow control hardware (Within group “line” with none instance.) (continued) software xon char xoff char memory main heap condition clean corrupt total memory available memory fragments allocated blocks processes...
  • Page 42 4: Configuration Using XML Group Name Item Name Value Name Valid Values state active waiting disabled totals uptime bytes in bytes out retransmission algorithm vanj timeout minimum timeout maximum connections maximum open active open passive failed resets established errors in resets segments retransmitted...
  • Page 43 4: Configuration Using XML Group Name Item Name Value Name Valid Values tunnel aggregate completed connects (Attribute of “instance” is a completed accepts number.) disconnects dropped connects dropped accepts octets from serial octets from network connect connection time accept connection time connect dns address changes connect dns address...

  • Page 44: 5: Configuration Using Xml

    Commands and Levels Click the level in the tree structure and it will take you to the command list for that level. root • enable (enable) • configure (config) • arp (config-arp) • bridge 1 (config-bridge:bridge0) • cli (config-cli) • ssh (config-cli-ssh) •...
  • Page 45 5: Commands and Levels • snmp (config-snmp) • traps (config-snmp-traps) • syslog (config-syslog) • tcp (config-tcp) • terminal 1 (config-terminal:1) • terminal 2 (config-terminal:2) • terminal network (config-terminal:network) • tftp (config-tftp) • udp (config-udp) • vip (config-vip) • wlan profiles (config-profiles) •...
  • Page 46 5: Commands and Levels • dns (dns) • email 1 (email:1) • cp (email-cp:1) • email 2 (email:2) • cp (email-cp:2) • email 3 (email:3) • cp (email-cp:3) • email 4 (email:4) • cp (email-cp:4) • filesystem (filesystem) • line 1 (line:1) •...

  • Page 47: Table 5-1 Commands And Levels

    5: Commands and Levels • host 3 (tunnel-connect-host:2:3) • host 4 (tunnel-connect-host:2:4) • host 5 (tunnel-connect-host:2:5) • host 6 (tunnel-connect-host:2:6) • host 7 (tunnel-connect-host:2:7) • host 8 (tunnel-connect-host:2:8) • host 9 (tunnel-connect-host:2:9) • host 10 (tunnel-connect-host:2:10) • host 11 (tunnel-connect-host:2:11) •...
  • Page 48 5: Commands and Levels Bytes may run together or be separated by optional punc- tuation: 123ABC "12 3A BC" 12,3A,BC 12.3a.bc 12:3a:bc Note that quotes must enclose the value if it contains spaces. aes encrypt key text <text> Sets the accept tunnel AES encrypt key with up to 16 bytes.
  • Page 49 5: Commands and Levels no local port Uses the default port number as the local port for accept mode tunneling. The default port is 10000 + #, where # is the line number for this tunnel. no tcp keep alive Disables the accept mode TCP keep alive timeout.
  • Page 50 5: Commands and Levels aes encrypt key <hexadecimal> Sets the accept tunnel AES encrypt key with up to 16 bytes. Each byte is represented by two adjacent hex digits. Bytes may run together or be separated by optional punc- tuation: 123ABC "12 3A BC"...
  • Page 51 5: Commands and Levels accept mode tunnel. no email disconnect Discontinues sending email alerts upon closing an accept mode tunnel. no local port Uses the default port number as the local port for accept mode tunneling. The default port is 10000 + #, where # is the line number for this tunnel.
  • Page 52 5: Commands and Levels beacon is 100 msec.) security Switch to security level show Displays the current configuration. show history Displays the last 20 commands entered during the current CLI session. tx data rate auto-reduction Enables TX data rate auto-reduction. tx data rate fixed Enables a fixed data rate.
  • Page 53 5: Commands and Levels show Displays the current configuration. show history Displays the last 20 commands entered during the current CLI session. tx data rate auto-reduction Enables TX data rate auto-reduction. tx data rate fixed Enables a fixed data rate. tx data rate maximum 1 mbps Sets the data rate maximum to 1 Mbps.
  • Page 54 5: Commands and Levels exit Exits to the config level. no bridging mac address Removes the Bridging MAC Address. show Displays the current configuration. show history Displays the last 20 commands entered during the current CLI session. show statistics Show bridge statistics show status Show bridge status state disable...
  • Page 55 5: Commands and Levels If the settings do not work, when you reboot the device, it will still have the original settings. clrscrn Clears the screen. exit Exits to the next higher level. no profile Removes reference to the profile. profile <text>...
  • Page 56 5: Commands and Levels show user <username> Show information for a user user <username> Set username and RSA or DSA keys user <username> command <command> Customizes the user command user <username> generate dsa 1024 Generate DSA public and private keys user <username>...
  • Page 57 5: Commands and Levels <line> = number of the terminal line (serial port) to be con- figured. terminal network Enters the configure-terminal level for the network. tftp Enters the tftp level. Changes to the command level for UDP configuration and status.
  • Page 58 5: Commands and Levels flush serial disable Characters already in the serial data buffer are retained upon establishing a connect mode tunneling connection. flush serial enable Flushes the serial data buffer upon establishing a connect mode tunneling connection. flush start character disable Enables forwarding of the connect start character into the network.
  • Page 59 5: Commands and Levels connections. connect mode any character Enables the tunneling server to establish a tunneling con- nection when a character is received on the corresponding line (serial port). connect mode disable Disables connect mode tunneling. connect mode modem control asserted Enables the tunneling server to make tunneling connec- tions when the modem control pin is asserted.
  • Page 60 5: Commands and Levels no email disconnect Discontinues sending email alerts upon closing a connect mode tunnel. promote host <number> Promotes the identified host, exchanging it place with the host above it, to adjust the order of the defined hosts. reconnect time <milliseconds>...
  • Page 61 5: Commands and Levels group <text> Specify a CP group that shall trigger an email. <text> = configurable pin group. no group Disables the trigger to send an email. no trigger value Clears the value that shall trigger an email. show Shows the current configuration.
  • Page 62 5: Commands and Levels <number> = binary to output (typically 1 or 0). default connection value Restores the default value for accept mode connection. default disconnection value Restores the default value for accept mode disconnection. disconnection value <number> Sets the value to output to the CP Group upon accept mode disconnection.
  • Page 63 5: Commands and Levels show Shows the current configuration. show history Displays the last 20 commands entered during the current CLI session. write Stores the current configuration in permanent memory. cpm (cpm) level commands add <cp> to <group> Adds the specified CP to the specified group. <cp>...
  • Page 64 5: Commands and Levels auto show tlog Continuously displays the internal trouble log. auto show upload Continuously displays the status of firmware upload. clrscrn Clears the screen. default long name Restores the default product long name. default short name Restores the default product short name. dhrystone Runs the Dhrystone benchmark program.
  • Page 65 5: Commands and Levels asserted. no stop character Removes the stop character. no timeout Disables disconnect after timeout feature for tunneling sessions. show Displays the current configuration. show history Displays the last 20 commands entered during the current CLI session. stop character <control>...
  • Page 66 5: Commands and Levels remove host <host> Removes an entry from the DNS Cache. show Show DNS status and cache entries. show history Displays the last 20 commands entered during the current CLI session. write Stores the current configuration in permanent memory. edit 1 (config-profile-basic:default_adhoc_profile) level commands advanced Switch to advanced level...
  • Page 67 5: Commands and Levels clear log Clears all entries from the mail log. clear mail counters Sets the email counters to zero. clrscrn Clears the screen. Enters the next lower level. default local port Sets the local port (used to send email alerts) to random. default priority Sets X-Priority for email alerts to 3 (normal).
  • Page 68 5: Commands and Levels to <text> Sets To addresses for email alerts. <text> = a quoted, semicolon separated list of email ad- dresses. write Stores the current configuration in permanent memory. email 2 (email:2) level commands auto show statistics Continuously displays email statistics. cc <text>...
  • Page 69 5: Commands and Levels server port <number> Sets the port used by the SMTP server. <number> = port used for SMTP on the server side. show Displays the current configuration. show history Displays the last 20 commands entered during the current CLI session.
  • Page 70 5: Commands and Levels priority high Sets X-Priority for email alerts to 2 (high). priority low Sets X-Priority for email alerts to 4 (low). priority normal Sets X-Priority for email alerts to 3 (normal). priority urgent Sets X-Priority for email alerts to 1 (urgent). priority very low Sets X-Priority for email alerts to 5 (very low).
  • Page 71 5: Commands and Levels no reply to Removes the Reply To address for email alerts. no subject Removes subject used for email alerts. no to Removes the To addresses for email alerts. overriding domain <text> Sets a domain name that will be used when connecting to an SMTP server to send an email alert instead of the device’s domain name in EHLO.
  • Page 72 5: Commands and Levels no clear interfaces counters Unzeros interface session counters ping <host> Ping destination continuously with 5 second timeout ping <host> <count> Ping destination n times with 5 second timeout ping <host> <count> <timeout> Ping destination n times with x timeout (in seconds) ppp <line>...
  • Page 73 5: Commands and Levels rmdir <directory> Remove a directory show Show file system statistics show history Displays the last 20 commands entered during the current CLI session. show tree Show all files and directories from current directory tftp get ascii <source file> <destination file> <host> Get an ascii file using TFTP tftp get ascii <source file>...
  • Page 74 5: Commands and Levels aes encrypt key <hexadecimal> Sets the connect tunnel AES encrypt key with up to 16 bytes. Each byte is represented by two adjacent hex digits. Bytes may run together or be separated by optional punc- tuation: 123ABC "12 3A BC"...
  • Page 75 5: Commands and Levels validate certificate enable Requires verification of the server certificate when con- necting. vip disable Makes connections using the specified Address. vip enable Makes connections using the VIP name. vip name <text> Sets the VIP name. write Stores the current configuration in permanent memory.
  • Page 76 5: Commands and Levels protocol ssl Uses SSL protocol for connect mode tunneling. protocol tcp Uses TCP protocol for connect mode tunneling. protocol tcp aes Uses TCP protocol with AES encryption for connect mode tunneling. protocol telnet Uses Telnet protocol (with IAC) for connect mode tunnel- ing.
  • Page 77 5: Commands and Levels ssh username <text> Sets the username for logging into the host via SSH. <text> = username. write Stores the current configuration in permanent memory. host 10 (tunnel-connect-host:2:10) level commands address <text> Sets the remote host to establish tunneling connections with.
  • Page 78 5: Commands and Levels protocol telnet Uses Telnet protocol (with IAC) for connect mode tunnel- ing. protocol udp Uses UDP protocol for connect mode tunneling. protocol udp aes Uses UDP protocol with AES encryption for connect mode tunneling. show Shows the current configuration. show history Displays the last 20 commands entered during the current CLI session.
  • Page 79 5: Commands and Levels clrscrn Clears the screen. default protocol Restores the default protocol as "TCP". default tcp keep alive Restores the default 45 second connect mode TCP keep alive timeout. exit Exits to the next higher level. no address Removes the remote host address used to establish tun- neling connections.
  • Page 80 5: Commands and Levels host <number> Change to config host level name <text> Sets the name of the host. <text> = name of the host. no name Clears the name of the host. no remote address Clears the remote address of the host. no ssh username Clears the SSH username associated with the host.
  • Page 81 5: Commands and Levels exit Exits to the next higher level. no address Removes the remote host address used to establish tun- neling connections. no aes decrypt key Removes the connect tunnel AES decrypt key. no aes encrypt key Removes the connect tunnel AES encrypt key. no port Removes the remote port used to establish tunnel con- nections.
  • Page 82 5: Commands and Levels aes decrypt key text <text> Sets the connect tunnel AES decrypt key with up to 16 bytes. Each byte is represented by a single character. Note that quotes must enclose the value if it contains spaces. aes encrypt key <hexadecimal>...
  • Page 83 5: Commands and Levels sets the timer. <milliseconds> = timer value, in milliseconds. validate certificate disable Skips verification of the server certificate when connect- ing. validate certificate enable Requires verification of the server certificate when con- necting. vip disable Makes connections using the specified Address. vip enable Makes connections using the VIP name.
  • Page 84 5: Commands and Levels spaces. aes encrypt key <hexadecimal> Sets the connect tunnel AES encrypt key with up to 16 bytes. Each byte is represented by two adjacent hex digits. Bytes may run together or be separated by optional punc- tuation: 123ABC "12 3A BC"...
  • Page 85 5: Commands and Levels ing. validate certificate enable Requires verification of the server certificate when con- necting. vip disable Makes connections using the specified Address. vip enable Makes connections using the VIP name. vip name <text> Sets the VIP name. write Stores the current configuration in permanent memory.
  • Page 86 5: Commands and Levels protocol ssh Uses SSH protocol for connect mode tunneling. protocol ssl Uses SSL protocol for connect mode tunneling. protocol tcp Uses TCP protocol for connect mode tunneling. protocol tcp aes Uses TCP protocol with AES encryption for connect mode tunneling.
  • Page 87 5: Commands and Levels CLI session. ssh username <text> Sets the username for logging into the host via SSH. <text> = username. write Stores the current configuration in permanent memory. host 13 (tunnel-connect-host:2:13) level commands address <text> Sets the remote host to establish tunneling connections with.
  • Page 88 5: Commands and Levels protocol tcp aes Uses TCP protocol with AES encryption for connect mode tunneling. protocol telnet Uses Telnet protocol (with IAC) for connect mode tunnel- ing. protocol udp Uses UDP protocol for connect mode tunneling. protocol udp aes Uses UDP protocol with AES encryption for connect mode tunneling.
  • Page 89 5: Commands and Levels auto show statistics show connection statistics clrscrn Clears the screen. default protocol Restores the default protocol as "TCP". default tcp keep alive Restores the default 45 second connect mode TCP keep alive timeout. exit Exits to the next higher level. no address Removes the remote host address used to establish tun- neling connections.
  • Page 90 5: Commands and Levels exit Exits to the configuration level. host <number> Change to config host level name <text> Sets the name of the host. <text> = name of the host. no name Clears the name of the host. no remote address Clears the remote address of the host.
  • Page 91 5: Commands and Levels alive timeout. exit Exits to the next higher level. no address Removes the remote host address used to establish tun- neling connections. no aes decrypt key Removes the connect tunnel AES decrypt key. no aes encrypt key Removes the connect tunnel AES encrypt key.
  • Page 92 5: Commands and Levels spaces. aes decrypt key text <text> Sets the connect tunnel AES decrypt key with up to 16 bytes. Each byte is represented by a single character. Note that quotes must enclose the value if it contains spaces.
  • Page 93 5: Commands and Levels tcp keep alive <milliseconds> Enables TCP keep alive for connect mode tunneling and sets the timer. <milliseconds> = timer value, in milliseconds. validate certificate disable Skips verification of the server certificate when connect- ing. validate certificate enable Requires verification of the server certificate when con- necting.
  • Page 94 5: Commands and Levels Note that quotes must enclose the value if it contains spaces. aes encrypt key <hexadecimal> Sets the connect tunnel AES encrypt key with up to 16 bytes. Each byte is represented by two adjacent hex digits. Bytes may run together or be separated by optional punc- tuation: 123ABC "12 3A BC"...
  • Page 95 5: Commands and Levels validate certificate disable Skips verification of the server certificate when connect- ing. validate certificate enable Requires verification of the server certificate when con- necting. vip disable Makes connections using the specified Address. vip enable Makes connections using the VIP name. vip name <text>...
  • Page 96 5: Commands and Levels protocol ssh Uses SSH protocol for connect mode tunneling. protocol ssl Uses SSL protocol for connect mode tunneling. protocol tcp Uses TCP protocol for connect mode tunneling. protocol tcp aes Uses TCP protocol with AES encryption for connect mode tunneling.
  • Page 97 5: Commands and Levels CLI session. ssh username <text> Sets the username for logging into the host via SSH. <text> = username. write Stores the current configuration in permanent memory. host 16 (tunnel-connect-host:2:16) level commands address <text> Sets the remote host to establish tunneling connections with.
  • Page 98 5: Commands and Levels protocol tcp aes Uses TCP protocol with AES encryption for connect mode tunneling. protocol telnet Uses Telnet protocol (with IAC) for connect mode tunnel- ing. protocol udp Uses UDP protocol for connect mode tunneling. protocol udp aes Uses UDP protocol with AES encryption for connect mode tunneling.
  • Page 99 5: Commands and Levels auto show statistics show connection statistics clrscrn Clears the screen. default protocol Restores the default protocol as "TCP". default tcp keep alive Restores the default 45 second connect mode TCP keep alive timeout. exit Exits to the next higher level. no address Removes the remote host address used to establish tun- neling connections.
  • Page 100 5: Commands and Levels exit Exits to the configuration level. host <number> Change to config host level name <text> Sets the name of the host. <text> = name of the host. no name Clears the name of the host. no remote address Clears the remote address of the host.
  • Page 101 5: Commands and Levels alive timeout. exit Exits to the next higher level. no address Removes the remote host address used to establish tun- neling connections. no aes decrypt key Removes the connect tunnel AES decrypt key. no aes encrypt key Removes the connect tunnel AES encrypt key.
  • Page 102 5: Commands and Levels spaces. aes decrypt key text <text> Sets the connect tunnel AES decrypt key with up to 16 bytes. Each byte is represented by a single character. Note that quotes must enclose the value if it contains spaces.
  • Page 103 5: Commands and Levels tcp keep alive <milliseconds> Enables TCP keep alive for connect mode tunneling and sets the timer. <milliseconds> = timer value, in milliseconds. validate certificate disable Skips verification of the server certificate when connect- ing. validate certificate enable Requires verification of the server certificate when con- necting.
  • Page 104 5: Commands and Levels Note that quotes must enclose the value if it contains spaces. aes encrypt key <hexadecimal> Sets the connect tunnel AES encrypt key with up to 16 bytes. Each byte is represented by two adjacent hex digits. Bytes may run together or be separated by optional punc- tuation: 123ABC "12 3A BC"...
  • Page 105 5: Commands and Levels validate certificate disable Skips verification of the server certificate when connect- ing. validate certificate enable Requires verification of the server certificate when con- necting. vip disable Makes connections using the specified Address. vip enable Makes connections using the VIP name. vip name <text>...
  • Page 106 5: Commands and Levels protocol ssh Uses SSH protocol for connect mode tunneling. protocol ssl Uses SSL protocol for connect mode tunneling. protocol tcp Uses TCP protocol for connect mode tunneling. protocol tcp aes Uses TCP protocol with AES encryption for connect mode tunneling.
  • Page 107 5: Commands and Levels CLI session. ssh username <text> Sets the username for logging into the host via SSH. <text> = username. write Stores the current configuration in permanent memory. host 4 (tunnel-connect-host:2:4) level commands address <text> Sets the remote host to establish tunneling connections with.
  • Page 108 5: Commands and Levels protocol tcp aes Uses TCP protocol with AES encryption for connect mode tunneling. protocol telnet Uses Telnet protocol (with IAC) for connect mode tunnel- ing. protocol udp Uses UDP protocol for connect mode tunneling. protocol udp aes Uses UDP protocol with AES encryption for connect mode tunneling.
  • Page 109 5: Commands and Levels auto show statistics show connection statistics clrscrn Clears the screen. default protocol Restores the default protocol as "TCP". default tcp keep alive Restores the default 45 second connect mode TCP keep alive timeout. exit Exits to the next higher level. no address Removes the remote host address used to establish tun- neling connections.
  • Page 110 5: Commands and Levels exit Exits to the configuration level. host <number> Change to config host level name <text> Sets the name of the host. <text> = name of the host. no name Clears the name of the host. no remote address Clears the remote address of the host.
  • Page 111 5: Commands and Levels alive timeout. exit Exits to the next higher level. no address Removes the remote host address used to establish tun- neling connections. no aes decrypt key Removes the connect tunnel AES decrypt key. no aes encrypt key Removes the connect tunnel AES encrypt key.
  • Page 112 5: Commands and Levels spaces. aes decrypt key text <text> Sets the connect tunnel AES decrypt key with up to 16 bytes. Each byte is represented by a single character. Note that quotes must enclose the value if it contains spaces.
  • Page 113 5: Commands and Levels tcp keep alive <milliseconds> Enables TCP keep alive for connect mode tunneling and sets the timer. <milliseconds> = timer value, in milliseconds. validate certificate disable Skips verification of the server certificate when connect- ing. validate certificate enable Requires verification of the server certificate when con- necting.
  • Page 114 5: Commands and Levels Note that quotes must enclose the value if it contains spaces. aes encrypt key <hexadecimal> Sets the connect tunnel AES encrypt key with up to 16 bytes. Each byte is represented by two adjacent hex digits. Bytes may run together or be separated by optional punc- tuation: 123ABC "12 3A BC"...
  • Page 115 5: Commands and Levels validate certificate disable Skips verification of the server certificate when connect- ing. validate certificate enable Requires verification of the server certificate when con- necting. vip disable Makes connections using the specified Address. vip enable Makes connections using the VIP name. vip name <text>...
  • Page 116 5: Commands and Levels protocol ssh Uses SSH protocol for connect mode tunneling. protocol ssl Uses SSL protocol for connect mode tunneling. protocol tcp Uses TCP protocol for connect mode tunneling. protocol tcp aes Uses TCP protocol with AES encryption for connect mode tunneling.
  • Page 117 5: Commands and Levels CLI session. ssh username <text> Sets the username for logging into the host via SSH. <text> = username. write Stores the current configuration in permanent memory. host 7 (tunnel-connect-host:2:7) level commands address <text> Sets the remote host to establish tunneling connections with.
  • Page 118 5: Commands and Levels protocol tcp aes Uses TCP protocol with AES encryption for connect mode tunneling. protocol telnet Uses Telnet protocol (with IAC) for connect mode tunnel- ing. protocol udp Uses UDP protocol for connect mode tunneling. protocol udp aes Uses UDP protocol with AES encryption for connect mode tunneling.
  • Page 119 5: Commands and Levels auto show statistics show connection statistics clrscrn Clears the screen. default protocol Restores the default protocol as "TCP". default tcp keep alive Restores the default 45 second connect mode TCP keep alive timeout. exit Exits to the next higher level. no address Removes the remote host address used to establish tun- neling connections.
  • Page 120 5: Commands and Levels exit Exits to the configuration level. host <number> Change to config host level name <text> Sets the name of the host. <text> = name of the host. no name Clears the name of the host. no remote address Clears the remote address of the host.
  • Page 121 5: Commands and Levels alive timeout. exit Exits to the next higher level. no address Removes the remote host address used to establish tun- neling connections. no aes decrypt key Removes the connect tunnel AES decrypt key. no aes encrypt key Removes the connect tunnel AES encrypt key.
  • Page 122 5: Commands and Levels spaces. aes decrypt key text <text> Sets the connect tunnel AES decrypt key with up to 16 bytes. Each byte is represented by a single character. Note that quotes must enclose the value if it contains spaces.
  • Page 123 5: Commands and Levels tcp keep alive <milliseconds> Enables TCP keep alive for connect mode tunneling and sets the timer. <milliseconds> = timer value, in milliseconds. validate certificate disable Skips verification of the server certificate when connect- ing. validate certificate enable Requires verification of the server certificate when con- necting.
  • Page 124 5: Commands and Levels Note that quotes must enclose the value if it contains spaces. aes encrypt key <hexadecimal> Sets the connect tunnel AES encrypt key with up to 16 bytes. Each byte is represented by two adjacent hex digits. Bytes may run together or be separated by optional punc- tuation: 123ABC "12 3A BC"...
  • Page 125 5: Commands and Levels validate certificate disable Skips verification of the server certificate when connect- ing. validate certificate enable Requires verification of the server certificate when con- necting. vip disable Makes connections using the specified Address. vip enable Makes connections using the VIP name. vip name <text>...
  • Page 126 5: Commands and Levels protocol ssh Uses SSH protocol for connect mode tunneling. protocol ssl Uses SSL protocol for connect mode tunneling. protocol tcp Uses TCP protocol for connect mode tunneling. protocol tcp aes Uses TCP protocol with AES encryption for connect mode tunneling.
  • Page 127 5: Commands and Levels CLI session. ssh username <text> Sets the username for logging into the host via SSH. <text> = username. write Stores the current configuration in permanent memory. http (config-http) level commands auth <uri> <realm> Creates a new HTTP server authentication directive. <uri>...
  • Page 128 5: Commands and Levels delete auth user <uri> <user> Deletes an existing user for an HTTP Server authentica- tion directive. <uri> = URI of the server. <user> = username. exit Returns to the config level. log format <text> Sets the log format string for the HTTP server, using the following directives: %a remote ip address (could be a proxy)
  • Page 129 5: Commands and Levels write Stores the current configuration in permanent memory. icmp (config-icmp) level commands auto show statistics Continuously shows ICMP statistics clear counters Zeros counters clrscrn Clears the screen. exit Exits to the configuration level. no clear counters Unzeros IP counters show Displays the current configuration.
  • Page 130 5: Commands and Levels show Displays the current configuration. show history Displays the last 20 commands entered during the current CLI session. show status Show interface status state disable Disables the interface. state enable Enables the interface. write Stores the current configuration in permanent memory. if 2 (config-if:wlan0) level commands bootp disable Disables BOOTP.
  • Page 131 5: Commands and Levels ip (config-ip) level commands auto show statistics Continuously shows IP statistics clear counters Zeros counters clrscrn Clears the screen. default ip time to live Restores the default IP time to live. default multicast time to live Restores the default IP multicast time to live, which is one hop.
  • Page 132 5: Commands and Levels write Stores the current configuration in permanent memory. key 1 (config-profile-security-wep-key:default_adhoc_profile:1) level commands apply wlan Try out WLAN settings without saving them to Flash. If the settings do not work, when you reboot the device, it will still have the original settings. clrscrn Clears the screen.
  • Page 133 5: Commands and Levels tuation: 123ABC "12 3A BC" 12,3A,BC 12.3a.bc 12:3a:bc Note that quotes must enclose the value if it contains spaces. key text <text> Sets key. Each byte is represented by a single character. Note that quotes must enclose the value if it contains spaces.
  • Page 134 5: Commands and Levels CLI session. write Stores the current configuration in permanent memory. key 4 (config-profile-security-wep-key:default_infrastructure_profile:4) level commands apply wlan Try out WLAN settings without saving them to Flash. If the settings do not work, when you reboot the device, it will still have the original settings.
  • Page 135 5: Commands and Levels command mode always Sets the current line to always be in command mode. command mode cp Sets the current line to enter command mode under con- trol of a CP. command mode cp <cp group> <value> Specifies the CP group and trigger value.
  • Page 136 5: Commands and Levels kill session Kills command mode session on the Line line <line> Enters the line level. <line> = number of the line (serial port) to be configured. lpd <line> Enters the configure lpd level. <line> = number of the line (lpd serial port) to be config- ured.
  • Page 137 5: Commands and Levels write Stores the current configuration in permanent memory. xoff char <control> Sets the xoff character for use with software flow control on this line. The character may be input as text, control, decimal, or hex. A control character has the form <control>C. A decimal value character has the form \99.
  • Page 138 5: Commands and Levels default data bits Restores the default of eight data bits. default flow control Restores the default of no flow control. default interface Restores the default interface type to this line. default parity Restores the default of no parity. default protocol Restores the default protocol on the line.
  • Page 139 5: Commands and Levels reassert Asserts line status with current configured values. show Displays the current status. show command mode Shows the command mode settings for the current line. show history Displays the last 20 commands entered during the current CLI session.
  • Page 140 5: Commands and Levels roaming disable Disables roaming. roaming enable Enables roaming to other Access Points with the same SSID. scan Scan the radio environment for all networks. scan <ssid> Scan the radio environment for the named network. show Displays the current configuration. show history Displays the last 20 commands entered during the current CLI session.
  • Page 141 5: Commands and Levels clrscrn Clears the screen. exit Exits to the enable level. kill <line> Kills the current print job on the specified line. <line> = LPD line with print job. show <line> Displays lpd status for the specified line. <line>...
  • Page 142 5: Commands and Levels no queue name Removes the queue name. no soj text Removes the start-of-job string. ppp <line> Enters the serial line PPP level. queue name <text> Sets the name of the queue that this lpd line belongs to. <text>...
  • Page 143 5: Commands and Levels eoj text binary <binary> Sets the end-of-job text allowing for binary characters. <binary> = string in binary format that will be sent to the printer at the end of each print job. Within [] use binary decimal up to 255 or hex up to 0xFF. eoj text set <text>...
  • Page 144 5: Commands and Levels additional port <number> Sets an additional TCP server port. clrscrn Clears the screen. default response timeout Restores the default Modbus Response Timeout. exit Exits to the config level. kill connection <index> Kills modbus connection selected by index from show connections.
  • Page 145 5: Commands and Levels verbose response enable Sends Modem Response Codes out on the Serial Line. write Stores the current configuration in permanent memory. modem (tunnel-modem:1) level commands clrscrn Clears the screen. connect string <text> Sets the CONNECT string used in modem emulation. <string>...
  • Page 146 5: Commands and Levels packing mode timeout Sets packing mode to accumulate data and transmit it after a specified amount of time (timeout). send character <control> Sets the send character for packing mode. The character may be input as text, control, decimal, or hex.
  • Page 147 5: Commands and Levels <milliseconds> = timeout value, in milliseconds. trailing character <control> Sets the trailing character for packing mode. The character may be input as text, control, decimal, or hex. A control character has the form <control>C. A decimal value character has the form \99. A hex value character has the form 0xFF.
  • Page 148 5: Commands and Levels exit Exits to the configuration level. line <line> Enters the line level. <line> = number of the line (serial port) to be configured. local ip <ip address/cidr> Sets the Local IP address and network mask. Formats accepted: 192.168.1.1 (default mask) 192.168.1.1/24 (CIDR) "192.168.1.1 255.255.255.0"...
  • Page 149 5: Commands and Levels no local ip Removes the Local IP address. no password Removes the PPP authentication password. no peer ip Removes the peer IP address. no username Removes the PPP authentication username. password <text> Sets the password for PPP authentication. peer ip <ip address>...
  • Page 150 <text> = put quotes around characters that make up the passphrase. Please refer to the other equipment’s manual to determine the passphrase input style recommended. NOTE: Lantronix recommends using a passphrase of 20 characters or more for maximum security. Spaces and punctuation characters are permitted. show Displays the current configuration.
  • Page 151 <text> = put quotes around characters that make up the passphrase. Please refer to the other equipment’s manual to determine the passphrase input style recommended. NOTE: Lantronix recommends using a passphrase of 20 characters or more for maximum security. Spaces and punctuation characters are permitted. show Displays the current configuration.
  • Page 152 5: Commands and Levels clrscrn Clears the screen. default dtr Restores default DTR control, asserted while connected. dtr asserted while connected Asserts DTR whenever a connect or accept mode tunnel connection is active. dtr continuously asserted Asserts DTR regardless of any connections. dtr truport Asserts DTR to match remote DSR when connected via Telnet.
  • Page 153 5: Commands and Levels snmp (config-snmp) level commands clrscrn Clears the screen. default read community Clears the SNMP read-only community. default system description Restores the SNMP system description to its default. default system name Restores the SNMP system name to default: the product name.
  • Page 154 5: Commands and Levels show history Displays the last 20 commands entered during the current CLI session. show statistics Displays the SSH server statistics. state disable Disables the SSH Server. state enable Enables the SSH Server. write Stores the current configuration in permanent memory. ssl (ssl) level commands authority Adds an Authority Certificate.
  • Page 155 5: Commands and Levels show history Displays the last 20 commands entered during the current CLI session. show statistics Displays the syslog statistics. state disable Disables syslog logging. state enable Enables syslog logging. write Stores the current configuration in permanent memory. tcp (config-tcp) level commands ack limit <packets>...
  • Page 156 5: Commands and Levels <number> = local port number. show Displays the current configuration. show history Displays the last 20 commands entered during the current CLI session. show statistics Displays the Telnet statistics. state disable Disables the Telnet Server. state enable Enables the Telnet Server.
  • Page 157 5: Commands and Levels terminal network Enters the configure-terminal level for the network. terminal type <text> Sets the terminal type. tunnel <line> Enters the tunnel level. <line> = number of the tunnel line (serial port) to be con- figured. write Stores the current configuration in permanent memory.
  • Page 158 5: Commands and Levels tunnel <line> Enters the tunnel level. <line> = number of the tunnel line (serial port) to be con- figured. write Stores the current configuration in permanent memory. terminal network (config-terminal:network) level commands break duration <milliseconds> Sets how long a break should last when it is being sent to the line.
  • Page 159 5: Commands and Levels figured. write Stores the current configuration in permanent memory. tftp (config-tftp) level commands allow file creation disable Prohibits the TFTP server from creating files on the file system. allow file creation enable Enables the TFTP server to create files on the file system. allow firmware update disable The TFTP server rejects any attempt to update firmware.
  • Page 160 5: Commands and Levels <line> = number of the line (lpd serial port) to be config- ured. modem Enters the modem level for this tunnel. no clear counters Unzeros all tunnel counters packing Enters the packing level for this tunnel. ppp <line>...
  • Page 161 5: Commands and Levels exit Exits to the configuration level. no clear counters Unzeros IP counters show history Displays the last 20 commands entered during the current CLI session. show statistics Shows UDP statistics write Stores the current configuration in permanent memory. verbosity (config-diagnostics-verbosity) level commands clrscrn Clears the screen.
  • Page 162 5: Commands and Levels tx key index 2 Selects key 2 for transmission encryption. tx key index 3 Selects key 3 for transmission encryption. tx key index 4 Selects key 4 for transmission encryption. write Stores the current configuration in permanent memory. wep (config-profile-security-wep:default_adhoc_profile) level commands apply wlan Try out WLAN settings without saving them to Flash.
  • Page 163 5: Commands and Levels topic init disable Disables this WLAN verbosity topic. topic init enable Enables this WLAN verbosity topic. topic ioctl disable Disables this WLAN verbosity topic. topic ioctl enable Enables this WLAN verbosity topic. topic proc disable Disables this WLAN verbosity topic. topic proc enable Enables this WLAN verbosity topic.
  • Page 164 5: Commands and Levels eap-ttls option mschap Sets the EAP-TTLS authentication protocol option to MSCHAP. eap-ttls option mschapv2 Sets the EAP-TTLS authentication protocol option to MSCHAP V2. eap-ttls option pap Sets the EAP-TTLS authentication protocol option to PAP. encryption ccmp disable Disables this encryption method.
  • Page 165 5: Commands and Levels clrscrn Clears the screen. default authentication Restores the authentication method to the default value (PSK). default eap-ttls option Restores the eap-ttls protocol options to the default (EAP- MSCHAP V2). default encryption Restores the encryption type to the default value (none enabled).
  • Page 166 5: Commands and Levels show Shows the current configuration. show history Displays the last 20 commands entered during the current CLI session. username <text> Sets the value of the username. <text> = value in characters (max 63). validate certificate disable Skips verification of the server certificate when connect- ing.

Table of Contents