XPort Pro CR

You might also like

Download as pdf or txt
Download as pdf or txt
You are on page 1of 131

XPort Pro Command Reference

Part Number 900-558 Revision B December 2010

Copyright and Trademark


2010 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.

Contacts
Lantronix Corporate Headquarters 167 Technology Drive Irvine, CA 92618, USA Toll Free: Phone: Fax: 800-526-8766 949-453-3990 949-450-7249

Technical Support Online: www.lantronix.com/support

Sales Offices For a current list of our domestic and international sales offices, go to the Lantronix web site at www.lantronix.com/about/contact.

Disclaimer
The information in this guide may change without notice. The manufacturer assumes no responsibility for any errors that may appear in this guide. For the latest revision of this product document, please check our online documentation at www.lantronix.com/support/documentation.

Revision History
Date September 2009 December 2010 Rev. A B Comments Initial Document Updated for firmware v5.2.0.0R20. Includes the new Modbus feature.

XPort Pro Command Reference

Table of Contents
Table of Contents __________________________________________________________ 3 List of Figures _____________________________________________________________ 4 List of Tables ______________________________________________________________ 5

1: About This Guide

Chapter Summaries ________________________________________________________ 6 Conventions _ _____________________________________________________________6 Additional Documentation ____________________________________________________ 7

2: Overview

Command Line Interface _____________________________________________________ 8 XML Architecture and Device Control ___________________________________________ 8

3: Command Line Interface

Configuration Using Telnet ___________________________________________________ 9 Configuration Using Serial Ports _______________________________________________ 9 Serial Command Mode ___________________________________________________ 9 Serial Recovery ________________________________________________________ 9 Navigating the CLI Hierarchy ________________________________________________ 10 Using Keyboard Shortcuts and CLI ____________________________________________ 10 Understanding the CLI Level Hierarchy ________________________________________ 11

4: Configuration Using XML

14

XML Configuration Record Document Type Definition _____________________________ 14 Quick Tour of XML Syntax __________________________________________________ 15 Declaration __ _________________________________________________________ 15 Element Start and End Tags _____________________________________________ 15 Element Attributes _____________________________________________________ 15 Record, Group, Item, and Value Tags _________________________________________ 16 Importing and Exporting an XML Configuration File _______________________________ 17 Best Practices ____________________________________________________________ 18 Importing _____________________________________________________________ 18 Exporting ___ _________________________________________________________ 19 Passwords in the XML File _______________________________________________19 XML Configuration Groups __________________________________________________ 20 XML Status Record Groups and Items _________________________________________ 37

5: Commands and Levels

51

XPort Pro Command Reference

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 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 Figure 4-7 XML Example of Supplying Passwords _______________________________________ 20

XPort Pro Command Reference

List of Tables
Table 4-8 XCR Groups ____________________________________________________________ 20 Table 4-9 XSR Groups and Items ____________________________________________________ 37 Table 5-1 Commands and Levels ____________________________________________________ 53

XPort Pro Command Reference

1:

About This Guide


This guide describes how to configure the XPort Pro using the Command Line Interface (CLI) and/ or Extensible Markup Language (XML). It is written for software developers and system integrators.

Chapter Summaries
This table lists and summarizes each chapter and appendix.
Chapter Summary Gives an overview of CLI and XML. Lists commands and describes how to use CLI to configure the XPort Pro. Lists XCR groups and items and describes how to use XCRs to configure the XPort Pro. Provides an index of the CLI Command Hierarchy with hyperlinks to the corresponding command details.

Chapter 2: Overview Chapter 3: Command Line Interface Chapter 4: Configuration Using XML Chapter 5: Commands and Levels

Conventions
The table below lists and describes the conventions used in this book.
Convention Bold text Italic text Brackets [ ] Angle Brackets < > Pipe | Warning Description Default parameters. Required values for parameters Optional parameters. Possible values for parameters. Choice of parameters. Warning: Means that you are in a situation that could cause equipment damage or bodily injury. Before you work on any equipment, you must be aware of the hazards involved with electrical circuitry and familiar with standard practices for preventing accidents. Note: Means take notice. Notes contain helpful suggestions, information, or references to material not covered in the publication. Caution: Means you might do something that could result in faulty equipment operation, or loss of data. CLI terminal sessions and examples of CLI input.

Note

Caution

Screen Font (Courier New)

XPort Pro Command Reference

1: About This Guide

Additional Documentation
Visit the Lantronix web site at www.lantronix.com/support/documentation for the latest documentation and the following additional documentation.
Document XPort Pro Integration Guide Description Information for configuring, using and updating the XPort Pro firmware. Instructions for how to install, configure and use the XPort Pro.

XPort Pro User Guide

XPort Pro Universal Demo Board Quick Start XPort Pro Universal Demo Board User Guide

Instructions for getting the XPort Pro demonstration board up and running. Information for using the XPort Pro on the demo board.

XPort Pro Command Reference

2:

Overview
Evolution OS 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 XPort Pro User Guide at the Lantronix website.

Command Line Interface


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. For details of the CLI, see Chapter 5: Commands and Levels. It provides an index of the CLI Command Hierarchy with links to the corresponding command details. The CLI provides commands for configuring, monitoring, and controlling the device server.

XML Architecture and Device Control


XML is a fundamental building block for the future growth of Machine-to-Machine (M2M) networks. Evolution supports XML configuration records that make configuring the device server easy for users and administrators. XML configuration records are easy to edit with a a standard text editor or an XML editor. For a brief overview of XML, see Chapter 4: Configuration Using XML . It provides rules on basic XML syntax, a guide to the specific XML tags used, and a guide to using XML configuration records.

XPort Pro Command Reference

3:

Command Line Interface


This chapter describes accessing the XPort Pro by using Telnet, SSH, or serial ports to configure the XPort Pro, navigating the Command Line Interface (CLI), typing keyboard shortcuts, and moving between the levels. It contains the following sections:

Configuration Using Telnet Configuration Using Serial Ports Navigating the CLI Hierarchy Using Keyboard Shortcuts and CLI Understanding the CLI Level Hierarchy

Refer to Chapter 5: Commands and Levels for a complete list of levels, commands, and descriptions.

Configuration Using Telnet


To access and configure the device server by using a Telnet session over the network, you must first establish a Telnet connection. You can also establish a Telnet connection by clicking the Telnet Configuration tab in DeviceInstaller. See the DeviceInstaller Online Help for more information, available on our website www.lantronix.com/support/downloads. To access the XPort Pro by using Telnet, perform the following steps. 1. Click Start > Run. The Run dialog box displays. 2. Type telnet x.x.x.x (x.x.x.x is the IP address). The XPort Pro is online when the command prompt (>) displays. You are at the root level of the CLI. Note: Depending on the level of security, a password may be required.

Configuration Using Serial Ports


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 back door 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 boot processes has been temporarily halted. To complete the boot process, terminate the serial CLI session (with the exit command).

XPort Pro Command Reference

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. 1. Power off the device. 2. Press and hold down the exclamation point (!) key. 3. Power on the device. The exclamation point displays on the terminal or PC screen. 4. Type xyz within 5 seconds to display the CLI prompt.

Navigating the CLI Hierarchy


The CLI is organized into a hierarchy of levels. Each level has a group of commands for a specific purpose. For example, to configure a setting for the FTP server, one would navigate to the FTP level, which is under the configuration level.

To move to a different levelEnter the name of the level from within its parent level. For example, to enter the tunnel level, type tunnel <number> at the enable prompt. This displays: <enable> tunnel <number>#. To exit and return to one level higherType exit and press the Enter key. Typing exit at the login level or the enable level will close the CLI session. If Line Command Mode is specified as Always, a new session starts immediately. To view the current configuration at any levelType show. To view the list of commands available at the current levelType the question mark "?". Items within < > (e.g. <string>) are required parameters. To view the available commands and explanationsType the asterisk ( *). To view the list of commands available for a partial commandType the partial command followed by the question mark "?". For example: <tunnel-1>#echo? displays a list of all echo commands at the tunnel level. To view available commands and their explanations for a partial commandType the partial command followed by the asterisk ( *). 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 CLIType show history.

Using Keyboard Shortcuts and CLI


One useful shortcut built into Evolution OS is that the complete text of a command does not have to be entered to issue a command. Typing just enough characters to uniquely identify a command, then hitting enter, can be used as a short cut for a command. For example, at the enable level, "sh" can be used for the "show" command. Tab Completion is also available. Typing the first few characters of a command, then hitting the <tab> key displays the first command that begins with those characters. Hitting the <tab> key again displays the next command that begins with the original characters typed. You can press <Enter> to execute the command or you can backspace to edit any parameters. The following key combinations are allowed when configuring the device server using the CLI:

Ctrl + a: place cursor at the beginning of a line

XPort Pro Command Reference

10

3: Command Line Interface 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

Understanding the CLI Level Hierarchy


The CLI hierarchy is a series of levels. Arranging commands in a hierarchy of levels provides a way to organize and group similar commands, provide different levels of security, and reduce the complexity and number commands and options presented to a user at one time. When you start a command line session, you begin at the login level. This level can be password protected and provides access to high level status, a few diagnostic commands, and the enable level. Further device information and configuration are accessed via the enable level. The enable level can also be password protected and is the gateway to full configuration and management of the device server. There are commands for gathering and effecting all elements of device status and configuration, as well as commands that take you to additional levels. For instance, tunnel specific status and configuration is found under the "tunnel" level, and network specific status and configuration commands are found under the "configuration" level. An overview of the levels in the XPort Pro is presented in Figure 3-1.

XPort Pro Command Reference

11

3: Command Line Interface

Figure 3-1 CLI Level Hierarchy


arp cli diagnostics ftp host http icmp If 1 lpd ppp <number> ssh ssl tunnel <line> accept connect disconnect modem packing serial ip ip filter lpd <number> modbus query port rss smtp snmp syslog tcp terminal <line> terminal network tftp udp vip Ethernet link ssh telnet

(login)

configure cpm

enable

device dns email Filesystem line <line>

xml

Commands at the login level, shown in Figure 3-2, do not affect current configuration settings and are not displayed initially. If you type <?>, you will see the login sub-commands. These commands provide diagnostic and status information only.

XPort Pro Command Reference

12

3: Command Line Interface

Figure 3-2 Login Level Commands >? clrscrn exit ping <host> <count> show show history > enable ping <host> ping <host> <count> <timeout> show xport_pro trace route <host>

To configure the XPort 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 (enable)#? auto show interfaces clear interfaces counters configure connect line <line> device dns exit kill ssh <session> line <line> no clear interfaces counters ping <host> <count> ppp <line> reload factory defaults show history show ip sockets show sessions ssh ssh <optClientUsername> <host> <port> telnet <host> trace route <host> write

auto show processes clrscrn connect cpm disable email <number> filesystem kill telnet <session> lpd ping <host> ping <host> <count> <timeout> reload show show interfaces show processes show xport_pro ssh <optClientUsername> <host> ssl telnet <host> <port> tunnel <line> xml

See the Chapter 5: Commands and Levels at the end of this document for a complete list of levels, commands, and descriptions.

XPort Pro Command Reference

13

4:

Configuration Using XML


The 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). An XCR can be imported or exported via the CLI, a Web browser, FTP, or the device server filesystem. An XCR can contain many configuration settings or just a few. For example, it might change all of the configurable parameters for a device server, or it may only change the baud rate for a single serial line. Using XCRs is a straightforward and flexible way to manage the configuration of multiple device server devices.

XML Configuration Record Document Type Definition


An XML document type definition (DTD) is a description of the structure and content of an XML document. It verifies that a document is valid. XCRs are exported using the DTD shown in Figure 4-1.
Figure 4-1 DTD for XCRs

<!DOCTYPE <!ELEMENT <!ELEMENT <!ELEMENT <!ELEMENT <!ATTLIST <!ATTLIST <!ATTLIST <!ATTLIST <!ATTLIST ]>

configrecord [ configrecord (configgroup+)> configgroup (configitem+)> configitem (value+)> value (#PCDATA)> configrecord version CDATA #IMPLIED> configgroup name CDATA #IMPLIED> configgroup instance CDATA #IMPLIED> configitem name CDATA #IMPLIED> value name CDATA #IMPLIED>

The device server DTD rules state the following:


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. A <configitem> element must have one or more <value> elements and can have a name attribute. A <value> element can have only data and can have a name attribute. The name attribute identifies a group, item, or value. It is always a quoted string. The instance attribute identifies the specific option, like the serial port number. The instance attribute is always a quoted string.

XPort Pro Command Reference

14

4: Configuration Using XML

Notes:

The name for each <configgroup> (specified with the name attribute) is the group name listed in the Web Manager XCR groups or with the xcr list CLI command. See the XPort Pro User Guide for more information about the Web Manager XCR groups. An empty or missing <value> element in each present <configgroup> clears the setting to its default.

Quick Tour of XML Syntax


Declaration
The first line, <?xml version=1.0 standalone=yes?>, is called the XML declaration. It is required and indicates the XML version in use (normally version 1.0). The remainder of the file consists of nested XML elements, some of which have attributes and content.

Element Start and End Tags


An element typically consists of two tags: start tag and an end tag that surrounds text and other elements (element content). The start tag consists of a name surrounded by angle brackets, for example <configrecord>. The end tag consists of the same name surrounded by angle brackets, but with a forward slash preceding the name, for example </configrecord>. The element content can also contain other child elements.

Element Attributes
The XML element attributes that are name-value pairs included in the start tag after the element name. The values must always be quoted, using single or double quotes. Each attribute name should appear only once in an element. Figure 4-2 shows an XML example which consists of a declaration (first line), nested elements with attributes and content.
Figure 4-2 XML Example

<?xml version=1.0 standalone=yes?> <configrecord> <configgroup name = serial command mode instance = 1> <configitem name = mode serial string> <value>disable</value> </configitem> </configgroup> </configrecord>

The Evolution OS uses the attributes in the following subsections to label the group configuration settings.

XPort Pro Command Reference

15

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. For example, the line group might have parameters such as baud rate, data bits, and parity. A value may specify the value of a configuration parameter. It may contain the name attribute. In this example, a value of 9600 might be specified for baud rate; 7 may be specified for data bits, and even may be specified for parity. A name attribute identifies the group, item, or value. It is always quoted (as are all XML attributes). For example, a group that contains serial port parameters has the name line. An instance attribute identifies which of several instances is being addressed. It is always quoted. For example, the serial port name (in the line configgroup) has the instance 1 to indicate serial port 1 or 2 to specify serial port 2. 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 Example

<?xml version=1.0 standalone=yes?> <configrecord> <configgroup name = serial command mode instance = 1> <configitem name = mode> <value>disable</value> </configitem> </configgroup> </configrecord>

Figure 4-4 XML Example of Multiple Named Values

<?xml version=1.0 standalone=yes?> <configgroup name = ssh server <configitem name = host rsa keys> <value name = public key></value> <value name = private key></value> </configitem> </configgroup>

XPort Pro Command Reference

16

4: Configuration Using XML

Figure 4-5 XML Example of Multiple Items

<?xml version=1.0 standalone=yes?> <configgroup name = email instance = 1> <configitem name = to> <value>john.doe@somewhere.com></value> </configitem> <configitem name = from> <value>evolution@xportpro.com></value> </configitem> </configgroup>

Figure 4-6 XML Example with Multiple Groups

<?xml version=1.0 standalone=yes?> <configgroup name = "ftp server"> <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> <configitem name = "allow file creation"> <value>disable</value> </configitem> </configgroup>

Importing and Exporting an XML Configuration File


An XCR can be imported or exported using the following methods:

FilesystemXCRs 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 XPort Pro User Guide. CLIXCRs can be imported (captured) or exported (dumped) directly to a Telnet, SSH, or serial line CLI session. Capturing an XCR can be started by pasting a valid XCR directly into the CLI prompt. Evolution OS immediately processes the configuration record, changing any settings specified. This can be done on any level, including the root. Special tags in the XML

XPort Pro Command Reference

17

4: Configuration Using XML allow for providing root and enable level passwords so that this can also be done at the password prompt.

Web browserWeb Manager can be used to import and export an XCR to the device server file system. It can also be used to import an XCR from an external source such as your local hard drive. FTPThe device server FTP server can export and import XCRs when an FTP get or put command on the filename xport_pro.xcr is requested. On export (FTP get of xport_pro.xcr), the FTP server obtains the current XCR from Evolution OS and sends it as a file. On import (FTP put of xport_pro.xcr), the FTP server processes the file by sending it directly to the XML engine. In both cases the device server filesystem is not accessed. The file xport_pro.xcr is not read from or written to the file system. See FTP in the XPort Pro User Guide. TFTPTFTP supports XCR importing. Due to limited security capabilities of TFTP, the option is disabled by default.

Best Practices
You can import or export an entire XCR, or just a portion of it, by specifying the group name and/or group instances. In the examples below, import and export operations are performed from the CLI on the local filesystem and require a XCR on the local filesystem. The Web Manager provides the same functionality. Caution: Using Microsoft Word to edit and save an XCR will change the format of the file and make it incompatible with Evolution OS. This is true even if the file is saved as Plain Text (.txt) or an XML Document (.xml). Notepad, a third party text editor, or a specialized XML editor should be used instead.

Importing
The following syntax can be used to import configurations from a file: xcr import <file> xcr import <file> <groups and/or group:instances> The first line imports all groups specified in the XML config record named in <file>. Any filename is valid, and the file name and extension are not important. Caution: The filename xport_pro.xcr is not acceptable, because performing a FTP get on that name produces the current configuration and does not perform an FTP from the filesystem. Also, the filename xport_pro.xsr is not acceptable, because performing an FTP get on that name produces the current status and does not get anything from the filesystem.

In the second line:


Instance follows group with a colon (see the third example on the next page). Multiple groups are separated with a comma. Any white space requires the list of groups to be quoted. Only the named groups get imported, even if the XCR contains additional XCR groups.

The following syntax can be used to export configurations to a file on the device servers file system:

XPort Pro Command Reference

18

4: Configuration Using XML

xcr export <file> xcr export <file> <groups and/or group:instances> The same guidelines above regarding importing configurations also apply to exporting configurations. If no groups are specified, then the export command will export all configuration settings to the file. If instances are specified after the groups, only those group instances are written. If no instance is specified, all instances of that group are written.

Exporting
The following example exports only the accept mode tunneling settings for line 1 to the file tunnel_1.xcr on the device server filesystem: xcr export tunnel_1.xcr tunnel accept:1 The following example exports only the connect mode tunneling settings for all ports to the file tunnel_all.xcr on the device server filesystem: xcr export tunnel_all.xcr tunnel connect The following example imports only the settings for line 2 from a XCR named factory_config.xcr on the device server filesystem. If factory_config.xcr has other configuration settings, they are ignored: xcr import factory_config.xcr line:2 The following example imports only line settings for all ports from a configuration record on the device server filesystem named foobar.xcr: xcr import foobar.xcr line To import only disconnect mode tunneling settings for port 1 and serial line settings for port 2 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:2" The following example imports all tunneling settings and line settings for all serial ports from a file named xcr_file: xcr import xcr_file "tunnel accept, tunnel connect, tunnel disconnect, tunnel modem, tunnel packing, tunnel serial, tunnel start, tunnel stop, line" The following example exports only accept mode tunneling settings on serial port 1, and line settings on serial port 2 to a file named tunnel_config_t1_l2.xcr on the device server filesystem. xcr export tunnel_config_t1_l2.xcr "tunnel accept:1, line:2" The following example exports connect mode tunneling and line settings for all ports to the file tunnel_config.xcr on the device server filesystem: xcr export tunnel_config.xcr "tunnel, line"

Passwords in the XML File


If you log in to a device server to which you will be pasting an XCR, you do not need to include passwords in the file, because you are already logged into the device. However, if you send an XCR to one or more devices that are password protected, you can include the appropriate passwords in the XCR and skip the login steps.

XPort Pro Command Reference

19

4: Configuration Using XML The xml paste passwords <configgroup> name is used with the passwords <configitem> name and cli login and cli enable level values to specify the passwords to use when the device has been configured with password protection. The password value is clear text. To protect the password, establish an SSH connection to the device server. Figure 4-7 shows an example.
Figure 4-7 XML Example of Supplying Passwords

<!To supply passwords when importing via cli capture --> <configgroup name = "xml paste passwords"> <configitem name = "passwords"> <value name = "cli login"></value> <value name = "cli enable level"></value> </configitem> </configgroup>

XML Configuration Groups


Table 4-8 lists the XPort 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 less than and any instance of &#62 may be read as greater than.

Table 4-8 XCR Groups Group Name arp Group Item arp delete Value Name ip address Value Options Addition Information Remove an entry from the ARP table. Specify the entry by its IP address.

arp entry timeout

ip address mac address Default: 60 seconds

XPort Pro Command Reference

20

4: Configuration Using XML

Group Name cli

Group Item login password enable level password quit connect line

Value Name

Value Options

Addition Information Value is SECRET, hidden from user view. Value is SECRET, hidden from user view. Accepts text containing control characters, for example, &#60;control&#62; A represents control-A Default: <control>L

inactivity timeout cp group (Attribute of instance is required for the group name.) state cp (Attribute of instance is a number.) bit type assert low device short name long name serial number firmware version diagnostics log output max length severity level

&#60;None&#62;, ... enable disable input output enable disable

Default: 15 minutes Changes state of the CP group. Bit number

Read only. Read only. disable, filesystem, line <number> debug, information, notice, warning, error Default: disable Default: 50 Kbytes Default: debug

XPort Pro Command Reference

21

4: Configuration Using XML

Group Name email (Attribute of instance is a number.)

Group Item to

Value Name

Value Options

Addition Information Multiple addresses may be separated with semicolons. Multiple addresses may be separated with semicolons.

cc

from reply to subject message file overriding domain server port local port priority &#60;Random&#6 2;, ... urgent, high, normal, low, very low auto, 10, 100 auto, half, full enable, disable Default: 25 Default: <Random> Default: normal

ethernet (Attribute of instance is eth0.) ftp server

speed duplex state admin username admin password

Default: auto Default: auto Default: enable Default: admin Value is SECRET, hidden from user view.

host (Attribute of instance is either a number.)

name protocol ssh username remote address remote port Default: 0 telnet, ssh Default: telnet

XPort Pro Command Reference

22

4: Configuration Using XML

Group Name http authenticati on uri (Attribute of instance is the URI.)

Group Item user delete

Value Name name

Value Options

Addition Information Deletes an HTTP Authentication URI user. The value element is used to specify the user for deletion.

realm type user (Attribute of instance is the user name.) http server state port secure port secure protocols password

enable, disable &#60;None&#62;, ... &#60;None&#62;, ... ssl3, tls1.0, tls1.1

Default: enable Default: 80 Default: 443 May contain zero, one, or more of the values, separated by commas. Default: ssl3, tls1.0, tls1.1 Default: 10 seconds Default: 40960

max timeout max bytes logging state max log entries log format enable, disable

Default: enable Default: 50 Default: %h %t "%r" %s %B "%{Referer}i" "%{User-Agent}i" Default: 30 minutes

authenticati on timeout icmp state enable, disable

Default: enable

XPort Pro Command Reference

23

4: Configuration Using XML

Group Name interface (Attribute of instance is eth0)

Group Item bootp dhcp ip address

Value Name

Value Options enable, disable enable, disable &#60;None&#62;), ...

Addition Information Default: disable Default: enable Accepts an IP address and mask as either: (1) IP address only (192.168.1.1) gets a default mask, (2) CIDR (192.168.1.1/24), or (3) Explicit mask (192.168.1.1 255.255.255.0). Accepts in IP address in dotted notation, like 192.168.1.1.

default gateway

&#60;None&#62;), ...

hostname domain dhcp client id primary dns &#60;None&#62;), ... Set the identity of the client device. Accepts in IP address in dotted notation, like 192.168.1.1. Accepts in IP address in dotted notation, like 192.168.1.1. Default: 1500 bytes Default: 64 hops Default: 1 hops

secondary dns

&#60;None&#62;), ...

mtu ip ip time to live multicast time to live

XPort Pro Command Reference

24

4: Configuration Using XML

Group Name ip filter

Group Item delete entries

Value Name

Value Options enable, disable

Addition Information If enabled, deletes any existing entries before adding filter entry. Deletes a specific IP filter entry. Deletes a specific IP filter entry. If configured, is a specific IP address. If configured, is a specific net mask.

filter delete

ip address net mask

filter entry

ip address

net mask

XPort Pro Command Reference

25

4: Configuration Using XML

Group Name line (Attribute of instance is a number.)

Group Item name interface

Value Name

Value Options

Addition Information Default:

rs232, rs485 halfduplex, rs485 fullduplex enable, disable enable, disable none, modbus rtu, modbus ascii, tunnel, ppp, lpd, lpd or tunnel

termination state protocol

Default: disable Default: depends on instance Default:

baud rate parity data bits stop bits flow control xon char even, none, odd 7, 8 1, 2 none, hardware, software

Default: 9600 bits per second Default: none Default: 8 Default: 1 Default: none Accepts a control character, for example, &#60;control&#62; A represents control-A Default: <control>Q Accepts a control character, for example, &#60;control&#62; A represents control-A Default: <control>S &#60;None&#62;, ... enable, disable enable, disable enable, disable enable, disable enable, disable enable, disable Default: <None> Default: 56 bytes Default: enable Default: disable Default: disable Default: disable Default: disable Default: disable

xoff char

gap timer threshold lpd (Attribute of instance is a number.) banner binary soj eoj formfeed convert newline soj text eoj text queue name

XPort Pro Command Reference

26

4: Configuration Using XML

Group Name managelinx

Group Item plaintext dsm credentials encrypted dsm credentials

Value Name dna.xml.replication.protocol.version dna.capabilities.tcp.connect.fail dna.dsc.auth.tunnel.username dna.dsc.auth.ssh.pub dna.dsc.auth.ssh.priv device.dna.dsc.tunnel.portlist.list device.dna.dsc.tunnel.ip.addr device.dna.dsc.tunnel.ip.list device.dna.dsc.tunnel.ssh.public device.dnaid device.dna.dsc.tunnel.portlist.httpconne ct device.dna.dsc.tunnel.proxy.host device.dna.dsc.tunnel.proxy.port device.dna.dsc.tunnel.proxy.enable

Value Options

Addition Information Default: disable

enable, disable

managelinx common

device.dna.system.change.number device.config.name device.dna.system.change.timestamp device.dna.dsc.replication.period Default: 1800 seconds

managelinx network interface

device.dna.system.network.iface.name device.dna.system.network.iface.ipaddr ess device.dna.system.network.iface.vip.po ol device.viproute.target.name Default: 0

modbus

tcp server state additional port response timeout rss trace input

enable, disable &#60;None&#62;, ...

Default: disable Default: <None> Default: 3000 milliseconds

enable, disable

Default: disable

XPort Pro Command Reference

27

4: Configuration Using XML

Group Name ppp (Attribute of instance is a number.)

Group Item local ip

Value Name

Value Options &#60;None&#62;), ...

Addition Information Accepts an IP address and mask as either: (1) IP address only (192.168.1.1) gets a default mask, (2) CIDR (192.168.1.1/24), or (3) Explicit mask (192.168.1.1 255.255.255.0). Accepts in IP address in dotted notation, like 192.168.1.1. Default: none

peer ip

&#60;None&#62;), ...

authenticati on mode username password

none, pap, chap, ms-chap, mschapv2

Value is SECRET, hidden from user view. enable, disable enable, disable Default: disable Default: disable Default: 100

query port rss

state feed persist max entries

serial command mode (Attribute of instance is a number.)

mode echo serial string serial string signon message wait time relay address relay port Default: 25

smtp

XPort Pro Command Reference

28

4: Configuration Using XML

Group Name snmp

Group Item state read community

Value Name

Value Options enable, disable

Addition Information Default: enable Value is SECRET, hidden from user view. Default: public Value is SECRET, hidden from user view. Default: private

write community

system contact system name system description system location traps state primary destination secondary destination ssh state port max sessions enable, disable Default: enable Default: 22 Default: 3 enable, disable Default: enable Default: <Default> Default: <Default>

XPort Pro Command Reference

29

4: Configuration Using XML

Group Name ssh client

Group Item delete known hosts known host delete known host (Attribute of instance is required for the known host name) delete client users

Value Name

Value Options enable, disable

Addition Information If enabled, deletes any existing hosts before adding known host. Specify the known host to delete.

name public rsa key public dsa key

enable, disable

If enabled, deletes any existing client users before adding client user. Specify the user to delete.

client user delete client user (Attribute of instance is required for the user name)

name password remote command public rsa key private rsa key public dsa key private dsa key public key private key public key private key

ssh server

host rsa keys host dsa keys delete authorized users authorized user delete authorized user (Attribute of instance is required for the authorized user name)

name password public rsa key public dsa key

XPort Pro Command Reference

30

4: Configuration Using XML

Group Name ssl

Group Item RSA certificate

Value Name certificate private key

Value Options

Addition Information Enter the text of the certificate. Enter the text of the private key. If configured and not exporting secrets, exports only a placeholder.

DSA certificate

certificate private key

Enter the text of the certificate. Enter the text of the private key. If configured and not exporting secrets, exports only a placeholder.

delete all cas

enable, disable

If enabled, deletes any existing trusted cas before adding trusted ca. Default: disable Default: 514 Default: 514

syslog

state host local port remote port severity log level

enable, disable

none, emergency, alert, critical, error, warning, notice, information, debug enable, disable

Default: none

tcp

resets ack limit

Default: enable Number of packets received before an ACK is forced. Default: 3 packets

send data telnet state port max sessions

standard, expedited enable, disable

Default: standard Default: enable Default: 23 Default: 3

XPort Pro Command Reference

31

4: Configuration Using XML

Group Name terminal (Attribute of instance is either network or a number.)

Group Item terminal type login connect menu exit connect menu send break

Value Name

Value Options

Addition Information Default: UNKNOWN

enable, disable

Default: disable

enable, disable

Default: disable Accepts a control character, for example, &#60;control&#62; A represents control-A Default: 500 milliseconds

break duration echo tftp server state allow file creation allow firmware update allow xcr import enable, disable enable, disable enable, disable enable, disable

Default: enable Default: enable Default: disable Default: disable

enable, disable

Default: disable

XPort Pro Command Reference

32

4: Configuration Using XML

Group Name tunnel accept (Attribute of instance is a number.)

Group Item accept mode

Value Name

Value Options disable, always, any character, start character, modem control asserted, modem emulation

Addition Information Default: always

start character

Accepts a control character, for example, &#60;control&#62; A represents control-A Default: <control>B enable, disable &#60;None&#62;, ... tcp, ssh, telnet, tcp aes, ssl &#60;None&#62;, ... Default: enable Default: <None> Default: tcp Default: 45000 milliseconds Value is SECRET, hidden from user view. Value is SECRET, hidden from user view. enable, disable enable, disable enable, disable password Default: disable Default: disable Default: disable Value is SECRET, hidden from user view. enable, disable &#60;None&#62;, ... &#60;None&#62;, ... Default: disable Default: <None> Default: <None>

flush start character local port protocol tcp keep alive aes encrypt key aes decrypt key flush serial block serial block network password

prompt email connect email disconnect

XPort Pro Command Reference

33

4: Configuration Using XML

Group Name tunnel connect (Attribute of instance is a number.)

Group Item connect mode

Value Name

Value Options disable, always, any character, start character, modem control asserted, modem emulation

Addition Information Default: disable

start character

Accepts a control character, for example, &#60;control&#62; A represents control-A Default: <control>B enable, disable &#60;Random&#6 2;, ... vip vip name address port protocol &#60;None&#62;, ... tcp, udp, ssh, telnet, tcp aes, udp aes, ssl Default: <None> Default: tcp enable, disable Default: enable Default: <Random> Default: disable

flush start character local port host

ssh username

Username must correspond to a configured ssh client user. enable, disable &#60;None&#62;, ... Default: enable Default: 45000 milliseconds Value is SECRET, hidden from user view. Value is SECRET, hidden from user view. sequential, simultaneous Default: sequential Default: 15000 milliseconds enable, disable enable, disable enable, disable &#60;None&#62;, ... &#60;None&#62;, ... Default: disable Default: disable Default: disable Default: <None> Default: <None>

validate certificate tcp keep alive aes encrypt key

aes decrypt key

host mode reconnect time flush serial block serial block network email connect email disconnect

XPort Pro Command Reference

34

4: Configuration Using XML

Group Name tunnel disconnect (Attribute of instance is a number.)

Group Item stop character

Value Name

Value Options

Addition Information Accepts a control character, for example, &#60;control&#62; A represents control-A

flush stop character modem control timeout flush serial tunnel modem (Attribute of instance is a number.) echo pluses echo commands verbose response response type error unknown commands incoming connection connect string display remote ip tunnel packing (Attribute of instance is a number.) packing mode timeout threshold send character

enable, disable enable, disable

Default: enable Default: disable Default: 0 milliseconds

enable, disable enable, disable enable, disable enable, disable text, numeric enable, disable

Default: disable Default: disable Default: enable Default: enable Default: text Default: disable

disabled, automatic, manual

Default: disabled

enable, disable disable, timeout, send character

Default: disable Default: disable Default: 1000 milliseconds Default: 512 bytes Accepts a control character, for example, &#60;control&#62; A represents control-A Default: <control>M Accepts a control character, for example, &#60;control&#62; A represents control-A

trailing character

XPort Pro Command Reference

35

4: Configuration Using XML

Group Name tunnel serial (Attribute of instance is a number.) vip xml import control

Group Item dtr

Value Name

Value Options asserted while connected, continuously asserted, unasserted, truport enable, disable

Addition Information Default: asserted while connected

state restore factory configuratio n delete http authenticati on uris

Default: disable

enable, disable

Deletes existing http authentication uris before importing new ones. Deletes the specified http authentication uri.

http authenticati on uri delete reboot

name

enable, disable

Reboots after importing.

XPort Pro Command Reference

36

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. Currently, the only XSR groups that contain any sub groups are buffer pools and tunnel. The buffer pools group has the following sub groups:

Protocol stack Ethernet driver Line Tunnel Modem

The tunnel group has the following sub groups:

Table 4-9 XSR Groups and Items Group Name arp (Attribute of instance is eth0.) Item Name arp entry Value Name ip address mac address age type buffer/protocol stack buffer headers total free used max used cluster pool cluster size total free used max used buffer pool this group contains other groups: ethernet driver, line #, protocol stack. dynamic static Valid Values

XPort Pro Command Reference

37

4: Configuration Using XML

Group Name cp group (Attribute of instance is required for the group name.

Item Name state

Value Name

Valid Values disabled disabled and locked enabled enabled and locked

value cp (Attribute of instance is a number.) value level logic position cps cp (Attribute of instanceis a number.) pin configured as value level logic active group group device product info product type serial number firmware version uptime permanent config email (Attribute of instance is a number from 1 to 4.) success failed queued email log (Attribute of instance is a number from 1 to 4.) entry time log sent sent with retries saved unsaved low high inverted not inverted input output low high inverted not inverted

XPort Pro Command Reference

38

4: Configuration Using XML

Group Name ethernet driver (Within group buffer pool.)

Item Name buffer headers

Value Name total free used max used

Valid Values

cluster pool

cluster size total free used max used

filesystem

filesystem size banks current firmware begin firmware end firmware erase cycles bank a begin bank a end bank a erase cycles bank b begin bank b end bank b erase cycles available space clean space dirty space file and dir space used data space used number of files number of directories number of system files opened files locked files opened for sharing busy no yes A B

XPort Pro Command Reference

39

4: Configuration Using XML

Group Name ftp

Item Name status connections last client

Value Name

Valid Values running inactive

rejected accepted ip address port type speed flash size ram size enabled disabled entries bytes

hardware

cpu memory

http

state logging

http log

entry (Attribute of instance is a number.) totals entries bytes

XPort Pro Command Reference

40

4: Configuration Using XML

Group Name icmp

Item Name in

Value Name 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

Valid Values

out

messages messages discarded errors destination unreachables time exceeded messages parameter problems source quench requests redirects ping requests ping replies timestamp requests timestamp replies address mask requests address mask replies

interface (Attribute of instance is eth0.)

generic

status

no link link up disabled unknown

errors

(error text) none

XPort Pro Command Reference

41

4: Configuration Using XML

Group Name interface (Attribute of instance is eth0.) (Continued.)

Item Name ethernet (Present only for eth0.)

Value Name speed duplex

Valid Values 10 100 full half ARPA ARPA

arp

encapsulation type timeout

default gateway network mask domain mac address hostname ip address last change mtu primary dns secondary dns transmit octets unicast non unicast discards errors broadcast packets multicast packets filtered packets deferred multiple retries one retry underflows late collisions retry errors carrier lost errors

XPort Pro Command Reference

42

4: Configuration Using XML

Group Name interface (Attribute of instance is eth0.) (Continued.)

Item Name receive

Value Name octets unicast non unicast discards errors broadcast packets multicast packets filtered packets unknown protocol framing errors overflows crc errors missed frame errors

Valid Values

ip

state default ttl forwarded route discards in receives header errors address errors unknown protocols discarded delivered out requests discards discards no route reassembly timeout needed success failures fragments needed failures success

enabled disabled

XPort Pro Command Reference

43

4: Configuration Using XML

Group Name ip sockets

Item Name ip socket

Value Name protocol rx queue tx queue local address local port remote address remote port state

Valid Values UDP TCP

line (Attribute of instance is a number.)

receiver

bytes breaks parity errors framing errors overrun errors no receive buffer errors queued bytes flow control n/a stop go

transmitter

bytes breaks queued bytes flow control n/a stop go

line levels

cts rts dsr dtr

asserted not asserted asserted not asserted asserted not asserted asserted not asserted

XPort Pro Command Reference

44

4: Configuration Using XML

Group Name line (With no instance.) (Within group line with instance.)

Item Name state protocol

Value Name

Valid Values enable disable lpd none ppp tunnel

baud rate parity

Any value from 300 to 230400. even none odd

data bits stop bits flow control

7 8 1 2 hardware none software

xon char xoff char lpd (Attribute of instance is a number.) jobs printed bytes printed current client ip address current client port last client ip address last client port memory main heap condition total memory available memory fragments allocated blocks modbus local slave totals pdus in pdus out exceptions clean corrupt

XPort Pro Command Reference

45

4: Configuration Using XML

Group Name modbus tcp server (Attribute of instance is permanent or additional.)

Item Name state

Value Name

Valid Values down up binding no port

local port totals uptime pdus in pdus out connections last connection local ip address local port remote ip address remote port current connection local ip address local port remote ip address remote port uptime pdus in pdus out processes process (Attribute of instance is a number.) cpu % stack used stack size thread name protocol stack (within group buffer pool) buffer headers total free used max used cluster pool cluster size total free used max used

XPort Pro Command Reference

46

4: Configuration Using XML

Group Name query port

Item Name status last connection in

Value Name

Valid Values enabled disabled

ip address port discoveries unknown queries erroneous packets

out rss url data sessions line (Attribute of instance is a number.)

discovery replies errors entries bytes baud parity none even odd data bits stop bits flow control 7 8 1 2 none hardware software

ssh (Attribute of instance is the ssh session number.)

local port remote ip address remote port duration local port remote ip address remote port duration active waiting disabled

telnet (Attribute of instance is the telnet session number.)

ssh

state

totals

uptime bytes in bytes out

XPort Pro Command Reference

47

4: Configuration Using XML

Group Name syslog

Item Name status messages failed messages send

Value Name

Valid Values running inactive

tcp

retransmission

algorithm timeout minimum timeout maximum

vanj

connections

maximum open active open passive failed resets established

errors in resets segments in out in out retransmitted telnet state active waiting disabled totals uptime bytes in bytes out tftp status downloaded uploaded not found errors read write unknown last client ip address port running inactive

XPort Pro Command Reference

48

4: Configuration Using XML

Group Name tunnel (Attribute of instance is a number.)

Item Name aggregate

Value Name completed connects completed accepts disconnects dropped connects dropped accepts octets from serial octets from network connect 015 connection time accept connection time connect dns address changes connect dns address invalids

Valid Values

current connection (As many as present.)

local ip address local port remote ip address remote port uptime octets from serial octets from network connect dns address changes connect dns address invalids

tunnel modem (within group tunnel)

echo commands verbose response response type error unknown commands incoming connection

enable disable enable disable text numeric disable enable disabled automatic manual

udp

in unknown ports in datagrams in errors out datagrams

XPort Pro Command Reference

49

4: Configuration Using XML

Group Name vip

Item Name conduit status

Value Name

Valid Values up down disabled idle negotiating closing

conduit uptime config name current tunnel port dsm ip address list local dna id time of last replication tunnel user tunnel http port list data bytes udp packet queue udp packets current dsm ip address tunnel proxy host tunnel proxy port vip pools network interface (instance is a number.) xsr out name bytes lines elements errors receive transmit receive transmit receive transmit

XPort Pro Command Reference

50

5: Commands and Levels

5: Commands and Levels


Click the level in the tree structure and it will take you to the command list for that level. root o enable (enable) configure (config) arp (config-arp) cli (config-cli) ssh (config-cli-ssh) telnet (config-cli-telnet) diagnostics (config-diagnostics) log (config-diagnostics-log) ftp (config-ftp) host 1 (config-host:1) host 2 (config-host:2) host 3 (config-host:3) host 4 (config-host:4) host 5 (config-host:5) host 6 (config-host:6) host 7 (config-host:7) host 8 (config-host:8) host 9 (config-host:9) host 10 (config-host:10) host 11 (config-host:11) host 12 (config-host:12) host 13 (config-host:13) host 14 (config-host:14) host 15 (config-host:15) host 16 (config-host:16) http (config-http) icmp (config-icmp) if 1 (config-if:eth0) link (config-ethernet:eth0) ip (config-ip) ip filter (config-filter) lpd 1 (config-lpd:1) modbus (modbus) rss (modbus-rss) query port (config-query_port) rss (config-rss) smtp (config-smtp) snmp (config-snmp) traps (config-snmp-traps) syslog (config-syslog) tcp (config-tcp) terminal 1 (config-terminal:1) terminal network (config-terminal:network) tftp (config-tftp) udp (config-udp) vip (config-vip) cpm (cpm) device (device) dns (dns)

XPort Pro Command Reference

51

5: Commands and Levels

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) lpd (lpd) ppp 1 (ppp:1) ssh (ssh) client (ssh-client) server (ssh-server) ssl (ssl) tunnel 1 (tunnel:1) accept (tunnel-accept:1) cp output (tunnel-accept-cp_output:1) password (tunnel-accept-password:1) connect (tunnel-connect:1) cp output (tunnel-connect-cp_output:1) host 1 (tunnel-connect-host:1:1) host 2 (tunnel-connect-host:1:2) host 3 (tunnel-connect-host:1:3) host 4 (tunnel-connect-host:1:4) host 5 (tunnel-connect-host:1:5) host 6 (tunnel-connect-host:1:6) host 7 (tunnel-connect-host:1:7) host 8 (tunnel-connect-host:1:8) host 9 (tunnel-connect-host:1:9) host 10 (tunnel-connect-host:1:10) host 11 (tunnel-connect-host:1:11) host 12 (tunnel-connect-host:1:12) host 13 (tunnel-connect-host:1:13) host 14 (tunnel-connect-host:1:14) host 15 (tunnel-connect-host:1:15) host 16 (tunnel-connect-host:1:16) disconnect (tunnel-disconnect:1) modem (tunnel-modem:1) packing (tunnel-packing:1) serial (tunnel-serial:1) xml (xml)

XPort Pro Command Reference

52

5: Commands and Levels

Table 5-1 Commands and Levels accept (tunnel-accept:1) level commands accept mode always accept mode any character

accept mode disable 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 disable block network enable

block serial disable

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

53

5: Commands and Levels

block serial enable

clrscrn cp output default accept mode default protocol default start character default tcp keep alive email connect <number>

email disconnect <number>

exit flush serial disable

flush serial enable

flush start character disable flush start character enable kill connection local port <number> no aes decrypt key no aes encrypt key no email connect no email disconnect no local port

no tcp keep alive password protocol ssh protocol ssl protocol tcp

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 email profile to use to send an email alert upon establishing an accept mode tunnel. <number> = the number of the email profile to use. Sets an email profile to use to send an email alert upon closing an accept mode tunnel. <number> = the number of the email 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 email alerts upon establishing an accept mode tunnel. Discontinues sending email alerts upon closing an accept mode tunnel. 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. 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.

XPort Pro Command Reference

54

5: Commands and Levels

protocol tcp aes protocol telnet show show history show status start character <control>

tcp keep alive <milliseconds>

write arp (config-arp) level commands add <ip address> <MAC address>

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. 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 all entries from the ARP cache. Removes an entry from the ARP cache. <ip address> = address of the entry being removed. 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. 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 enable-level password. Exits to the configuration level. Sets the inactivity timeout for all CLI sessions. Sets the CLI login password.

clrscrn default timeout exit remove all remove ip <ip address> show show cache show history timeout <seconds> write cli (config-cli) level commands clrscrn default inactivity timeout default quit connect line enable level password <text> exit inactivity timeout <minutes> login password <text>

XPort Pro Command Reference

55

5: Commands and Levels

no enable level password no inactivity timeout no login password quit connect line <control>

show show history ssh telnet write client (ssh-client) level commands clrscrn default user <username> command delete all known hosts delete all users delete known host <server> delete user <username> exit known host <server> no known host <server> dsa no known host <server> rsa no user <username> dsa no user <username> rsa show show history show known host <server> show user <username> user <username> user <username> command <command> user <username> generate dsa 1024 user <username> generate dsa 512 user <username> generate dsa 768 user <username> generate rsa 1024 user <username> generate rsa 512 user <username> generate rsa 768 user <username> password <password> write

Removes the enable-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. Clears the screen. Restore the user command to the default login shell Remove all hnown hosts Remove all users Remove known host Delete the named user Exits to the ssh level. Set known host RSA or DSA key Remove known host DSA key Remove known host RSA key Remove user DSA key Remove user RSA key Show SSH Client settings Displays the last 20 commands entered during the current CLI session. Show known host RSA and DSA keys Show information for a user Set username and RSA or DSA keys Customizes the user command Generate DSA public and private keys Generate DSA public and private keys Generate DSA public and private keys Generate RSA public and private keys Generate RSA public and private keys Generate RSA public and private keys Set username with password and optional RSA or DSA keys Stores the current configuration in permanent memory.

XPort Pro Command Reference

56

5: Commands and Levels

configure (config) level commands arp cli clrscrn diagnostics exit ftp host <number> http icmp if <instance> ip ip filter kill ssh <session> kill telnet <session> lpd <line>

modbus query port rss show show history smtp snmp syslog tcp terminal <line>

terminal network tftp udp vip write connect (tunnel-connect:1) level commands

Changes to the command level for ARP configuration and status. Change to menu level for CLI configuration and status Clears the screen. Enters the diagnostics level. Exits to the enable 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. Changes to the modbus configuration level. 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. Changes to the command level for SMTP configuration and status. 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 Stores the current configuration in permanent memory.

XPort Pro Command Reference

57

5: Commands and Levels

block network disable block network enable

block serial disable block serial enable

clrscrn connect mode always connect mode any character

connect mode disable connect mode modem control asserted

connect mode modem emulation connect mode start character

cp output default connect mode default host mode default local port

default reconnect time default start character email connect <number>

email disconnect <number>

exit flush serial disable

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 "disable". 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. Restores the default reconnect time value for connect mode tunneling. Defaults the connect mode start character. Sets an email profile to use to send an email alert upon establishing a connect mode tunnel. <number> = the number of the email profile to use. Sets an email profile to use to send an email alert upon closing a connect mode tunnel. <number> = the number of the email profile to use. Returns to the tunnel level. Characters already in the serial data buffer are retained upon establishing a connect mode tunneling connection.

XPort Pro Command Reference

58

5: Commands and Levels

flush serial enable

flush start character disable flush start character enable host <instance> host mode sequential host mode simultaneous kill connection local port <number> no email connect no email disconnect promote host <number>

reconnect time <milliseconds>

show show history show status start character <control>

write cp (email-cp:4) level commands clrscrn exit group <text> no group no trigger value show show history

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 or connections. Sets a specific port for use as the local port. <number> = the number of the port to use. Discontinues sending email alerts upon establishing a connect mode tunnel. Discontinues sending email 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 the current configuration. 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. Clears the screen. Exits to the next higher level. Specify a CP group that shall trigger an email. <text> = configurable pin group. Disables the trigger to send an email. Clears the value that shall trigger an email. Shows the current configuration. Displays the last 20 commands entered during the current CLI session.

XPort Pro Command Reference

59

5: Commands and Levels

trigger value <number>

write cp (email-cp:3) level commands clrscrn exit group <text> no group no trigger value show show history trigger value <number>

Specify a value of the CP group that shall trigger an email. <number> = numeric value to watch for from the CP group. Can be specified as hex if prepended with 0x. Stores the current configuration in permanent memory. Clears the screen. Exits to the next higher level. Specify a CP group that shall trigger an email. <text> = configurable pin group. Disables the trigger to send an email. Clears the value that shall trigger an email. Shows the current configuration. Displays the last 20 commands entered during the current CLI session. Specify a value of the CP group that shall trigger an email. <number> = numeric value to watch for from the CP group. Can be specified as hex if prepended with 0x. Stores the current configuration in permanent memory. Clears the screen. Exits to the next higher level. Specify a CP group that shall trigger an email. <text> = configurable pin group. Disables the trigger to send an email. Clears the value that shall trigger an email. Shows the current configuration. Displays the last 20 commands entered during the current CLI session. Specify a value of the CP group that shall trigger an email. <number> = numeric value to watch for from the CP group. Can be specified as hex if prepended with 0x. Stores the current configuration in permanent memory. Clears the screen. Exits to the next higher level. Specify a CP group that shall trigger an email. <text> = configurable pin group. Disables the trigger to send an email. Clears the value that shall trigger an email.

write cp (email-cp:2) level commands clrscrn exit group <text> no group no trigger value show show history trigger value <number>

write cp (email-cp:1) level commands clrscrn exit group <text> no group no trigger value

XPort Pro Command Reference

60

5: Commands and Levels

show show history

Shows the current configuration. Displays the last 20 commands entered during the current CLI session. trigger value <number> Specify a value of the CP group that shall trigger an email. <number> = numeric value to watch for from the CP group. Can be specified as hex if prepended with 0x. write Stores the current configuration in permanent memory. cp output (tunnel-connect-cp_output:1) level commands clrscrn Clears the screen. connection value <number> Sets the value to output to the CP Group upon connect mode connection. <number> = binary to output (typically 1 or 0). default connection value Restores the default value for connect mode connection. default disconnection value Restores the default value for connect mode disconnection. disconnection value <number> Sets the value to output to the CP Group upon connect mode disconnection. <number> = binary to output (typically 1 or 0). exit Exits to the next higher level. group <text> Configures the CP Group to set upon making or breaking a connect mode connection. <text> = CP Group. no group Removes the CP Set Group for connect mode. 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. cp output (tunnel-accept-cp_output:1) level commands clrscrn Clears the screen. connection value <number> Sets the value to output to the CP Group upon accept mode connection. <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. <number> = binary to output (typically 1 or 0). exit Exits to the next higher level. group <text> Configures the CP Group to set upon making or breaking an accept mode connection. <text> = CP Group.

XPort Pro Command Reference

61

5: Commands and Levels

no group show show history write cpm (cpm) level commands add <cp> to <group>

Removes the CP Set Group for accept mode. Shows the current configuration. Displays the last 20 commands entered during the current CLI session. Stores the current configuration in permanent memory. 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 disabled group. <group> = the name of the group. Exits to the enable 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.

add <cp> to <group> <bit>

clrscrn create <group> delete <cp> from <group>

delete <group>

disable <group> enable <group> 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>

XPort Pro Command Reference

62

5: Commands and Levels

show cp show groups show history write device (device) level commands auto show tlog auto show upload clrscrn default long name default short name dhrystone exit long name <name> short name <name>

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. 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. Exit to the enable 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.

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

diagnostics (config-diagnostics) level commands clrscrn Clears the screen. exit Returns to the config level. log Enters the next lower level. show Displays the current configuration. 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

63

5: Commands and Levels

disconnect (tunnel-disconnect:1) level commands clrscrn Clears the screen. exit Returns to the tunnel level. flush serial disable Does not flush serial data upon closing a tunneling connection. flush serial enable Flushes serial data buffer when a tunneling connection is closed. flush stop character disable Forwards the stop character from the Line to the network. flush stop character enable Prevents the stop character from the Line from being forwarded to the network. modem control disable Does not watch the modem control pin to disconnect. modem control enable Watches the modem control pin and disconnects if it is not 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> 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. timeout <milliseconds> Disconnects when no data has been received on the line (serial port) for the specified length of time. <milliseconds> = timeout in milliseconds. write Stores the current configuration in permanent memory. dns (dns) level commands clrscrn Clears the screen. exit Exits to the enable level. lookup <host_or_ip> Return a lookup on the DNS name or IP address. remove all Removes all entries from the DNS Cache. 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. email 1 (email:1) level commands auto show statistics Continuously displays email statistics. cc <text> Sets Cc addresses for email alerts. <text> = a quoted, semicolon separated list of email addresses.

XPort Pro Command Reference

64

5: Commands and Levels

clear log clear mail counters clrscrn cp default local port default priority default server port email <number> exit from <text>

local port <number> message file <text>

no cc no clear mail counters no from no message file no overriding domain no reply to no subject no to overriding domain <text>

priority high priority low priority normal priority urgent priority very low reply to <text>

send server port <number> show

Clears all entries from the mail log. Sets the email counters to zero. Clears the screen. Enters the next lower level. Sets the local port (used to send email alerts) to random. Sets X-Priority for email alerts to 3 (normal). Restores the factory default port for SMTP on the server side. Enters the configure email level. Exits to the enable level. Sets the From address for email alerts. <text> = email address to place in the From field of the email alert. Sets the local port used to send email alerts. <number> local port to use for email alerts. Specifies a text file, the contents of which will be the message body of an email alert. <text> = the name of a local file. Removes the Cc addresses for email alerts. Restores the email counters to the aggregate values. Removes the From address for email alerts. Removes the file name, so the message body will be empty. Removes the overriding domain name option. Removes the Reply To address for email alerts. Removes subject used for email alerts. Removes the To addresses for email alerts. Sets a domain name that will be used when connecting to an SMTP server to send an email alert instead of the devices domain name in EHLO. <text> = domain name to override the current domain name in EHLO. Sets X-Priority for email alerts to 2 (high). Sets X-Priority for email alerts to 4 (low). Sets X-Priority for email alerts to 3 (normal). Sets X-Priority for email alerts to 1 (urgent). Sets X-Priority for email alerts to 5 (very low). Sets the Reply To address for email alerts. <text> = email address to place in the Reply To field of the email alert. Sends an email using the current settings. Sets the port used by the SMTP server. <number> = port used for SMTP on the server side. Displays the current configuration.

XPort Pro Command Reference

65

5: Commands and Levels

show history show log show statistics subject <text> to <text>

write email 2 (email:2) level commands auto show statistics cc <text>

Displays the last 20 commands entered during the current CLI session. Displays the email log. Displays email statistics. Sets the Subject for email alerts. <text> = text to placed as the subject. Sets To addresses for email alerts. <text> = a quoted, semicolon separated list of email addresses. Stores the current configuration in permanent memory. Continuously displays email statistics. Sets Cc addresses for email alerts. <text> = a quoted, semicolon separated list of email addresses. Clears all entries from the mail log. Sets the email counters to zero. Clears the screen. Enters the next lower level. Sets the local port (used to send email alerts) to random. Sets X-Priority for email alerts to 3 (normal). Restores the factory default port for SMTP on the server side. Enters the configure email level. Exits to the enable level. Sets the From address for email alerts. <text> = email address to place in the From field of the email alert. Sets the local port used to send email alerts. <number> local port to use for email alerts. Specifies a text file, the contents of which will be the message body of an email alert. <text> = the name of a local file. Removes the Cc addresses for email alerts. Restores the email counters to the aggregate values. Removes the From address for email alerts. Removes the file name, so the message body will be empty. Removes the overriding domain name option. Removes the Reply To address for email alerts. Removes subject used for email alerts. Removes the To addresses for email alerts. Sets a domain name that will be used when connecting to an SMTP server to

clear log clear mail counters clrscrn cp default local port default priority default server port email <number> exit from <text>

local port <number> message file <text>

no cc no clear mail counters no from no message file no overriding domain no reply to no subject no to overriding domain <text>

XPort Pro Command Reference

66

5: Commands and Levels

priority high priority low priority normal priority urgent priority very low reply to <text>

send server port <number> show show history show log show statistics subject <text> to <text>

write email 3 (email:3) level commands auto show statistics cc <text>

send an email alert instead of the devices domain name in EHLO. <text> = domain name to override the current domain name in EHLO. Sets X-Priority for email alerts to 2 (high). Sets X-Priority for email alerts to 4 (low). Sets X-Priority for email alerts to 3 (normal). Sets X-Priority for email alerts to 1 (urgent). Sets X-Priority for email alerts to 5 (very low). Sets the Reply To address for email alerts. <text> = email address to place in the Reply To field of the email alert. Sends an email using the current settings. Sets the port used by the SMTP server. <number> = port used for SMTP on the server side. Displays the current configuration. Displays the last 20 commands entered during the current CLI session. Displays the email log. Displays email statistics. Sets the Subject for email alerts. <text> = text to placed as the subject. Sets To addresses for email alerts. <text> = a quoted, semicolon separated list of email addresses. Stores the current configuration in permanent memory. Continuously displays email statistics. Sets Cc addresses for email alerts. <text> = a quoted, semicolon separated list of email addresses. Clears all entries from the mail log. Sets the email counters to zero. Clears the screen. Enters the next lower level. Sets the local port (used to send email alerts) to random. Sets X-Priority for email alerts to 3 (normal). Restores the factory default port for SMTP on the server side. Enters the configure email level. Exits to the enable level. Sets the From address for email alerts. <text> = email address to place in the From field of the email alert. Sets the local port used to send email alerts. <number> local port to use for email alerts.

clear log clear mail counters clrscrn cp default local port default priority default server port email <number> exit from <text>

local port <number>

XPort Pro Command Reference

67

5: Commands and Levels

message file <text>

no cc no clear mail counters no from no message file no overriding domain no reply to no subject no to overriding domain <text>

priority high priority low priority normal priority urgent priority very low reply to <text>

send server port <number> show show history show log show statistics subject <text> to <text>

write email 4 (email:4) level commands auto show statistics cc <text>

Specifies a text file, the contents of which will be the message body of an email alert. <text> = the name of a local file. Removes the Cc addresses for email alerts. Restores the email counters to the aggregate values. Removes the From address for email alerts. Removes the file name, so the message body will be empty. Removes the overriding domain name option. Removes the Reply To address for email alerts. Removes subject used for email alerts. Removes the To addresses for email alerts. Sets a domain name that will be used when connecting to an SMTP server to send an email alert instead of the devices domain name in EHLO. <text> = domain name to override the current domain name in EHLO. Sets X-Priority for email alerts to 2 (high). Sets X-Priority for email alerts to 4 (low). Sets X-Priority for email alerts to 3 (normal). Sets X-Priority for email alerts to 1 (urgent). Sets X-Priority for email alerts to 5 (very low). Sets the Reply To address for email alerts. <text> = email address to place in the Reply To field of the email alert. Sends an email using the current settings. Sets the port used by the SMTP server. <number> = port used for SMTP on the server side. Displays the current configuration. Displays the last 20 commands entered during the current CLI session. Displays the email log. Displays email statistics. Sets the Subject for email alerts. <text> = text to placed as the subject. Sets To addresses for email alerts. <text> = a quoted, semicolon separated list of email addresses. Stores the current configuration in permanent memory. Continuously displays email statistics. Sets Cc addresses for email alerts. <text> = a quoted, semicolon separated list of email addresses.

XPort Pro Command Reference

68

5: Commands and Levels

clear log clear mail counters clrscrn cp default local port default priority default server port email <number> exit from <text>

local port <number> message file <text>

no cc no clear mail counters no from no message file no overriding domain no reply to no subject no to overriding domain <text>

priority high priority low priority normal priority urgent priority very low reply to <text>

send server port <number> show

Clears all entries from the mail log. Sets the email counters to zero. Clears the screen. Enters the next lower level. Sets the local port (used to send email alerts) to random. Sets X-Priority for email alerts to 3 (normal). Restores the factory default port for SMTP on the server side. Enters the configure email level. Exits to the enable level. Sets the From address for email alerts. <text> = email address to place in the From field of the email alert. Sets the local port used to send email alerts. <number> local port to use for email alerts. Specifies a text file, the contents of which will be the message body of an email alert. <text> = the name of a local file. Removes the Cc addresses for email alerts. Restores the email counters to the aggregate values. Removes the From address for email alerts. Removes the file name, so the message body will be empty. Removes the overriding domain name option. Removes the Reply To address for email alerts. Removes subject used for email alerts. Removes the To addresses for email alerts. Sets a domain name that will be used when connecting to an SMTP server to send an email alert instead of the devices domain name in EHLO. <text> = domain name to override the current domain name in EHLO. Sets X-Priority for email alerts to 2 (high). Sets X-Priority for email alerts to 4 (low). Sets X-Priority for email alerts to 3 (normal). Sets X-Priority for email alerts to 1 (urgent). Sets X-Priority for email alerts to 5 (very low). Sets the Reply To address for email alerts. <text> = email address to place in the Reply To field of the email alert. Sends an email using the current settings. Sets the port used by the SMTP server. <number> = port used for SMTP on the server side. Displays the current configuration.

XPort Pro Command Reference

69

5: Commands and Levels

show history show log show statistics subject <text> to <text>

write enable (enable) level commands auto show interfaces auto show processes clear interfaces counters clrscrn configure connect connect line <line> cpm device disable dns email <number> exit filesystem kill ssh <session> kill telnet <session> line <line>

Displays the last 20 commands entered during the current CLI session. Displays the email log. Displays email statistics. Sets the Subject for email alerts. <text> = text to placed as the subject. Sets To addresses for email alerts. <text> = a quoted, semicolon separated list of email addresses. Stores the current configuration in permanent memory. Show interface statistics Continuously show thread runtime information Zeros interface session counters Clears the screen. 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 enable level. Enters the DNS level. Enters the configure email level. Exit from the system Enters the filesystem level. 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 Ping destination continuously with 5 second timeout Ping destination n times with 5 second timeout Ping destination n times with x timeout (in seconds) Enters the serial line PPP level. Reboot system Reload factory defaults to permanent storage Show system information Displays the last 20 commands entered during the current CLI session. Show interface statistics Show UDP/TCP state information Show thread runtime information Show active Telnet and SSH Sessions

lpd no clear interfaces counters ping <host> ping <host> <count> ping <host> <count> <timeout> ppp <line> reload reload factory defaults show show history show interfaces show ip sockets show processes show sessions

XPort Pro Command Reference

70

5: Commands and Levels

show xport_pro ssh ssh <optClientUsername> <host>

ssh <optClientUsername> <host> <port>

ssl telnet <host> telnet <host> <port> trace route <host> tunnel <line>

write xml filesystem (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>

Show system information 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 telnet session on network <host>. Begin telnet 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. Enters the XML level. 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 enable 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

XPort Pro Command Reference

71

5: Commands and Levels

tftp get binary <source file> <destination file> <host> Get a binary file using TFTP tftp get binary <source file> <destination file> <host> Get a binary file using TFTP <port> tftp put ascii <source file> <destination file> <host> Put an ascii file using TFTP tftp put ascii <source file> <destination file> <host> Put an ascii file using TFTP <port> tftp put binary <source file> <destination file> <host> Put a binary file using TFTP tftp put binary <source file> <destination file> <host> Put a binary file using TFTP <port> touch <file> Create a file ftp (config-ftp) level commands admin password <text> Sets the administrative password for the FTP server. <text> = administrative password. admin username <text> Sets the administrative username for the FTP server. <text> = administrative username. It also removes the administrative password. clear counters Zeros FTP counters. clrscrn Clears the screen. default admin username Resets the FTP username to the default (admin). exit Returns to the config level. no admin password Removes the FTP administrative password. no clear counters Unzeros FTP counters. show Displays the current configuration. show history Displays the last 20 commands entered during the current CLI 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. host 1 (tunnel-connect-host:1:1) level commands address <text> Sets the remote host to establish tunneling connections with. <text> = IP address or host name of the remote host. aes decrypt key <hexadecimal> Sets the connect 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. 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

XPort Pro Command Reference

72

5: Commands and Levels

aes encrypt key <hexadecimal>

aes encrypt key text <text>

auto show statistics clrscrn default protocol default tcp keep alive exit no address no aes decrypt key no aes encrypt key no port no ssh username no tcp keep alive no vip name port <number>

protocol ssh protocol ssl protocol tcp protocol tcp aes protocol telnet protocol udp protocol udp aes show show history show statistics ssh username <text>

contains spaces. 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 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 connect 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. show connection statistics Clears the screen. Restores the default protocol as "TCP". Restores the default 45 second connect mode TCP keep alive timeout. Exits to the next higher level. Removes the remote host address used to establish tunneling connections. Removes the connect tunnel AES decrypt key. Removes the connect tunnel AES encrypt key. Removes the remote port used to establish tunnel connections. Removes the SSH user name. Disables the connect mode TCP keep alive timeout. Removes the VIP name. Sets the remote port to use for connect mode tunneling. <number> = number of the port to use. Uses SSH protocol for connect mode tunneling. Uses SSL protocol for connect mode tunneling. Uses TCP protocol for connect mode tunneling. Uses TCP protocol with AES encryption for connect mode tunneling. Uses Telnet protocol (with IAC) for connect mode tunneling. Uses UDP protocol for connect mode tunneling. Uses UDP protocol with AES encryption for connect mode tunneling. Shows the current configuration. Displays the last 20 commands entered during the current CLI session. show connection statistics Sets the SSH user name for use when establishing tunneling connections with other devices.

XPort Pro Command Reference

73

5: Commands and Levels

tcp keep alive <milliseconds>

validate certificate disable validate certificate enable vip disable vip enable vip name <text> write host 1 (config-host:1) level commands clrscrn default protocol default remote port

<text> = SSH user name. Enables TCP keep alive for connect mode tunneling and sets the timer. <milliseconds> = timer value, in milliseconds. Skips verification of the server certificate when connecting. Requires verification of the server certificate when connecting. Makes connections using the specified Address. Makes connections using the VIP name. Sets the VIP name. Stores the current configuration in permanent memory.

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. 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. no ssh username Clears the SSH username associated with the host. protocol ssh Sets the protocol to SSH. protocol telnet Sets the protocol to Telnet. remote address <text> Sets the IP address of the remote host to connect to when this host is selected on the login connect menu. <text> = IP address. remote port <number> Sets the remote port used to connect to the host. <number> = port to be used. show Displays the current configuration. show history Displays the last 20 commands entered during the current 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 10 (tunnel-connect-host:1:10) level commands address <text> Sets the remote host to establish tunneling connections with. <text> = IP address or host name of the remote host. aes decrypt key <hexadecimal> Sets the connect tunnel AES decrypt key with up to 16 bytes.

XPort Pro Command Reference

74

5: Commands and Levels

aes decrypt key text <text>

aes encrypt key <hexadecimal>

aes encrypt key text <text>

auto show statistics clrscrn default protocol default tcp keep alive exit no address no aes decrypt key no aes encrypt key no port no ssh username no tcp keep alive no vip name port <number>

protocol ssh protocol ssl protocol tcp protocol tcp aes protocol telnet protocol udp

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 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. 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 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 connect 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. show connection statistics Clears the screen. Restores the default protocol as "TCP". Restores the default 45 second connect mode TCP keep alive timeout. Exits to the next higher level. Removes the remote host address used to establish tunneling connections. Removes the connect tunnel AES decrypt key. Removes the connect tunnel AES encrypt key. Removes the remote port used to establish tunnel connections. Removes the SSH user name. Disables the connect mode TCP keep alive timeout. Removes the VIP name. Sets the remote port to use for connect mode tunneling. <number> = number of the port to use. Uses SSH protocol for connect mode tunneling. Uses SSL protocol for connect mode tunneling. Uses TCP protocol for connect mode tunneling. Uses TCP protocol with AES encryption for connect mode tunneling. Uses Telnet protocol (with IAC) for connect mode tunneling. Uses UDP protocol for connect mode tunneling.

XPort Pro Command Reference

75

5: Commands and Levels

protocol udp aes show show history show statistics ssh username <text>

tcp keep alive <milliseconds>

validate certificate disable validate certificate enable vip disable vip enable vip name <text> write host 10 (config-host:10) level commands clrscrn default protocol default remote port

Uses UDP protocol with AES encryption for connect mode tunneling. Shows the current configuration. Displays the last 20 commands entered during the current CLI session. show connection statistics Sets the SSH user name for use when establishing tunneling connections with other devices. <text> = SSH user name. Enables TCP keep alive for connect mode tunneling and sets the timer. <milliseconds> = timer value, in milliseconds. Skips verification of the server certificate when connecting. Requires verification of the server certificate when connecting. Makes connections using the specified Address. Makes connections using the VIP name. Sets the VIP name. Stores the current configuration in permanent memory. 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.

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>

XPort Pro Command Reference

76

5: Commands and Levels

write

Stores the current configuration in permanent memory. host 11 (tunnel-connect-host:1:11) level commands address <text> Sets the remote host to establish tunneling connections with. <text> = IP address or host name of the remote host. aes decrypt key <hexadecimal> Sets the connect 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. 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> 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 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. aes encrypt key text <text> Sets the connect 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. 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 tunneling 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 connections. no ssh username Removes the SSH user name. no tcp keep alive Disables the connect mode TCP keep alive timeout. no vip name Removes the VIP name. port <number> Sets the remote port to use for connect mode tunneling. <number> = number of the port to use.

XPort Pro Command Reference

77

5: Commands and Levels

protocol ssh protocol ssl protocol tcp protocol tcp aes protocol telnet protocol udp protocol udp aes show show history show statistics ssh username <text>

tcp keep alive <milliseconds>

validate certificate disable validate certificate enable vip disable vip enable vip name <text> write host 11 (config-host:11) level commands clrscrn default protocol default remote port

Uses SSH protocol for connect mode tunneling. Uses SSL protocol for connect mode tunneling. Uses TCP protocol for connect mode tunneling. Uses TCP protocol with AES encryption for connect mode tunneling. Uses Telnet protocol (with IAC) for connect mode tunneling. Uses UDP protocol for connect mode tunneling. Uses UDP protocol with AES encryption for connect mode tunneling. Shows the current configuration. Displays the last 20 commands entered during the current CLI session. show connection statistics Sets the SSH user name for use when establishing tunneling connections with other devices. <text> = SSH user name. Enables TCP keep alive for connect mode tunneling and sets the timer. <milliseconds> = timer value, in milliseconds. Skips verification of the server certificate when connecting. Requires verification of the server certificate when connecting. Makes connections using the specified Address. Makes connections using the VIP name. Sets the VIP name. Stores the current configuration in permanent memory. 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.

exit host <number> name <text> no name no remote address no ssh username protocol ssh protocol telnet remote address <text>

XPort Pro Command Reference

78

5: Commands and Levels

<text> = IP address. remote port <number> Sets the remote port used to connect to the host. <number> = port to be used. show Displays the current configuration. show history Displays the last 20 commands entered during the current 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 12 (tunnel-connect-host:1:12) level commands address <text> Sets the remote host to establish tunneling connections with. <text> = IP address or host name of the remote host. aes decrypt key <hexadecimal> Sets the connect 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. 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> 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 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. aes encrypt key text <text> Sets the connect 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. 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 tunneling connections. no aes decrypt key Removes the connect tunnel AES decrypt key. no aes encrypt key Removes the connect tunnel AES encrypt key.

XPort Pro Command Reference

79

5: Commands and Levels

no port no ssh username no tcp keep alive no vip name port <number>

protocol ssh protocol ssl protocol tcp protocol tcp aes protocol telnet protocol udp protocol udp aes show show history show statistics ssh username <text>

tcp keep alive <milliseconds>

validate certificate disable validate certificate enable vip disable vip enable vip name <text> write host 12 (config-host:12) level commands clrscrn default protocol default remote port

Removes the remote port used to establish tunnel connections. Removes the SSH user name. Disables the connect mode TCP keep alive timeout. Removes the VIP name. Sets the remote port to use for connect mode tunneling. <number> = number of the port to use. Uses SSH protocol for connect mode tunneling. Uses SSL protocol for connect mode tunneling. Uses TCP protocol for connect mode tunneling. Uses TCP protocol with AES encryption for connect mode tunneling. Uses Telnet protocol (with IAC) for connect mode tunneling. Uses UDP protocol for connect mode tunneling. Uses UDP protocol with AES encryption for connect mode tunneling. Shows the current configuration. Displays the last 20 commands entered during the current CLI session. show connection statistics Sets the SSH user name for use when establishing tunneling connections with other devices. <text> = SSH user name. Enables TCP keep alive for connect mode tunneling and sets the timer. <milliseconds> = timer value, in milliseconds. Skips verification of the server certificate when connecting. Requires verification of the server certificate when connecting. Makes connections using the specified Address. Makes connections using the VIP name. Sets the VIP name. Stores the current configuration in permanent memory. 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.

exit host <number> name <text>

XPort Pro Command Reference

80

5: Commands and Levels

no name no remote address no ssh username protocol ssh protocol telnet remote address <text>

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. remote port <number> Sets the remote port used to connect to the host. <number> = port to be used. show Displays the current configuration. show history Displays the last 20 commands entered during the current 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:1:13) level commands address <text> Sets the remote host to establish tunneling connections with. <text> = IP address or host name of the remote host. aes decrypt key <hexadecimal> Sets the connect 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. 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> 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 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. aes encrypt key text <text> Sets the connect 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. auto show statistics show connection statistics clrscrn Clears the screen.

XPort Pro Command Reference

81

5: Commands and Levels

default protocol default tcp keep alive exit no address no aes decrypt key no aes encrypt key no port no ssh username no tcp keep alive no vip name port <number>

protocol ssh protocol ssl protocol tcp protocol tcp aes protocol telnet protocol udp protocol udp aes show show history show statistics ssh username <text>

tcp keep alive <milliseconds>

validate certificate disable validate certificate enable vip disable vip enable vip name <text> write host 13 (config-host:13) level commands clrscrn

Restores the default protocol as "TCP". Restores the default 45 second connect mode TCP keep alive timeout. Exits to the next higher level. Removes the remote host address used to establish tunneling connections. Removes the connect tunnel AES decrypt key. Removes the connect tunnel AES encrypt key. Removes the remote port used to establish tunnel connections. Removes the SSH user name. Disables the connect mode TCP keep alive timeout. Removes the VIP name. Sets the remote port to use for connect mode tunneling. <number> = number of the port to use. Uses SSH protocol for connect mode tunneling. Uses SSL protocol for connect mode tunneling. Uses TCP protocol for connect mode tunneling. Uses TCP protocol with AES encryption for connect mode tunneling. Uses Telnet protocol (with IAC) for connect mode tunneling. Uses UDP protocol for connect mode tunneling. Uses UDP protocol with AES encryption for connect mode tunneling. Shows the current configuration. Displays the last 20 commands entered during the current CLI session. show connection statistics Sets the SSH user name for use when establishing tunneling connections with other devices. <text> = SSH user name. Enables TCP keep alive for connect mode tunneling and sets the timer. <milliseconds> = timer value, in milliseconds. Skips verification of the server certificate when connecting. Requires verification of the server certificate when connecting. Makes connections using the specified Address. Makes connections using the VIP name. Sets the VIP name. Stores the current configuration in permanent memory. Clears the screen.

XPort Pro Command Reference

82

5: Commands and Levels

default protocol default remote port

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. 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. no ssh username Clears the SSH username associated with the host. protocol ssh Sets the protocol to SSH. protocol telnet Sets the protocol to Telnet. remote address <text> Sets the IP address of the remote host to connect to when this host is selected on the login connect menu. <text> = IP address. remote port <number> Sets the remote port used to connect to the host. <number> = port to be used. show Displays the current configuration. show history Displays the last 20 commands entered during the current 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 14 (tunnel-connect-host:1:14) level commands address <text> Sets the remote host to establish tunneling connections with. <text> = IP address or host name of the remote host. aes decrypt key <hexadecimal> Sets the connect 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. 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> 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 punctuation: 123ABC "12 3A BC" 12,3A,BC 12.3a.bc 12:3a:bc Note that quotes must enclose the value if it

XPort Pro Command Reference

83

5: Commands and Levels

aes encrypt key text <text>

auto show statistics clrscrn default protocol default tcp keep alive exit no address no aes decrypt key no aes encrypt key no port no ssh username no tcp keep alive no vip name port <number>

protocol ssh protocol ssl protocol tcp protocol tcp aes protocol telnet protocol udp protocol udp aes show show history show statistics ssh username <text>

tcp keep alive <milliseconds>

validate certificate disable validate certificate enable

contains spaces. Sets the connect 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. show connection statistics Clears the screen. Restores the default protocol as "TCP". Restores the default 45 second connect mode TCP keep alive timeout. Exits to the next higher level. Removes the remote host address used to establish tunneling connections. Removes the connect tunnel AES decrypt key. Removes the connect tunnel AES encrypt key. Removes the remote port used to establish tunnel connections. Removes the SSH user name. Disables the connect mode TCP keep alive timeout. Removes the VIP name. Sets the remote port to use for connect mode tunneling. <number> = number of the port to use. Uses SSH protocol for connect mode tunneling. Uses SSL protocol for connect mode tunneling. Uses TCP protocol for connect mode tunneling. Uses TCP protocol with AES encryption for connect mode tunneling. Uses Telnet protocol (with IAC) for connect mode tunneling. Uses UDP protocol for connect mode tunneling. Uses UDP protocol with AES encryption for connect mode tunneling. Shows the current configuration. Displays the last 20 commands entered during the current CLI session. show connection statistics Sets the SSH user name for use when establishing tunneling connections with other devices. <text> = SSH user name. Enables TCP keep alive for connect mode tunneling and sets the timer. <milliseconds> = timer value, in milliseconds. Skips verification of the server certificate when connecting. Requires verification of the server certificate when

XPort Pro Command Reference

84

5: Commands and Levels

vip disable vip enable vip name <text> write host 14 (config-host:14) level commands clrscrn default protocol default remote port

connecting. Makes connections using the specified Address. Makes connections using the VIP name. Sets the VIP name. Stores the current configuration in permanent memory.

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. 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. no ssh username Clears the SSH username associated with the host. protocol ssh Sets the protocol to SSH. protocol telnet Sets the protocol to Telnet. remote address <text> Sets the IP address of the remote host to connect to when this host is selected on the login connect menu. <text> = IP address. remote port <number> Sets the remote port used to connect to the host. <number> = port to be used. show Displays the current configuration. show history Displays the last 20 commands entered during the current 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 15 (tunnel-connect-host:1:15) level commands address <text> Sets the remote host to establish tunneling connections with. <text> = IP address or host name of the remote host. aes decrypt key <hexadecimal> Sets the connect 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. aes decrypt key text <text> Sets the connect tunnel AES decrypt key with up to 16 bytes.

XPort Pro Command Reference

85

5: Commands and Levels

aes encrypt key <hexadecimal>

aes encrypt key text <text>

auto show statistics clrscrn default protocol default tcp keep alive exit no address no aes decrypt key no aes encrypt key no port no ssh username no tcp keep alive no vip name port <number>

protocol ssh protocol ssl protocol tcp protocol tcp aes protocol telnet protocol udp protocol udp aes show show history show statistics ssh username <text>

Each byte is represented by a single character. Note that quotes must enclose the value if it contains spaces. 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 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 connect 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. show connection statistics Clears the screen. Restores the default protocol as "TCP". Restores the default 45 second connect mode TCP keep alive timeout. Exits to the next higher level. Removes the remote host address used to establish tunneling connections. Removes the connect tunnel AES decrypt key. Removes the connect tunnel AES encrypt key. Removes the remote port used to establish tunnel connections. Removes the SSH user name. Disables the connect mode TCP keep alive timeout. Removes the VIP name. Sets the remote port to use for connect mode tunneling. <number> = number of the port to use. Uses SSH protocol for connect mode tunneling. Uses SSL protocol for connect mode tunneling. Uses TCP protocol for connect mode tunneling. Uses TCP protocol with AES encryption for connect mode tunneling. Uses Telnet protocol (with IAC) for connect mode tunneling. Uses UDP protocol for connect mode tunneling. Uses UDP protocol with AES encryption for connect mode tunneling. Shows the current configuration. Displays the last 20 commands entered during the current CLI session. show connection statistics Sets the SSH user name for use when establishing

XPort Pro Command Reference

86

5: Commands and Levels

tcp keep alive <milliseconds>

validate certificate disable validate certificate enable vip disable vip enable vip name <text> write host 15 (config-host:15) level commands clrscrn default protocol default remote port

tunneling connections with other devices. <text> = SSH user name. Enables TCP keep alive for connect mode tunneling and sets the timer. <milliseconds> = timer value, in milliseconds. Skips verification of the server certificate when connecting. Requires verification of the server certificate when connecting. Makes connections using the specified Address. Makes connections using the VIP name. Sets the VIP name. Stores the current configuration in permanent memory.

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. 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. no ssh username Clears the SSH username associated with the host. protocol ssh Sets the protocol to SSH. protocol telnet Sets the protocol to Telnet. remote address <text> Sets the IP address of the remote host to connect to when this host is selected on the login connect menu. <text> = IP address. remote port <number> Sets the remote port used to connect to the host. <number> = port to be used. show Displays the current configuration. show history Displays the last 20 commands entered during the current 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:1:16) level commands address <text> Sets the remote host to establish tunneling connections with. <text> = IP address or host name of the remote host.

XPort Pro Command Reference

87

5: Commands and Levels

aes decrypt key <hexadecimal>

aes decrypt key text <text>

aes encrypt key <hexadecimal>

aes encrypt key text <text>

auto show statistics clrscrn default protocol default tcp keep alive exit no address no aes decrypt key no aes encrypt key no port no ssh username no tcp keep alive no vip name port <number>

protocol ssh protocol ssl protocol tcp protocol tcp aes protocol telnet

Sets the connect 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 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. 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 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 connect 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. show connection statistics Clears the screen. Restores the default protocol as "TCP". Restores the default 45 second connect mode TCP keep alive timeout. Exits to the next higher level. Removes the remote host address used to establish tunneling connections. Removes the connect tunnel AES decrypt key. Removes the connect tunnel AES encrypt key. Removes the remote port used to establish tunnel connections. Removes the SSH user name. Disables the connect mode TCP keep alive timeout. Removes the VIP name. Sets the remote port to use for connect mode tunneling. <number> = number of the port to use. Uses SSH protocol for connect mode tunneling. Uses SSL protocol for connect mode tunneling. Uses TCP protocol for connect mode tunneling. Uses TCP protocol with AES encryption for connect mode tunneling. Uses Telnet protocol (with IAC) for connect mode

XPort Pro Command Reference

88

5: Commands and Levels

protocol udp protocol udp aes show show history show statistics ssh username <text>

tcp keep alive <milliseconds>

validate certificate disable validate certificate enable vip disable vip enable vip name <text> write host 16 (config-host:16) level commands clrscrn default protocol default remote port

tunneling. Uses UDP protocol for connect mode tunneling. Uses UDP protocol with AES encryption for connect mode tunneling. Shows the current configuration. Displays the last 20 commands entered during the current CLI session. show connection statistics Sets the SSH user name for use when establishing tunneling connections with other devices. <text> = SSH user name. Enables TCP keep alive for connect mode tunneling and sets the timer. <milliseconds> = timer value, in milliseconds. Skips verification of the server certificate when connecting. Requires verification of the server certificate when connecting. Makes connections using the specified Address. Makes connections using the VIP name. Sets the VIP name. Stores the current configuration in permanent memory. 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.

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

XPort Pro Command Reference

89

5: Commands and Levels

ssh username <text> write

Sets the username for logging into the host via SSH. <text> = username. Stores the current configuration in permanent memory.

host 2 (tunnel-connect-host:1:2) level commands address <text> Sets the remote host to establish tunneling connections with. <text> = IP address or host name of the remote host. aes decrypt key <hexadecimal> Sets the connect 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. 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> 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 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. aes encrypt key text <text> Sets the connect 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. 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 tunneling 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 connections. no ssh username Removes the SSH user name. no tcp keep alive Disables the connect mode TCP keep alive timeout. no vip name Removes the VIP name. port <number> Sets the remote port to use for connect mode

XPort Pro Command Reference

90

5: Commands and Levels

protocol ssh protocol ssl protocol tcp protocol tcp aes protocol telnet protocol udp protocol udp aes show show history show statistics ssh username <text>

tcp keep alive <milliseconds>

validate certificate disable validate certificate enable vip disable vip enable vip name <text> write host 2 (config-host:2) level commands clrscrn default protocol default remote port

tunneling. <number> = number of the port to use. Uses SSH protocol for connect mode tunneling. Uses SSL protocol for connect mode tunneling. Uses TCP protocol for connect mode tunneling. Uses TCP protocol with AES encryption for connect mode tunneling. Uses Telnet protocol (with IAC) for connect mode tunneling. Uses UDP protocol for connect mode tunneling. Uses UDP protocol with AES encryption for connect mode tunneling. Shows the current configuration. Displays the last 20 commands entered during the current CLI session. show connection statistics Sets the SSH user name for use when establishing tunneling connections with other devices. <text> = SSH user name. Enables TCP keep alive for connect mode tunneling and sets the timer. <milliseconds> = timer value, in milliseconds. Skips verification of the server certificate when connecting. Requires verification of the server certificate when connecting. Makes connections using the specified Address. Makes connections using the VIP name. Sets the VIP name. Stores the current configuration in permanent memory. 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

exit host <number> name <text> no name no remote address no ssh username protocol ssh protocol telnet remote address <text>

XPort Pro Command Reference

91

5: Commands and Levels

remote port <number> show show history ssh username <text> write

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.

host 3 (tunnel-connect-host:1:3) level commands address <text> Sets the remote host to establish tunneling connections with. <text> = IP address or host name of the remote host. aes decrypt key <hexadecimal> Sets the connect 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. 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> 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 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. aes encrypt key text <text> Sets the connect 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. 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 tunneling connections.

XPort Pro Command Reference

92

5: Commands and Levels

no aes decrypt key no aes encrypt key no port no ssh username no tcp keep alive no vip name port <number>

protocol ssh protocol ssl protocol tcp protocol tcp aes protocol telnet protocol udp protocol udp aes show show history show statistics ssh username <text>

tcp keep alive <milliseconds>

validate certificate disable validate certificate enable vip disable vip enable vip name <text> write host 3 (config-host:3) level commands clrscrn default protocol default remote port

Removes the connect tunnel AES decrypt key. Removes the connect tunnel AES encrypt key. Removes the remote port used to establish tunnel connections. Removes the SSH user name. Disables the connect mode TCP keep alive timeout. Removes the VIP name. Sets the remote port to use for connect mode tunneling. <number> = number of the port to use. Uses SSH protocol for connect mode tunneling. Uses SSL protocol for connect mode tunneling. Uses TCP protocol for connect mode tunneling. Uses TCP protocol with AES encryption for connect mode tunneling. Uses Telnet protocol (with IAC) for connect mode tunneling. Uses UDP protocol for connect mode tunneling. Uses UDP protocol with AES encryption for connect mode tunneling. Shows the current configuration. Displays the last 20 commands entered during the current CLI session. show connection statistics Sets the SSH user name for use when establishing tunneling connections with other devices. <text> = SSH user name. Enables TCP keep alive for connect mode tunneling and sets the timer. <milliseconds> = timer value, in milliseconds. Skips verification of the server certificate when connecting. Requires verification of the server certificate when connecting. Makes connections using the specified Address. Makes connections using the VIP name. Sets the VIP name. Stores the current configuration in permanent memory. 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

exit host <number>

XPort Pro Command Reference

93

5: Commands and Levels

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

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.

host 4 (tunnel-connect-host:1:4) level commands address <text> Sets the remote host to establish tunneling connections with. <text> = IP address or host name of the remote host. aes decrypt key <hexadecimal> Sets the connect 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. 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> 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 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. aes encrypt key text <text> Sets the connect 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.

XPort Pro Command Reference

94

5: Commands and Levels

auto show statistics clrscrn default protocol default tcp keep alive exit no address no aes decrypt key no aes encrypt key no port no ssh username no tcp keep alive no vip name port <number>

protocol ssh protocol ssl protocol tcp protocol tcp aes protocol telnet protocol udp protocol udp aes show show history show statistics ssh username <text>

tcp keep alive <milliseconds>

validate certificate disable validate certificate enable vip disable vip enable vip name <text> write

show connection statistics Clears the screen. Restores the default protocol as "TCP". Restores the default 45 second connect mode TCP keep alive timeout. Exits to the next higher level. Removes the remote host address used to establish tunneling connections. Removes the connect tunnel AES decrypt key. Removes the connect tunnel AES encrypt key. Removes the remote port used to establish tunnel connections. Removes the SSH user name. Disables the connect mode TCP keep alive timeout. Removes the VIP name. Sets the remote port to use for connect mode tunneling. <number> = number of the port to use. Uses SSH protocol for connect mode tunneling. Uses SSL protocol for connect mode tunneling. Uses TCP protocol for connect mode tunneling. Uses TCP protocol with AES encryption for connect mode tunneling. Uses Telnet protocol (with IAC) for connect mode tunneling. Uses UDP protocol for connect mode tunneling. Uses UDP protocol with AES encryption for connect mode tunneling. Shows the current configuration. Displays the last 20 commands entered during the current CLI session. show connection statistics Sets the SSH user name for use when establishing tunneling connections with other devices. <text> = SSH user name. Enables TCP keep alive for connect mode tunneling and sets the timer. <milliseconds> = timer value, in milliseconds. Skips verification of the server certificate when connecting. Requires verification of the server certificate when connecting. Makes connections using the specified Address. Makes connections using the VIP name. Sets the VIP name. Stores the current configuration in permanent memory.

XPort Pro Command Reference

95

5: Commands and Levels

host 4 (config-host:4) 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.

host 5 (tunnel-connect-host:1:5) level commands address <text> Sets the remote host to establish tunneling connections with. <text> = IP address or host name of the remote host. aes decrypt key <hexadecimal> Sets the connect 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. 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> 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

XPort Pro Command Reference

96

5: Commands and Levels

aes encrypt key text <text>

auto show statistics clrscrn default protocol default tcp keep alive exit no address no aes decrypt key no aes encrypt key no port no ssh username no tcp keep alive no vip name port <number>

protocol ssh protocol ssl protocol tcp protocol tcp aes protocol telnet protocol udp protocol udp aes show show history show statistics ssh username <text>

tcp keep alive <milliseconds>

validate certificate disable

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 connect 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. show connection statistics Clears the screen. Restores the default protocol as "TCP". Restores the default 45 second connect mode TCP keep alive timeout. Exits to the next higher level. Removes the remote host address used to establish tunneling connections. Removes the connect tunnel AES decrypt key. Removes the connect tunnel AES encrypt key. Removes the remote port used to establish tunnel connections. Removes the SSH user name. Disables the connect mode TCP keep alive timeout. Removes the VIP name. Sets the remote port to use for connect mode tunneling. <number> = number of the port to use. Uses SSH protocol for connect mode tunneling. Uses SSL protocol for connect mode tunneling. Uses TCP protocol for connect mode tunneling. Uses TCP protocol with AES encryption for connect mode tunneling. Uses Telnet protocol (with IAC) for connect mode tunneling. Uses UDP protocol for connect mode tunneling. Uses UDP protocol with AES encryption for connect mode tunneling. Shows the current configuration. Displays the last 20 commands entered during the current CLI session. show connection statistics Sets the SSH user name for use when establishing tunneling connections with other devices. <text> = SSH user name. Enables TCP keep alive for connect mode tunneling and sets the timer. <milliseconds> = timer value, in milliseconds. Skips verification of the server certificate when

XPort Pro Command Reference

97

5: Commands and Levels

validate certificate enable vip disable vip enable vip name <text> write host 5 (config-host:5) level commands clrscrn default protocol default remote port

connecting. Requires verification of the server certificate when connecting. Makes connections using the specified Address. Makes connections using the VIP name. Sets the VIP name. Stores the current configuration in permanent memory. 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.

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

host 6 (tunnel-connect-host:1:6) level commands address <text> Sets the remote host to establish tunneling connections with. <text> = IP address or host name of the remote host. aes decrypt key <hexadecimal> Sets the connect 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.

XPort Pro Command Reference

98

5: Commands and Levels

aes decrypt key text <text>

aes encrypt key <hexadecimal>

aes encrypt key text <text>

auto show statistics clrscrn default protocol default tcp keep alive exit no address no aes decrypt key no aes encrypt key no port no ssh username no tcp keep alive no vip name port <number>

protocol ssh protocol ssl protocol tcp protocol tcp aes protocol telnet protocol udp protocol udp aes show show history

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. 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 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 connect 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. show connection statistics Clears the screen. Restores the default protocol as "TCP". Restores the default 45 second connect mode TCP keep alive timeout. Exits to the next higher level. Removes the remote host address used to establish tunneling connections. Removes the connect tunnel AES decrypt key. Removes the connect tunnel AES encrypt key. Removes the remote port used to establish tunnel connections. Removes the SSH user name. Disables the connect mode TCP keep alive timeout. Removes the VIP name. Sets the remote port to use for connect mode tunneling. <number> = number of the port to use. Uses SSH protocol for connect mode tunneling. Uses SSL protocol for connect mode tunneling. Uses TCP protocol for connect mode tunneling. Uses TCP protocol with AES encryption for connect mode tunneling. Uses Telnet protocol (with IAC) for connect mode tunneling. Uses UDP protocol for connect mode tunneling. Uses UDP protocol with AES encryption for connect mode tunneling. Shows the current configuration. Displays the last 20 commands entered during the current CLI session.

XPort Pro Command Reference

99

5: Commands and Levels

show statistics ssh username <text>

tcp keep alive <milliseconds>

validate certificate disable validate certificate enable vip disable vip enable vip name <text> write host 6 (config-host:6) level commands clrscrn default protocol default remote port

show connection statistics Sets the SSH user name for use when establishing tunneling connections with other devices. <text> = SSH user name. Enables TCP keep alive for connect mode tunneling and sets the timer. <milliseconds> = timer value, in milliseconds. Skips verification of the server certificate when connecting. Requires verification of the server certificate when connecting. Makes connections using the specified Address. Makes connections using the VIP name. Sets the VIP name. Stores the current configuration in permanent memory. 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.

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

host 7 (tunnel-connect-host:1:7) level commands address <text> Sets the remote host to establish tunneling connections with.

XPort Pro Command Reference

100

5: Commands and Levels

aes decrypt key <hexadecimal>

aes decrypt key text <text>

aes encrypt key <hexadecimal>

aes encrypt key text <text>

auto show statistics clrscrn default protocol default tcp keep alive exit no address no aes decrypt key no aes encrypt key no port no ssh username no tcp keep alive no vip name port <number>

protocol ssh protocol ssl protocol tcp protocol tcp aes

<text> = IP address or host name of the remote host. Sets the connect 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 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. 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 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 connect 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. show connection statistics Clears the screen. Restores the default protocol as "TCP". Restores the default 45 second connect mode TCP keep alive timeout. Exits to the next higher level. Removes the remote host address used to establish tunneling connections. Removes the connect tunnel AES decrypt key. Removes the connect tunnel AES encrypt key. Removes the remote port used to establish tunnel connections. Removes the SSH user name. Disables the connect mode TCP keep alive timeout. Removes the VIP name. Sets the remote port to use for connect mode tunneling. <number> = number of the port to use. Uses SSH protocol for connect mode tunneling. Uses SSL protocol for connect mode tunneling. Uses TCP protocol for connect mode tunneling. Uses TCP protocol with AES encryption for connect

XPort Pro Command Reference

101

5: Commands and Levels

protocol telnet protocol udp protocol udp aes show show history show statistics ssh username <text>

tcp keep alive <milliseconds>

validate certificate disable validate certificate enable vip disable vip enable vip name <text> write host 7 (config-host:7) level commands clrscrn default protocol default remote port

mode tunneling. Uses Telnet protocol (with IAC) for connect mode tunneling. Uses UDP protocol for connect mode tunneling. Uses UDP protocol with AES encryption for connect mode tunneling. Shows the current configuration. Displays the last 20 commands entered during the current CLI session. show connection statistics Sets the SSH user name for use when establishing tunneling connections with other devices. <text> = SSH user name. Enables TCP keep alive for connect mode tunneling and sets the timer. <milliseconds> = timer value, in milliseconds. Skips verification of the server certificate when connecting. Requires verification of the server certificate when connecting. Makes connections using the specified Address. Makes connections using the VIP name. Sets the VIP name. Stores the current configuration in permanent memory. 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.

exit host <number> name <text> no name no remote address no ssh username protocol ssh protocol telnet remote address <text>

remote port <number> show

XPort Pro Command Reference

102

5: Commands and Levels

show history ssh username <text> write

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.

host 8 (tunnel-connect-host:1:8) level commands address <text> Sets the remote host to establish tunneling connections with. <text> = IP address or host name of the remote host. aes decrypt key <hexadecimal> Sets the connect 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. 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> 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 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. aes encrypt key text <text> Sets the connect 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. 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 tunneling 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 connections. no ssh username Removes the SSH user name. no tcp keep alive Disables the connect mode TCP keep alive timeout.

XPort Pro Command Reference

103

5: Commands and Levels

no vip name port <number>

protocol ssh protocol ssl protocol tcp protocol tcp aes protocol telnet protocol udp protocol udp aes show show history show statistics ssh username <text>

tcp keep alive <milliseconds>

validate certificate disable validate certificate enable vip disable vip enable vip name <text> write host 8 (config-host:8) level commands clrscrn default protocol default remote port

Removes the VIP name. Sets the remote port to use for connect mode tunneling. <number> = number of the port to use. Uses SSH protocol for connect mode tunneling. Uses SSL protocol for connect mode tunneling. Uses TCP protocol for connect mode tunneling. Uses TCP protocol with AES encryption for connect mode tunneling. Uses Telnet protocol (with IAC) for connect mode tunneling. Uses UDP protocol for connect mode tunneling. Uses UDP protocol with AES encryption for connect mode tunneling. Shows the current configuration. Displays the last 20 commands entered during the current CLI session. show connection statistics Sets the SSH user name for use when establishing tunneling connections with other devices. <text> = SSH user name. Enables TCP keep alive for connect mode tunneling and sets the timer. <milliseconds> = timer value, in milliseconds. Skips verification of the server certificate when connecting. Requires verification of the server certificate when connecting. Makes connections using the specified Address. Makes connections using the VIP name. Sets the VIP name. Stores the current configuration in permanent memory. 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.

exit host <number> name <text> no name no remote address no ssh username protocol ssh

XPort Pro Command Reference

104

5: Commands and Levels

protocol telnet remote address <text>

remote port <number> show show history ssh username <text> write

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.

host 9 (tunnel-connect-host:1:9) level commands address <text> Sets the remote host to establish tunneling connections with. <text> = IP address or host name of the remote host. aes decrypt key <hexadecimal> Sets the connect 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. 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> 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 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. aes encrypt key text <text> Sets the connect 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. 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.

XPort Pro Command Reference

105

5: Commands and Levels

no address no aes decrypt key no aes encrypt key no port no ssh username no tcp keep alive no vip name port <number>

protocol ssh protocol ssl protocol tcp protocol tcp aes protocol telnet protocol udp protocol udp aes show show history show statistics ssh username <text>

tcp keep alive <milliseconds>

validate certificate disable validate certificate enable vip disable vip enable vip name <text> write host 9 (config-host:9) level commands clrscrn default protocol default remote port

Removes the remote host address used to establish tunneling connections. Removes the connect tunnel AES decrypt key. Removes the connect tunnel AES encrypt key. Removes the remote port used to establish tunnel connections. Removes the SSH user name. Disables the connect mode TCP keep alive timeout. Removes the VIP name. Sets the remote port to use for connect mode tunneling. <number> = number of the port to use. Uses SSH protocol for connect mode tunneling. Uses SSL protocol for connect mode tunneling. Uses TCP protocol for connect mode tunneling. Uses TCP protocol with AES encryption for connect mode tunneling. Uses Telnet protocol (with IAC) for connect mode tunneling. Uses UDP protocol for connect mode tunneling. Uses UDP protocol with AES encryption for connect mode tunneling. Shows the current configuration. Displays the last 20 commands entered during the current CLI session. show connection statistics Sets the SSH user name for use when establishing tunneling connections with other devices. <text> = SSH user name. Enables TCP keep alive for connect mode tunneling and sets the timer. <milliseconds> = timer value, in milliseconds. Skips verification of the server certificate when connecting. Requires verification of the server certificate when connecting. Makes connections using the specified Address. Makes connections using the VIP name. Sets the VIP name. Stores the current configuration in permanent memory. 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.

XPort Pro Command Reference

106

5: Commands and Levels

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 http (config-http) level commands auth <uri> <realm>

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. 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

auth type <uri> basic

auth type <uri> digest

auth type <uri> none

auth type <uri> ssl

auth type <uri> ssl-basic

auth type <uri> ssl-digest

auth user <uri> <user> <password>

XPort Pro Command Reference

107

5: Commands and Levels

authentication timeout <minutes>

clear counters clear log clrscrn default authentication timeout default log format default max bytes default max log entries default max timeout default port default secure port default secure protocols delete auth <uri>

delete auth user <uri> <user>

exit log format <text>

logging state disable

authentication directive. <uri> = URI of the server. <user> = username. <password> = password associated with the username. For any Digest AuthType, sets the timeout for authentication. <minutes> = authentication timeout value. Sets the HTTP counters to zero. Clears the HTTP server log. Clears the screen. Resets the authentication timeout to its default value. Restores the HTTP Server log format string to its default value. Resets the maximum bytes to its default value. Restores the default maximum number of HTTP Server log entries. Resets the timeout to its default value. Resets the HTTP Server port to its default value. Resets the HTTP Server SSL port to its default value. Restores the default secure protocol selections. 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. 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 Disables HTTP server logging.

XPort Pro Command Reference

108

5: Commands and Levels

logging state enable max bytes <number>

max log entries <number>

max timeout <seconds>

no clear counters no port no secure port port <number> secure port <number>

secure protocols ssl3 disable secure protocols ssl3 enable secure protocols tls1.0 disable secure protocols tls1.0 enable secure protocols tls1.1 disable secure protocols tls1.1 enable show show auth show history show log show statistics state disable state enable write icmp (config-icmp) level commands auto show statistics clear counters clrscrn exit no clear counters show show history show statistics state disable

Enables HTTP server logging. Sets the maximum number of bytes the HTTP server accepts when receiving a request. Sets the maximum number of HTTP server log entries. <number> = maximum number of HTTP server log entries. Sets the maximum time the HTTP server waits when receiving a request. <seconds> = maximum timeout value. Restores the HTTP counters to the aggregate values. Disables the HTTP Server port. Disables the HTTP Server SSL port. Sets the port number the HTTP server will use. <number> = port number. Sets the port number the HTTP server will use over SSL. <number> = port number. Disables the protocol. Enables the protocol. Disables the protocol. Enables the protocol. Disables the protocol. Enables the protocol. Displays the current configuration. 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. Disables the HTTP server. Enables the HTTP server. Stores the current configuration in permanent memory. Continuously shows ICMP statistics Zeros counters Clears the screen. Exits to the configuration level. Unzeros IP counters 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.

XPort Pro Command Reference

109

5: Commands and Levels

state enable write if 1 (config-if:eth0) level commands bootp disable bootp enable clrscrn default gateway <ip address> default mtu dhcp client id binary <binary>

Allows ICMP packets to be sent and received. Stores the current configuration in permanent memory. Disables BOOTP. Enables BOOTP. Clears the screen. Sets the configurable gateway IP address to the default value. Restores the default Maximum Transmission Unit (MTU) size. 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. <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: 192.168.1.1 (default mask) 192.168.1.1/24 (CIDR) "192.168.1.1 255.255.255.0" (explicit mask) Enter link configuration level Sets the Maximum Transmission Unit (MTU) size. 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. Continuously shows IP statistics

dhcp client id set <text> dhcp disable dhcp enable dhcp renew domain <text> exit hostname <text> ip address <ip address/cidr>

link mtu <bytes> 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 ip (config-ip) level commands auto show statistics

XPort Pro Command Reference

110

5: Commands and Levels

clear counters clrscrn default ip time to live default multicast time to live exit ip time to live <hops>

multicast time to live <hops>

no clear counters show show history show statistics write ip filter (config-filter) level commands add <ip address> <subnet mask> clrscrn exit no filtering remove <ip address> <subnet mask> show show history write line 1 (line:1) level commands auto show statistics baud rate <bits per second>

Zeros counters Clears the screen. Restores the default IP time to live. Restores the default IP multicast time to live, which is one hop. Exits to the configuration level. Sets the IP time to live, known by SNMP as "ipDefaultTTL". <hops> = number of hops that a typical IP packet is allowed to live. 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. Adds an entry to the IP filter table. Clears the screen. Returns to the config level. Removes filtering so ALL addresses are allowed. Removes an entry from the IP filter table. Displays the IP filter table. Displays the last 20 commands entered during the current CLI session. Stores the current configuration in permanent memory. Continuously displays line statistics. Sets the line speed. <bits per second> = the speed. Standard speeds include 1200, 2400, 4800, 9600, 19200, and so on. Sets the serial counters to zero. Clears the screen. Sets the current line to always be in command mode. Sets the current line to enter command mode under control of a CP. Specifies the CP group and trigger value. Disables user-defined serial boot string to be echoed in the CLI. Enables user-defined serial boot string to be echoed in the CLI.

clear line counters clrscrn command mode always command mode cp command mode cp <cp group> <value> command mode echo serial string disable command mode echo serial string enable

XPort Pro Command Reference

111

5: Commands and Levels

command mode serial string command mode serial string <string>

command mode serial string binary <string>

command mode signon message <string>

command mode signon message binary <string>

command mode wait time <milliseconds>

configure current settings data bits 7 data bits 8 default baud rate default data bits default flow control default interface default parity default protocol default stop bits default threshold default xoff char default xon char exit flow control hardware flow control none flow control software gap timer <milliseconds>

interface rs232 interface rs485 full-duplex interface rs485 half-duplex

Enables user to enter a custom string at boot time to enter command mode. Sets a string that can be entered at boot time to enter command mode. <string> = text. Sets a binary string that can be entered at boot time to enter command mode. <string> = string that may contain binary characters. Within [] use binary decimal up to 255 or hex up to 0xFF. Sets an ASCII sign-on message that is sent from the serial port when the device boots and when the line is in command mode. <string> = text. Sets a binary sign-on message that is sent from the serial port when the device boots and when the line is in command mode. <string> = string that may contain binary characters. Within [] use binary decimal up to 255 or hex up to 0xFF. Sets boot-up wait time for command mode serial string. <milliseconds> = wait time. Configures line with the current value of settings. Uses seven bits for data on the line. Uses eight bits for data on the line. Restores the default speed of 9600 bits per second. Restores the default of eight data bits. Restores the default of no flow control. Restores the default interface type to this line. Restores the default of no parity. Restores the default protocol on the line. Restores the default of one stop bit. Restores the factory default threshold. Restores the default xoff character on this line. Restores the default xon character on this line. Exits to the enable level Uses hardware (RTS/CTS) flow control on the line. Does not provide flow control on the line. Uses software (xon/xoff characters) flow control on the line. Sets the gap timer in milliseconds. If some data has been received, it will be forwarded after this time since the last character. Sets the line interface to RS232. Sets the line interface to RS485 in full-duplex mode. Sets the line interface to RS485 in half-duplex

XPort Pro Command Reference

112

5: Commands and Levels

kill session line <line>

lpd <line>

name <text> no clear line counters no command mode no command mode cp no command mode serial string

no command mode signon message

no gap timer no name parity even parity none parity odd ppp <line> protocol lpd protocol lpd or tunnel protocol modbus ascii protocol modbus rtu protocol none protocol ppp protocol tunnel reassert show show command mode show history show line show statistics state disable state enable stop bits 1 stop bits 2 terminal <line>

mode. Kills command mode session on the Line Enters the line level. <line> = number of the line (serial port) to be configured. Enters the configure lpd level. <line> = number of the line (lpd serial port) to be configured. Sets the name for this line. Restores the serial counters to the aggregate values. Disables command mode for the current line. Disables control of a CP to enter command mode. Prevents the user-defined serial boot string from being used to enter command mode in the CLI. Clears the signon message displayed at boot time and when entering command mode. Removes the gap timer, so forwarding depends on the line speed. Removes the name of this line. Uses a parity bit on the line for even parity. Does not use a parity bit on the line. Uses a parity bit on the line for odd parity. Enters the serial line PPP level. Applies Line Printer Daemon (LPD) protocol on the line. Applies LPD or tunnel protocol on the line. Applies Modbus ASCII protocol on the line. Applies Modbus RTU protocol on the line. Uses no protocol on the line. Applies point-to-point protocol (PPP) on the line. Applies tunnel protocol on the line. Asserts line status with current configured values. Displays the current status. Shows the command mode settings for the current line. Displays the last 20 commands entered during the current CLI session. Displays the current configuration. Shows the line statistics. Disables the line so data cannot be sent/received. Enables the line so data can be sent/received. Uses one stop bit after data on the line. Uses two stop bits after data on the line. Enters the configure-terminal level.

XPort Pro Command Reference

113

5: Commands and Levels

terminal network threshold <bytes>

tunnel <line>

write xoff char <control>

xon char <control>

<line> = number of the terminal line (serial port) to be configured. Enters the configure-terminal level for the network. Sets the threshold in bytes. After this many bytes are received, they are forwarded without delay. Enters the tunnel level. <line> = number of the tunnel line (serial port) to be configured. Stores the current configuration in permanent memory. 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. A hex value character has the form 0xFF. Sets the xon 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. A hex value character has the form 0xFF. Clears the screen. Restores the default duplex setting, which is auto. Restores the default speed setting, which is autonegotiate. Sets duplex mode to auto. Sets duplex mode to full. Sets duplex mode to half. Exit back to interface configuration level Displays the current configuration. Displays the last 20 commands entered during the current CLI session. Sets the speed of the Ethernet link to 10 Mbps. Sets the speed of the Ethernet link to 100 Mbps. Sets the speed of the Ethernet link to autonegotiate. Stores the current configuration in permanent memory. Clears the screen. Restores the factory default maximum Log file size. Disables log output. Log all events. Exits to the next higher level.

link (config-ethernet:eth0) level commands clrscrn default duplex default speed duplex auto duplex full duplex half exit show show history speed 10 speed 100 speed auto write log (config-diagnostics-log) level commands clrscrn default max length default output default severity level exit

XPort Pro Command Reference

114

5: Commands and Levels

max length <Kbytes> output disable output filesystem output line <number> severity level debug severity level error severity level information severity level notice severity level warning show show history write lpd (lpd) level commands auto show <line>

Sets the maximum size in Kbytes for the Log file. Enables log to filesystem. Enables log to serial line. Could not find VarID 438 entry 3 in file http/config/varid_help.mtxt Log all events. Log only Error and more severe events. Log only Information and more severe events. Log only Notice and more severe events. Log only Warning and more severe events. Shows the current configuration. Displays the last 20 commands entered during the current CLI session. Stores the current configuration in permanent memory. Continuously displays lpd status for the specified line. <line> = LPD line to display. Clears the screen. Exits to the enable level. Kills the current print job on the specified line. <line> = LPD line with print job. Displays lpd status for the specified line. <line> = LPD line to display. Displays the last 20 commands entered during the current CLI session. Stores the current configuration in permanent memory. Disables printing banner for all print jobs. Only print the banner when a job requests it. Enables printing banner for all print jobs. Treats print job as ascii text. Filters out all non-ascii characters and certain control characters. Treats print job as binary. Sends data byte-for-byte to the printer. Redirects serial output back to the line. Redirects serial output from the line to this CLI session. Clears the screen. Disables converting single new line and carriage return characters to DOS-style line endings. Enables converting single new line and carriage return characters to

clrscrn exit kill <line> show <line> show history write lpd 1 (config-lpd:1) level commands banner disable

banner enable binary disable

binary enable capture disable capture enable clrscrn convert newline disable

convert newline enable

XPort Pro Command Reference

115

5: Commands and Levels

eoj disable eoj enable eoj text binary <binary>

eoj text set <text>

exit formfeed disable

formfeed enable kill line <line>

lpd <line>

no eoj text no queue name no soj text ppp <line> queue name <text>

show show history show statistics soj disable soj enable soj text binary <binary>

DOS-style line endings. If characters are already in DOS line-ending order, they are not converted. Disables sending the end-of-job string after each print job. Enables sending the end-of-job string after each print job. 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. Sets the end-of-job text. <text> = ascii string that will be sent to the printer at the end of each print job. Exits to the configuration level. Disables the printer from advancing to the next page at the end of each print job. Forces the printer to advance to the next page at the end of each print job. Ends the current print job on this lpd line. Enters the line level. <line> = number of the line (serial port) to be configured. Enters the configure lpd level. <line> = number of the line (lpd serial port) to be configured. Removes the end-of-job string. Removes the queue name. Removes the start-of-job string. Enters the serial line PPP level. Sets the name of the queue that this lpd line belongs to. <text> = name for the queue. Displays the current configuration. Displays the last 20 commands entered during the current CLI session. Displays statistics and status information for this lpd line. Disables sending the start-of-job string after each print job. Enables sending the start-of-job string after each print job. Sets the start-of-job text allowing for binary characters. <binary> = string in binary format that will be sent to

XPort Pro Command Reference

116

5: Commands and Levels

soj text set <text>

terminal <line>

terminal network test print <number of lines> tunnel <line>

write modbus (modbus) level commands additional port <number> clrscrn default response timeout exit kill connection <index> no additional port response timeout <milliseconds> rss show show connections show history show statistics tcp server state disable tcp server state enable write modem (tunnel-modem:1) level commands clrscrn connect string <text>

the printer at the beginning of each print job. Within [] use binary decimal up to 255 or hex up to 0xFF. Sets the start-of-job text. <text> = ascii string that will be sent to the printer at the beginning of each print job. Enters the configure-terminal level. <line> = number of the terminal line (serial port) to be configured. Enters the configure-terminal level for the network. Prints lines of text directly to the lpd line. <number of lines> = number of lines to print. Enters the tunnel level. <line> = number of the tunnel line (serial port) to be configured. Stores the current configuration in permanent memory. Sets an additional TCP server port. Clears the screen. Restores the default Modbus Response Timeout. Exits to the config level. Kills modbus connection selected by index from show connections. Removes the additional TCP server port. Sets the Modbus Response Timeout in milliseconds. Enters the next lower level. Displays the current configuration. Displays connections. Displays the last 20 commands entered during the current CLI session. Displays statistics. Disables the Modbus TCP Server. Enables the Modbus TCP Server. Stores the current configuration in permanent memory. Clears the screen. Sets the CONNECT string used in modem emulation. <string> = connect string. Default disables incoming network connections. Default uses text type responses. The incoming RING has nothing following it. The incoming RING is followed by the IP address of the caller.

default incoming connection default response type display remote ip disable display remote ip enable

XPort Pro Command Reference

117

5: Commands and Levels

echo commands disable echo commands enable echo pluses disable echo pluses enable error unknown commands disable error unknown commands enable exit incoming connection automatic incoming connection disabled incoming connection manual no connect string reassert response type numeric response type text show show history show status verbose response disable verbose response enable write packing (tunnel-packing:1) level commands clrscrn default packing mode default send character default threshold default timeout exit no trailing character packing mode disable packing mode send character

Does not echo modem commands. Echoes modem commands. Does not echo the +++ characters when entering modem command mode. Echoes the +++ characters when entering modem command mode. Returns OK on unknown AT commands. Returns an error upon unknown AT commands. Returns to the tunnel level. Automatically answer incoming network connections. Disable incoming network connections. Wait for an ATA command before answering an incoming network connection. Removes optional CONNECT string information for modem emulation. Asserts tunnel modem status with current configured values. Uses numeric type responses. Uses text type responses. Displays the current configuration. Displays the last 20 commands entered during the current CLI session. Displays tunnel modem status. Does not send Modem Response Codes. Sends Modem Response Codes out on the Serial Line. Stores the current configuration in permanent memory. Clears the screen. Sets to default packing mode, which is "Disable" Removes the send character for packing mode. Restores the default threshold. Restores the default packing mode timeout. Returns to the tunnel level. Removes the trailing character for packing mode. Disables packing. Data is sent to the network when received. Sets packing mode to accumulate data and transmit it upon receiving the configured send character on the line (serial port). Sets packing mode to accumulate data and transmit it after a specified amount of time (timeout). Sets the send character for packing mode. The character may be input as text, control, decimal, or hex.

packing mode timeout

send character <control>

XPort Pro Command Reference

118

5: Commands and Levels

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. show history Displays the last 20 commands entered during the current CLI session. threshold <bytes> Sets the threshold (byte count). If the queued data reaches this threshold then the data will be sent. <bytes> = number of bytes in the threshold. timeout <milliseconds> Sets the timeout value for packing mode in milliseconds. <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. write Stores the current configuration in permanent memory. password (tunnel-accept-password:1) level commands clrscrn Clears the screen. exit Exits to the next higher level. no password Removes the password so connections will be accepted unchallenged. password <text> Sets the password required on the network side of the tunnel to begin a connection. prompt disable 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 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. ppp 1 (ppp:1) level commands authentication mode chap Sets authentication to Challenge-Handshake Authentication Protocol (CHAP). authentication mode ms-chap Sets authentication to MS-CHAP version 1. authentication mode ms-chapv2 Sets authentication to MS-CHAP version 2. authentication mode none Removes PPP authentication. authentication mode pap Sets authentication to Password Authentication Protocol (PAP). clrscrn Clears the screen. default authentication mode Removes PPP authentication.

XPort Pro Command Reference

119

5: Commands and Levels

exit line <line>

local ip <ip address/cidr>

lpd <line>

no local ip no password no peer ip no username password <text> peer ip <ip address>

ppp <line> show show history terminal <line>

terminal network tunnel <line>

username <text> write query port (config-query_port) level commands clear counters clrscrn exit no clear counters show show history state disable state enable write root level commands

Exits to the configuration level. Enters the line level. <line> = number of the line (serial port) to be configured. 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" (explicit mask) Enters the configure lpd level. <line> = number of the line (lpd serial port) to be configured. Removes the Local IP address. Removes the PPP authentication password. Removes the peer IP address. Removes the PPP authentication username. Sets the password for PPP authentication. Sets the IP Address assigned to the peer when requested during negotiation. <ip address> IP address of the peer device. Enters the serial line PPP level. Displays the current configuration. Displays the last 20 commands entered during the current CLI session. 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 tunnel level. <line> = number of the tunnel line (serial port) to be configured. Sets the user name for PPP authentication. Stores the current configuration in permanent memory. Zeros Query Port counters Clears the screen. Returns to the config level. Unzeros Query Port counters Displays statistics and information about the query port. Displays the last 20 commands entered during the current CLI session. Disables response to 77FE requests. Permits response to 77FE requests. Stores the current configuration in permanent memory.

XPort Pro Command Reference

120

5: Commands and Levels

clrscrn enable exit ping <host> ping <host> <count> ping <host> <count> <timeout> show show history show xport_pro trace route <host> rss (config-rss) level commands clear rss clrscrn default max entries exit feed disable feed enable max entries <number> persist disable persist enable show show history show status write rss (modbus-rss) level commands clrscrn exit show show history trace input disable trace input enable write serial (tunnel-serial:1) level commands clrscrn default dtr dtr asserted while connected dtr continuously asserted

Clears the screen. Enters the enable level. Exit from the system Ping destination continuously with 5 second timeout Ping destination n times with 5 second timeout Ping destination n times with x timeout (in seconds) Show system information Displays the last 20 commands entered during the current CLI session. Show system information Trace route to destination Clear the RSS Feed data Clears the screen. Restores the default number of RSS feed entries. Exits to the configuration level. Disables RSS feed. Enables RSS feed. Sets the maximum number of RSS feed entries. Disables RSS feed data persistence. Enables RSS feed data persistence. Displays the current configuration. Displays the last 20 commands entered during the current CLI session. Display the RSS Feed status Stores the current configuration in permanent memory. Clears the screen. Exits to the next higher level. Shows the current configuration. Displays the last 20 commands entered during the current CLI session. Disables RSS trace of Modbus PDUs received on the serial line. Enables RSS trace of Modbus PDUs received on the serial line. Stores the current configuration in permanent memory. Clears the screen. Restores default DTR control, asserted while connected. Asserts DTR whenever a connect or accept mode tunnel connection is active. Asserts DTR regardless of any connections.

XPort Pro Command Reference

121

5: Commands and Levels

dtr truport dtr unasserted exit show show history write server (ssh-server) level commands authorized user <username> <password> clrscrn delete all authorized users delete authorized user <username> exit host generate dsa 1024 host generate dsa 512 host generate dsa 768 host generate rsa 1024 host generate rsa 512 host generate rsa 768 host keys no host dsa no host rsa show show authorized user <username> show history show host dsa show host rsa write smtp (config-smtp) level commands clrscrn default relay port exit no relay address relay address <text>

Asserts DTR to match remote DSR when connected via Telnet. Does not assert DTR. Returns to the tunnel level. Displays the current configuration. Displays the last 20 commands entered during the current CLI session. Stores the current configuration in permanent memory. Sets authorized username, password, and optionally RSA and/or DSA public keys Clears the screen. Removes all authorized users Remove an authorized user Exits to the ssh level. Generate DSA public and private keys Generate DSA public and private keys Generate DSA public and private keys Generate RSA public and private keys Generate RSA public and private keys Generate RSA public and private keys Sets RSA or DSA public and/or private keys Removes DSA public and private keys Removes RSA public and private keys Show SSH Server settings Show information for an authorized user Displays the last 20 commands entered during the current CLI session. Show full DSA public key Show full RSA public key Stores the current configuration in permanent memory. Clears the screen. Restores the SMTP relay port to its default. Exits to the configuration level. Removes the SMTP relay address. Sets an SMTP relay address to direct all outbound email messages through a mail server. Sets the SMTP relay port. Displays the current configuration. Displays the last 20 commands entered during the current CLI session. Stores the current configuration in permanent

relay port <number> show show history write

XPort Pro Command Reference

122

5: Commands and Levels

memory. snmp (config-snmp) level commands clrscrn default read community default system description default system name default write community exit no system contact no system location read community <text> Clears the screen. Clears the SNMP read-only community. Restores the SNMP system description to its default. Restores the SNMP system name to default: the product name. Clears the SNMP read/write community. Returns to the config level. Clears the SNMP system contact. Clears the SNMP system location. Sets the SNMP read-only community string. <text> = name of the read-only community string to be set. Displays the current configuration. Displays the last 20 commands entered during the current CLI session. Displays the SNMP agent status. Disables the SNMP server. Enables the SNMP server. Sets the SNMP system contact information. <text> = system contact information. Sets the SNMP system description. <text> = description of device. Sets the SNMP system location. <text> = location of device. Sets the SNMP system name. <text> = SNMP system name. Enters the next lower level. Stores the current configuration in permanent memory. Sets the SNMP read-write community string. <text> = name of the read-write community string to be set. Enters the SSH Client configuration level. Clears the screen. Exits to the enable level. Enters the SSH Server configuration level. Displays the last 20 commands entered during the current CLI session. Stores the current configuration in permanent memory. Sets the SSH counters to zero. Clears the screen.

show show history show status state disable state enable system contact <text> system description <text> system location <text> system name <text> traps write write community <text>

ssh (ssh) level commands client clrscrn exit server show history write ssh (config-cli-ssh) level commands clear counters clrscrn

XPort Pro Command Reference

123

5: Commands and Levels

default max sessions default port exit max sessions <number> no clear counters port <number> show show history show statistics state disable state enable write ssl (ssl) level commands authority clrscrn dsa exit generate dsa generate rsa no dsa no intermediate authority <cert>

Could not find VarID 316 in file http/config/varid_help.mtxt Restores the default local port to the SSH server. Exits to the CLI level. Could not find VarID 316 in file http/config/varid_help.mtxt Restores the SSH counters to the aggregate values. Sets the local port that the SSH server uses. <number> = local port number. Displays the current configuration. Displays the last 20 commands entered during the current CLI session. Displays the SSH server statistics. Disables the SSH Server. Enables the SSH Server. Stores the current configuration in permanent memory. Adds an Authority Certificate. Clears the screen. Adds DSA Certificate and Private Key. Exits to the enable level. Generates a new Self-Signed DSA Certificate. Generates a new Self-Signed RSA Certificate. Removes DSA Certificate and Private Key Removes an Intermediate Authority Certificate. <cert> = index displayed by "show authority" command. Removes RSA Certificate and Private Key Removes a Trusted Authority Certificate. <cert> = index displayed by "show authority" command. Adds RSA Certificate and Private Key. Displays Certificate Information. Displays Authority Certificate Information. Displays the last 20 commands entered during the current CLI session. Stores the current configuration in permanent memory. Clears the screen. Restores the default syslog local port. Restores the default syslog remote port. No logging. Returns to the config level. Sets the address of the syslog recipient. <text> = IP address or name of the host.

no rsa no trusted authority <cert>

rsa show show authority show history write syslog (config-syslog) level commands clrscrn default local port default remote port default severity log level exit host <text>

XPort Pro Command Reference

124

5: Commands and Levels

local port <number>

no host remote port <number>

severity log level alert severity log level critical severity log level debug severity log level emergency severity log level error severity log level information severity log level none severity log level notice severity log level warning show show history show statistics state disable state enable write tcp (config-tcp) level commands ack limit <packets>

Sets the syslog local port. <number> = number of the local port used when making a syslog connection. Removes the address of the syslog recipient. Sets the syslog remote port. <number> = number of the remote port used when making a syslog connection. Log only Alert and more severe events. Log only Critical and more severe events. Log all events. Log only Emergency events. Log only Error and more severe events. Log only Information and more severe events. No logging. Log only Notice and more severe events. Log only Warning and more severe events. Displays the current configuration. Displays the last 20 commands entered during the current CLI session. Displays the syslog statistics. Disables syslog logging. Enables syslog logging. Stores the current configuration in permanent memory. Sets the number of packets that must be received before an ACK is forced. If there is a large amount of data to acknowledge, an ACK will be forced before this. Continuously shows TCP statistics Zeros TCP counters Clears the screen. Restores the default ack limit of 3 packets. Restores the default Maximum Retransmissions. Restores the default Maximum Retransmissions for SYN/ACK. Restores the default Maximum Timeout between retransmissions. Sets TCP to send data in accordance with standards. Exits to the configuration level. Sets the Maximum Retransmisssions. Sets the Maximum Retransmisssions for SYN/ACK. It is lower than "Max Retrans" to thwart denial-ofservice attacks. Sets the Maximum Timeout between retransmisssions in seconds.

auto show statistics clear counters clrscrn default ack limit default max retrans default max retrans syn ack default max timeout default send data exit max retrans <number> max retrans syn ack <number>

max timeout <seconds>

XPort Pro Command Reference

125

5: Commands and Levels

no clear counters resets disable resets enable send data expedited

send data standard show show history show statistics write telnet (config-cli-telnet) level commands clear counters clrscrn default max sessions default port exit max sessions <number> no clear counters port <number> show show history show statistics state disable state enable write terminal 1 (config-terminal:1) level commands break duration <milliseconds>

Unzeros TCP counters Does not send TCP RSTs upon connection to unused ports. Sends TCP RSTs upon connection to unused ports. Sets TCP to send data whenever the window is sufficiently open, for improved real-time performance. Sets TCP to send data in accordance with standards. Displays the current configuration. Displays the last 20 commands entered during the current CLI session. Shows TCP statistics Stores the current configuration in permanent memory. Sets the Telnet counters to zero. Clears the screen. Could not find VarID 315 in file http/config/varid_help.mtxt Restores the default local port to the Telnet server. Exits to the CLI level. Could not find VarID 315 in file http/config/varid_help.mtxt Restores the Telnet counters to the aggregate values. Sets the local port that the Telnet server uses. <number> = local port number. Displays the current configuration. Displays the last 20 commands entered during the current CLI session. Displays the Telnet statistics. Disables the Telnet Server. Enables the Telnet Server. Stores the current configuration in permanent memory. Sets how long a break should last when it is being sent to the line. <milliseconds> = number of milliseconds. Clears the screen. Restores the break duration to the default value (500 ms). Sets the default terminal type, "UNKNOWN". Disables echoing of characters received on the line back to the line. Enables echoing of characters received on the line back to the line.

clrscrn default break duration default terminal type echo disable echo enable

XPort Pro Command Reference

126

5: Commands and Levels

exit exit connect menu disable

Exits to the configuration level. On the login connect menu, removes the menu item allowing the user to exit to the CLI. exit connect menu enable On the login connect menu, inserts the menu item allowing the user to exit to the CLI. line <line> Enters the line level. <line> = number of the line (serial port) to be configured. login connect menu disable Disables the login connect menu, so a user will get the CLI immediately after logging in. login connect menu enable Enables the login connect menu, so a user will get the menu rather than the CLI immediately after logging in. lpd <line> Enters the configure lpd level. <line> = number of the line (lpd serial port) to be configured. no send break Removes the configured send break character. ppp <line> Enters the serial line PPP level. preview connect menu Shows the layout of the connect menu with current settings. send break <control> Sets the optional send break character. <text> = the 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. show Displays the current configuration. show history Displays the last 20 commands entered during the current CLI session. terminal <line> Enters the configure-terminal level. <line> = number of the terminal line (serial port) to be configured. 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 configured. 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. <milliseconds> = number of milliseconds. clrscrn Clears the screen. default break duration Restores the break duration to the default value (500 ms).

XPort Pro Command Reference

127

5: Commands and Levels

default terminal type echo disable echo enable exit exit connect menu disable

exit connect menu enable

line <line>

login connect menu disable

login connect menu enable

lpd <line>

no send break ppp <line> preview connect menu send break <control>

show show history terminal <line>

terminal network terminal type <text> tunnel <line>

write tftp (config-tftp) level commands allow file creation disable

Sets the default terminal type, "UNKNOWN". Disables echoing of characters received on the line back to the line. Enables echoing of characters received on the line back to the line. Exits to the configuration level. On the login connect menu, removes the menu item allowing the user to exit to the CLI. On the login connect menu, inserts the menu item allowing the user to exit to the CLI. Enters the line level. <line> = number of the line (serial port) to be configured. Disables the login connect menu, so a user will get the CLI immediately after logging in. Enables the login connect menu, so a user will get the menu rather than the CLI immediately after logging in. Enters the configure lpd level. <line> = number of the line (lpd serial port) to be configured. Removes the configured send break character. Enters the serial line PPP level. Shows the layout of the connect menu with current settings. Sets the optional send break character. <text> = the 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. Displays the current configuration. Displays the last 20 commands entered during the current CLI session. Enters the configure-terminal level. <line> = number of the terminal line (serial port) to be configured. Enters the configure-terminal level for the network. Sets the terminal type. Enters the tunnel level. <line> = number of the tunnel line (serial port) to be configured. Stores the current configuration in permanent memory. Prohibits the TFTP server from creating files on the

XPort Pro Command Reference

128

5: Commands and Levels

allow file creation enable allow firmware update disable allow firmware update enable allow xcr import disable allow xcr import enable clear counters clrscrn exit no clear counters show show history show statistics state disable state enable write traps (config-snmp-traps) level commands clrscrn exit no primary destination no secondary destination primary destination <text> secondary destination <text> show show history state disable state enable write tunnel 1 (tunnel:1) level commands accept auto show statistics clear counters clrscrn connect disconnect

file system. Enables the TFTP server to create files on the file system. The TFTP server rejects any attempt to update firmware. The TFTP server accepts a firmware image for update based on the file name. The TFTP server rejects any attempt to import XML configuration. The TFTP server accepts an XCR file for configuration update based on the file name. Sets the TFTP counters to zero. Clears the screen. Returns to the config level. Restores the TFTP counters to the aggregate values. Displays the current configuration. Displays the last 20 commands entered during the current CLI session. Displays the TFTP statistics. Disables the TFTP server. Enables the TFTP server. Stores the current configuration in permanent memory. Clears the screen. Exits to the next higher level. Deletes the primary SNMP trap host. Deletes the secondary SNMP trap host. Sets the primary SNMP trap host. <text> = IP address of host running the SNMP trap. Sets the secondary SNMP trap host. <text> = IP address of host running the SNMP trap. Shows the current configuration. Displays the last 20 commands entered during the current CLI session. Disables the sending of SNMP trap messages. Enables the sending of SNMP trap messages. Stores the current configuration in permanent memory. Enters the accept level for this tunnel. show connection statistics Zeros all tunnel counters Clears the screen. Enters the connect level for this tunnel. Enters the disconnect level for this tunnel.

XPort Pro Command Reference

129

5: Commands and Levels

exit line <line>

lpd <line>

modem no clear counters packing ppp <line> serial show history show statistics terminal <line>

terminal network tunnel <line>

write udp (config-udp) level commands auto show statistics clear counters clrscrn exit no clear counters show history show statistics write vip (config-vip) level commands auto show counters auto show status clear counters clrscrn exit no clear counters show show counters show history show status

Exits to the enable level. Enters the line level. <line> = number of the line (serial port) to be configured. Enters the configure lpd level. <line> = number of the line (lpd serial port) to be configured. Enters the modem level for this tunnel. Unzeros all tunnel counters Enters the packing level for this tunnel. Enters the serial line PPP level. Enters the serial level for this tunnel. Displays the last 20 commands entered during the current CLI session. show connection statistics 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 tunnel level. <line> = number of the tunnel line (serial port) to be configured. Stores the current configuration in permanent memory. Continuously shows UDP statistics Zeros counters Clears the screen. Exits to the configuration level. Unzeros IP counters Displays the last 20 commands entered during the current CLI session. Shows UDP statistics Stores the current configuration in permanent memory. Displays VIP counters continuously. Displays VIP status continuously. Sets the VIP counters to zero. Clears the screen. Exits to the configuration level. Restores the VIP counters to the aggregate values. Displays the current configuration. Displays the VIP counters. Displays the last 20 commands entered during the current CLI session. Displays the VIP status.

XPort Pro Command Reference

130

5: Commands and Levels

state disable state enable write xml (xml) level commands auto show statistics clear counters clrscrn exit no clear counters secret xcr dump secret xcr dump <group list> secret xcr export <file> secret xcr export <file> <group list> show history show statistics 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

Disables use of Virtual IP (VIP) addresses. Enables use of Virtual IP (VIP) addresses. Stores the current configuration in permanent memory. Show XML statistics Zeros XML statistics Clears the screen. Exits to the enable level. Unzeros XML statistics 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 Displays the last 20 commands entered during the current CLI session. Show XML statistics 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

131

You might also like