Lantronix XPort Pro Command Reference Manual
  1. Manuals
  2. Brands
  3. Lantronix Manuals
  4. Server
  5. xport pro
  6. Command reference manual

Lantronix XPort Pro Command Reference Manual

Hide thumbs Also See for XPort Pro:
Table of Contents

Advertisement

Quick Links

Download this manual See also: User Manual
XPort Pro™ Command Reference
Part Number 900-558
Revision A September 2009

Advertisement

Table of Contents
loading
Need help?

Need help?

Do you have a question about the XPort Pro and is the answer not in the manual?

Questions and answers

Related Manuals for Lantronix XPort Pro

Summary of Contents for Lantronix XPort Pro

  • Page 1 XPort Pro™ Command Reference Part Number 900-558 Revision A September 2009...

  • Page 2: Copyright & Trademark

    Copyright & Trademark © 2009, Lantronix. 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. Printed in the United States of America.

  • Page 3: Table Of Contents

    Level Commands .................... 25 disconnect Level Commands ..................26 enable Level Commands.................... 27 filesystem Level Commands ..................30 ftp Level Commands ....................31 host <number> Level Commands ................32 http Level Commands ....................33 icmp Level Commands....................35 XPort Pro™ Command Reference...
  • Page 4 Importing and Exporting an XML Configuration File ..........68 Best Practices......................68 Importing and Exporting Partial Configurations _________________________ 68 Including Passwords in the XML File _________________________________ 70 Special XCR Items _______________________________________________ 70 XML Configuration Groups..................70 XML Status Groups and Items ................... 86 XPort Pro™ Command Reference...
  • Page 5 Contents Index XPort Pro™ Command Reference...

  • Page 6: 1: Introduction

    Evolution OS™, the Lantronix cutting edge operating system, supports three convenient configuration methods (Web, command line, and XML). This Command Reference describes how to configure Lantronix device servers running on Evolution using Command-Line and XML interfaces. Command Line Interface (CLI): Making the edge-to-enterprise vision a reality, Evolution OS™...

  • Page 7: 2: Configuration Using Telnet Or A Serial Port

    As an alternative to using the Web Manager, you can configure the Lantronix Evolution device server using a series of commands through the Command Line Interface (CLI). You can access the CLI through a Telnet session, an SSH session, or a direct connection to a serial port.

  • Page 8: Navigating The Command Line Interface

    To complete the boot process, terminate the serial CLI session (with the exit command), 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.
  • Page 9 2: Configuration Using Telnet or a Serial Port Figure 2-1. CLI Command Hierarchy XPort Pro™ Command Reference...
  • Page 10 To view the list of commands available for a partial command: At the command prompt, type the partial command followed by the question mark “?”. (There is no need to press Enter.) For example: <tunnel-1>#echo? displays a list of all echo commands at the tunnel level. XPort Pro™ Command Reference...
  • Page 11 “ and press Enter. For example: <tunnel-1>#echo* displays a list of all echo commands and descriptions at the tunnel level. To view the last 20 commands entered at the CLI: Type show history and press the Enter key. XPort Pro™ Command Reference...

  • Page 12: Keyboard Shortcut Commands

    Ctrl + u: delete entire line and place cursor at start of prompt Ctrl + w: delete one word back Ctrl + z: a shortcut for the exit command Esc + b: move cursor back one word Esc + f: move cursor forward one word XPort Pro™ Command Reference...

  • Page 13: 3: Summary Of Cli Commands

    Page Command Level Page accept login (root) chem modem packing configure password connect query port cp output device security disconnect serial enable ethernet link filesystem snmp syslog host http terminal icmp tftp tunnel ip filter line XPort Pro™ Command Reference...

  • Page 14: Accept Level Commands

    Forwards (tunnels) network data in accept mode tunneling. Discards all data coming in from the accept mode tunnel before block network enable forwarding it to the serial interface (generally used for debugging). block serial disable Forwards (tunnels) serial data in accept mode tunneling. XPort Pro™ Command Reference...
  • Page 15 Uses the default port number as the local port for accept mode tunneling. no local port The default port is 10000 + #, where # is the line number for this tunnel. XPort Pro™ Command Reference...

  • Page 16: Arp Level Commands

    Clears the screen. default timeout Restores the default ARP cache timeout. exit Exits to the configuration level. remove <ip address> Removes an entry from the ARP cache. <ip address> = address of the entry being removed. XPort Pro™ Command Reference...

  • Page 17: Chem Level Commands

    Sets local port used to send email alerts. local port <number> <number> local port to use for email alerts. no cc Removes the Cc addresses for email alerts. no clear mail counters Restores the email counters to the aggregate values. XPort Pro™ Command Reference...
  • Page 18 Specify a CP group and its value that shall trigger an email. <cp group> = configurable pin group. trigger <cp group> <value> = numeric value to watch for from the CP group. Can be <value> specified as hex if prepended with “0x”. XPort Pro™ Command Reference...

  • Page 19: Cli Level Commands

    Change to menu level for SSH configuration and status. telnet Change to menu level for Telnet configuration and status. write Stores the current configuration in permanent memory. configure Level Commands Command Path: enable>config Level Prompt: config XPort Pro™ Command Reference...
  • Page 20 <line> = number of the terminal line (serial port) to be configured. 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. Change to menu level for VIP configuration and status. XPort Pro™ Command Reference...

  • Page 21: Connect Level Commands

    Restores the default connect mode as "disable". Connects to the first host in the list that accepts the default host mode connection. Uses a random port number as the local port for establishing default local port tunneling connections to other devices. XPort Pro™ Command Reference...
  • Page 22 Sets the reconnect time value for tunneling connections established by the reconnect time <milliseconds> device in milliseconds. <milliseconds> = timeout in milliseconds. show Displays tunnel connect settings. XPort Pro™ Command Reference...

  • Page 23: Cp Output Level Commands

    Exits to the next higher level. Configures the CP Group to set upon making or breaking an accept group <text> mode connection. <text> = CP Group. no group Removes the CP Set Group for accept mode. XPort Pro™ Command Reference...

  • Page 24: Cpm Level Commands

    <group> = the name of the group. Disables the specified group. disable <group> <group> = the name of the group. Enables a disabled group. enable <group> <group> = the name of the group. XPort Pro™ Command Reference...

  • Page 25: Device Level Commands

    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. XPort Pro™ Command Reference...

  • Page 26: Disconnect Level Commands

    Clears the screen. exit Returns to the tunnel level. Does not flush serial data upon closing a tunneling flush serial disable connection. flush serial enable Flushes serial data buffer when a tunneling connection is XPort Pro™ Command Reference...

  • Page 27: Enable Level Commands

    Show XML Status Record counters chem <number> Enters the configure email level. clear interfaces counters Zeros interface session counters clear query port counters Zeros Query Port counters clear xsr counters Zeros XML Status Record counters clrscrn Clears the screen. XPort Pro™ Command Reference...
  • Page 28 <file> <group Save specified XML configuration containing secrets list> to a local file show Show system information Displays the last 20 commands entered during the show history current CLI session. show hosts Show domain settings XPort Pro™ Command Reference...
  • Page 29 Dump specified XML Status Records to the console xsr export <file> Save XML Status Record to a file xsr export <file> <group list> Save specified XML Status Record to a local file xsr list List XML Status Record groups to the console XPort Pro™ Command Reference...

  • Page 30: Filesystem Level Commands

    Level Commands Command Path: enable>filesystem Level Prompt: filesystem The following commands are available in the filesystem level. This level allows for the management of files in the XPort Pro. filesystem level commands Description cat <file> Show the contents of a file Change the current directory to the specified cd <directory>...

  • Page 31: Ftp Level Commands

    Displays the last 20 commands entered during the current CLI show history session. show statistics Displays the FTP statistics. state disable Disables the FTP server. state enable Enables the FTP server. write Stores the current configuration in permanent memory. XPort Pro™ Command Reference...

  • Page 32: Host Level Commands

    Displays the last 20 commands entered during the current CLI show history session. Sets the username for logging into the host via SSH. ssh username <text> <text> = username. write Stores the current configuration in permanent memory. XPort Pro™ Command Reference...

  • Page 33: Http Level Commands

    <uri> <uri> = URI of the server. <user> <password> <user> = username. <password> = password associated with the username. clear counters Sets the HTTP counters to zero. clear log Clears the HTTP server log. XPort Pro™ Command Reference...
  • Page 34 %r first line of request (same as '%m %U%q <version>') %s return status Sets the maximum number of bytes the HTTP server accepts max bytes <bytes> when receiving a request. max timeout Sets the maximum timeout the HTTP server waits when <seconds> receiving a request. XPort Pro™ Command Reference...

  • Page 35: Icmp Level Commands

    The following commands are available in the icmp level. icmp level Description commands auto show stats Continuously shows ICMP statistics clear counters Zeros counters clrscrn Clears the screen. exit Exits to the configuration level. no clear counters Unzeros IP counters XPort Pro™ Command Reference...

  • Page 36: If Interface Commands

    Within [] use binary decimal up to 255 or hex up to 0xFF. dhcp client id set <text> Sets the client id in text format. dhcp disable Disables DHCP. dhcp enable Enables DHCP. dhcp renew Force DHCP to renew domain <text> Sets the domain name. XPort Pro™ Command Reference...
  • Page 37 Sets the IP address of the secondary DNS server. show Displays the current configuration. Displays the last 20 commands entered during the current show history CLI session. show status Show interface status write Stores the current configuration in permanent memory. XPort Pro™ Command Reference...

  • Page 38: Ip Level Commands

    Returns to the config level. remove <ip address> Removes an entry from the IP filter table. <subnet mask> show Displays the IP filter table. show history Displays the last 20 commands entered during the current XPort Pro™ Command Reference...

  • Page 39: Line Level Commands

    Stores the current configuration in permanent memory. line <line> Level Commands Command Path: enable>line # Level Prompt: line:# For the XPort Pro, only line 1 is available. The following commands are available in the line level. These commands configure the corresponding serial ports. line level commands...
  • Page 40 Sets the line interface to RS232. Sets the line interface to RS485 in full-duplex interface rs485 full-duplex mode. Sets the line interface to RS485 in half-duplex interface rs485 half-duplex mode. line <line> Enters the line level. XPort Pro™ Command Reference...
  • Page 41 Disables the line so data cannot be sent/received. state enable Enables the line so data can be sent/received. stop bits 1 Uses one stop bit after data on the line. stop bits 2 Uses two stop bits after data on the line. XPort Pro™ Command Reference...

  • Page 42: Ethernet Link Level Commands

    Clears the screen. default duplex Restores the default duplex setting, which is auto. default speed Restores the default speed setting, which is auto-negotiate. duplex auto Sets duplex mode to auto. duplex full Sets duplex mode to full. XPort Pro™ Command Reference...

  • Page 43: Login (Root) Level Commands

    LPD Level commands do not allow the configuration of any LPD properties. You can only view status, view statistics, and kill print jobs. LPD <line> commands allow you to Configure LPD properties for a given line. XPort Pro™ Command Reference...

  • Page 44: Lpd Level Commands

    Treats print job as binary. Sends data byte-for-byte to the binary enable printer. capture disable Redirects serial output back to the line. capture enable Redirects serial output from the line to this CLI session. clrscrn Clears the screen. XPort Pro™ Command Reference...
  • Page 45 Sets the name of the queue that this lpd line belongs to. queue name <text> <text> = name for the queue. show Displays the current configuration. Displays the last 20 commands entered during the current CLI show history session. XPort Pro™ Command Reference...

  • Page 46: Modem Level Commands

    Description clrscrn Clears the screen. Sets the CONNECT string used in modem emulation. connect string <text> <string> = connect string. default incoming Default disables incoming network connections. connection default response type Default uses text type responses. XPort Pro™ Command Reference...
  • Page 47 CLI session. show status Displays tunnel modem status. verbose response disable Does not send Modem Response Codes. verbose response enable Sends Modem Response Codes out on the Serial Line. write Stores the current configuration in permanent memory. XPort Pro™ Command Reference...

  • Page 48: Packing Level Commands

    A control character has the form <control>C. A decimal value character has the form \99. A hex value character has the form 0xFF. show Displays the current configuration. Displays the last 20 commands entered during show history the current CLI session. XPort Pro™ Command Reference...

  • Page 49: Password Level Commands

    Inhibits any prompting for password on the network side of the tunnel. prompt enable Sets up so a user on the network side of the tunnel will be prompted for a password. show Displays the password configuration. XPort Pro™ Command Reference...
  • Page 50 3: Summary of CLI Commands password level Description commands show history Displays the last 20 commands entered during the current CLI session. write Stores the current configuration in permanent memory. XPort Pro™ Command Reference...

  • Page 51: Ppp Level Commands

    Removes the PPP authentication username. password <text> Sets the password for PPP authentication. Sets the IP Address assigned to the peer when requested during negotiation. peer ip <ip address> <ip address> IP address of the peer device. XPort Pro™ Command Reference...

  • Page 52: Query Port Level Commands

    Displays statistics and information about the query port. Displays the last 20 commands entered during the show history current CLI session. state disable Disables response to 77FE requests. state enable Permits response to 77FE requests. write Stores the current configuration in permanent memory. XPort Pro™ Command Reference...

  • Page 53: Rss Level Commands

    Sets the size of the buffer for data read from the serial port. buffer size <bytes> <bytes> = size of the buffer. clrscrn Clears the screen. default buffer size Restores the default buffer size. Restores default DTR control, asserted while default dtr connected. XPort Pro™ Command Reference...

  • Page 54: Snmp Level Commands

    Sets the primary and secondary SNMP trap hosts. <ip address> = IP address of primary host running the host <ip address> <ip SNMP trap. address> <ip address> = IP address of secondary host running the SNMP trap. XPort Pro™ Command Reference...

  • Page 55: Ssh Level Commands

    <user> generate dsa 1024 Generate DSA public and private keys client user <user> generate dsa 512 Generate DSA public and private keys client user <user> generate dsa 768 Generate DSA public and private keys XPort Pro™ Command Reference...
  • Page 56 Remove a host user show Show SSH settings show client server <server> Show Client Server RSA and DSA keys show client user <user> Show information for a client user show history Displays the last 20 commands entered XPort Pro™ Command Reference...

  • Page 57: Ssl Level Commands

    Displays Certificate Information. show authority Displays Authority Certificate Information. Displays the last 20 commands entered during the current show history CLI session. write Stores the current configuration in permanent memory. syslog Level Commands Command Path: enable>configure>syslog XPort Pro™ Command Reference...
  • Page 58 Displays the last 20 commands entered during the current show history 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. XPort Pro™ Command Reference...

  • Page 59: Tcp Level Commands

    Stores the current configuration in permanent memory. terminal Level Commands Command Path: enable>configure>terminal # Level Prompt: config-terminal:# Where # is the line number or “network”. Following are the commands available in the terminal network and terminal <line> levels. XPort Pro™ Command Reference...
  • Page 60 A control character has the form <control>C. A decimal value character has the form \99. A hex value character has the form 0xFF. show Displays the current configuration. Displays the last 20 commands entered during the current show history CLI session. XPort Pro™ Command Reference...

  • Page 61: Tftp Level Commands

    Displays the last 20 commands entered during the show history current CLI session. show statistics Displays the TFTP statistics. state disable Disables the TFTP server. state enable Enables the TFTP server. write Stores the current configuration in permanent memory. XPort Pro™ Command Reference...

  • Page 62: Tunnel Level Commands

    Enters the configure-terminal level for the network. Enters the tunnel level. tunnel <line> <line> = number of the tunnel line (serial port) to be configured. write Stores the current configuration in permanent memory. XPort Pro™ Command Reference...

  • Page 63: Udp Level Commands

    CLI session. show statistics Displays the VIP statistics. state disable Disables use of Virtual IP (VIP) addresses. state enable Enables use of Virtual IP (VIP) addresses. write Stores the current configuration in permanent memory. XPort Pro™ Command Reference...

  • Page 64: 4: Configuration Using Xml

    The XML document element is a <configrecord> element. This is the root element. A <configrecord> must have one or more <configgroup> elements and can have a version attribute. A <configgroup> must have one or more <configitem> elements and can have name and instance attributes. XPort Pro™ Command Reference...

  • Page 65: Attributes

    The remainder of the file consists of nested “elements,” some of which have “attributes” and “content.” An element typically consists of two tags, a “start tag” and an “end tag,” possibly surrounding text and other elements. XPort Pro™ Command Reference...

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

    The following figures show examples of XML configuration records and the use of the <configrecord>, <configgroup>, <configitem>, and <value> XML elements. Figure 4-3. XML Group Example <?xml version=”1.0” standalone=”yes”?> <configrecord> <configgroup name = “serial command mode” instance = “1”> <configitem name = “mode”> <value>disable</value> </configitem> </configgroup> XPort Pro™ Command Reference...
  • Page 67 <configitem name = "state"> <value>enable</value> </configitem> <configitem name = "admin username"> <value>admin</value> </configitem> <configitem name = "admin password"> <value><!-- configured and ignored --></value> </configitem> </configgroup> <configgroup name = "tftp server"> <configitem name = "state"> <value>enable</value> </configitem> XPort Pro™ Command Reference...

  • Page 68: Importing And Exporting An Xml Configuration File

    Plain Text (.txt) or XML Document (.xml) file. Use Microsoft Notepad instead. The following syntax can be used to import configurations from a file on the device server’s file system: XPort Pro™ Command Reference...
  • Page 69 4 from an XML configuration record named “production.xcr” that contains these settings (and possibly more), issue the following command: xcr import production.xcr "tunnel disconnect:1, line:4" The following example imports all tunneling settings and line settings for all serial ports from a file named xcr_file: XPort Pro™ Command Reference...

  • Page 70: Including Passwords In The Xml File

    XCR is generated. Entries that are not exported are marked as Import only in the “Import/Export column.” XML Configuration Groups Table 4-1 lists the XPort XML configuration record groups in alphabetical order. This table indicates whether each item can be imported, exported, or exported with the placeholder: <!--configured and ignored-->. XPort Pro™ Command Reference...
  • Page 71 (Attribute of name) “instance” is a output number from 1 assert low enable import/export to 3.) disable device long name import/export serial number export short name import/export firmware export version XPort Pro™ Command Reference...
  • Page 72 Normal High Urgent overriding import/export domain group import/export trigger value import/export ethernet duplex auto import/export full (Attribute of half “instance” is speed auto import/export “eth0”.) disable ftp server state enable import/export disable admin import/export username XPort Pro™ Command Reference...
  • Page 73 XPort Pro™ Command Reference...
  • Page 74 Deletes a specific IP enable net mask filter entry. line state enable import/export disable (Attribute of “instance” is baud rate import/export Any value the number 1.) from 300 to 230400. XPort Pro™ Command Reference...
  • Page 75 (Attribute of binary disable import/export “instance” is enable the number 1.) convert disable import/export newline enable disable import/export eoj text enable import/export formfeed disable import/export XPort Pro™ Command Reference...
  • Page 76 Specifies both the address and mask. (Attribute of Use CIDR “instance” is form the number 1.) (192.168.0.1/1 6) or explicit mask (192.168.0.1 255.255.0.0) peer ip none import/export authentication import/export mode ms-chap ms-chapv2 XPort Pro™ Command Reference...
  • Page 77 Milliseconds. group import/export trigger value enable import/export snmp state disable import/export system name import/export system contact import/export system import/export description system enable import/export location traps state disable import/export primary import/export destination XPort Pro™ Command Reference...
  • Page 78 Specify the delete user to delete. delete known disable import If enabled, hosts deletes any enable existing hosts before adding “known host”. delete client disable import If enabled, XPort Pro™ Command Reference...
  • Page 79 Delete an user delete authorized user. delete disable import If enabled, authorized deletes any users authorized users before adding “authorized user”. rsa certificate certificate import/export Enter the text of the certificate. XPort Pro™ Command Reference...
  • Page 80 Number of packets received before an ACK is forced. send data expedited import/export XPort Pro™ Command Reference...
  • Page 81 If configured Placeholder and not exporting secrets, exports only a placeholder. aes encrypt import/export If configured Placeholder and not exporting secrets, exports only a placeholder. local port import/export protocol tcp aes import/export XPort Pro™ Command Reference...
  • Page 82 Placeholder exporting secrets, exports only a placeholder. tunnel connect connect mode disable import/export character (Attribute of “instance” is start the number 1.) character modem control asserted modem emulation start character flush start enable character XPort Pro™ Command Reference...
  • Page 83 Milliseconds. flush serial disable import/export ssh username enable import/export Username must correspond to a configured ssh client user. block serial disable import/export enable block network disable import/export XPort Pro™ Command Reference...
  • Page 84 (Attribute of “instance” is the number 1.) timeout import/export Milliseconds threshold import/export Bytes XPort Pro™ Command Reference...
  • Page 85 Deletes authentication existing http uris authentication uris before importing new ones. http name enable import/export Deletes the authentication specified http uri delete authentication uri. reboot disable import/export Reboots after importing. XPort Pro™ Command Reference...

  • Page 86: Xml Status Groups And Items

    The tunnel group, which has the following group as sub group: Tunnel Modem The CLI command usage is identical to the XCR export, dump, and list. Table 4-2. XPort Pro XSR Groups and Items Group Name Item Name Value Name...
  • Page 87 1 to 4.) email log entry time (Attribute of “instance” is a number from 1 to 4.) ethernet driver buffer headers total free (within group “buffer pool”) used max used cluster pool cluster size XPort Pro™ Command Reference...
  • Page 88 2 begin firmware 2 end firmware 2 erase cycles bank a begin bank a end bank a erase cycles bank b begin bank b end bank b erase XPort Pro™ Command Reference...
  • Page 89 (Attribute of “instance” is a number from 1 to N) totals entries bytes icmp messages messages discarded XPort Pro™ Command Reference...
  • Page 90 XPort Pro™ Command Reference...
  • Page 91 “instance” is either “eth0”) unknown errors ethernet speed duplex (Present only for eth0) encapsulation type timeout default gateway network mask domain mac address hostname ip address last change primary dns secondary dns transmit octets unicast XPort Pro™ Command Reference...
  • Page 92 XPort Pro™ Command Reference...
  • Page 93 XPort Pro™ Command Reference...
  • Page 94 (with no state enabled instance) disabled (within group protocol “line” with instance 1 or 2) none tunnel baud rate Any value from 300 to 230400. parity even none data bits stop bits XPort Pro™ Command Reference...
  • Page 95 % stacks thread name protocol stack buffer headers total (within group free “buffer pool”) used max used cluster pool cluster size XPort Pro™ Command Reference...
  • Page 96 Attribute of “instance” is the ssh remote port session number.) duration telnet local port remote ip address (Attribute of “instance” is the remote port telnet session duration number.) state totals uptime bytes in bytes out syslog status XPort Pro™ Command Reference...
  • Page 97 (Attribute of accepts “instance” is the number 1.) disconnects XPort Pro™ Command Reference...
  • Page 98 “tunnel”) response type text error unknown disable commands incoming connection disabled in unknown ports in datagrams in errors out datagrams conduit status conduit uptime time of last replication config name network interface bytes lines elements errors XPort Pro™ Command Reference...
  • Page 99 Serial port configuration, 7 login (root) Level Commands, 43 Telnet configuration, 7 lpd <line> Level Commands, 44 XML configuration, 64 lpd Level Commands, 43 disconnect Level Commands, 26 DTD, 64 modem Level Commands, 46 enable Level Commands, 27 XPort Pro™ Command Reference...
  • Page 100 Level Commands, 57 XML pages Summary of Export system configuration record, 68 CLI commands, 13 Import system configuration record, 68 syslog Level Commands, 57 System configuration record Import and export groups, 86 exporting, 68 importing, 68 XPort Pro™ Command Reference...

Table of Contents