Lantronix 900-558 User Manual
XPort Pro
Command Reference
Part Number 900-558
Revision C March 2012
Copyright and Trademark
© 2012 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 is a trademark of Microsoft Corporation.
Contacts
Lantronix Corporate Headquarters
167 Technology Drive
Irvine, CA 92618, USA
Toll Free: 800-526-8766
Phone: 949-453-3990
Fax: 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 Rev. Comments
September 2009 A Initial Document
December 2010 B Updated for firmware v5.2.0.0R20. Includes the new Modbus feature.
March 2012 C Updated for firmware v5.2.0.1R5. Includes new VIP commands.
.
XPort Pro Command Reference 2
Table of Contents
List of Figures _____________________________________________________________4
List of Tables ______________________________________________________________5
1: About This Guide 6
Chapter Summaries ________________________________________________________6
Conventions ______________________________________________________________6
Additional Documentation ____________________________________________________7
2: Overview 8
XML Architecture and Device Control ___________________________________________8
Command Line Interface _____________________________________________________8
3: Command Line Interface 9
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 ____________________________________________11
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 _________________________________________33
5: Commands and Levels 47
XPort Pro Command Reference 3
List of Figures
Figure 3-1 CLI Level Hierarchy ______________________________________________________12
Figure 3-2 Login Level Commands___________________________________________________13
Figure 3-3 Enable Level Commands__________________________________________________13
Figure 4-1 DTD for XCRs __________________________________________________________14
Figure 4-2 XML Example __________________________________________________________15
Figure 4-3 XML Group Example _____________________________________________________16
Figure 4-4 XML Example of Multiple Named Values _____________________________________16
Figure 4-5 XML Example of Multiple Items _____________________________________________17
Figure 4-6 XML Example with Multiple Groups _________________________________________17
Figure 4-7 XML Example of Supplying Passwords_______________________________________20
XPort Pro Command Reference 4
List of Tables
Table 4-8 XCR Groups ____________________________________________________________20
Table 4-9 XSR Groups and Items____________________________________________________34
Table 5-1 Commands and Levels____________________________________________________49
XPort Pro Command Reference 5
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
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 Description
Bold text Default parameters.
Italic text Required values for parameters
Brackets [ ] Optional parameters.
Angle Brackets < > Possible values for parameters.
Pipe | Choice of parameters.
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.
Warning 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 Note: Means take notice. Notes contain helpful suggestions, information,
or references to material not covered in the publication.
Caution Caution: Means you might do something that could result in faulty
equipment operation, or loss of data.
Screen Font
(Courier New)
CLI terminal sessions and examples of CLI input.
XPort Pro Command Reference 6
Additional Documentation
Visit the Lantronix web site at www.lantronix.com/support/documentation for the latest
documentation and the following additional documentation.
Document Description
XPort Pro Integration Guide Information about the XPort Pro hardware, testing the XPort Pro
XPort Pro User Guide Instructions for how to install, configure and use the XPort Pro.
1: About This Guide
using the demonstration board, and integrating the XPort Pro into
your product.
XPort Pro Universal Demo Board
Quick Start
XPort Pro Universal Demo Board
User Guide
DeviceInstaller Online Help Instructions for using the Lantronix Windows-based utility to locate
Secure Com Port Redirector
User Guide
Com Port Redirector
Quick Start and Online Help
Instructions for getting the XPort Pro demonstration board up and
running.
Information for using the XPort Pro on the demo board.
the XPort Pro and to view its current settings.
Instructions for using the Lantronix Windows-based utility to create
secure virtual com ports.
Instructions for using the Lantronix Windows-based utility to
create virtual com ports.
XPort Pro Command Reference 7
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.
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.
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.
XPort Pro Command Reference 8
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 cmd in the dialog box and press OK.
3. 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 requ i re d.
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 9
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. After about ten seconds, the exclamation point will display 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 level—Enter 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>#.
3: Command Line Interface
To exit and return to one level higher—Type 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 level—Type show.
To view the list of commands available at the current level—Type the question mark "?". Items
within < > (e.g. <string>) are required parameters.
To view the available commands and explanations—Type the asterisk ( *).
To view the list of commands available for a partial command—Type 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 command—Type 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 CLI—Type show history.
XPort Pro Command Reference 10
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
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
3: Command Line Interface
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
Figure 3-1 CLI Level Hierarchy
(login)
enable
ssl
cli
http
arp
Ethernet
link
If 1
ip
ip filter
query port
rss
snmp
syslog
tcp
tftp
udp
terminal
network
ftp
serial
packing
modem
disconnect
connect
accept
tunnel
<line>
ssh
cpm
line <line>
Filesystem
configure
icmp
device
terminal
<line>
ppp
<number>
lpd
ssh
telnet
modbus
vip
dns
email
host
diagnostics
lpd
<number>
smtp
xml
3: Command Line Interface
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 enable
exit ping <host>
ping <host> <count> ping <host> <count> <timeout>
show show xport_pro
show history 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 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> 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 show xport_pro
ssh ssh <optClientUsername> <host>
ssh <optClientUsername> <host> <port> ssl
telnet <host> telnet <host> <port>
trace route <host> tunnel <line>
write xml
See the Chapter 5: Comma nds 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
<!DOCTYPE configrecord [
<!ELEMENT configrecord (configgroup+)>
<!ELEMENT configgroup (configitem+)>
<!ELEMENT configitem (value+)>
<!ELEMENT value (#PCDATA)>
<!ATTLIST configrecord version CDATA #IMPLIED>
<!ATTLIST configgroup name CDATA #IMPLIED>
<!ATTLIST configgroup instance CDATA #IMPLIED>
<!ATTLIST configitem name CDATA #IMPLIED>
<!ATTLIST value name CDATA #IMPLIED>
]>
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
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
Notes:
<?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 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 a bout the Web Man ager 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>.
4: Configuration Using XML
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
XPort Pro Command Reference 15
The Evolution OS™ uses the attributes in the following subsections to label the group
configuration settings.
Record, Group, Item, and Value Tags
<?xml version=”1.0” standalone=”yes”?>
<configrecord>
<configgroup name = “serial command mode” instance = “1”>
<configitem name = “mode”>
<value>disable</value>
</configitem>
</configgroup>
</configrecord>
<?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>
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.
4: Configuration Using XML
Figure 4-3 XML Group Example
Figure 4-4 XML Example of Multiple Named Values
XPort Pro Command Reference 16
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>
<?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>
Figure 4-6 XML Example with Multiple Groups
4: Configuration Using XML
Importing and Exporting an XML Configuration File
XPort Pro Command Reference 17
An XCR can be imported or exported using the following methods:
Filesystem—XCRs can be saved to the device server file system and imported or accessed as
needed. See Best Practices or the Filesystem Browser section in the XPort Pro User Guide.
CLI—XCRs 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
allow for providing root and enable level passwords so that this can also be done at the
password prompt.
Web browser—Web Manager can be used to import and export an XCR to the device server
file system. It can also be used to import an XCR from an external source such as your local
hard drive.
FTP—The 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.
TFTP—TFTP 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.
4: Configuration Using XML
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). Not epad,
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 accept able, because performing a FT P
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 server’s 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
The “xml paste passwords” <configgroup> name is used with the “passwords” <configitem>
<!—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>
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
XML Configuration Groups
4: Configuration Using XML
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 < in the table may be read as < (the html encoded form for
less than) and any instance of > may be read as > ( the html encoded form for gr eater
than).
Table 4-8 XCR Groups
Group Name Group Item Value Name Value Options Additional
Information
arp arp delete ip address Remove an entry
from the ARP
table. Specify the
entry by its IP
address.
arp entry ip address
mac address
timeout Default: 60
seconds
cli login password Value is SECRET,
hidden from user
view.
enable level password Value is SECRET,
hidden from user
view.
XPort Pro Command Reference 20
4: Configuration Using XML
Group Name Group Item Value Name Value Options Additional
Information
cli (continued) quit connect line Accepts text
containing control
characters, for
example,
<control>
A represents
control-A Default:
<control>L
inactivity timeout
cp group
(Attribute of
“instance” is
required for the
group name.)
device cpu speed
diagnostics log output disable, filesystem,
email
(Attribute of
“instance” is a
number.)
state enable Changes state of
cp
(Attribute of “instance is a
number.)
short name
long name
serial number Read only.
firmware version Read only.
to Multiple addresses
cc Multiple addresses
from
reply to
subject
message file
overriding domain
server port Default: 25
local port
priority urgent, high, normal,
bit Bit number
type input
assert low enable
max length Default: 50 Kbytes
severity level debug, information,
<None>,
...
disable
output
disable
line <number>
notice, warning, error
<Random>, ...
low, very low
Default: 15
minutes
the CP group.
Default: disable
Default: debug
may be separated
with semicolons.
may be separated
with semicolons.
Default:
<Random>
Default: normal
XPort Pro Command Reference 21
4: Configuration Using XML
Group Name Group Item Value Name Value Options Additional
Information
ethernet
(Attribute of
“instance” is
“eth0”.)
ftp server state enable, disable Default: enable
host
(Attribute of
“instance” is a
number.)
http
authentication uri
(Attribute of
“instance” is the
URI.)
http server state enable, disable Default: enable
speed auto, 10, 100 Default: auto
duplex auto, half, full Default: auto
admin username Default: admin
admin password Value is SECRET,
hidden from user
view.
name
protocol telnet, ssh Default: telnet
ssh username
remote address
remote port Default: 0
user delete name 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.)
port <None>, ... Default: 80
secure port <None>, ... Default: 443
secure protocols ssl3, tls1.0, tls1.1 May contain zero,
max timeout Default: 10
max bytes Default: 40960
logging state enable, disable Default: enable
max log entries Default: 50
log format Default: %h %t
authentication timeout Default: 30
password
one, or more of the
values, separated
by commas.
Default: ssl3,
tls1.0, tls1.1
seconds
"%r" %s %B
"%{Referer}i"
"%{User-Agent}i"
minutes
XPort Pro Command Reference 22
4: Configuration Using XML
Group Name Group Item Value Name Value Options Additional
Information
icmp state enable, disable Default: enable
interface
(Attribute of
“instance” is
eth0”)
ip
bootp enable, disable Default: disable
dhcp enable, disable Default: enable
ip address <None>, ... 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).
default gateway <None>, ... Accepts in IP
address in dotted
notation, like
192.168.1.1.
hostname
domain
dhcp client id Set the identity of
the client device.
mtu Default: 1500
bytes
primary dns <None>, ... Accepts in IP
address in dotted
notation, like
192.168.1.1.
secondary dns <None>, ... Accepts in IP
address in dotted
notation, like
192.168.1.1.
multicast time to live Default: 1 hops
ip time to live
XPort Pro Command Reference 23
4: Configuration Using XML
Group Name Group Item Value Name Value Options Additional
Information
ip filter delete entries enable, disable If enabled, deletes
any existing
entries before
adding “filter
entry”.
filter delete ip address Deletes a specific
IP filter entry.
net mask Deletes a specific
IP filter entry.
filter entry ip address If configured, is a
specific IP
address.
net mask If configured, is a
specific net mask.
line
(Attribute of
“instance” is a
number.)
name
interface rs232, rs485 half-
duplex, rs485 fullduplex
termination enable, disable Default: disable
state enable, disable Default: depends
protocol none, modbus rtu,
modbus ascii, tunnel,
ppp, lpd, lpd or
tunnel
baud rate Default: 9600 bits
parity even, none, odd Default: none
data bits 7, 8 Default: 8
stop bits 1, 2 Default: 1
flow control none, hardware,
software
xon char Accepts a control
Default:
on instance
Default:
per second
Default: none
character, for
example,
<control>
A represents
control-A Default:
<control>Q
XPort Pro Command Reference 24
4: Configuration Using XML
Group Name Group Item Value Name Value Options Additional
Information
line
(Attribute of
“instance” is a
number.)
(continued)
lpd
(Attribute of
“instance” is a
number.)
xoff char Accepts a control
character, for
example,
<control>
A represents
control-A Default:
<control>S
gap timer
threshold Default: 56 bytes
banner enable, disable Default: enable
binary enable, disable Default: disable
soj enable, disable Default: disable
eoj enable, disable Default: disable
formfeed enable, disable Default: disable
convert newline enable, disable Default: disable
soj text
eoj text
queue name
<None>,
...
Default: none
XPort Pro Command Reference 25
4: Configuration Using XML
Group Name Group Item Value Name Value Options Additional
Information
managelinx plaintext dsm credentials dna.xml.replication.
protocol.version
dna.capabilities.tcp.
connect.fail
encrypted dsm
credentials
managelinx common device.dna.system.
managelinx network
interface
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.
httpconnect
device.dna.dsc.
tunnel.proxy.host
device.dna.dsc.
tunnel.proxy.port
device.dna.dsc.
tunnel.proxy.enable
change.number
device.config.name
device.dna.system.
change.timestamp
device.dna.dsc.
replication.period
device.dna.system.
network.iface.name
device.dna.system.
network.iface.
ipaddress
device.dna.system.
network.iface.vip.
pool
device.viproute.
target.name
enable, disable Default: disable
Default: 1800
seconds
Default: 0
XPort Pro Command Reference 26
4: Configuration Using XML
Group Name Group Item Value Name Value Options Additional
Information
modbus tcp server state enable, disable Default: disable
additional port <None>, ... Default: <None>
response timeout Default: 3000
milliseconds
rss trace input enable, disable Default: disable
ppp
(Attribute of
“instance” is a
number.)
query port state
rss feed enable, disable Default: disable
serial command
mode
(Attribute of
“instance” is a
number.)
smtp relay address
local ip <None>), ... 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).
peer ip <None>), ... Accepts in IP
address in dotted
notation, like
192.168.1.1.
authentication mode none, pap, chap, ms-
chap, ms-chapv2
username
password Value is SECRET,
persist enable, disable Default: disable
max entries Default: 100
mode
echo serial string
serial string
signon message
wait time
relay port Default: 25
Default: none
hidden from user
view.
XPort Pro Command Reference 27
4: Configuration Using XML
Group Name Group Item Value Name Value Options Additional
Information
snmp state enable, disable Default: enable
read community Value is SECRET,
hidden from user
view. Default:
public
write community Value is SECRET,
hidden from user
view. Default:
private
system contact
system name Default: <Default>
system description Default: <Default>
system location
traps state enable, disable Default: enable
primary destination
secondary
destination
ssh state enable, disable Default: enable
port Default: 22
max sessions Default: 3
ssh client delete known hosts enable, disable If enabled, deletes
any existing hosts
before adding
“known host”.
known host delete name Specify the known
host to delete.
known host
(Attribute of “instance” is
required for the known
host name)
delete client users enable, disable If enabled, deletes
client user delete name
client user
(Attribute of “instance” is
required for the user
name)
public rsa key
public dsa key
any existing client
users before
adding “client
user”.
password
remote command
public rsa key
private rsa key
public dsa key
private dsa key
XPort Pro Command Reference 28
4: Configuration Using XML
Group Name Group Item Value Name Value Options Additional
Information
ssh server host rsa keys public key
private key
host dsa keys public key
private key
delete authorized users
authorized user delete name
authorized user
(Attribute of “instance” is
required for the
authorized user name)
ssl RSA certificate certificate Enter the text of
DSA certificate certificate Enter the text of
delete all cas enable, disable If enabled, deletes
syslog state enable, disable Default: disable
host
local port Default: 514
remote port Default: 514
severity log level none, emergency,
tcp resets enable, disable Default: enable
ack limit Number of packets
send data standard, expedited Default: standard
password
public rsa key
public dsa key
the certificate.
private key Enter the text of
the private key.
If configured and
not exporting
secrets, exports
only a placeholder.
the certificate.
private key Enter the text of
the private key.
If configured and
not exporting
secrets, exports
only a placeholder.
any existing
trusted cas before
adding “trusted
ca”.
Default: none
alert, critical, error,
warning, notice,
information, debug
received before an
ACK is forced.
Default: 3 packets
XPort Pro Command Reference 29
4: Configuration Using XML
Group Name Group Item Value Name Value Options Additional
Information
telnet state enable, disable Default: enable
port Default: 23
max sessions Default: 3
terminal
(Attribute of
“instance” is
either “network”
or a number.)
tftp server state enable, disable Default: enable
tunnel accept
(Attribute of
“instance” is a
number.)
terminal type Default:
UNKNOWN
login connect menu enable, disable Default: disable
exit connect menu enable, disable Default: disable
send break Accepts a control
character, for
example,
<control>
A represents
control-A
break duration Default: 500
milliseconds
echo enable, disable Default: enable
allow file creation enable, disable Default: disable
allow firmware update enable, disable Default: disable
allow xcr import enable, disable Default: disable
accept mode disable, always, any
character, start
character, modem
control asserted,
modem emulation
start character
flush start character enable, disable Default: enable
local port <None>, ... Default: <None>
protocol tcp, ssh, telnet, tcp
aes, ssl
tcp keep alive <None>, ... Default: 45000
aes encrypt key Value is SECRET,
aes decrypt key Value is SECRET,
flush serial enable, disable Default: disable
Default: always
Accepts a control
character, for
example,
<control>
A represents
control-A Default:
<control>B
Default: tcp
milliseconds
hidden from user
view.
hidden from user
view.
XPort Pro Command Reference 30
Loading...