Lantronix EDS4100 User manual

Part Number 900-455
Revision B January 2007
EDS Device Servers
Command Reference
EDS4100
EDS8PR
EDS16PR
EDS32PR

EDS Device Servers Command Reference 2
Copyright & Trademark
© 2006, 2007 Lantronix. All rights reserved. No part of the contents of this book may be
transmitted or reproduced in any form or by any means without the written permission of
Lantronix. Printed in the United States of America.
Ethernet is a trademark of XEROX Corporation. UNIX is a registered trademark of The
Open Group. Windows 95, Windows 98, Windows 2000, and Windows NT are
trademarks of Microsoft Corp. Netscape is a trademark of Netscape Communications
Corporation.
Contacts
Lantronix Corporate Headquarters
15353 Barranca Parkway
Irvine, CA 92618, USA
Phone: [phone]
Fax: [phone]
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 .

EDS Device Servers Command Reference 3
Contents
1: Introduction 4
2: Configuration Using Telnet or Serial Port 5
Using Telnet________________________________________________________ 5
Using a Serial Port___________________________________________________ 5
Navigating the Command Line Interface __________________________________ 6
Guidelines _____________________________________________________________ 6
CLI Levels _____________________________________________________________ 7
3: Summary of CLI Commands 8
Root Menu _________________________________________________________ 9
Enable Menu ______________________________________________________ 10
Chem Level Commands _____________________________________________ 14
Configure Menu ____________________________________________________ 16
Interface 1 Level Menu ______________________________________________ 24
Device Menu ______________________________________________________ 26
Filesystem Menu ___________________________________________________ 28
Line Menu ________________________________________________________ 31
SSH Menu ________________________________________________________ 33
SSL Menu ________________________________________________________ 36
Tunnel Menu ______________________________________________________ 37
4: Configuration Using XML 44
XML Configuration Record Schema_____________________________________ 44
Quick Syntax Tour for XCRs __________________________________________ 45
Records, Groups, Items, and Values____________________________________ 46
Importing and Exporting an XML Configuration File ________________________ 47
Best Practices _____________________________________________________ 48
Testing the XML Configuration File _________________________________________ 48
Importing and Exporting Partial Configurations ________________________________ 48
Including Passwords in the XML File________________________________________ 49
Special XCR Groups ____________________________________________________ 50
XML Groups_______________________________________________________ 51
XSR Groups and Items ______________________________________________ 61
Index 68

EDS Device Servers Command Reference 4
1: Introduction
EDS device servers (EDS4100, EDS8PR, EDS16PR, and EDS32PR) contain all the
components necessary to deliver full network connectivity to virtually any kind of serial
device, a reliable TCP/IP protocol stack, and a variety of remote management
capabilities. They boast an innovative design and run on Lantronix’s leading-edge
Evolution OS™, which supports three convenient configuration methods (Web, command
line, and XML). The EDS User Guide describes how to configure the EDS using a web
interface.
Command-Line Interface (CLI): Making the edge-to-enterprise vision a reality, the EDS
with the Evolution OS™ uses industry-standard tools for configuration, communication,
and control. For example, the Evolution OS™ uses a Cisco®-like command line interface
(CLI) whose syntax is very similar to that used by data center equipment such as routers
and hubs
This Command Reference provides information about navigating the CLI interface and
lists the CLI commands for configuring, monitoring, and controlling the EDS.
XML-based Architecture and Device Control: XML is a fundamental building block for
the future growth of M2M network. The EDS supports XML-based configuration and
setup records that makes device configuration transparent to users and administrators.
The XML is easily editable with a standard text or XML editor.
This command reference provides a brief overview of the XML interface, shows typical
XML commands, and provides best practices for using XML commands.

EDS Device Servers Command Reference 5
2: Configuration Using Telnet or Serial Port
As an alternative to using Web Manager, you can configure the EDS using a series of
commands. You can access this command-line interface (CLI) with a Telnet session or
through a serial port connection to the EDS.
This command reference describes how to use the CLI and provides a detailed list of all
the CLI commands supported.
Using Telnet
To configure the EDS using a Telnet session over the network, establish a Telnet
connection.
Note: As an alternative, establish a Telnet connection by clicking the Telnet
Configuration tab in DeviceInstaller. See the EDS User Guide for more
information.
1. From the Windows Start menu, click Run. The Run dialog box appears.
2. In the Run dialog box, type the following command, where x.x.x.x is the IP address:
telnet x.x.x.x
A prompt displays.
Note: Depending on the level of security you have configured, the User Name
and Password may be required. If you named the unit, the name displays as the
prompt. If you assigned a host name to the unit, a host name prompt displays.
Using a Serial Port
To configure the EDS locally using a serial port, connect a terminal or a PC running a
terminal-emulation program to an EDS serial port. Configure the terminal (or emulation)
for 9600 baud, 8-bit, no parity, 1 stop bit, and no flow control.
1. Cycle the unit’s power (power off and back on). After power-up, the self-test begins.
Note: The EDS8/16/32PR products have a dedicated console port that
automatically provides a CLI. If you are using the the console port, skip
step 2.
2. Press and hold down the exclamation point (!) key. (Some keyboard require you to
press the Shift key when typing an exclamation point.) Then, when an exclamation
point appears on the terminal or PC screen, immediately type xyz to display a CLI
prompt.

2: Configuration Using Telnet or Serial Port
EDS Device Servers Command Reference 6
Navigating the Command Line Interface
Guidelines
Commands at the root level (top level) of the CLI do not affect current configuration
settings. Commands within the Enable menu (and its sub-menus) modify the EDS’s
configuration.
Items within < > (e.g. <string>) are required parameters.
To view acceptable commands: Type enter “?”.
To move to a sub-level and traverse the tree of commands: Enter each sub-
command only in its parent command prompt. For example, to access the Tunnel1 level
within the Enable level (which is below the root level), enter:
>enable
(enable)#tunnel 1
To exit and return to the menu one level higher: Type exit.
The following key combinations are allowed when configuring the EDS from the CLI:
Ctrl + a: place cursor at the beginning of line
Ctrl + b: backspace one character
Ctrl + d: delete one character
Ctrl + e: place cursor at the end of the line
Ctrl + f: move cursor forward one character
Ctrl + k: delete everything to the end of the line
Ctrl + l: redraw the command line
Ctrl + n: display the next line in the history
Ctrl + p: display the previous line in the history
Ctrl + u: delete entire line and place cursor at start of prompt
Ctrl + w: delete one word back in line
Esc + b: move cursor back one word
Esc + f: move cursor forward one word
Notes:
You need only type enough characters to uniquely identify each part of a command.
The EDS CLI also supports tab completion.

2: Configuration Using Telnet or Serial Port
EDS Device Servers Command Reference 7
To view the current configuration at any level: Type show. The configuration for that
menu level displays.
To view the list of commands available at the current menu level: At the command
prompt, type ?. The list of current commands displays.
To return to the next level up in the menu hierarchy: At the command prompt, type
exit. The prompt for the parent menu displays.
To view the available commands and their explanation: At the command prompt,
type *. The list of commands for that menu level and their description displays.
CLI Levels
The following diagram shows the CLI command levels.
root
enable
chem. <n>
chem. <n>
config
if 1
device filesystem line <n>
line <n>
tunnel <n>
ssh ssl
tunnel <n>
line <n>
tunnel <n>

EDS Device Servers Command Reference 8
3: Summary of CLI Commands
The following sections describe the CLI commands. The commands are organized as
follows:
Root menu: page 9
Enable menu: page 10
Chem menu: page 14
Configure menu: page 16
Interface 1 Level Menu: page 24
Device menu: page 26
Filesystem menu: page 28
Line menu: page 31
SSH menu: page 33
SSL menu: page 36
Tunnel menu: page 37

3: Summary of CLI Commands
EDS Device Servers Command Reference 9
Root Menu
The following parameters are top-level root commands. These commands do not alter
the configuration of the EDS. You can issue these commands from any level.
Root Configuration
Command Description
clrscrn Clears the screen.
enable Displays the Enable level prompt.
exit Exits from the system.
ping <host> Pings the host destination the specified number of times
(count) with a 5-second timeout.
<host> = host destination.
ping <host> <count>
<timeout> Pings the string destination a specified number of times
with a specified timeout.
<host> = host destination.
<count> = number of times the ping is to occur.
<timeout> = number of seconds that must elapse without a
response before the ping times out.
show history Displays the set of commands inputted from the moment
user was brought back up to this menu.
show eds4100
show eds8PR
show eds16PR
show eds32PR
Displays the current EDS settings.
trace route <host> Determines the path taken from a computer to a specified
destination.
<host> = host destination.

3: Summary of CLI Commands
EDS Device Servers Command Reference 10
Enable Menu
The following configurable parameters reside in the Enable configuration menu
Enable Menu Command Description
auto show interfaces Displays interface statistics.
auto show processes Continuously displays thread runtime information.
auto show xsr Displays XML Status Record counters.
chem <number> Changes to the Configure Email level.
clear interface
counters Sets the interface session counters to zero.
clear line <number> Closes a specific command mode session.
<number> = number of the serial line to be cleared.
clear query port
counters Sets the Query Port counters to zero.
clear ssh <session> Closes an active SSH session on the EDS.
<session> = session number displayed by the show
sessions command.
clear telnet <session> Closes an active Telnet session on the EDS.
<session> = session number displayed by the show
session command.
clear xsr counters Sets the XML Status Record counters to 0.
configure Displays the Configuration-level menu.
connect Displays names and numbers of all lines.
connect line <line> Starts a session on the serial line.
<line> = line number.
device Displays the device-level menu.
disable Exits current menu level and returns to main root level
menu.
exit Exits the system.
filesystem Displays the Filesystem-level menu.
kill line <line> Closes a command mode session on the line.
<line> =line number

3: Summary of CLI Commands
EDS Device Servers Command Reference 11
Enable Menu Command Description
kill ssh <session> Closes an SSH session.
<session> = session number in the index displayed by the
show sessions command.
kill telnet <session> Closes a Telnet SSH session.
<session> = session number in the index displayed by the
show sessions command.
line <line> Displays the configuration menu for the specified serial
port.
<line> = number of the line (serial port)
no clear interfaces
counters Restores the interface counters to the last aggregate
value.
no clear query port
counters Restores the query port counters to the last aggregate
value.
no clear xsr counters Restores the XML Status Record counters to the last
aggregate value.
nslookup Looks up host information for the given host name.
nslookup <host> Displays host information for a specified host name.
<host> = IP address of the host whose information you
want to view.
ping <host> Pings the host destination five times with a 5-second
timeout
<host> = IP address of the host you want to ping.
ping <host> <count> Pings the host destination a specified number of times with
a 5-second timeout.
<host> = IP address host you want to ping.
<count> = number of times the specified host is to be
pinged.
ping <host> <count>
<timeout> Pings the host destination the specified number (count) of
times with a specified timeout (in seconds).
reload Reboots the EDS and reloads the configuration from Flash
memory.
reload factory
defaults Resets the EDS configuration to the default settings.
show eds4100
show eds8pr
show eds16pr
show eds32pr
Displays the EDS’s configuration.

3: Summary of CLI Commands
EDS Device Servers Command Reference 12
Enable Menu Command Description
show history Displays previously entered commands.
show hosts Displays the domain settings.
show interfaces Displays network-interface statistics.
show ip sockets Displays TCP and UDP state information and their
associated ports.
show processes Displays thread runtime information.
show query port Displays statistics and information on the query port.
show sessions Displays active Telnet and SSH sessions on the EDS.
show xsr Displays XML Status Record counters.
ssh Displays the SSH configuration level.
ssl Displays the SSL configuration level.
trace route <host> Determines the path taken from a computer to a specified
destination.
<host> = IP address of the host you want to trace route.
tunnel <line> Displays the Tunnel menu for configuring tunneling the line
number entered.
<line> = line number
write Stores and applies current configuration into permanent
memory.
xcr dump Displays the XML configuration to the console.
xcr dump <group list> Displays a specified XML configuration to the console.
<group list> = name of the group list whose XML
configuration you want to view.
xcr export <file> Saves the EDS’s current configuration to a file.
<file> = name of the file in which the current EDS
configuration will be saved.
xcr export <file>
<group list>
Saves a specified XML configuration to a file.
<file> = name of the file in which the XML configuration will
be saved.
<group list> = name of the XML configuration to be
imported.
xcr import <file> Imports a local XML configuration to the EDS.
<file> = name of the file to be imported.

3: Summary of CLI Commands
EDS Device Servers Command Reference 13
Enable Menu Command Description
xcr import <file>
<group list>
Imports a specific XML configuration to the EDS.
<file> = name of the file to be imported.
<group list> = name of the XML configuration to be
imported.
xcr list Lists XML configuration record groups to the console.
xsr dump Displays the XML Status Record to the console. (
xsr dump <group list> Displays a specified XML Status Record to the console.
<group list> = name of the group list whose XML Status
Record you want to view.
xsr export <file> Saves the current EDS’s Status Record to a file.
<file> = name of the file in which the current EDS Status
Record will be saved.
xsr export <file>
<group list> Saves a specified XML Status Record to a local file.
<file> = name of the file in which the XML Status Record
will be saved.
<group list> = name of the group list whose XML Status
Record will be saved.
xsr list Lists XML Status Record groups to the console.

3: Summary of CLI Commands
EDS Device Servers Command Reference 14
Chem Level Commands
The following is a list of commands available in the chem (configurable host email) level.
Chem Level Command Description
auto show statistics Continuously displays email statistics
<email addresses> = a semi-colon separated list of email
addresses.
chem <number> Enters the chem level.
<number> = number of the chem level to enter.
clear log Clears all entries from the mail log.
clear mail counters Sets the email counters to zero.
clrscrn Clears the screen.
exit Returns to the enable level.
file <file> Specifies a text file, the contents of which will be the
message body of an email alert.
<file> = the name of a local file.
from <email address> Sets the From address for email alerts.
<email address> = email address to list in the From field
of the email alert.
local port <number> Sets local port used to send email alerts.
<number> local port to use for email alerts.
local port random Sets local port (used to send email alerts) to random.
no cc Clears the Cc addresses for email alerts.
no clear mail counters Restores the email counters to the aggregate values.
no file Removes the file used for the body of the email.
no from Removes From address for email alerts.
no overriding domain Removes the overriding domain name option.
no replyto Removes Reply-To address for email alerts.
no subject Removes subject used for email alerts.
no to Removes To address for email alerts.

3: Summary of CLI Commands
EDS Device Servers Command Reference 15
Chem Level Command Description
overriding domain
<domain> Sets a domain name that will be used when connecting
to an SMTP server to send an email alert instead of the
device’s domain name in EHLO.
<domain> = domain name to override the current
domain name in EHLO.
priority high Sets X-Priority for email alerts to 2.
priority low Sets X-Priority for email alerts to 4.
priority normal Sets X-Priority for email alerts to 3.
priority urgent Sets X-Priority for email alerts to 1.
priority very low Sets X-Priority for email alerts to 5.
replyto <email address> Sets Reply-To address for email alerts.
<email address> = email address to list in the Reply-
To field of the email alert.
send Sends an email using the current settings.
server port <number> Sets the port used by the SMTP server.
<number> = port used for SMTP on the server side.
show Displays email settings.
show history Displays the last 20 commands entered during the
current CLI session.
show log Displays the email log.
show statistics Displays email statistics.
subject <string> Sets the subject for email alerts.
<string> = text to place as the subject.
to <email addresses> Sets email address to which the email alerts will be sent.
<email addresses> = a quoted, semi-colon
separated list of email addresses
write Writes runtime configuration to permanent storage.

3: Summary of CLI Commands
EDS Device Servers Command Reference 16
Configure Menu
The following configurable parameters reside in the Configure menu.
Configure Menu
Command Description
arp <ip address> <mac
address>
Maps an IP address to a device’s MAC address.
<ip address> = IP address to be mapped.
<MAC address> = device’s MAC address.
auto show icmp Continuously displays ICMP state and statistics.
auto show ip Continuously displays IP statistics.
auto show tcp Continuously displays TCP statistics.
auto show udp Continuously displays UDP statistics.
clear arp-cache Removes all entries from the ARP table.
clear ftp counters Sets the FTP counters to zero.
clear host <host>
Removes a specified entry from the DNS cache.
<host> = IP address of the host with the DNS cache.
clear http counters Sets the HTTP counters to zero.
clear icmp counters Sets the Internet Control Message Protocol (ICMP)
counters to zero.
clear ip counters Sets the IP counters to zero.
clear ip http log Clears the HTTP server log.
clear ip ssh counters Sets the SSH counters to zero.
clear ip telnet
counters Sets the Telnet counters to zero.
clear rss Clears the RSS feed data.
clear ssh Closes an active SSH session on the EDS.
clear telnet Closes an active Telenet session on the EDS.
clear ssh counters Sets the SSH counters to zero.
clear tcp counters Sets the TCP counters to zero.
clear telnet Closes an active Telnet session on the EDS.
clear tftp counters Sets the TFTP counters to zero.

3: Summary of CLI Commands
EDS Device Servers Command Reference 17
Configure Menu
Command Description
clear udp counters Sets the UDP counters to zero.
clock set <time
(HH:MM:SS)> <day (1-
31)> <month text>
<year>
Sets the system clock.
<time (HH:MM:SS)> = time in hours, minutes, and
seconds
<day (1-31)>= day of the month
<month text> = month of the year (in text)
<year> = year (4 digits)
clock timezone Shows possible time zone names.
clock timezone <time
zone> <hour offset> Sets the displayed time zone.
<time zone> = abbreviation of time zone where EDS is
located
<hour offset> = n umber of hours off the time is from that
of the time zone. Prefix with minus sign if the time is
earlier than the time zone's.
clock timezone <time
zone> <hour offset>
<minute offset>
Sets the displayed time zone.
<time zone> = abbreviation of time zone where EDS is
located
<hour offset> = number of hours off the time is from that
of the time zone. Prefix with minus sign if the time is
earlier than the time zone's.
<minute offset> = number of minutes off the time is from
that of the time zone. Prefix with minus sign if the time is
earlier than the time zone's.
clrscrn Clears the screen.
enable password Sets the password for the Enable-level menu.
exit Exits the Configure menu and returns to the Enable
menu.
hostname <string> Sets the system hostname.
<string> = hostname to be assigned to the system.
if 1 Displays the Interface 1 menu.
ip domain name <string>
Sets the default domain name on the EDS.
<string> = default domain name.
ip ftp enable Enables the FTP server.
ip ftp password
<string> Sets the administrative password for the FTP server.
<string> = administrative password.

3: Summary of CLI Commands
EDS Device Servers Command Reference 18
Configure Menu
Command Description
ip ftp username
<string> Sets the administrative username for the FTP server.
<string> = administrative username.
ip http auth <uri>
<realm> Creates a new HTTP server authentication directive.
<uri> = URI of the server.
<realm> = domain of the server.
ip http auth type <uri>
basic
Sets an HTTP server authentication directive to the Basic
Access Authentication scheme.
<uri> = URI of the server.
ip http auth type <uri>
digest Sets an HTTP server authentication directive to the
Digest Access Authentication scheme.
<uri> = URI of the server.
ip http auth type <uri>
none
Sets the authentication type for an HTTP server
authentication directive to none.
<uri> = URI of the server.
ip http auth type <uri>
ssl
Sets the authentication type for an HTTP server
authentication directive to SSL.
<uri> = URI of the server.
ip http auth type <uri>
ssl-basic Sets the authentication type for an HTTP server
authentication directive to SSL-Basic.
<uri> = URI of the server.
ip http auth type <uri>
ssl-digest Sets the authentication type for an HTTP server
authentication directive to SSL-Digest.
<uri> = URI of the server.
ip http auth user <uri>
<user> <password>
Creates or modifies a user for an HTTP server
authentication directive.
<uri> = URI of the server.
<user> = username.
<password> = password associated with the username.
ip http log Enables HTTP server logging.
ip http log entries
<number> Sets the maximum number of HTTP server log entries.
<number> = maximum number of HTTP server log
entries.
ip http log format
<string> Sets the log format for the HTTP server.
<string> = log format.

3: Summary of CLI Commands
EDS Device Servers Command Reference 19
Configure Menu
Command Description
ip http max bytes
<bytes>
Sets the maximum number of bytes the HTTP server
accepts when receiving a request.
<bytes> = maximum number of bytes.
ip http max timeout
<seconds> Sets the maximum timeout the HTTP server waits when
receiving a request.
<seconds> = maximum timeout value.
ip http port <number>
Sets the port number.
<number> = port number.
ip http server Enables the HTTP server.
ip http ssl port
<number> Sets the SSL port number for use with the HTTP server.
<number> = SSL port number.
ip icmp enable Allows the transmission and retrieval of Internet Control
Message Protocol (ICMP) packets.
ip name-server <ip
address> Sets the primary DNS server.
<ip address> = IP address of the primary server.
ip name-server <ip
address1> <ip address2>
Sets the primary and secondary DNS servers.
<ip address1> = IP address of the primary server.
<ip address2> = IP address of the secondary server.
ip ssh enable Enable the SSH server.
ip ssh port <number>
Sets the local port for SSH that the server uses.
<number> = local port number.
ip tcp resets enable Sends TCP RSTs upon connection to unused ports.
ip telnet enable Enables and starts the Telnet server.
ip telnet port <number>
Sets the Telnet port that the server uses.
<number> = Telnet port number.
ip tftp allow file
creation Enables the automatic creation of files by the TFTP
server.
ip tftp enable Enables the TFTP server.
kill ssh <session> Closes the SSH session using the index from the show
sessions command.
kill telnet <session> Closes the Telnet session using the index from the show
sessions command.

3: Summary of CLI Commands
EDS Device Servers Command Reference 20
Configure Menu
Command Description
no arp Clears the ARP table.
no clear ftp counters Restores the FTP counters to the last aggregate value.
no clear http counters Restores the HTTP counters to the last aggregate value.
no clear icmp counters Restores the ICMP counters to the last aggregate value.
no clear ip counters Restores the IP counters to the last aggregate value.
no clear ip ssh
counters Restores the IP SSH counters to the last aggregate
value.
no clear ip telnet
counters Restores the IP Telnet counters to the last aggregate
value.
no clear tcp counters Restores the TCP counters to the last aggregate value.
no clear tftp counters Restores the TFTP counters to the last aggregate value.
no clear udp counters Restores the UDP counters to the last aggregate value.
no clock timezone Disables the timezone.
no hostname Clears the system host name.
no ip domain name Removes the IP domain name entered.
no ip ftp enable Disables the IP FTP.
no ip ftp password Removes the FTP password.
no ip ftp username Removes the FTP username.
no ip http auth <uri> Deletes an existing HTTP server authentication directive.
<uri> = URI of the HTTP server.
no ip http auth user
<uri> <user> Deletes an existing user for the specified HTTP server’s
authentication directive.
<uri> = URI of the HTTP server.
<user> = user name.
no ip http auth log Disables HTTP server logging.
no ip http auth log
format Removes the log format string for the HTTP server.
no ip http server Disables the HTTP server.
no ip icmp enable Prevents the sending or retrieval of ICMP packets.