Lantronix LX6 User Manual

XPort Pro Lx6

Embedded Device Server

Command Reference

Part Number 900-689-R

Revision A December 2013

Copyright and Trademark

Lantronix and XPort are registered trademarks of Lantronix, Inc. in the United States and other countries. DeviceInstaller is a trademark of Lantronix, Inc. U.S. Patents 6,881,096; 7,018,242. Additional patents pending.

Windows and Internet Explorer are a registered trademarks of Microsoft Corporation. Mozilla and Firefox are registered trademarks of the Mozilla Foundation. Chrome is a trademark of Google,

Inc. Opera is a trademark of Opera Software ASA Corporation Norway. All other trademarks and trade names are the property of their respective holders.

Contacts

Lantronix, Inc. Corporate Headquarters

167 Technology Drive Irvine, CA 92618, USA Toll Free: 800-526-8766 Phone: 949-453-3990 Fax: 949-453-3995

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.

Revision History

Date Revision Comments

ember 2013 A

Dec

Initial document.

XPort® Pro Lx6 Embedded Device Server Command Reference 2

Contacts _________________________________________________________________2

Disclaimer ________________________________________________________________2

Revision History ___________________________________________________________2

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 the Serial Port _____________________________________________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 _______________________________18

Best Practices ____________________________________________________________18

Importing _____________________________________________________________19

Exporting ____________________________________________________________19

XML Configuration Groups __________________________________________________20

XML Status Record Groups and Items _________________________________________28

5: Commands and Levels 38

XPort® Pro Lx6 Embedded Device Server Command Reference 3

List of Figures

Figure 3-2 CLI Level Hierarchy ______________________________________________________12

Figure 3-3 Login Level Commands___________________________________________________12

Figure 3-4 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

XPort® Pro Lx6 Embedded Device Server Command Reference 4

List of Tables

Table 3-1 Keyboard Shortcuts ______________________________________________________11

Table 4-7 XCR Groups ____________________________________________________________20

Table 4-8 XSR Group and Items ____________________________________________________28

Table 5-1 Commands and Levels ____________________________________________________39

XPort® Pro Lx6 Embedded Device Server Command Reference 5

1: About This Guide

This guide describes how to configure the XPort® Pro Lx6 embedded device server using the Command Line Interface (CLI) and/or Extensible Markup Language (XML). CLI provides an interactive mode for accessing the device configuration and management interface. It is most suited for system and network administrators comfortable with using similar interfaces on Enterprise IT and Networking products. It is also helpful as a quick tool for access via the product's serial ports or console/management ports.

XML provides an extensible mode for software developers interfacing with the device and system integrators performing batch provisioning/updates.

Chapter Summaries

This table lists and summarizes content of each chapter.

Chapter Summary

Chapter 2: Overview Gives an overview of CLI and XML.

Chapter 3: Command Line Interface Lists commands and describes how to use CLI to configure the

Chapter 4: Configuration Using XML Lists XCR groups and items and describes how to use XCRs to

Chapter 5: Commands and Levels Provides an index of the CLI Command Hierarchy with hyperlinks

XPort Pro Lx6 embedded device server.

configure the XPort® Pro Lx6 embedded device server.

to the corresponding command details.

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.

Warning Warning: Means that you are in a situation that could cause

Note Note: Means take notice. Notes contain helpful suggestions, information,

Caution Caution: Means you might do something that could result in faulty

Screen Font (Courier New)

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.

or references to material not covered in the publication.

equipment operation, or loss of data.

CLI terminal sessions and examples of CLI input.

XPort® Pro Lx6 Embedded Device Server Command Reference 6

Additional Documentation

Visit the Lantronix website at www.lantronix.com/support/documentation for the latest documentation and the following additional documentation.

Document Description

XPort® Pro Lx6 Embedded Device Server User Guide

XPort® Pro Embedded Device Server Integration Guide

DeviceInstaller Online Help Instructions for using the Lantronix Windows-based utility to locate

1: About This Guide

Describes how to configure and use the XPort Pro Lx6 embedded device server.

Contains information about the hardware and integrating the XPort Pro Lx6 into your product.

the XPort Pro Lx6 and to view its current settings.

XPort® Pro Lx6 Embedded Device Server Command Reference 7

2: Overview

XPort Pro Lx6 embedded device server 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 Lx6 Embedded Device Server User Guide on the Lantronix website.

XML Architecture and Device Control

XML is a fundamental building block for the future growth of Machine-to-Machine (M2M) networks. XPort Pro Lx6 embedded device server supports XML configuration records that make configuring the device server easy for users and administrators. XML configuration records are easy to edit with 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, the XPort Pro Lx6 embedded device server uses industry-standard tools for configuration, communication, and control. For example, the XPort Pro Lx6 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 Lx6 Embedded Device Server Command Reference 8

3: Command Line Interface

This chapter describes accessing the XPort Pro Lx6 embedded device server by using Telnet or serial ports to configure the device, navigating the Command Line Interface (CLI), typing keyboard shortcuts, and moving between the levels.

It contains the following sections:

 Configuration Using Telnet

 Configuration Using the Serial Port

 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 the DeviceInstaller utility. See the DeviceInstaller Online Help for more information, available on our website www.lantronix.com/support/downloads

To access the XPort Pro Lx6 embedded device server 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. Enter telnet command according to the type of device you are utilizing:

a. Type telnet x.x.x.x (x.x.x.x is the IP address) in a Windows/Linux command prompt.

a. To login through telnet using IPv6 address, please use the below commands.

 Type telnet x:x:x::x%eth0 (x:x:x::x is the IPv6 address) in Linux machines.

 Type telnet x:x:x::x (x:x:x::x is the IPv6 address) in Windows command

prompt.

4. The XPort Pro Lx6 embedded device server 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 the Serial Port

Serial Recovery

Serial Recovery mode will temporarily override the line and tunnel settings for the serial line to allow configuration changes to be made. The line and tunnel settings will be restored once the user exits the Serial Recovery mode CLI.

XPort® Pro Lx6 Embedded Device Server Command Reference 9

3: Command Line Interface

To configure the Lantronix device server locally using a serial port:

1. Connect a terminal or a PC running a terminal emulation program to one of the device server's serial ports.

2. Configure the terminal to the following settings:

 9600 baud

 8-bit

 No parity

 1 stop bit

 No flow control.

3. Power off the device.

4. Press and hold down the exclamation point (!) key.

5. Power on the device. After about 15 seconds, the exclamation point will display on the terminal or PC screen.

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

 To exit and return to one level higher—Type exit and press the Enter key. Typing exit at the

 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>#show? 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>#show* 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 Lx6 Embedded Device Server Command Reference 10

Using Keyboard Shortcuts and CLI

One useful shortcut built into XPort Pro Lx6 embedded device server 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 using the Tab and Enter keys on the keyboard. 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:

Table 3-1 Keyboard Shortcuts

Key Combination Description

Ctrl + a Places cursor at the beginning of a line

Ctrl + b Backspaces one character

Ctrl + d Deletes one character

Ctrl + e Places cursor at the end of the line

Ctrl + f Moves cursor forward one character

Ctrl + k Deletes from the current position to the end of the line

Ctrl + l Redraws the command line

Ctrl + n Displays the next line in the history

Ctrl + p Displays the previous line in the history

Ctrl + u Deletes entire line and places cursor at start of prompt

Ctrl + w Deletes one word back

Ctrl + z Exits the current CLI level

Esc + b Moves cursor back one word

Esc + f Moves cursor forward one word

3: Command Line Interface

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.

XPort® Pro Lx6 Embedded Device Server Command Reference 11

3: Command Line Interface

(login) enable

ethernet

link

if 1

syslog

cpm

line <line>

filesystem

configure

device

telnet

dns

email <number>

arp

diagnostics

discovery

http

icmp

smtp

terminal

<line>

terminal network

tunnel <line>

xml

connect

disconnect

modem

packing

serial

icmpv6

cli

cp output

password

cp output

host

log

ftp

An overview of the levels in the XPort Pro Lx6 embedded device server is presented in Figure 3-2

CLI Level Hierarchy below.

Figure 3-2 CLI Level Hierarchy

Commands at the login level (see Figure 3-3 Login Level Commands below) do not affect current configuration settings and are not displayed initially. If you type ?, you will see the login subcommands. These commands provide diagnostic and status information only.

Figure 3-3 Login Level Commands

>? clrscrn exit iperf <params> ping <host> ping <host> <count> ping <host> <count> <timeout> ping6 <host> ping6 <host> <count> ping6 <host> <count> <timeout> show show history trace route <host> trace route <host> <protocol> enable

Note: To configure the XPort Pro Lx6 embedded device server, you must be in the

enable level and any of its sub-levels. Figure 3-4 below shows the enable level commands.

XPort® Pro Lx6 Embedded Device Server Command Reference 12

3: Command Line Interface

Figure 3-4 Enable Level Commands

> >enable (enable)#? auto show interfaces auto show processes clrscrn configure connect connect line <line> cpm device disable dns email <number> exit filesystem iperf <params> kill telnet <session> line <line> ping <host> ping <host> <count> ping <host> <count> <timeout> ping6 <host> ping6 <host> <count> ping6 <host> <count> <timeout> reload reload factory defaults show show history show interfaces show ip sockets show processes show sessions telnet <host> telnet <host> <port> trace route <host> trace route <host> <protocol> tunnel <line> write xml

(enable)#

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

XPort® Pro Lx6 Embedded Device Server 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 as shown in

Figure 4-1 DTD for XCRs.

Figure 4-1 DTD for XCRs

<!DOCTYPE configrecord [ <!ELEMENT configrecord (configgroup+)> <!ELEMENT configgroup (configitem+,configgroup*)> <!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 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 Lx6 Embedded Device Server Command Reference 14

Note:

 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 Lx6 Embedded Device Server User Guide for more information about the 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: a 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.

4: Configuration Using XML

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

<value name="ip address">172.19.39.17</value> <value name="mac address">00:30:48:5B:6A:A6</value> <value name="type">dynamic</value> <value name="interface">eth0</value>

</statusitem>

XPort® Pro Lx6 Embedded Device Server Command Reference 15

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.

4: Configuration Using XML

Figure 4-3 XML Example

</configitem>

Figure 4-4 XML Example of Multiple Named Values

<value name="bit">0</value> <value name="type">input</value>

<value name="assert low">enable</value> </configitem> <configitem name="state">

<value>disable</value> </configitem> </configgroup>

<value>Telnet</value> </configitem> <configitem name="ssh username">

XPort® Pro Lx6 Embedded Device Server Command Reference 16

</configgroup>

Figure 4-5 XML Example of Multiple Items

<value>disable</value>

</configitem> <configitem name="delete cpm groups">

<value>enable</value>

</configitem> <configitem name="cpm group delete">

</configitem> <configitem name="delete http authentication uris">

<value>disable</value>

</configitem> <configitem name="http authentication uri delete">

</configitem> <configitem name="reboot">

<value>disable</value>

</configitem>

</configgroup>

4: Configuration Using XML

Figure 4-6 XML Example with Multiple Groups

<value name="bit">0</value> <value name="type">output</value> <value name="assert low">enable</value>

</configitem> <configitem name="state">

<value>disable</value>

</configitem> </configgroup> <configgroup name="cp group" instance="Line1_RS485_Select">

<value>disable</value>

</configitem> </configgroup>

XPort® Pro Lx6 Embedded Device Server Command Reference 17

<value name="bit">0</value> <value name="type">input</value>

<value name="assert low">enable</value> </configitem> <configitem name="state">

<value>disable</value> </configitem>

</configgroup>

Importing and Exporting an XML Configuration File

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 on page 18 or the Filesystem Browser section in the XPort Pro Lx6 Embedded Device Server User Guide.

 CLI-XCRs can be imported (captured) or exported (dumped) directly to a Telnet or serial line

CLI session. Capturing an XCR can be started by pasting a valid XCR directly into the CLI prompt. The XPort Pro Lx6 embedded device server 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.

4: Configuration Using XML

 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 for the filename (xport_pro_lx6.xcr for export, xport_pro_lx6_import.xcr for import; both are under the pwxcr directory) is requested. On export (FTP get of xport_pro_lx6.xcr), the FTP server obtains the current XCR from the XPort Pro Lx6 and sends it as a file. On import (FTP put of xport_pro_lx6_import.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 files xport_pro_lx6.xcr and xport_pro_lx6_import.xcr are not read from or written to the file system. See FTP in the XPort Pro Lx6 Embedded Device Server User Guide.

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 XPort Pro Lx6 embedded device server. 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.

XPort® Pro Lx6 Embedded Device Server Command Reference 18

4: Configuration Using XML

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.

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:

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 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 mode tunneling settings for all to the file "tunnel_all.xcr" on the device server filesystem:

xcr export tunnel_all.xcr "tunnel "

The following example imports only the settings for 2 from an 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 ":2"

The following example imports only settings for all from a configuration record on the device server filesystem named "foobar.xcr":

xcr import foobar.xcr ""

To import only mode tunnel settings for 1 and all settings for 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 :1"

The following example exports mode tunneling for all to the file tunnel_config.xcr on the device server filesystem:

xcr export tunnel_config.xcr "tunnel"

XPort® Pro Lx6 Embedded Device Server Command Reference 19

4: Configuration Using XML

XML Configuration Groups

Table 4-7 lists the XPort Pro Lx6 embedded device server 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 "less than" and any instance of

> may be read as "greater than".

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

ip address

mac address

control characters, for example, <control>A represents control-A Default: <control>L

assert low

bit

type

assert low

bit

type

cli

cp group

(Attribute of an instance is “Line1_Modem_Ctl_ In”)

cp group

(Attribute of an instance is Out”)

cp group

(Attribute of an instance is “Line1_RS485_HDp x”)

cp group

(Attribute of an instance is “Line1_RS485_Sele ct”)

arp entry

inactivity timeout Default: 15 minutes

line authentication enable, disable Default: disable

quit connect line Accepts text containing

cp (Attribute of an instance is “3”)

state enable, disable Default: disable

cp (Attribute of an instance is “2”)

state enable, disable Default: disable

XPort® Pro Lx6 Embedded Device Server Command Reference 20

4: Configuration Using XML

Group Name (continued)

cp group

(Attribute of an instance is “Line1_RS485_TxE nable”)

cp group

(Attribute of an instance is “Line1_RTS_CTS”)

device firmware version 7.5.0.0R20

diagnostics log output

discovery state enable, disable

dns ipv6 precedence enable, disable

email (Attribute of“instance” is a number.)

ethernet

(Attribute of an instance is “eth0”)

ftp server state enable, disable Default: enable

Group Item Value Name Value Options Additional

Information

cp (Attribute of an instance is “2”)

state enable, disable Default: disable

cp (Attribute of an instance is “1)

cp (Attribute of an instance is “3”)

state enable, disable Default: disable

long name Lantronix XPort Pro

serial number 07110977T8OOR2

short name XPort Pro Lx6

cp group

from

local port <None>, ...

message file

overriding domain

priority normal

reply to

server port 25

subject

duplex

speed

assert low

bit

type

assert low

bit

type

assert low

bit

type

Lx6

max length

trigger value

XPort® Pro Lx6 Embedded Device Server Command Reference 21

4: Configuration Using XML

Group Name (continued)

http authentication uri

http server

icmp

interface (Attribute of an instance is “eth0”)

Group Item Value Name Value Options Additional

Information

realm

type

user delete name

user (Attribute of an instance is “admin”)

authentication timeout

log format

logging state

max bytes

max log entries

max timeout

port

state

state disable, enable Default: enable

state

bootp

default gateway

dhcp client id

password

dhcp

dhcpv6

domain

hostname

ip address

ipv6 address

ipv6 autoconf

ipv6 default gateway

mtu

primary dns

secondary dns

ip time to live

multicast time to live

XPort® Pro Lx6 Embedded Device Server Command Reference 22

4: Configuration Using XML

Group Name (continued)

line

(Attribute of

“instance” is a

number.)

Group Item Value Name Value Options Additional

Information

name

interface rs232, rs485 half-

duplex, rs485 fullduplex, usb-cdc-acm

termination enable, disable Default: disable

state enable, disable Default: depends on

protocol none, tunnel Default:

baud rate Default: 9600 bits per

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

xoff char Accepts a control

gap timer <None>, ... Default: <None>

threshold Default: 56 bytes

Default:

instance

second

Default: none

character, for example, <control>A represents control-A Default: <control>Q

character, for example, <control>A represents control-A Default: <control>S

XPort® Pro Lx6 Embedded Device Server Command Reference 23

4: Configuration Using XML

Group Name (continued)

serial command mode (Attribute of

“instance” is a

number.)

smtp relay address

syslog state enable, disable Default: disable

telnet state enable, disable Default: enable

Group Item Value Name Value Options Additional

Information

mode always, serial string,

disable

echo serial string enable, disable Default: enable

serial string Sets a string that can

signon message Sets a sign-on

wait time Default: 5000

relay port

host

remote port Default: 514

severity log level none, emergency,

alert, critical, error, warning, notice, information, debug

port Default: 23

max sessions Default: 3

authentication enable, disable Default: disable

Default: disable

be entered at boot time to enter command mode. This text may specify binary characters. Within [] use binary decimal up to 255 or hex up to 0xFF. Within {} specify decimal milliseconds time delay.

message that is sent from the serial port when the device boots and when the line is in command mode. This text may specify binary characters. Within [] use binary decimal up to 255 or hex up to 0xFF.

milliseconds

Default: none

XPort® Pro Lx6 Embedded Device Server Command Reference 24

4: Configuration Using XML

Group Name (continued)

terminal

(Attribute of

“instance” is a

number or “network”)

tunnel accept

(Attribute of

“instance” is a

number.)

Group Item Value Name Value Options Additional

Information

terminal type Default: UNKNOWN

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

accept mode disable, always Default: always

start character Accepts a control

character, for example, <control>A represents control-A Default: <control>B

flush start character enable, disable Default: enable

local port Default: 0

protocol tcp, telnet, tcp aes Default: tcp

tcp keep alive <None>, ... Default: 45000

milliseconds

aes encrypt key Value is SECRET,

hidden from user view.

aes decrypt key Value is SECRET,

hidden from user view.

flush serial enable, disable Default: disable

block serial enable, disable Default: disable

block network enable, disable Default: disable

password password Value is SECRET,

hidden from user view.

prompt enable, disable Default: disable

email connect <None>, ... Default: <None>

email disconnect <None>, ... Default: <None>

XPort® Pro Lx6 Embedded Device Server Command Reference 25

4: Configuration Using XML

Group Name (continued)

tunnel connect

(Attribute of

“instance” is a

number.)

tunnel disconnect

(Attribute of

“instance” is a

number.)

Group Item Value Name Value Options Additional

Information

connect mode disable, always, any

character, start character, modem control asserted, modem emulation

start character Accepts a control

flush start character enable, disable Default: enable

local port <Random>,

...

host (Attribute of an “instance” is a number)

host mode sequential,

reconnect time Default: 15000

flush serial enable, disable Default: disable

block serial enable, disable Default: disable

block network enable, disable Default: disable

email connect <None>, ... Default: <None>

email disconnect <None>, ... Default: <None>

stop character Accepts a control

flush stop character enable, disable Default: enable

modem control enable, disable Default: disable

timeout Default: 0 milliseconds

flush serial enable, disable Default: disable

address

port <None>, ... Default: <None>

protocol tcp, udp, telnet, tcp

aes, udp aes

tcp keep alive <None>, ... Default: 45000

aes encrypt key Value is SECRET,

aes decrypt key Value is SECRET,

simultaneous

Default: disable

character, for example, <control>A represents control-A Default: <control>B

Default: <Random>

Default: tcp

milliseconds

hidden from user view.

Default: sequential

milliseconds

character, for example, <control>A represents control-A

XPort® Pro Lx6 Embedded Device Server Command Reference 26

4: Configuration Using XML

Group Name (continued)

tunnel modem

(Attribute of

“instance” is a

number.)

tunnel packing packing mode disable, timeout, send

tunnel serial

(Attribute of

“instance” is a

number.)

xml import control

Group Item Value Name Value Options Additional

echo pluses enable, disable Default: disable

echo commands enable, disable Default: enable

verbose response enable, disable Default: enable

response type text, numeric Default: text

error unknown commands

incoming connection disabled, automatic,

connect string

display remote ip enable, disable Default: disable

timeout Default: 1000

threshold Default: 512 bytes

send character Accepts a control

trailing character Accepts a control

dtr asserted while

restore factory configuration

cpm group delete

delete cpm groups enable, disable

delete http authentication uris

http authentication uri delete

reboot enable, disable Reboots after

name Deletes the specified

enable, disable Default: disable

manual

character

connected, continuously asserted, unasserted, truport

enable, disable

enable, disable Deletes existing HTTP

Information

Default: disabled

Default: disable

milliseconds

character, for example, <control>A represents control-A Default: <control> M

character, for example, <control>A represents control-A

Default: asserted while connected

authentication URIs before importing new ones.

HTTP authentication URI.

importing.

XPort® Pro Lx6 Embedded Device Server Command Reference 27

+ 60 hidden pages

Lantronix LX6 User Manual

Copyright and Trademark

Contacts

Disclaimer

Revision History

Table of Contents

List of Figures

List of Tables

1: About This Guide

Chapter Summaries

Conventions

Additional Documentation

2: Overview

XML Architecture and Device Control

Command Line Interface

3: Command Line Interface

Configuration Using Telnet

Configuration Using the Serial Port

Navigating the CLI Hierarchy

Using Keyboard Shortcuts and CLI

Understanding the CLI Level Hierarchy

4: Configuration Using XML

XML Configuration Record Document Type Definition

Quick Tour of XML Syntax

Declaration

Element Start and End Tags

Element Attributes

Record, Group, Item, and Value Tags

Importing and Exporting an XML Configuration File

Best Practices

Importing

Exporting

XML Configuration Groups