XPort Pro Command Reference

Transcription

1 XPort Pro Command Reference Part Number Revision A September 2009

2 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. Ethernet is a trademark of XEROX Corporation. UNIX is a registered trademark of The Open Group. Windows 95, Windows 98, Windows 2000, and Windows NT are trademarks of Microsoft Corp. Netscape is a trademark of Netscape Communications Corporation. Contacts Lantronix Corporate Headquarters Barranca Parkway Irvine, CA 92618, USA Phone: Fax: Technical Support Online: Sales Offices For a current list of our domestic and international sales offices go to the Lantronix web site at Revision History Date Rev. Comments September 2009 A Initial Document For the latest revision of this product document, please check our online documentation at XPort Pro Command Reference 2

3 Contents Copyright & Trademark... 2 Contacts... 2 Revision History : Introduction 6 2: Configuration Using Telnet or a Serial Port 7 Configuration Using Telnet... 7 Configuration Using a Serial Port... 7 Serial Command Mode 7 Serial Recovery 7 Navigating the Command Line Interface... 8 Keyboard Shortcut Commands : Summary of CLI Commands 13 Command Hierarchy Command Index accept Level Commands arp Level Commands chem Level Commands cli Level Commands configure Level Commands Connect Level Commands cp output Level Commands cpm Level Commands device Level Commands disconnect Level Commands Level Commands filesystem Level Commands ftp Level Commands host <number> Level Commands http Level Commands icmp Level Commands XPort Pro Command Reference 3

4 Contents if <instance> Interface Commands ip Level Commands ip filter Level Commands line <line> Level Commands ethernet link Level Commands login (root) Level Commands lpd Level Commands lpd <line> Level Commands modem Level Commands packing Level Commands password Level Commands ppp Level Commands query port Level Commands rss Level Commands serial Level Commands snmp Level Commands ssh Level Commands ssl Level Commands syslog Level Commands tcp Level Commands terminal Level Commands tftp Level Commands tunnel <line> Level Commands udp Level Commands vip Level Commands : Configuration Using XML 64 XML Configuration Record Document Type Definition (DTD) Attributes 65 Record, Group, Item, and Value Tags Importing and Exporting an XML Configuration File Best Practices Importing and Exporting Partial Configurations 68 Including Passwords in the XML File 70 Special XCR Items 70 XML Configuration Groups XML Status Groups and Items XPort Pro Command Reference 4

5 Contents Index 99 XPort Pro Command Reference 5

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 uses industry-standard tools for configuration, communication, and control. For example, the Evolution OS uses a command line interface (CLI) whose syntax is very similar to that used by data center equipment such as routers and hubs. This Command Reference provides information about navigating the CLI interface and lists the CLI commands for configuring, monitoring, and controlling the device server. XML-based Architecture and Device Control: XML is a fundamental building block for the future growth of Machine-to-Machine (M2M) networks. Evolution supports XML-based configuration records that make configuring the device server easy for users and administrators. The XML is easily editable with a standard text editor or an XML editor. Chapter 4 provides a brief overview of the XML interface, contains rules on basic XML syntax, provides a guide to the interface with specific tags, and provides a guide to using XML configuration records. XPort Pro Command Reference 6

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. This command reference describes how to use the CLI and provides a detailed list of all the CLI commands supported. Configuration Using Telnet To configure the device server using a Telnet session over the network, you must first establish a Telnet connection. Note: As an alternative, you may establish a Telnet connection by clicking the Telnet Configuration tab in DeviceInstaller. See the product User Guide for more information. 1. From the Windows Start menu, click Run. The Run dialog box appears. 2. In the Run dialog box, type the following command, where x.x.x.x is the IP address: telnet x.x.x.x A prompt appears. Note: Depending on the level of security you have configured, a password may be required. Configuration Using a Serial Port Serial Command Mode The serial port can be configured to operate in command mode permanently or to be triggered under specified conditions. See the line <line> Level command description for more information. Serial Recovery In this mode, the normal boot process is interrupted, allowing recovery from unknown or incorrect configuration settings. While the backdoor is active, the CLI prompt is changed to >> (instead of > ) and the Web Manager is inaccessible. These serve as an important indication that the device XPort Pro Command Reference 7

8 2: Configuration Using Telnet or a Serial Port boot processes has been temporarily halted. 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. Configure the terminal for 9600 baud, 8-bit, no parity, 1 stop bit, and no flow control. 1. Power off the device. 2. Press and hold down the exclamation point (!) key. 3. Power on the device. 4. When an exclamation point appears on the terminal or PC screen, type xyz within 5 seconds to display the CLI prompt. Navigating the Command Line Interface The CLI is organized into a hierarchy of levels. When you start a command line session, you are in the login level. Commands at the login level of the CLI do not affect current configuration settings. These commands provide diagnostic and status information only. To configure the device server running on Evolution, you must be in the level or any of its sub-levels. The level structure is depicted in the following figure: XPort Pro Command Reference 8

9 2: Configuration Using Telnet or a Serial Port Figure 2-1. CLI Command Hierarchy XPort Pro Command Reference 9

10 2: Configuration Using Telnet or a Serial Port To move to a different level: For example: Enter the name of that level from within its parent level. > ()#tunnel 2 Note: Some levels require a number to indicate one of several level instances. In the example, the number 2 indicates configuring the settings for tunneling on serial port 2. To exit and return to one level higher: Type exit and press the Enter key. Note: Typing exit at the login level or the level will close the CLI session. If Command Mode is configured for always-on operation, a new session will immediately be restarted. To view the current configuration at any level: Type show To view the list of commands available at the current level: At the command prompt, type the question mark?. The list of current commands appears. (There is no need to press Enter.) Note: Items within < > (e.g. <string>) are required parameters. To view the available commands and their explanations: At the command prompt, type and press Enter. * 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 10

11 2: Configuration Using Telnet or a Serial Port To view available commands and their explanations for a partial command: At the prompt, type the partial command followed by 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 11

12 2: Configuration Using Telnet or a Serial Port Keyboard Shortcut Commands Typing enough characters to uniquely identify a command is a shortcut for that command. Tab completion: Typing some characters then typing <tab> will display the first command that begins with those characters. Typing <tab> again will display the next command that begins with the original characters typed. While the command is displayed, you may press <enter> to execute the command or you may backspace to edit any parameters. The following key combinations are allowed when configuring the device server from the command line interface (CLI): Ctrl + a: place cursor at the beginning of line Ctrl + b: backspace one character Ctrl + d: delete one character Ctrl + e: place cursor at the end of the line Ctrl + f: move cursor forward one character Ctrl + k: delete from the current position to the end of the line Ctrl + l: redraw the command line Ctrl + n: display the next line in the history Ctrl + p: display the previous line in the history 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 12

13 Command Hierarchy The hierarchy of commands is shown in Figure 2-1. CLI Command Hierarchy on page 9. Command Index The command levels are indexed in alphabetical order below. Click on a page number to see the details of a command. Command Level Page accept 14 arp 16 chem 17 cli 19 configure 19 connect 21 cpm 23 cp output 23 device 25 disconnect ethernet link 42 filesystem 30 ftp 31 host 32 http 33 icmp 35 if 36 ip 38 ip filter 38 line 39 Command Level Page login (root) 43 lpd 43 modem 46 packing 48 password 49 ppp 51 query port 52 rss 53 security 53 serial 53 ssh 55 ssl 57 snmp 54 syslog 57 tcp 59 terminal 59 tftp 61 tunnel 62 udp 63 vip 63 XPort Pro Command Reference 13

14 accept Level Commands Command Path: >tunnel #>accept Level Prompt: tunnel-accept:# Where # is the line number. The following commands are available in the accept level. accept level commands accept mode always accept mode any character accept mode accept mode modem control asserted accept mode modem emulation accept mode start character aes decrypt key <hexadecimal> aes decrypt key text <text> aes encrypt key <hexadecimal> aes encrypt key text <text> block network block network block serial Enables the tunneling server to always accept tunneling connections. Enables the tunneling server to accept tunneling connections only when a character is received through the corresponding line (serial port) Disables accept mode tunneling. Enables the tunneling server to accept tunneling connections when the modem control pin is asserted. Enables modem emulation for accept mode tunneling. Enables accept mode tunneling when the configured start character is received on the line. Sets the accept tunnel AES decrypt key with up to 16 bytes. Each byte is represented by two adjacent hex digits. Bytes may run together or be separated by optional punctuation: 123ABC "12 3A BC" 12,3A,BC 12.3a.bc 12:3a:bc Note that quotes must enclose the value if it contains spaces. Sets the accept 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. 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 punctuation: 123ABC "12 3A BC" 12,3A,BC 12.3a.bc 12:3a:bc Note that quotes must enclose the value if it contains spaces. Sets the accept tunnel AES encrypt 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. Forwards (tunnels) network data in accept mode tunneling. Discards all data coming in from the accept mode tunnel before forwarding it to the serial interface (generally used for debugging). Forwards (tunnels) serial data in accept mode tunneling. XPort Pro Command Reference 14

15 accept level commands block serial clrscrn cp output default accept mode default protocol default start character default tcp keep alive connect <number> disconnect <number> exit flush serial flush serial flush start character flush start character kill connection local port <number> no aes decrypt key no aes encrypt key no connect no disconnect no local port Discards all data coming in from the serial interface before forwarding it to the accept mode tunnel (generally used for debugging). Clears the screen. Enters the next lower level. Restores the default accept mode as "always". Restores the default protocol as "TCP". Defaults the accept mode start character. Restores the default 45 second accept mode TCP keep alive timeout. Sets an profile to use to send an alert upon establishing an accept mode tunnel. <number> = the number of the profile to use. Sets an profile to use to send an alert upon closing an accept mode tunnel. <number> = the number of the profile to use. Returns to the tunnel level. Characters already in the serial data buffer are retained upon establishing an accept mode tunneling connection. Flushes the serial data buffer upon establishing an accept mode tunneling connection. Enables forwarding of the accept start character into the network. Disables forwarding of the accept start character into the network. Disconnects the active accept mode tunneling connection. Sets the port to use for accept mode tunneling. <number> = number of the port to use. Removes the accept tunnel AES decrypt key. Removes the accept tunnel AES encrypt key. Discontinues sending alerts upon establishing an accept mode tunnel. Discontinues sending alerts upon closing an accept mode tunnel. Uses the default port number as the local port for accept mode tunneling. The default port is #, where # is the line number for this tunnel. XPort Pro Command Reference 15

16 accept level commands no tcp keep alive password protocol ssh protocol ssl protocol tcp protocol tcp aes protocol telnet show show history show status start character <control> tcp keep alive <milliseconds> write Disables the accept mode TCP keep alive timeout. Enters the next lower level. Uses SSH protocol for accept mode tunneling. Uses SSL protocol for accept mode tunneling. Uses TCP protocol for accept mode tunneling. Uses TCP protocol with AES encryption for accept mode tunneling. Uses Telnet protocol (with IAC) for accept mode tunneling. Displays the current configuration. Displays the last 20 commands entered during the current CLI session. Displays tunnel accept status. Sets the accept mode start character. 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. Enables TCP keep alive for accept mode tunneling and sets the timer. <milliseconds> = timer value, in milliseconds. Stores the current configuration in permanent memory. arp Level Commands Command Path: >config>arp Level Prompt: config-arp The following commands are available in the ARP level. arp level commands add <ip address> <MAC address> clrscrn default timeout exit remove <ip address> Adds an entry to the ARP table, mapping an IP address to a MAC address. <ip address> = IP address to be mapped. <mac address> = MAC address in colon-separated form. Clears the screen. Restores the default ARP cache timeout. Exits to the configuration level. Removes an entry from the ARP cache. <ip address> = address of the entry being removed. XPort Pro Command Reference 16

17 show show cache show history timeout <seconds> write Displays the current configuration. Displays the ARP cache table. Displays the last 20 commands entered during the current CLI session. Sets the ARP cache timeout. <seconds> = ARP cache timeout in seconds. Stores the current configuration in permanent memory. chem Level Commands This level allows you to change configuration settings. Command Path: >chem # Level Prompt: chem:# Where # is an number, 1-4. The following commands are available in the chem level for up to four configurable s. chem level commands auto show statistics cc < addresses> chem <number> clear log clear mail counters clrscrn exit file <file> from < address> local port <number> no cc no clear mail counters Continuously displays statistics. Sets Cc addresses for alerts. < addresses> = a semicolon-separated list of addresses within quotation marks (For example, name1; name2 ) Enters the configure level. Clears all entries from the mail log. Sets the counters to zero. Clears the screen. Exits to the level. Specifies a text file, the contents of which will be the message body of an alert. <file> = the name of a local file. Sets the From address for alerts. < address> = address to list in the From field of the alert. Sets local port used to send alerts. <number> local port to use for alerts. Removes the Cc addresses for alerts. Restores the counters to the aggregate values. XPort Pro Command Reference 17

18 chem level commands no file no from no overriding domain no replyto no subject no to no trigger overriding domain <domain> Removes the file name, so the message body will be empty. Removes From address for alerts. Removes the overriding domain name option. Removes Reply-To address for alerts. Removes subject used for alerts. Removes To address for alerts. Disables the trigger to send an . Sets a domain name that will be used when connecting to an SMTP server to send an alert instead of the device s domain name in EHLO. <domain> = domain name to override the current domain name in EHLO. priority high Sets X-Priority for alerts to 2. priority low Sets X-Priority for alerts to 4. priority normal Sets X-Priority for alerts to 3. priority urgent Sets X-Priority for alerts to 1. priority very low Sets X-Priority for alerts to 5. replyto < address> send server port <number> show show history show log show statistics subject <string> to < addresses> trigger <cp group> <value> Sets Reply-To address for alerts. < address> = address to list in the Reply-To field of the alert. Sends an using the current settings. Sets the port used by the SMTP server. <number> = port used for SMTP on the server side. Displays settings. Displays the last 20 commands entered during the current CLI session. Displays the log. Displays statistics. Sets the subject for alerts. <string> = text to placed as the subject. Sets address to which the alerts will be sent. < addresses> = a quoted, semi-colon separated list of addresses. Specify a CP group and its value that shall trigger an . <cp group> = configurable pin group. <value> = numeric value to watch for from the CP group. Can be specified as hex if prepended with 0x. XPort Pro Command Reference 18

19 chem level commands write Stores the current configuration in permanent memory. cli Level Commands Command Path: >config>cli Level Prompt: cli The following commands are available in the cli level. cli level commands clrscrn default inactivity timeout default quit connect line level password <text> exit inactivity timeout <minutes> login password <text> no level password no inactivity timeout no login password quit connect line <control> show show history ssh telnet write Clears the screen. The default inactivity timeout will apply to CLI sessions. Restores the default string used to quit the "connect line <line>" command. Sets the -level password. Exits to the configuration level. Sets the inactivity timeout for all CLI sessions. Sets the CLI login password. Removes the -level password. No inactivity timeout will apply to CLI sessions. Removes the CLI login password. Sets the string used to quit the "connect line <line>" command. The characters may be input as text or control. A control character has the form <control>c. Displays the current configuration. Displays the last 20 commands entered during the current CLI session. Change to menu level for SSH configuration and status. Change to menu level for Telnet configuration and status. Stores the current configuration in permanent memory. configure Level Commands Command Path: >config Level Prompt: config XPort Pro Command Reference 19

20 The following commands are available in the configure level. configure level commands arp clear host <host> cli clrscrn exit ftp host <number> http icmp if <instance> ip ip filter kill ssh <session> kill telnet <session> lpd <line> query port rss show show history snmp syslog tcp terminal <line> terminal network tftp udp vip Changes to the command level for ARP configuration and status. Removes an entry from the DNS Cache Change to menu level for CLI configuration and status Clears the screen. Exits to the level. Enters the ftp level. Change to config host level Enters the http level. Changes to the command level for ICMP configuration and status. Changes to the interface configuration level. Changes to the command level for IP configuration and status. Enters the config-filter level. Kills SSH session with index from show sessions Kills Telnet session with index from show sessions Enters the configure lpd level. <line> = number of the line (lpd serial port) to be configured. Enters the query port level. Change to menu level for RSS configuration and status Displays system information. Displays the last 20 commands entered during the current CLI session. Enters the snmp level. Enters the syslog level. Changes to the command level for TCP configuration and status. Enters the configure-terminal level. <line> = number of the terminal line (serial port) to be configured. Enters the configure-terminal level for the network. 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 20

21 configure level commands write Stores the current configuration in permanent memory. Connect Level Commands Command Path: >tunnel #>connect Level Prompt: connect Where # is the line number. The following commands are available in the connect level. connect Level Commands block network block network block serial block serial clrscrn connect mode always connect mode any character connect mode connect mode modem control asserted connect mode modem emulation connect mode start character cp output default connect mode default host mode default local port Forwards (tunnels) network data in connect mode tunneling. Discards all data coming in from the connect mode tunnel before forwarding it to the serial interface (generally used for debugging). Forwards (tunnels) serial data in connect mode tunneling. Discards all data coming in from the serial interface before forwarding it to the connect mode tunnel (generally used for debugging). Clears the screen. Enables the tunneling server to always establish tunneling connections. Enables the tunneling server to establish a tunneling connection when a character is received on the corresponding line (serial port). Disables connect mode tunneling. Enables the tunneling server to make tunneling connections when the modem control pin is asserted. Enables modem emulation for connect mode tunneling. Enables connect mode tunneling when the configured start character is received on the line. Enters the next lower level. Restores the default connect mode as "". Connects to the first host in the list that accepts the connection. Uses a random port number as the local port for establishing tunneling connections to other devices. XPort Pro Command Reference 21

22 connect Level Commands default reconnect time default start character connect <number> disconnect <number> exit flush serial flush serial flush start character flush start character host <instance> host mode sequential host mode simultaneous kill connection local port <number> no connect no disconnect promote host <number> reconnect time <milliseconds> show Restores the default reconnect time value for connect mode tunneling. Defaults the connect mode start character. Sets an profile to use to send an alert upon establishing a connect mode tunnel. <number> = the number of the profile to use. Sets an profile to use to send an alert upon closing a connect mode tunnel. <number> = the number of the profile to use. Returns to the tunnel level. Characters already in the serial data buffer are retained upon establishing a connect mode tunneling connection. Flushes the serial data buffer upon establishing a connect mode tunneling connection. Enables forwarding of the connect start character into the network. Disables forwarding of the connect start character into the network. Enters the next lower level. Specify the instance for the next lower level. Connects to the first host in the list that accepts the connection. Selects simultaneous connections to all hosts on the host list. Disconnects the active connect mode tunneling connection. Sets a specific port for use as the local port. <number> = the number of the port to use. Discontinues sending alerts upon establishing a connect mode tunnel. Discontinues sending alerts upon closing a connect mode tunnel. Promotes the identified host, exchanging it place with the host above it, to adjust the order of the defined hosts. Sets the reconnect time value for tunneling connections established by the device in milliseconds. <milliseconds> = timeout in milliseconds. Displays tunnel connect settings. XPort Pro Command Reference 22

23 connect Level Commands show history show status start character <control> write Displays the last 20 commands entered during the current CLI session. Displays tunnel connect status. Sets the connect mode start character. 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. Stores the current configuration in permanent memory. cp output Level Commands Command Path: >tunnel #>accept>cp output Or >tunnel #>connect>cp output Level Prompt: cp_output The following commands are available in the cp output level. cp output level commands clrscrn connection value <number> default connection value default disconnection value disconnection value <number> exit group <text> no group Clears the screen. Sets the value to output to the CP Group upon connect mode connection. <number> = binary to output (typically 1 or 0). Restores the default value for accept/connect mode connection. Restores the default value for accept/connect mode disconnection. Sets the value to output to the CP Group upon connect mode disconnection. <number> = binary to output (typically 1 or 0). Exits to the next higher level. Configures the CP Group to set upon making or breaking an accept mode connection. <text> = CP Group. Removes the CP Set Group for accept mode. XPort Pro Command Reference 23

24 cp output level commands show show history write Shows the current configuration. Displays the last 20 commands entered during the current CLI session. Stores the current configuration in permanent memory. cpm Level Commands Command Path: >cpm Level Prompt: cpm The following commands are available in the configurable pin level. cpm level commands add <cp> to <group> add <cp> to <group> <bit> clrscrn create <group> delete <cp> from <group> delete <group> <group> <group> Adds the specified CP to the specified group. <cp> = configurable pin. <group> = the name of the group to which you want to add the CP. Adds a specified CP to a specified group at a specified bit position. <cp> = configurable pin. <group> = the name of the group to which you want to add the CP. <bit> = bit position. Clears the screen. Creates a configurable pin (CP) group. <group> = the name for the new group. Removes a CP from a specified group and sets the CP to its default configuration of input. <cp> = configurable pin. <group> = the name of the group. Removes a group and resets all CPs in that group to the default configuration of input. <group> = the name of the group. Disables the specified group. <group> = the name of the group. Enables a d group. <group> = the name of the group. XPort Pro Command Reference 24

25 cpm level commands exit get <group> set <cp> as input set <cp> as input assert low set <cp> as output set <cp> as output assert low set <group> <value> show <group> show cp show groups show history write Exits to the level. Displays the value of the specified group. <group> = the name of the group. Configures a CP as an asserted high input. <cp> = configurable pin. Configures a CP as an asserted low input. <cp> = configurable pin. Configures a CP as an asserted high output. <cp> = configurable pin. Configures a CP as an asserted low output. <cp> = configurable pin. Assigns a value to the specified group. <group> = the name of the group. <value> = numeric value to assign to the CP group. Can be specified as hex if prepended with 0x. Displays group information for specified group. <group> = the name of the group. Displays configuration and group information for all CPs. Displays all groups defined and their state. Displays the last 20 commands entered during the current CLI session. Stores the current configuration in permanent memory. device Level Commands Command Path: >device Level Prompt: device The following commands are available in the device level. device level commands auto show tlog auto show upload clrscrn default long name default short name dhrystone Continuously displays the internal trouble log. Continuously displays the status of firmware upload. Clears the screen. Restores the default product long name. Restores the default product short name. Runs the Dhrystone benchmark program. XPort Pro Command Reference 25

26 device level commands exit long name <name> short name <name> show show buffer pool show codefile memory show delta memory show hardware information show history show linereference memory <code filename> show memory show task memory show task state show tlog show upload show xport_pro write Exit to the level. Sets the product long name, displayed in command mode and the Web interface. Sets the product short name, displayed in command mode and the Web interface. <name> = maximum of eight characters. Show system information Displays information about the various buffer pools. Displays memory utilization by code files. Displays differences in memory utilization by code files or line reference. Displays information about the hardware. Displays the last 20 commands entered during the current CLI session. Displays memory utilization by line reference for one code file. Displays current memory usage information. Displays task memory utilization. Displays current task states. Displays the internal trouble log. Displays the status of firmware upload. Show system information Stores the current configuration in permanent memory. disconnect Level Commands Command Path: >tunnel #>disconnect Level Prompt: disconnect Where # is the line number. The following commands are available in the disconnect level. disconnect level commands clrscrn exit flush serial flush serial Clears the screen. Returns to the tunnel level. Does not flush serial data upon closing a tunneling connection. Flushes serial data buffer when a tunneling connection is XPort Pro Command Reference 26

27 flush stop character flush stop character closed. Forwards the stop character from the Line to the network. Prevents the stop character from the Line from being forwarded to the network. modem control Does not watch the modem control pin to disconnect. modem control no stop character no timeout show show history stop character <control> timeout <milliseconds> write Watches the modem control pin and disconnects if it is not asserted. Removes the stop character. Disables disconnect after timeout feature for tunneling sessions. Displays the current configuration. Displays the last 20 commands entered during the current CLI session. Sets the stop character. 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. Disconnects when no data has been received on the line (serial port) for the specified length of time. <milliseconds> = timeout in milliseconds. Stores the current configuration in permanent memory. Level Commands Command Path: root> Level Prompt: The following commands are available in the level. level commands auto show interfaces auto show processes auto show xsr chem <number> clear interfaces counters clear query port counters clear xsr counters clrscrn Show interface statistics Continuously show thread runtime information Show XML Status Record counters Enters the configure level. Zeros interface session counters Zeros Query Port counters Zeros XML Status Record counters Clears the screen. XPort Pro Command Reference 27

28 level commands configure connect connect line <line> cpm device exit filesystem kill line <line> kill ssh <session> kill telnet <session> line <line> lpd no clear interfaces counters no clear query port counters no clear xsr counters nslookup nslookup <host> ping <host> ping <host> <count> Enters the configuration level. Show name and number for lines Begin session on serial port Enters the CP Manager level. Enters the device level. Exits the level. Exit from the system Enters the filesystem level. Kills command mode session on the Line Kills SSH session with index from show sessions Kills Telnet session with index from show sessions Enters the line level. <line> = number of the line (serial port) to be configured. Enters the lpd level. Unzeros interface session counters Unzeros Query Port counters Unzeros XML Status Record counters Lookup host information for the given host name Return host information for the given host name Ping destination 5 times with 5 second timeout Ping destination n times with 5 second timeout ping <host> <count> <timeout> Ping destination n times with x timeout (in seconds) ppp <line> reload reload factory defaults secret xcr dump secret xcr dump <group list> secret xcr export <file> secret xcr export <file> <group list> show show history show hosts Enters the serial line PPP level. Reboot system Reload factory defaults to permanent storage Dump XML configuration containing secrets to the console Dump specified XML configuration containing secrets to the console Save XML configuration containing secrets to a file Save specified XML configuration containing secrets to a local file Show system information Displays the last 20 commands entered during the current CLI session. Show domain settings XPort Pro Command Reference 28

29 level commands show interfaces show ip sockets show processes show sessions show xport_pro show xsr ssh ssh <optclientusername> <host> ssh <optclientusername> <host> <port> ssl telnet <host> telnet <host> <port> trace route <host> tunnel <line> write xcr dump xcr dump <group list> xcr export <file> xcr export <file> <group list> xcr import <file> xcr import <file> <group list> xcr list xsr dump xsr dump <group list> xsr export <file> xsr export <file> <group list> xsr list Show interface statistics Show UDP/TCP state information Show thread runtime information Show active Telnet and SSH Sessions Show system information Show XML Status Record counters Enters the SSH configuration level. Begin SSH session on network <host>. The optclientusername must match an SSH Client: Users configuration entry. Use "" in optclientusername to prompt for host username and password. Begin SSH session on network <host>:<port>. The optclientusername must match an SSH Client: Users configuration entry. Use "" in optclientusername to prompt for host username and password. Enters the SSL configuration level. Begin session on network <host> Begin session on network <host>:<port> Trace route to destination Enters the tunnel level. <line> = number of the tunnel line (serial port) to be configured. Stores the current configuration in permanent memory. Dump XML configuration to the console Dump specified XML configuration to the console Save XML configuration to a file Save specified XML configuration to a local file Load XML configuration from a local file Load specified XML configuration from a local file List XML Configuration Record groups to the console Dump XML Status Records to the console Dump specified XML Status Records to the console Save XML Status Record to a file Save specified XML Status Record to a local file List XML Status Record groups to the console XPort Pro Command Reference 29

30 filesystem Level Commands Command Path: >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 cat <file> cd <directory> clrscrn compact cp <source file> <destination file> dump <file> exit format ls ls <directory> mkdir <directory> mv <source file> <destination file> pwd rm <file> rmdir <directory> show show history show tree tftp get ascii <source file> <destination file> <host> tftp get ascii <source file> <destination file> <host> <port> tftp get binary <source file> <destination file> <host> tftp get binary <source file> <destination file> <host> <port> Show the contents of a file Change the current directory to the specified directory Clears the screen. Compact the file system, freeing all dirty space Copy an existing file Show contents of a file as a hex dump Exits to the level. Format the file system and lose all data Show all files and directories in the current directory Show all files and directories in the specified directory Create a directory Move a file on the file system Print working directory Remove a file Remove a directory Show file system statistics Displays the last 20 commands entered during the current CLI session. Show all files and directories from current directory Get an ASCII file using TFTP Get an ASCII file using TFTP Get a binary file using TFTP Get a binary file using TFTP XPort Pro Command Reference 30

31 filesystem level commands tftp put ascii <source file> <destination file> <host> tftp put ascii <source file> <destination file> <host> <port> tftp put binary <source file> <destination file> <host> tftp put binary <source file> <destination file> <host> <port> touch <file> Put an ASCII file using TFTP Put an ASCII file using TFTP Put a binary file using TFTP Put a binary file using TFTP Create a file ftp Level Commands Command Path: >config>ftp Level Prompt: config-ftp The following commands are available in the ftp level. ftp level commands admin password <text> admin username <text> clear counters clrscrn default admin username exit no admin password no clear counters show show history show statistics state state write Sets the administrative password for the FTP server. <text> = administrative password. Sets the administrative username for the FTP server. <text> = administrative username. It also removes the administrative password. Zeros FTP counters. Clears the screen. Resets the FTP username to the default (admin). Returns to the config level. Removes the FTP administrative password. Unzeros FTP counters. Displays the FTP settings and statistics. Displays the last 20 commands entered during the current CLI session. Displays the FTP statistics. Disables the FTP server. Enables the FTP server. Stores the current configuration in permanent memory. XPort Pro Command Reference 31

32 host <number> Level Commands Command Path: >config>host # Level Prompt: config-host:# Where # is the host number, 1 or 2. The following commands are available in the host level. host level commands clrscrn default protocol default remote port exit host <number> name <text> no name no remote address no ssh username protocol ssh protocol telnet remote address <text> remote port <number> show show history ssh username <text> write Clears the screen. Restores the default value of the protocol (Telnet). Sets the remote port (used to connect to the host) to the default value, which depends on the selected protocol. Exits to the configuration level. Change to config host level Sets the name of the host. <text> = name of the host. Clears the name of the host. Clears the remote address of the host. Clears the SSH username associated with the host. Sets the protocol to SSH. Sets the protocol to Telnet. Sets the IP address of the remote host to connect to when this host is selected on the login connect menu. <text> = IP address. Sets the remote port used to connect to the host. <number> = port to be used. Displays the current configuration. Displays the last 20 commands entered during the current CLI session. Sets the username for logging into the host via SSH. <text> = username. Stores the current configuration in permanent memory. XPort Pro Command Reference 32

33 http Level Commands Command Path: >config>http Level Prompt: config-http The following commands are available in the http level. http level commands auth <uri> <realm> auth type <uri> basic auth type <uri> digest auth type <uri> none auth type <uri> ssl auth type <uri> sslbasic auth type <uri> ssldigest auth user <uri> <user> <password> clear counters clear log Creates a new HTTP server authentication directive. <uri> = URI of the server. <realm> = domain of the server. Sets an HTTP server authentication directive to the Basic Access Authentication scheme. <uri> = URI of the server. Sets an HTTP server authentication directive to the Digest Access Authentication scheme. <uri> = URI of the server. Sets the authentication type for an HTTP server authentication directive to none. <uri> = URI of the server. Sets the authentication type for an HTTP server authentication directive to SSL. <uri> = URI of the server. Sets the authentication type for an HTTP server authentication directive to SSL-Basic. <uri> = URI of the server. Sets the authentication type for an HTTP server authentication directive to SSL-Digest. <uri> = URI of the server. Creates or modifies a user for an HTTP server authentication directive. <uri> = URI of the server. <user> = username. <password> = password associated with the username. Sets the HTTP counters to zero. Clears the HTTP server log. XPort Pro Command Reference 33

34 http level commands clrscrn default log format default log max entries default max bytes default max timeout default port default ssl port delete auth <uri> delete auth user <uri> <user> exit log log log format <string> max bytes <bytes> max timeout <seconds> Clears the screen. Restores the HTTP Server log format string to its default value. Restores the default maximum number of HTTP Server log entries. Resets the default maximum bytes the HTTP Server will accept when receiving a request. Resets the default maximum time the HTTP Server will wait when receiving a request. Resets the HTTP Server port to its default value. Resets the HTTP Server SSL port to its default value. Deletes an existing HTTP Server authentication directive. <uri> = URI of the server. Deletes an existing user for an HTTP Server authentication directive. <uri> = URI of the server. <user> = username. Returns to the config level. Disables HTTP server logging. Enables HTTP server logging. Sets the log format string for the HTTP server, using the following directives: %a remote ip address (could be a proxy) %b bytes sent excluding headers %B bytes sent excluding headers (0 = '-') %h remote host (same as %a) %{h}i header contents from request (h = header string) %m request method %p ephemeral local port value used for request %q query string (prepend with '?' or empty '-') %t timestamp HH:MM:SS (same as Apache '%(%H:%M:%S)t') %u remote user (could be bogus for 401 status) %U URL path info %r first line of request (same as '%m %U%q <version>') %s return status Sets the maximum number of bytes the HTTP server accepts when receiving a request. Sets the maximum timeout the HTTP server waits when receiving a request. XPort Pro Command Reference 34

35 http level commands no clear counters port <number> server server show show auth show history show log show statistics ssl port <number> ssl3 ssl3 tls1.0 tls1.0 tls1.1 tls1.1 write <seconds> = maximum timeout value. Restores the HTTP counters to the aggregate values. Sets the port number the HTTP server will use. <number> = port number. Disables the HTTP server. Enables the HTTP server. Displays the HTTP server settings. Displays the HTTP server authentication settings. Displays the last 20 commands entered during the current CLI session. Displays the HTTP server log. Displays the HTTP statistics. Sets the port number the HTTP server will use over SSL. <number> = port number. Disables SSLv3 handling. Enables SSLv3 handling. Disables TLSv1.0 handling. Enables TLSv1.0 handling. Disables TLSv1.1 handling. Enables TLSv1.1 handling. Stores the current configuration in permanent memory. icmp Level Commands Command Path: >config>icmp Level Prompt: config-icmp The following commands are available in the icmp level. icmp level commands auto show stats clear counters clrscrn exit no clear counters Continuously shows ICMP statistics Zeros counters Clears the screen. Exits to the configuration level. Unzeros IP counters XPort Pro Command Reference 35

36 icmp level commands show show history show stats state state write Displays the current configuration. Displays the last 20 commands entered during the current CLI session. Shows ICMP statistics Prevents ICMP packets from being sent or received. Allows ICMP packets to be sent and received. Stores the current configuration in permanent memory. if <instance> Interface Commands Command Path: >configure>if # Or >configure>if eth0 Level Prompt: config-if:eth0 Where # is the interface number, 1 for eth0. The following commands are available in the if level. if level commands bootp bootp clear host <string> clrscrn default gateway <ip address> dhcp client id binary <binary> dhcp client id set <text> dhcp dhcp dhcp renew domain <text> Disables BOOTP. Enables BOOTP. Removes an entry from the DNS Cache Clears the screen. Sets the configurable gateway IP address to the default value. Sets the client id allowing binary characters. Within [] use binary decimal up to 255 or hex up to 0xFF. Sets the client id in text format. Disables DHCP. Enables DHCP. Force DHCP to renew Sets the domain name. XPort Pro Command Reference 36

37 if level commands exit hostname <text> ip address <ip address/cidr> link no default gateway no dhcp client id no domain no hostname no ip address no primary dns no secondary dns primary dns <ip address> secondary dns <ip address> show show history show status write <text> = name of the domain. Exits to the config level. Sets the host name. <text> = name of the host. Sets the IP address and network mask. Formats accepted: (default mask) /24 (CIDR) " " (explicit mask) Enter link configuration level Clears the default gateway. Clears the DHCP client ID. Clears the domain name. Clears the host name. Clears the IP address. Clears the name of the primary DNS server. Clears the name of the secondary DNS server. Sets the IP address of the primary DNS server. Sets the IP address of the secondary DNS server. Displays the current configuration. Displays the last 20 commands entered during the current CLI session. Show interface status Stores the current configuration in permanent memory. XPort Pro Command Reference 37

38 ip Level Commands Command Path: >config>ip Level Prompt: config-ip The following commands are available at the ip level. ip level commands auto show stats clear counters clrscrn default multicast time to live exit multicast time to live <hops> no clear counters show show history show stats write Continuously shows IP statistics Zeros counters Clears the screen. Restores the default IP multicast time to live, which is one hop. Exits to the configuration level. Sets the IP multicast time to live. <hops> = number of hops that a multicast IP packet is allowed to live. Unzeros IP counters Displays the current configuration. Displays the last 20 commands entered during the current CLI session. Shows IP statistics Stores the current configuration in permanent memory. ip filter Level Commands Command Path: >config>ip filter Level Prompt: config-filter The following commands are available at the ip filter level. ip filter level commands add <ip address> <subnet mask> clrscrn exit remove <ip address> <subnet mask> show show history Adds an entry to the IP filter table. Clears the screen. Returns to the config level. Removes an entry from the IP filter table. Displays the IP filter table. Displays the last 20 commands entered during the current XPort Pro Command Reference 38