Lantronix 2100 User Manual

IntelliBox®-I/O 2100

Command Reference

Part Number 900-475

Revision B 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 wr itten permission of Lantron ix. 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

May 2007 A Initial Document. March 2012 B Updated for firmware v1.4.0.0.R2.

IntelliBox-I/O 2100 Command Reference 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 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 _________________________________________34

5: Commands and Levels 48

IntelliBox-I/O 2100 Command Reference 3

List of Figures

Figure 3-1 CLI Level Hierarchy______________________________________________________12 Figure 3-2 Login Level Commands___________________________________________________12 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

IntelliBox-I/O 2100 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

IntelliBox-I/O 2100 Command Reference 5

1: About This Guide

This guide describes how to configure the IntelliBox-I/O 2100 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 IntelliBox. Lists XCR groups and items and describes how to use

XCRs to configure the IntelliBox. 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.

IntelliBox-I/O 2100 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

IntelliBox-I/O 2100 User Guide Information about the IntelliBox hardware, testing the IntelliBox,

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

1: About This Guide

and integrating the IntelliBox device into your product.

the IntelliBox and to view its current settings.

Secure Com Port Redirector User Guide

Com Port Redirector Quick Start and Online Help

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.

IntelliBox-I/O 2100 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 ab ou t th e Web Ma nag er , see the IntelliBox-I/O 2100 User Guide at the Lantronix website.

XML Architecture and Device Control

XML is a fundamental building block for the future gr owth of Machine-to-Machine (M2 M) 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 Evol ution OS™ uses a command l ine 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.

IntelliBox-I/O 2100 Command Reference 8

3: Command Line Interface

This chapter describes accessing the IntelliBox by using Telnet, SSH, or serial ports to configure the IntelliBox, navigating the Comma nd Line I nt er fa ce (C LI) , typ ing key bo ar d sh or tcu ts , 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 IntelliBox 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 IntelliBox 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 ire 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 chang ed to “>>” (instead of “>”) and the Web Manager is inaccessible. These serve as an important indication that the device boot processes has been temporarily ha lte d. T o com plete the boot process, terminate the serial CLI session (with the exit command).

IntelliBox-I/O 2100 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 pa rent 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 ex it and re tu rn to o ne leve l hi gher—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 co mmands available at the cu rrent level—Type the que stion 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.

IntelliBox-I/O 2100 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 pl ace 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 hig h lev el sta tu s, a few diag no stic commands, and the enable level. Further device information and configuratio n 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 comma nds 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 IntelliBox is presented in Figure 3-1.

IntelliBox-I/O 2100 Command Reference 11

Figure 3-1 CLI Level Hierarchy

(login) enable

ssh

ethernet linkif 1

lpd <number>

rss

line <line>

chem

configure

modbus

device

filesystem

lpd

arp

eventtrak (number)

ftp

host <number>

http

ip filter

query port

terminal

tcp

snmp

syslog

tunnel <line> accept

connect

disconnect

modem

packing

serial

icmp

cli

match

task <number>

udp

tftp

ssl

3: Command Line Interface

Commands at the login level, shown in Figure 3-2, do not affect curr en t confi gur ation settin gs and are not displayed initially. If you type <?>, you will see the login sub-commands. These commands provide diagnostic and status information only.

>? clrscrn enable exit ping <host> ping <host> <count> ping <host> <count> <timeout> show show history show ibio2100 trace route <host>

Figure 3-2 Login Level Commands

IntelliBox-I/O 2100 Command Reference 12

3: Command Line Interface

To configure the , 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 auto show xsr chem <number> clear interfaces counters clear query port counters clear xsr counters clrscrn configure connect connect line <line> device disable exit filesystem io kill line <line> kill ssh <session> kill telnet <session> line <line> lpd no clear interfaces counters no clear query port counters no clear xsr counters nslookup nslookup <host> ping <host> ping <host> <count> ping <host> <count> <timeout> reload reload factory defaults secret xcr dump secret xcr dump <group list> secret xcr export <file> secret xcr export <file> <group list> show show history show hosts show ibio2100 show interfaces show ip sockets show processes show sessions show xsr ssh ssh <optClientUsername> <host> ssh <optClientUsername> <host> <port> ssl telnet <host> telnet <host> <port> trace route <host> tunnel <line> write xcr dump xcr dump <group list> xcr export <file> xcr export <file> <group list> xcr import <file> xcr import <file> <group list> xcr list xsr dump xsr dump <group list> xsr export <file> xsr export <file> <group list> xsr list

<enable>#

See the Chapter 5: Co mmands and Leve ls at the end of this document for a com plete list of levels, commands, and descriptions.

IntelliBox-I/O 2100 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 docu ment 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 fo r 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 str uct ur e an d cont en t 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 attrib ute 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.

IntelliBox-I/O 2100 Command Reference 14

Notes:

<?xml version=”1.0” standalone=”yes”?> <configrecord> <configgroup name = “serial command mode” instance = “1”>

<value>disable</value>

</configitem> </configgroup> </configrecord>

 The name fo r each <con fig gr oup> ( s pecified with th e n ame attr ibu te) is the group

name listed in the Web Manager XCR groups or with the “xcr list” CLI command. See the IntelliBox-I/O 2100 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>.

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

IntelliBox-I/O 2100 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”>

<value>disable</value>

</configitem> </configgroup> </configrecord>

<?xml version=”1.0” standalone=”yes”?> <configgroup name = “ssh server”

</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 conf igu ra tio n reco rd s an d th e us e of th e <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

IntelliBox-I/O 2100 Command Reference 16

Figure 4-5 XML Example of Multiple Items

<?xml version=”1.0” standalone=”yes”?> <configgroup name = “email” instance = “1”>

<value>john.doe@somewhere.com></value> </configitem> <configitem name = “from”>

<value>evolution@intellibox.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></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

IntelliBox-I/O 2100 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 IntelliBox-I/O 2100 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 Man ager 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 intellibox_io.xcr is requested. On export (FTP get of intellibox_io.xcr), the FTP server obtains the current XCR from Evolution OS™ and sends it as a file. On import (FTP put of intellibox_io.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 intellibox_io.xcr is not read from or written to the file system. See FTP in the IntelliBox-I/O 2100 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 provide s th e 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 Docu ment (.xml). Notepa d, 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 import an t.

Caution: The filename intellibox_io.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 intellibox_io.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.

IntelliBox-I/O 2100 Command Reference 18

4: Configuration Using XML

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

IntelliBox-I/O 2100 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 Intellibox 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

IntelliBox-I/O 2100 Command Reference 20

4: Configuration Using XML

Group Name Group Item Value Name Value Options Additional

Information

cli login password Value is SECRET,

hidden from user view.

enable level password Value is SECRET,

hidden from user view.

quit connect line Accepts text

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

device cpu speed

short name long name serial number Read only. firmware version Read only.

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

ethernet (Attribute of “instance” is “eth0”.)

to Multiple addresses

may be separated with semicolons.

cc Multiple addresses

may be separated

with semicolons. from reply to subject message file overriding domain server port Default: 25 local port <Random>,

...

priority urgent, high, normal,

low, very low

trigger inpu t name xio1, xio2

level high, low speed auto, 10, 100 Default: auto duplex auto, half, full Default: auto

Default: <Random>

Default: normal

IntelliBox-I/O 2100 Command Reference 21

4: Configuration Using XML

Group Name Group Item Value Name Value Options Additional

Information

event trak (Attribute of “instance” is a number.)

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

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

string

wildcard

timeout milliseconds

case sensitive no, yes

rss trace matches <None>,

...

description

activity none, ping, output

ping address

output control exclusive, logical-or

rss trace steps enable, disable

rss trace triggers enable, disable

rss trace ping

responses

enable, disable

IntelliBox-I/O 2100 Command Reference 22

4: Configuration Using XML

Group Name Group Item Value Name Value Options Additional

Information

event trak (Attribute of “instance” is a number.)

(continued)

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

name <None>,

...

activity

advance upon

advance timeout

value

advance timeout

units

fallback timeout

value

fallback timeout

units

fallback timeout

enabled

fallback if input high

to low

fallback if input low

to high

fallback if matched

string

fallback if trigger a

fallback if trigger b

fallback if output

data present

fallback if accepted

connection

fallback if accepted

disconnection

fallback if ping

response

upon fallback send

trigger

upon advance send

upon advance email

subject

IntelliBox-I/O 2100 Command Reference 23

4: Configuration Using XML

Group Name Group Item Value Name Value Options Additional

Information

event trak (Attribute of “instance” is a number.)

(continued)

ftp server state enable, disable Default: enable

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

http authentication uri

(Attribute of “instance” is the URI.)

step (Attribute of “instance” is a number.) (continued)

admin username Default: admin admin password Value is SECRET,

name protocol telnet, ssh Default: telnet ssh username remote address remote port Default: 0 user delete name Deletes an HTTP

realm type user

(Attribute of “instance” is the user name.)

upon advance clear

receive buffer

upon advance send

line

upon advance send

data

upon advance send

file name

upon advance send

trigger

upon advance rss

title

hidden from user view.

Authentication URI user. The value element is used to specify the user for deletion.

password

IntelliBox-I/O 2100 Command Reference 24

4: Configuration Using XML

Group Name Group Item Value Name Value Options Additional

Information

http server state enable, disable Default: enable

port <None>, ... Default: 80 secure port <None>, ... Default: 443 secure protocols ssl3, tls1.0, tls1.1 May contain zero,

one, or more of the values, separated by commas. Default: ssl3, tls1.0, tls1.1

max timeout Default: 10

seconds max bytes Default: 40960 logging state enable, disable Default: enable max log entries Default: 50 log format Default: %h %t

"%r" %s %B

"%{Referer}i"

"%{User-Agent}i"

icmp state enable, disable Default: enable input output

(Attribute of “instance” is a number.)

input output direction output, input

control force closed, force

open, normal

rss trace transitions enable, disable

IntelliBox-I/O 2100 Command Reference 25

4: Configuration Using XML

Group Name Group Item Value Name Value Options Additional

Information

interface (Attribute of “instance” is eth0”)

ip filter delete entries enable, disable If enabled, deletes

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 identi ty of

the client device.

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

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.

IntelliBox-I/O 2100 Command Reference 26

4: Configuration Using XML

Group Name Group Item Value Name Value Options Additional

Information

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

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

modbus tcp server state enable, disable Default: disable

query port state

name interface rs232, rs485 half-

duplex, rs485 full-

duplex termination enable, disable Default: disable state enable, disable Default: depends

protocol none, tunnel, ppp,

lpd 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

xoff char Accepts a control

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

additional port <None>, ... Default: <None> response timeout Default: 3000

Default:

on instance Default:

per 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

milliseconds

IntelliBox-I/O 2100 Command Reference 27

4: Configuration Using XML

Group Name Group Item Value Name Value Options Additional

Information

rss feed enable, disable Default: disable

persist enable, disable Default: disable max entries Default: 100

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

snmp state enable, disable Default: enable

mode echo serial string serial string signon message wait time

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

IntelliBox-I/O 2100 Command Reference 28

4: Configuration Using XML

Group Name Group Item Value Name Value Options Additional

Information

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 (Attribute of “instance” is required for the user name)

ssh command mode

ssh server host rsa keys public key

state enable, disable port max sessions

host dsa keys public key

delete authorized users authorized user delete name authorized user

(Attribute of “instance” is required for the authorized 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

private key

password public rsa key public dsa key

IntelliBox-I/O 2100 Command Reference 29

+ 66 hidden pages

Lantronix 2100 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 Serial Ports

Serial Command Mode

Serial Recovery

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

Passwords in the XML File

XML Configuration Groups