Вы находитесь на странице: 1из 81

EDS Device Servers and

Terminal Servers
Command Reference
• EDS4100
• EDS8PR
• EDS16PR
• EDS32PR
• EDS8PS
• EDS16PS

Part Number 900-455


Revision E May 2009
Copyright & Trademark
© 2009, 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: 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 .

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

Revisions
Date Rev. Comments
October 2006 A Initial Document.
January 2007 B Updates EDSPR and EDS4100 to version 3.0.0.1.
October 2007 C Updates EDSPR and EDS4100 to version 4.0.0.0.
November 2008 D Introduces EDSPS release 1.0.0.0 and updates
EDSPR and EDS4100 to release 4.1.0.1.
May 2009 E Updates EDSPR and EDS4100 to version 4.1.0.2

EDS Command Reference 2


Contents
Copyright & Trademark ................................................................................................ 2
Contacts ....................................................................................................................... 2
Revisions ...................................................................................................................... 2

Introduction 5
Configuration Using Telnet or a Serial Port 6
Configuration Using Telnet........................................................................................... 6
Configuration Using a Serial Port ................................................................................. 6
Configuration Using the Console Port .......................................................................... 7
Navigating the Command Line Interface...................................................................... 7
Keyboard Shortcut Commands .................................................................................. 10

Summary of CLI Commands 11


Command Hierarchy .................................................................................................. 11
CLI Command Index .................................................................................................. 11
accept Level Commands............................................................................................ 12
arp Level Commands ................................................................................................. 14
chem Level Commands.............................................................................................. 14
cli Level Commands ................................................................................................... 15
configure Level Commands........................................................................................ 16
connect Level Commands.......................................................................................... 18
device Level Commands ............................................................................................ 20
disconnect Level Commands ..................................................................................... 21
enable Level Commands............................................................................................ 21
filesystem Level Commands ...................................................................................... 23
ftp Level Commands .................................................................................................. 24
host <number> Level Commands .............................................................................. 25
http Level Commands ................................................................................................ 25
icmp Level Commands............................................................................................... 27
if <instance> Interface Commands............................................................................. 28
ip Level Commands.................................................................................................... 29
ip filter Level Commands............................................................................................ 29

EDS Command Reference 3


Contents

line <line> Level Commands ...................................................................................... 30


ethernet link Level Commands................................................................................... 32
login (root) Level Commands ..................................................................................... 33
lpd Level Commands.................................................................................................. 33
lpd <line> Level Commands....................................................................................... 34
modem Level Commands .......................................................................................... 36
packing Level Commands .......................................................................................... 37
serial Level Commands.............................................................................................. 38
query port Level Commands ...................................................................................... 38
root Level Commands ................................................................................................ 39
rss Level Commands.................................................................................................. 39
ssh Level Commands................................................................................................. 40
ssl Level Commands .................................................................................................. 41
snmp Level Commands.............................................................................................. 42
syslog Level Commands ............................................................................................ 43
tcp Level Commands.................................................................................................. 44
terminal Level Commands.......................................................................................... 44
terminal network Level Commands ............................................................................ 46
tftp Level Commands ................................................................................................. 47
tunnel <line> Level Commands.................................................................................. 47
udp Level Commands ................................................................................................ 48

Configuration Using XML 50


XML Configuration Record Document Type Definition (DTD) ................................... 50
Attributes _______________________________________________________ 51
Quick Syntax Tour for XCRs ...................................................................................... 51
Record, Group, Item, and Value Tags ....................................................................... 52
Importing and Exporting an XML Configuration File .................................................. 54
Best Practices............................................................................................................. 54
Importing and Exporting Partial Configurations _________________________ 54
Including Passwords in the XML File _________________________________ 56
Special XCR Items _______________________________________________ 56
XML Groups ............................................................................................................... 56
XSR Groups and Items .............................................................................................. 70

Index 80

EDS Command Reference 4


1: Introduction
Evolution OS™, the Lantronix cutting edge operating system, supports three convenient
configuration methods (Web, command line, and XML). This Command Reference
describes how to configure Lantronix device servers running on Evolution using
Command-Line and XML interfaces.

Command Line Interface (CLI): Making the edge-to-enterprise vision a reality, Evolution
OS™ uses industry-standard tools for configuration, communication, and control. For
®
example, the Evolution OS™ uses a 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 device server.

XML-based Architecture and Device Control: XML is a fundamental building block for
the future growth of Machine-to-Machine (M2M) networks. Evolution supports XML-based
configuration records that make configuring the device server easy for users and
administrators. The XML is easily editable with a standard text editor or an XML editor.

Chapter 4 provides a brief overview of the XML interface, contains rules on basic XML
syntax, provides a guide to the interface with specific tags, and provides a guide to using
XML configuration records on the Lantronix Evolution products.

EDS Command Reference 5


2: Configuration Using Telnet or a Serial Port
As an alternative to using the Web Manager, you can configure the Lantronix Evolution
device server using a series of commands through the Command-Line Interface (CLI).
You can access the CLI through a Telnet session, an SSH session, or a direct connection
to a serial port.

This command reference describes how to use the CLI and provides a detailed list of all
the CLI commands supported.

Configuration Using Telnet


To configure the device server using a Telnet session over the network, you must first
establish a Telnet connection.

Note: As an alternative, you may establish a Telnet connection by clicking the Telnet
Configuration tab in DeviceInstaller. See the product 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 appears.

Note: Depending on the level of security you have configured, a password may be
required.

Configuration Using a Serial Port


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.

4. When an exclamation point appears on the terminal or PC screen, type xyz within 5
seconds to display the CLI prompt.

Note: Accessing the device in this way delays some initialization until this session is
closed (via exit). The CLI prompt is >> rather than > during this phase as a
reminder that the device is not fully initialized.

EDS Command Reference 6


2: Configuration Using Telnet or a Serial Port

Alternatively, you may configure a serial port to operate in command mode permanently
or under specified conditions. In these cases the CLI is available after the device
initialization is completed. See the line <line> Level command description.

Configuration Using the Console Port


The EDS 8/16/32 PR and the EDS 16/32 PS devices have a console port. This port is a
dedicated serial interface to the CLI. Connecting to the console port will always provide
access to the CLI.

To configure the Lantronix device server locally using the console 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.

Navigating the Command Line Interface


The CLI is organized into a hierarchy of levels.

 When you start a command line session, you are in the login level.

 Commands at the login level of the CLI do not affect current configuration settings.

 These commands provide diagnostic and status information only.

 To configure the device server running on Evolution, you must be in the enable level
or any of its sub-levels.

 The level structure is depicted in the following figure:

EDS Command Reference 7


2: Configuration Using Telnet or a Serial Port

Figure 2-1. CLI Hierarchy

EDS Command Reference 8


2: Configuration Using Telnet or a Serial Port

To move to a different level:

Enter the name of that level from within its parent level.

For example:
>enable
(enable)#tunnel 2
Note: Some levels require a number to indicate a level instance. In the example, the
number 2 indicates configuring the settings for tunneling on serial port 2.

To exit and return to one level higher:

Type exit and press the Enter key.

Note: Typing exit at the login level or the enable level will close the CLI session.

To view the current configuration at any level:

Type show.

To view the list of commands available at the current level:

At the command prompt, type the question mark “?”. The list of current
commands appears. (There is no need to press Enter.)

Note: Items within < > (e.g. <string>) are required parameters.

To view the available commands and their explanations:

At the command prompt, type “


* “ and press Enter.

To view the list of commands available for a partial command:

At the command prompt, type the partial command followed by the question mark
“?”. (There is no need to press Enter.)

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:

At the prompt, type the partial command followed by “


* “ and press Enter.

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 and press the Enter key.

EDS Command Reference 9


2: Configuration Using Telnet or a Serial Port

Keyboard Shortcut Commands


Typing enough characters to uniquely identify a command is a shortcut for that
command.

Tab completion: Typing some characters then typing <tab> will display the first command
that begins with those characters. Typing <tab> again will display the next command that
begins with the original characters typed. While the command is displayed, you may
press <enter> to execute the command or you may backspace to edit any parameters.

The following key combinations are allowed when configuring the device server from the
command line interface (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 from the current position to the end of the line

 Ctrl + l: redraw the command line

 Ctrl + n: display the next line in the history

 Ctrl + p: display the previous line in the history

 Ctrl + u: delete entire line and place cursor at start of prompt

 Ctrl + w: delete one word back

 Ctrl + z: a shortcut for the exit command

 Esc + b: move cursor back one word

 Esc + f: move cursor forward one word

EDS Command Reference 10


3: Summary of CLI Commands
Command Hierarchy
The hierarchy of commands is shown in Figure 2-1. CLI Hierarchy on page 8.

CLI Command Index


The commands are indexed in alphabetical order below.

Click on a page number to see the details of a command.

Command Level Page Command Level Page


accept 12 line 30
arp 14 login (root) 33
chem 14 lpd 33
cli 15 modem 36
configure 16 packing 37
connect 18 query port 38
device 20 root 39
disconnect 21 rss 39
enable 21 serial 38
ethernet link 32 ssh 40
filesystem 23 ssl 41
ftp 24 snmp 42
host 25 syslog 43
http 25 tcp 44
icmp 27 terminal 44
if 28 tftp 47
ip 29 tunnel 47
ip filter 29 udp 48

EDS Command Reference 11


3: Summary of CLI Commands

accept Level Commands


Command Path: enable>tunnel #>accept
Level Prompt: tunnel-accept:#
Where # is the line number.

The following commands are available in the accept level.

accept level commands Description


accept mode always Enables the tunneling server to always accept
tunneling connections.
accept mode any character Enables the tunneling server to accept tunneling
connections only when a
accept mode disable Disables accept mode tunneling.
accept mode modem control Enables the tunneling server to accept tunneling
asserted connections when the modem
accept mode modem Enables modem emulation for accept mode tunneling.
emulation
accept mode start character Enables accept mode tunneling when the configured
start character
aes decrypt key Sets the accept tunnel AES decrypt key allowing for
binary <binary> binary characters.
aes decrypt key set <text> Sets the accept tunnel AES decrypt key with text.
aes encrypt key Sets the accept tunnel AES encrypt key allowing for
binary <binary> binary characters.
aes encrypt key set <text> Sets the accept tunnel AES encrypt key with text.
block network disable Forwards (tunnels) network data in accept mode
tunneling.
block network enable Discards all data coming in from the accept mode
tunnel before forwarding it
block serial disable Forwards (tunnels) serial data in accept mode
tunneling.
block serial enable Discards all data coming in from the serial interface
before forwarding it
clrscrn Clears the screen.
default port Uses the default port number as the local port for
accept mode tunneling.
email connect Sets an email profile to use to send an email alert
<email profile> upon establishing
email disconnect Sets an email profile to use to send an email alert
<email profile> upon closing
exit Returns to the tunnel level.
flush serial disable Characters already in the serial data buffer are
retained upon establishing
flush serial enable Flushes the serial data buffer upon establishing an
accept mode tunneling
keep alive <seconds> Enables TCP keepalives for accept mode tunneling
and sets the timer
kill connection Disconnects the active accept mode tunneling
connection.
no aes decrypt key Removes the accept tunnel AES decrypt key.
no aes encrypt key Removes the accept tunnel AES encrypt key.

EDS Command Reference 12


3: Summary of CLI Commands

accept level commands Description


no email connect Discontinues sending email alerts upon establishing
an accept mode tunnel.
no email disconnect Discontinues sending email alerts upon closing an
accept mode tunnel.
no keep alive Disables TCP keepalives for accept mode tunneling.
password Enters the next lower level.
port <number> Sets the port to use for accept mode tunneling.
protocol ssh Uses SSH protocol for accept mode tunneling.
protocol ssl Uses SSL protocol for accept mode tunneling.
protocol tcp Uses TCP protocol for accept mode tunneling.
protocol tcp aes Uses TCP protocol with AES encryption for accept
mode tunneling.
protocol telnet Uses Telnet protocol for accept mode tunneling.
show Displays tunnel accept setings.
show history Displays the last 20 commands entered during the
current CLI session.
write Stores the current configuration in permanent memory.

EDS Command Reference 13


3: Summary of CLI Commands

arp Level Commands


Command Path: enable>config>arp
Level Prompt: config-arp
The following commands are available in the ARP level.

arp level commands Description


add <IP address> Adds an entry to the ARP table, mapping an IP address to
<MAC address> a MAC address.
clrscrn Clears the screen.
default timeout Restores the default ARP cache timeout.
exit Exits to the configuration level.
remove <IP address> Removes an entry from the ARP cache.
remove all Removes all entries from the arp cache.
show Displays the current configuration.
show cache Displays the ARP cache table.
show history Displays the last 20 commands entered during the current
CLI session.
timeout <seconds> Sets the ARP cache timeout.
write Stores the current configuration in permanent memory.

chem Level Commands


This level allows you to change email configuration settings.

Command Path: enable>chem #


Level Prompt: chem:#
Where # is an email number, up to the maximum allowed on the device.

The following commands are available in the chem level for each configurable email.

chem. level Description


commands
auto show statistics Continuously displays email statistics.
cc Sets Cc addresses for email alerts.
<email addresses> <email addresses> = a semicolon-separated list of email
addresses within
quotation marks (For example, “name1; name2”)
chem <number> Enters the configure email level.
clear log Clears all entries from the mail log.
clear mail counters Sets the email counters to zero.
clrscrn Clears the screen.
exit Exits 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 Sets the From address for email alerts.
<email address> <email address> = email address to list in the From field of the
email alert.

EDS Command Reference 14


3: Summary of CLI Commands

chem. level Description


commands
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 Removes the Cc addresses for email alerts.
no clear mail Restores the email counters to the aggregate values.
counters
no file Removes the file name, leaving so the body empty.
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.
overriding Sets a domain name that will be used when connecting to an
domain <domain> 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.
Reply to Sets Reply-To address for email alerts.
<email address> <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 placed as the subject.
to Sets email address to which the email alerts will be sent.
<email addresses> <email addresses> = a quoted, semi-colon separated list of
email addresses.
write Stores the current configuration in permanent memory.

cli Level Commands


Command Path: enable>cli
Level Prompt: cli
The following commands are available in the cli level.

cli level commands Description

EDS Command Reference 15


3: Summary of CLI Commands

cli level commands Description


clear ssh counters Sets the SSH counters to zero.
clear telnet counters Sets the Telnet counters to zero.
clrscrn Clears the screen.
default quit connect line Restores the default string used to quit the "connect line
<line>" command.
enable level password Sets or removes the enable-level password by challenging
and prompting.
exit Exits to the configuration level.
login password Sets or removes the CLI login password by challenging and
prompting.
no clear ssh counters Restores the IP SSH counters to the aggregate values.
no clear telnet counters Restores the IP Telnet counters to the aggregate values.
quit connect Sets the string used to quit the "connect line <line>"
line <string> command.
show history Displays the last 20 commands entered during the current
CLI session.
show ssh Displays the SSH server settings.
show telnet Displays the Telnet settings and statistics.
ssh disable Disables the SSH Server.
ssh enable Enables the SSH Server.
ssh max Sets the maximum allowed concurrent incoming SSH
sessions <number> sessions.
<number> = number of sessions.
ssh port <number> Sets the local port that the SSH server uses.
<number> = local port number.
telnet disable Disables the Telnet Server.
telnet enable Enables the Telnet Server.
telnet max Sets the maximum concurrent incoming Telnet sessions.
sessions <number> <numbers> = number of sessions.
telnet port <number> Sets the local port that the Telnet server uses.
<number> = local port number.
write Stores the current configuration in permanent memory.

configure Level Commands


Command Path: enable>config
Level Prompt: config
The following commands are available in the configure level.

config level Description


commands
arp Changes to the command level for ARP configuration and
status.
clear host <host> Removes an entry from the DNS Cache
cli Change to menu level for CLI configuration and status
clock Sets the system clock.
set <time(hh:mm:ss)>
<day (1-31)> <month
text> <year>

EDS Command Reference 16


3: Summary of CLI Commands

config level Description


commands
clock timezone Shows possible time zone names.
clock timezone <time Sets the timezone to be displayed.
zone> <hour offset>
clock timezone <time Sets the timezone to be displayed.
zone> <hour
offset> <minute
offset>
clrscrn Clears the screen.
default clock timezone Restores the default timezone, which is GMT.
exit Exits to the enable level.
ftp Enters the ftp level.
host <number> Change to config host level
http Enters the http level.
icmp Changes to the command level for ICMP configuration and
status.
if <instance> Changes to the interface configuration level.
ip Changes to the command level for IP configuration and
status.
ip filter Enters the config-filter level.
kill ssh <session> Kills SSH session with index from "show sessions"
kill telnet <session> Kills Telnet session with index from "show sessions"
lpd <line> Enters the configure lpd level.
<line> = number of the line (lpd serial port) to be configured.
query port Enters the query port level.
rss Change to menu level for RSS configuration and status
show Displays system information.
show clock Displays the system clock.
show history Displays the last 20 commands entered during the current
CLI session.
show lines Displays line information.
snmp Enters the snmp level.
syslog Enters the syslog level.
tcp Changes to the command level for TCP configuration and
status.
terminal <line> Enters the configure-terminal level.
<line> = number of the terminal line (serial port) to be
configured.
terminal network Enters the configure-terminal level for the network.
tftp Enters the tftp level.
udp Changes to the command level for UDP configuration and
status.
write Stores the current configuration in permanent memory.

EDS Command Reference 17


3: Summary of CLI Commands

connect Level Commands


Command Path: enable>tunnel #> connect
Level Prompt: connect
Where # is the line number.

The following commands are available in the connect level.

connect level Description


commands
aes decrypt key Sets the connect tunnel AES decrypt key with up to 16 bytes.
binary <hexadecimal> Each byte is represented by two adjacent hex digits.
Bytes may run together or be separated by optional punctuation:
123ABC "12 3A BC" 12,3A,BC 12.3a.bc 12:3a:bc
Note that quotes must enclose the value if it contains spaces.
aes decrypt key Sets the connect tunnel AES decrypt key with up to 16 bytes.
set <text> Each byte is represented by a single character.
Note that quotes must enclose the value if it contains spaces.
aes encrypt key Sets the connect tunnel AES encrypt key with up to 16 bytes.
binary <hexadecimal> Each byte is represented by two adjacent hex digits.
Bytes may run together or be separated by optional punctuation:
123ABC "12 3A BC" 12,3A,BC 12.3a.bc 12:3a:bc
Note that quotes must enclose the value if it contains spaces.
aes encrypt key Sets the connect tunnel AES encrypt key with up to 16 bytes.
set <text> Each byte is represented by a single character.
Note that quotes must enclose the value if it contains spaces.
block network disable Forwards (tunnels) network data in connect mode tunneling.
block network enable Discards all data coming in from the serial interface before
forwarding
it to the connect mode tunnel (generally used for debugging).
block serial disable Forwards (tunnels) serial data in connect mode tunneling.
block serial enable Discards all data coming in from the serial interface before
forwarding it
clrscrn Clears the screen.
connect mode always Enables the tunneling server to always establish tunneling
connections.
connect mode any Enables the tunneling server to establish a tunneling connection
character when a
character is received on the corresponding line (serial port).
connect mode disable Disables connect mode tunneling.
connect mode modem Enables the tunneling server to make tunneling connections when
control asserted the modem
control pin is asserted.
connect mode modem Enables modem emulation for connect mode tunneling.
emulation
connect mode start Enables connect mode tunneling when the configured start
character character
is received on the line.
default connect mode Restores the default connect mode as "disable".
default local port Uses a random port number as the local port for establishing
tunneling connections to other devices.
default protocol Restores the default protocol as "TCP".

EDS Command Reference 18


3: Summary of CLI Commands

connect level Description


commands
default reconnect time Restores the default reconnect time value for connect mode
tunneling.
default tcp keep alive Restores the default 45 second connect mode TCP keep alive
timeout.
email connect Sets an email profile to use to send an email alert upon
<number> establishing
a connect mode tunnel.
<number> = the number of the email profile to use.
email disconnect Sets an email profile to use to send an email alert upon closing
<number> a connect mode tunnel.
<number> = the number of the email profile to use.
exit Returns to the tunnel level.
flush serial disable Characters already in the serial data buffer are retained upon
establishing
a connect mode tunneling connection.
flush serial enable Flushes the serial data buffer upon establishing a connect mode
tunneling
connection.
kill connection Disconnects the active connect mode tunneling connection.
local port <number> Sets a specific port for use as the local port.
<number> = the number of the port to use.
no aes decrypt key Removes the connect tunnel AES decrypt key.
no aes encrypt key Removes the connect tunnel AES encrypt key.
no email connect Discontinues sending email alerts upon establishing a connect
mode tunnel.
no email disconnect Discontinues sending email alerts upon closing a connect mode
tunnel.
no keep alive Disables TCP keepalives for connect mode tunneling.
no local port Uses a random port number as the local port for establishing
tunneling
no remote address Removes the remote host address used to establish tunneling
connections.
no remote port Removes the remote port used to establish tunneling connections.
no ssh username Removes the SSH user name.
no tcp keep alive Disables the connect mode TCP keep alive timeout.
protocol ssh Uses SSH protocol for connect mode tunneling.
protocol ssl Uses SSL protocol for connect mode tunneling.
protocol tcp Uses TCP protocol for connect mode tunneling.
protocol tcp aes Uses TCP protocol with AES encryption for connect mode
tunneling.
protocol telnet Uses Telnet protocol for connect mode tunneling.
protocol udp Uses UDP protocol for connect mode tunneling.
protocol udp aes Uses UDP protocol with AES encryption for connect mode
tunneling.
reconnect time Sets the reconnect time value for tunneling connections
<milliseconds> established by the
device in milliseconds.
<milliseconds> = timeout in milliseconds.
remote address<text> Sets the remote host to establish tunneling connections with.
<text> = IP address or host name of the remote host.
remote port Sets the remote port to use for connect mode tunneling.

EDS Command Reference 19


3: Summary of CLI Commands

connect level Description


commands
<number> <number> = number of the port to use.
show Displays tunnel connect settings.
show history Displays the last 20 commands entered during the current CLI
session.
show status Displays tunnel connect status.
ssh username Sets the SSH user name for use when establishing tunneling
<text> connections
with other devices.
<text> = SSH user name.
tcp keep alive Enables TCP keep alive for connect mode tunneling and sets the
<milliseconds> timer.
<milliseconds> = timer value, in milliseconds.
write Stores the current configuration in permanent memory.

device Level Commands


Command Path: enable>device
Level Prompt: device
The following commands are available in the device level.

device Level commands Description


auto show tlog Continuously displays the internal trouble log.
auto show upload Continuously displays the status of
firmware/bootloader upload.
clrscrn Clears the screen.
default long name Restores the default product long name.
default short name Restores the default product short name.
exit Exit to the enable level.
long name <name> Sets the product long name, displayed in command
mode and the Web interface.
short name <name> Sets the product short name, displayed in command
mode and the Web interface.
show Show system information
show buffer pool Displays information about the various buffer pools.
show codefile memory Displays memory utilization by code files.
show delta memory Displays differences in memory utilization by code
files or line reference.
show eds8ps Show system information
show hardware information Displays information about the hardware.
show history Displays the last 20 commands entered during the
current CLI session.
show linereference Displays memory utilization by line reference for one
memory <code filename> code file.
show lines Show line information
show memory Displays current memory usage information.
show task memory Displays task memory utilization.
show task state Displays current task states.
show tlog Displays the internal trouble log.

EDS Command Reference 20


3: Summary of CLI Commands

device Level commands Description


show upload Displays the status of firmware/bootloader upload.
write Stores the current configuration in permanent
memory.

disconnect Level Commands


Command Path: enable>tunnel #>disconnect
Level Prompt: disconnect
Where # is the line number.

The following commands are available in the disconnect level.

disconnect level Description


commands
character stop disable Does not watch for a stop character to disconnect.
character stop enable Watches for a stop character to disconnect.
clrscrn Clears the screen.
exit Returns to the tunnel level.
flush serial disable Does not flush serial data upon closing a tunneling
connection.
flush serial enable Flushes serial data buffer when a tunneling connection is
closed.
modem control disable Does not watch the modem control pin to disconnect.
modem control enable Watches the modem control pin and disconnects if it is not
asserted.
no timeout Disables disconnect after timeout feature for tunneling
sessions.
show Displays the current configuration.
show history Displays the last 20 commands entered during the current
CLI session.
timeout Disconnects when no data has been received on the line
<milliseconds> (serial port) for the
specified length of time.
<milliseconds> = timeout in milliseconds.
write Stores the current configuration in permanent memory.

enable Level Commands


Command Path: root>enable
Level Prompt: enable
The following commands are available in the enable level.

enable level commands Description


auto show interfaces Show interface statistics
auto show processes Continuously show thread runtime information
auto show xsr Show XML Status Record counters
chem <number> Enters the configure email level.

EDS Command Reference 21


3: Summary of CLI Commands

enable level commands Description


clear interfaces counters Zeros interface session counters
clear query port counters Zeros Query Port counters
clear xsr counters Zeros XML Status Record counters
clrscrn Clears the screen.
configure Enters the configuration level.
connect Show name and number for lines
connect line <line> Begin session on serial port
device Enters the device level.
disable Exits the enable level.
exit Exit from the system
filesystem Enters the filesystem level.
kill line <line> Kills command mode session on the Line
kill ssh <session> Kills SSH session with index from "show sessions"
kill telnet <session> Kills Telnet session with index from "show sessions"
line <line> Enters the line level.
<line> = number of the line (serial port) to be
configured.
lpd Enters the lpd level.
no clear interfaces counters Unzeros interface session counters
no clear query port counters Unzeros Query Port counters
no clear xsr counters Unzeros XML Status Record counters
nslookup Lookup host information for the given host name
nslookup <host> Return host information for the given host name
ping <host> Ping destination 5 times with 5 second timeout
ping <host> <count> Ping destination n times with 5 second timeout
ping <host> <count> Ping destination n times with x timeout (in seconds)
<timeout>
reload Reboot system
reload factory defaults Reload factory defaults to permanent storage
show Show system information
show eds8ps Show system information
show history Displays the last 20 commands entered during the
current CLI session.
show hosts Show domain settings
show interfaces Show interface statistics
show ip sockets Show UDP/TCP state information
show lines Show line information
show processes Show thread runtime information
show sessions Show active Telnet and SSH Sessions
show xsr Show XML Status Record counters
ssh Enters the SSH configuration level.
ssh <host> <port> Begin session on network <host>:<port> as
<username> <username>
ssh <host> <username> Begin session on network <host> as <username>
ssl Enters the SSL configuration level.
telnet <host> Begin session on network <host>
telnet <host> <port> Begin session on network <host>:<port>
trace route <host> Trace route to destination
tunnel <line> Enters the tunnel level.
<line> = number of the tunnel line (serial port) to be
configured.

EDS Command Reference 22


3: Summary of CLI Commands

enable level commands Description


write Stores the current configuration in permanent
memory.
xcr dump Dump XML configuration to the console
xcr dump <group list> Dump specified XML configuration to the console
xcr export <file> Save XML configuration to a file
xcr export <file> <group list> Save specified XML configuration to a local file
xcr import <file> Load XML configuration from a local file
xcr import <file> <group list> Load specified XML configuration from a local file
xcr list List XML Configuration Record groups to the console
xsr dump Dump XML Status Records to the console
xsr dump <group list> Dump specified XML Status Records to the console
xsr export <file> Save XML Status Record to a file
xsr export <file> <group list> Save specified XML Status Record to a local file
xsr list List XML Status Record groups to the console

filesystem Level Commands


Command Path: enable>filesystem
Level Prompt: filesystem
The following commands are available in the filesystem level. This level allows for the
management of files in the EDS.

filesystem level commands Description


cat <file> Show the contents of a file
cd <directory> Change the current directory to the
specified directory
clrscrn Clears the screen.
compact Compact the file system, freeing all dirty
space
cp <source file> Copy an existing file
<destination file>
dump <file> Show contents of a file as a hex dump
exit Exits to the enable level.
format Format the file system and lose all data
ls Show all files and directories in the current
directory
ls <directory> Show all file and directories in the specified
directory
mkdir <directory> Create a directory
mv <source file> <destination file> Move a file on the file system
pwd Print working directory
rm <file> Remove a file
rmdir <directory> Remove a directory
show Show file system statistics
show history Displays the last 20 commands entered
during the current CLI session.
show tree Show all files and directories from current
directory
tftp get ascii <source file> Get an ascii file using TFTP

EDS Command Reference 23


3: Summary of CLI Commands

filesystem level commands Description


<destination file> <host>
tftp get ascii Get an ascii file using TFTP
<source file>
<destination file> <host> <port>
tftp get binary <source file> Get a binary file using TFTP
<destination file> <host>
tftp get binary <source file> Get a binary file using TFTP
<destination file> <host> <port>
tftp put ascii <source file> Put an ascii file using TFTP
<destination file> <host>
tftp put ascii <source file> Put an ascii file using TFTP
<destination file> <host> <port>
tftp put binary <source file> Put a binary file using TFTP
<destination file> <host>
tftp put binary <source file> Put a binary file using TFTP
<destination file> <host> <port>
touch <file> Create a file

ftp Level Commands


Command Path: enable>config>ftp
Level Prompt: config-ftp
The following commands are available in the ftp level.

ftp level commands Description


admin password <string> Sets the administrative password for the FTP server.
<string> = administrative password.
admin username <string> Sets the administrative username for the FTP server.
<string> = administrative username.
clear counters Zeros FTP counters.
clrscrn Clears the screen.
default admin password Resets the FTP password to the default (PASS).
default admin username Resets the FTP username to the default (admin).
exit Returns to the config level.
no clear counters Unzeros FTP counters.
show Displays the FTP settings and statistics.
show history Displays the last 20 commands entered during the current
CLI session.
state disable Disables the FTP server.
state enable Enables the FTP server.
write Stores the current configuration in permanent memory.

EDS Command Reference 24


3: Summary of CLI Commands

host <number> Level Commands


Command Path: enable>config>host #
Level Prompt: config-host:#
Where # is the host number, 1 or 2.

The following commands are available in the host level.

host level commands Description


clrscrn Clears the screen.
default protocol Restores the default value of the protocol (Telnet).
default remote port Sets the remote port (used to connect to the host) to the
default value,
which depends on the selected protocol.
exit Exits to the configuration level.
host <number> Change to config host level
name <text> Sets the name of the host.
no name Clears the name of the host.
no remote address Clears the remote address of the host.
no remote port Sets the remote port (used to connect to the host) to the
default value,
no ssh username Clears the SSH username associated with the host.
protocol ssh Sets the protocol to SSH.
protocol telnet Sets the protocol to Telnet.
remote address <text> Sets the IP address of the remote host to connect to when
this host is
selected on the login connect menu.
<text> = IP address.
remote port <number> Sets the remote port used to connect to the host.
<number> = port to be used.
show Displays the current configuration.
show history Displays the last 20 commands entered during the current
CLI session.
ssh username <text> Sets the username for logging into the host via SSH.
write Stores the current configuration in permanent memory.

http Level Commands


Command Path: enable>config>http
Level Prompt: config-http
The following commands are available in the http level.

http level commands Description


auth <uri> <realm> Creates a new HTTP server authentication directive.
<uri> = URI of the server.
<realm> = domain of the server.
auth type <uri> basic Sets an HTTP server authentication directive to the Basic
Access

EDS Command Reference 25


3: Summary of CLI Commands

http level commands Description


Authentication scheme.
<uri> = URI of the server.
auth type <uri> digest Sets an HTTP server authentication directive to the Digest
Access
Authentication scheme.
<uri> = URI of the server.
auth type <uri> none Sets the authentication type for an HTTP server
authentication directive to
none.
<uri> = URI of the server.
auth type <uri> ssl Sets the authentication type for an HTTP server
authentication directive to SSL.
<uri> = URI of the server.
auth type <uri> ssl-basic Sets the authentication type for an HTTP server
authentication directive
to SSL-Basic.
<uri> = URI of the server.
auth type <uri> ssl-digest Sets the authentication type for an HTTP server
authentication directive
to SSL-Digest.
<uri> = URI of the server.
auth user <uri> <user> Creates or modifies a user for an HTTP server
<password> authentication directive.
<uri> = URI of the server.
<user> = username.
<password> = password associated with the username.
clear counters Sets the HTTP counters to zero.
clear log Clears the HTTP server log.
clrscrn Clears the screen.
default log format Restores the HTTP Server log format string to its default
value.
default log max entries Restores the default maximum number of HTTP Server
log entries.
default max bytes Resets the default maximum bytes the HTTP Server will
accept when receiving
default max timeout Resets the default maximum time the HTTP Server will
wait when receiving a request.
default port Resets the HTTP Server port to its default value.
default ssl port Resets the HTTP Server SSL port to its default value.
delete auth <uri> Deletes an existing HTTP Server authentication directive.
<uri> = URI of the server.
delete auth Deletes an existing user for an HTTP Server
user <uri> <user> authentication directive.
<uri> = URI of the server.
<user> = username.
exit Returns to the config level.
log disable Disables HTTP server logging.
log enable Enables HTTP server logging.
log format <string> Sets the log format string for the HTTP server, using the
following
directives:
%a remote ip address (could be a proxy)
%b bytes sent excluding headers

EDS Command Reference 26


3: Summary of CLI Commands

http level commands Description


%B bytes sent excluding headers (0 = '-')
%h remote host (same as %a)
%{h}i header contents from request (h = header string)
%m request method
%p ephemeral local port value used for request
%q query string (prepend with '?' or empty '-')
%t timestamp HH:MM:SS (same as Apache
'%(%H:%M:%S)t')
%u remote user (could be bogus for 401 status)
%U URL path info
%r first line of request (same as '%m %U%q <version>')
%s return status
max bytes <bytes> Sets the maximum number of bytes the HTTP server
accepts when receiving a request.
max timeout <seconds> Sets the maximum timeout the HTTP server waits when
receiving a request.
<seconds> = maximum timeout value.
no clear counters Restores the HTTP counters to the aggregate values.
port <number> Sets the port number the HTTP server will use.
<number> = port number.
server disable Disables the HTTP server.
server enable Enables the HTTP server.
show Displays the HTTP server settings.
show auth Displays the HTTP server authentication settings.
show history Displays the last 20 commands entered during the current
CLI session.
show log Displays the HTTP server log.
show statistics Displays the HTTP statistics.
ssl port <number> Sets the port number the HTTP server will use over SSL.
<number> = port number.
ssl3 disable Disables SSLv3 handling.
ssl3 enable Enables SSLv3 handling.
tls1.0 disable Disables TLSv1.0 handling.
tls1.0 enable Enables TLSv1.0 handling.
tls1.1 disable Disables TLSv1.1 handling.
tls1.1 enable Enables TLSv1.1 handling.
write Stores the current configuration in permanent memory.

icmp Level Commands


Command Path: enable>config>icmp
Level Prompt: config-icmp
The following commands are available in the icmp level.

icmp level Description


commands
auto show stats Continuously shows ICMP statistics
clear counters Zeros counters
clrscrn Clears the screen.

EDS Command Reference 27


3: Summary of CLI Commands

icmp level Description


commands
exit Exits to the configuration level.
no clear Unzeros IP counters
counters
show Displays the current configuration.
show history Displays last 20 commands entered during this CLI session.
show stats Shows ICMP statistics
state disable Prevents ICMP packets from being sent or received.
state enable Allows ICMP packets to be sent and received.
write Stores the current configuration in permanent memory.

if <instance> Interface Commands


Command Path:
enable>configure>if 1
—Or—
enable>configure>if eth0
Level Prompt:
config-if:eth0
The following commands are available in the if level.

if interface commands Description


bootp disable Disables BOOTP.
bootp enable Enables BOOTP.
clear host <string> Removes an entry from the DNS Cache
clrscrn Clears the screen.
default gateway <IP address> Sets the configurable gateway IP address to the
default value.
dhcp client id binary <binary> Sets the client id allowing binary characters.
Within [] use binary decimal up to 255 or hex up to
0xFF.
dhcp client id set <text> Sets the client id in text format.
dhcp disable Disables DHCP.
dhcp enable Enables DHCP.
dhcp renew Force DHCP to renew
domain <text> Sets the domain name.
<text> = name of the domain.
exit Exits to the config level.
hostname <text> Sets the host name.
<text> = name of the host.
ip address <ip address/cidr> Sets the IP address and network mask.
Formats accepted:
192.168.1.1 (default mask)
192.168.1.1/24 (CIDR)
"192.168.1.1 255.255.255.0" (explicit mask)
link Enter link configuration level

EDS Command Reference 28


3: Summary of CLI Commands

if interface commands Description


no default gateway Clears the default gateway.
no dhcp client id Clears the DHCP client ID.
no domain Clears the domain name.
no hostname Clears the host name.
no ip address Clears the IP address.
no primary dns Clears the name of the primary DNS server.
no secondary dns Clears the name of the secondary DNS server.
primary dns <IP address> Sets the IP address of the primary DNS server.
secondary dns <IP address> Sets the IP address of the secondary DNS server.
show Displays the current configuration.
show history Displays the last 20 commands entered during the
current CLI session.
show status Show interface status
write Stores the current configuration in permanent
memory.

ip Level Commands
Command Path: enable>config>ip
Level Prompt: config-ip
The following commands are available at the ip level.

ip level commands Description


auto show stats Continuously shows IP statistics
clear counters Zeros counters
clrscrn Clears the screen.
default multicast time to Restores the default IP multicast time to live, which is
live one hop.
exit Exits to the configuration level.
multicast time to Sets the IP multicast time to live.
live <hops> <hops> = number of hops that a multicast IP packet is
allowed to live.
no clear counters Unzeros IP counters
show Displays the current configuration.
show history Displays the last 20 commands entered during the
current CLI session.
show stats Shows IP statistics
write Stores the current configuration in permanent memory.

ip filter Level Commands


Command Path: enable>config>ip filter
Level Prompt: config-filter
The following commands are available at the ip filter level.

ip filter level Description


commands

EDS Command Reference 29


3: Summary of CLI Commands

ip filter level Description


commands
add <ip address> Adds an entry to the IP filter table.
<subnet mask>
clrscrn Clears the screen.
exit Returns to the config level.
remove <ip address> Removes an entry from the IP filter table.
<subnet mask>
show Displays the IP filter table.
show history Displays the last 20 commands entered during the current
CLI session.
write Stores the current configuration in permanent memory.

line <line> Level Commands


Command Path: enable>line #
Level Prompt: line:#
Where # is the serial port number. Valid numbers are from 1 to the number of serial ports.
For devices with a console port, use one greater than the last serial port. For example, to
set the configuration for the console port on an EDS 8 PR, use the line 9 command to
enter the console serial port configuration level.

The following commands are available in the line level. These commands configure the
corresponding serial ports.

line level commands Description


auto show statistics Continuously displays line statistics.
baud rate <bits per second> Sets the line speed.
<bits per second> = any rate between 300 and
230400.
clear line counters Sets the serial counters to zero.
clrscrn Clears the screen.
command mode always Sets the current line to always be in command mode.
command mode echo serial Disables user-defined serial boot string to be echoed
string disable in the CLI.
command mode echo serial Enables user-defined serial boot string to be echoed
string enable in the CLI.
command mode serial string Enables user to enter a custom string at boot time to
enter command mode.
command mode serial Sets a string that can be entered at boot time to enter
string <string> command mode.
<string> = text.
command mode serial string Sets a binary string that can be entered at boot time
binary <string> to enter command mode.
<string> = string that may contain binary characters.
Within [] use binary decimal up to 255 or hex up to
0xFF.
command mode signon Sets an ASCII sign-on message that is sent from the

EDS Command Reference 30


3: Summary of CLI Commands

line level commands Description


message <string> serial port when the
device boots and when the line is in command mode.
<string> = text.
command mode signon Sets a binary sign-on message that is sent from the
message binary <string> serial port when the
device boots and when the line is in command mode.
<string> = string that may contain binary characters.
Within [] use binary decimal up to 255 or hex up to
0xFF.
command mode wait Sets boot-up wait time for command mode serial
time <milliseconds> string.
<milliseconds> = wait time.
data bits 7 Uses seven bits for data on the line.
data bits 8 Uses eight bits for data on the line.
default baud rate Restores the default speed of 9600 bits per second.
default data bits Restores the default of eight data bits.
default flow control Restores the default of no flow control.
default parity Restores the default of no parity.
default protocol Restores the default protocol on the line.
default stop bits Restores the default of one stop bit.
default xoff char Restores the default xoff character on this line.
default xon char Restores the default xon character on this line.
exit Exits to the enable level
flow control hardware Uses hardware (RTS/CTS) flow control on the line.
flow control none Does not provide flow control on the line.
flow control software Uses software (xon/xoff characters) flow control on
the line.
line <line> Enters the line level.
<line> = number of the line (serial port) to be
configured.
lpd <line> Enters the configure lpd level.
<line> = number of the line (lpd serial port) to be
configured.
name <text> Sets the name for this line.
no clear line counters Restores the serial counters to the aggregate values.
no command mode Disables command mode for the current line.
no command mode serial Prevents the user-defined serial boot string from
string being used to enter
command mode in the CLI.
no command mode signon Clears the signon message displayed at boot time
message and when entering
command mode.
no name Removes the name of this line.
parity even Uses a parity bit on the line for even parity.
parity none Does not use a parity bit on the line.
parity odd Uses a parity bit on the line for odd parity.
protocol lpd Applies Line Printer Daemon (LPD) protocol on the
line.
Applies LPD or tunnel protocol on the line.
protocol lpd or tunnel Could not find VarID 268 entry 4 in file
http/config/varid_help.mtxt
protocol none Uses no protocol on the line.

EDS Command Reference 31


3: Summary of CLI Commands

line level commands Description


protocol tunnel Applies tunnel protocol on the line.
reassert Asserts line status with current configured values.
show Displays the current status.
show command mode Shows the command mode settings for the current
line.
show history Displays the last 20 commands entered during the
current CLI session.
show line Displays the current configuration.
show statistics Shows the line statistics.
state disable Disables the line so data cannot be sent/received.
state enable Enables the line so data can be sent/received.
stop bits 1 Uses one stop bit after data on the line.
stop bits 2 Uses two stop bits after data on the line.
terminal <line> Enters the configure-terminal level.
<line> = number of the terminal line (serial port) to be
configured.
terminal network Enters the configure-terminal level for the network.
tunnel <line> Enters the tunnel level.
<line> = number of the tunnel line (serial port) to be
configured.
write Stores the current configuration in permanent
memory.
xoff char <control> Sets the xoff character for use with software flow
control on this line.
The character may be input as text, control, decimal,
or hex.
A control character has the form <control>C.
A decimal value character has the form \99.
A hex value character has the form 0xFF.
xon char <control> Sets the xon character for use with software flow
control on this line.
The character may be input as text, control, decimal,
or hex.
A control character has the form <control>C.
A decimal value character has the form \99.
A hex value character has the form 0xFF.

ethernet link Level Commands


Command Path: enable>config>if 1>link
Level Prompt: config-ethernet:eth0
The following commands are available in the Ethernet link level.

link level Description


commands
clrscrn Clears the screen.
default duplex Restores the default duplex setting, which is auto.
default speed Restores the default speed setting, which is auto-negotiate.
duplex auto Sets duplex mode to auto.
duplex full Sets duplex mode to full.

EDS Command Reference 32


3: Summary of CLI Commands

link level Description


commands
duplex half Sets duplex mode to half.
exit Exit back to interface configuration level
show Displays the current configuration.
show history Displays the last 20 commands entered during the current CLI
session.
speed 10 Sets the speed of the Ethernet link to 10 Mbps.
speed 100 Sets the speed of the Ethernet link to 100 Mbps.
speed auto Sets the speed of the Ethernet link to auto-negotiate.
write Stores the current configuration in permanent memory.

login (root) Level Commands


(Also listed under root level commands, page 39.)

The following is a list of login (root) level commands.

These commands do not alter the configuration of the device server.

root level commands Description


clrscrn Clears the screen.
enable Enters the enable level.
exit Exit from the system
ping <host> Ping destination 5 times with 5 second timeout
ping <host> <count> Ping destination n times with 5 second timeout
ping <host> <count> Ping destination n times with x timeout (in seconds)
<timeout>
show Show system information
show eds8pr Show system information
show history Displays the last 20 commands entered during the
current CLI session.
show lines Show line information
trace route <host> Trace route to destination

lpd Level Commands


There are two levels having to do with LPD.

 The LPD level

 The LPD <line> level

LPD Level commands do not allow the configuration of any LPD properties. You can only
view status, view statistics, and kill print jobs.

LPD <line> commands allow you to

 Configure LPD properties for a given line.

EDS Command Reference 33


3: Summary of CLI Commands

 Enter the configure level and then the configure-LPD level with the lpd <line>
command.

Command Path: enable>lpd


Level Prompt: lpd
The following is a list of commands available in the lpd level.

lpd level Description


commands
auto show Continuously displays lpd status for the specified line.
<line> <line> = LPD line to display.
clrscrn Clears the screen.
exit Exits to the enable level.
kill <line> Kills the current print job on the specified line.
<line> = LPD line with print job.
show <line> Displays lpd status for the specified line.
<line> = LPD line to display.
show history Displays the last 20 commands entered during the current CLI
session.

lpd <line> Level Commands


Command Path: enable>config>lpd #
Level Prompt: config-lpd:#
Where # is the line number 1 or 2.

The following is a list of commands available in the lpd <line> level.

lpd <line> level Description


commands
banner disable Disables printing banner for all print jobs. Only print the
banner when a
job requests it.
banner enable Enables printing banner for all print jobs.
binary disable Treats print job as ascii text. Filters out all non-ascii
characters and
certain control characters.
binary enable Treats print job as binary. Sends data byte-for-byte to
the printer.
capture disable Redirects serial output back to the line.
capture enable Redirects serial output from the line to this CLI session.
clrscrn Clears the screen.
convert newline disable Disables converting single new line and carriage return
characters to
DOS-style line endings.
convert newline enable Enables converting single new line and carriage return
characters to
DOS-style line endings. If characters are already in DOS
line-ending order,
they are not converted.

EDS Command Reference 34


3: Summary of CLI Commands

lpd <line> level Description


commands
eoj disable Disables sending the end-of-job string after each print
job.
eoj enable Enables sending the end-of-job string after each print
job.
eoj text binary <binary> Sets the end-of-job text allowing for binary characters.
<binary> = string in binary format that will be sent to the
printer at the
end of each print job.
Within [] use binary decimal up to 255 or hex up to 0xFF.
eoj text set <text> Sets the end-of-job text.
<text> = ascii string that will be sent to the printer at the
end of each
print job.
exit Exits to the configuration level.
formfeed disable Disables the printer from advancing to the next page at
the end of each
print job.
formfeed enable Forces the printer to advance to the next page at the end
of each print job.
kill Ends the current print job on this lpd line.
line <line> Enters the line level.
<line> = number of the line (serial port) to be configured.
lpd <line> Enters the configure lpd level.
<line> = number of the line (lpd serial port) to be
configured.
no eoj text Removes the end-of-job string.
no queue name Removes the queue name.
no soj text Removes the start-of-job string.
queue name <text> Sets the name of the queue that this lpd line belongs to
<text> = name for the queue.
show Displays the current configuration.
show history Displays the last 20 commands entered during the
current CLI session.
show statistics Displays statistics and status information for this lpd line.
soj disable Disables sending the start-of-job string after each print
job.
soj enable Enables sending the start-of-job string after each print
job.
soj text binary <binary> Sets the start-of-job text allowing for binary characters.
<binary> = string in binary format that will be sent to the
printer at the
beginning of each print job.
Within [] use binary decimal up to 255 or hex up to 0xFF.
soj text set <text> Sets the start-of-job text.
<text> = ascii string that will be sent to the printer at the
beginning of
each print job.
terminal <line> Enters the configure-terminal level.
<line> = number of the terminal line (serial port) to be
configured.
terminal network Enters the configure-terminal level for the network.
test print Prints lines of text directly to the lpd line.

EDS Command Reference 35


3: Summary of CLI Commands

lpd <line> level Description


commands
<number of lines> <number of lines> = number of lines to print.
tunnel <line> Enters the tunnel level.
<line> = number of the tunnel line (serial port) to be
configured.
write Stores the current configuration in permanent memory.

modem Level Commands


Command Path: enable>tunnel #>modem
Level Prompt: tunnel-modem:#
Where # is the line number.

The following is a list of commands available in the modem level.

modem level Description


commands
clrscrn Clears the screen.
connect string <text> Sets the CONNECT string used in modem emulation.
<string> = connect string.
default incoming Default disables incoming network connections.
connection
default response type Default uses text type responses.
display remote ip disable The incoming RING has nothing following it.
display remote ip enable The incoming RING is followed by the IP address of the
caller.
echo commands disable Does not echo modem commands.
echo commands enable Echoes modem commands.
echo pluses disable Does not echo the +++ characters when entering modem
command mode.
echo pluses enable Echoes the +++ characters when entering modem
command mode.
error unknown commands Returns OK on unknown AT commands.
disable
error unknown commands Returns an error upon unknown AT commands.
enable
exit Returns to the tunnel level.
incoming connection Automatically answer incoming network connections.
automatic
incoming connection Disable incoming network connections.
disabled
incoming connection Wait for an ATA command before answering an incoming
manual network connection.
no connect string Removes optional CONNECT string information for
modem emulation.
reassert Asserts tunnel modem status with current configured
values.
response type numeric Uses numeric type responses.
response type text Uses text type responses.

EDS Command Reference 36


3: Summary of CLI Commands

show Displays the current configuration.


show history Displays the last 20 commands entered during the current
CLI session.
status Displays tunnel modem status.
verbose response disable Does not send Modem Response Codes.
verbose response enable Sends Modem Response Codes out on the Serial Line.
write Stores the current configuration in permanent memory.

packing Level Commands


Command Path: enable>tunnel #> packing
Level Prompt: tunnel-packing:#
Where # is the line number.

The following is a list of commands available in the packing level.

packing level Description


commands
clrscrn Clears the screen.
default packing mode Sets to default packing mode, which is "Disable"
default threshold Restores the default threshold.
default timeout Restores the default packing mode timeout.
exit Returns to the tunnel level.
no send character Removes the send character for packing mode.
no trailing character Removes the trailing character for packing mode.
packing mode disable Disables packing. Data is sent to the network when
received.
packing mode send Sets packing mode to accumulate data and transmit it
character upon receiving the
configured send character on the line (serial port).
packing mode timeout Sets packing mode to accumulate data and transmit it after
a specified
amount of time (timeout).
send character <control> Sets the send character for packing mode.
The character may be input as text, control, decimal, or
hex.
A control character has the form <control>C.
A decimal value character has the form \99.
A hex value character has the form 0xFF.
show Displays the current configuration.
show history Displays the last 20 commands entered during the current
CLI session.
threshold <bytes> Sets the threshold (byte count). If the queued data reaches
this threshold
then the data will be sent.
<bytes> = number of bytes in the threshold.
timeout <milliseconds> Sets the timeout value for packing mode in milliseconds.
<milliseconds> = timeout value, in milliseconds.
trailing Sets the trailing character for packing mode.
character <control> The character may be input as text, control, decimal, or
hex.
A control character has the form <control>C.

EDS Command Reference 37


3: Summary of CLI Commands

A decimal value character has the form \99.


A hex value character has the form 0xFF.
write Stores the current configuration in permanent memory.

serial Level Commands


Command Path: enable>tunnel #>serial
Level Prompt: tunnel-serial:#
Where # is the line number.

The following is a list of commands available in the serial level.

serial level Description


commands
buffer Sets the size of the buffer for data read from the serial port.
size <bytes> <bytes> = size of the buffer.
clrscrn Clears the screen.
default buffer size Restores the default buffer size.
default dtr Restores default DTR control, asserted while connected.
dtr asserted while Asserts DTR whenever a connect or accept mode tunnel
connected connection is active.
dtr continuously Asserts DTR regardless of any connections.
asserted
dtr unasserted Does not assert DTR.
exit Returns to the tunnel level.
show Displays the current configuration.
show history Displays the last 20 commands entered during the current CLI
session.
write Stores the current configuration in permanent memory.

query port Level Commands


Command Path: enable>config>query port
Level Prompt: config-query port
The following commands are available at the query port level.

query port Description


level
commands
clrscrn Clears the screen.
exit Returns to the config level.
show Displays statistics and information about the query port.
show history Displays the last 20 commands entered during the current CLI
session.
state disable Disables response to 77FE requests.
state enable Permits response to 77FE requests.
write Stores the current configuration in permanent memory.

EDS Command Reference 38


3: Summary of CLI Commands

root Level Commands


The following commands are available at the root level.

root level Description


commands
clrscrn Clears the screen.
enable Enters the enable level.
exit Exit from the system.
ping <host> Ping destination 5 times with 5 second timeout.
ping <host> <count> Ping destination n times with 5 second timeout.
ping <host> <count> Ping destination n times with x timeout (in seconds).
<timeout>
show Show system information.
show eds8pr Show system information.
show history Displays the last 20 commands entered during the current CLI
session.
show lines Show line information.
trace route <host> Trace route to destination.

rss Level Commands


Command Path: enable>config>rss
Level Prompt: config-rss
The following commands are available at the rss level.

rss level commands Description


clear rss Clear the RSS Feed data
clrscrn Clears the screen.
default max entries Restores the default number of RSS feed entries.
exit Exits to the configuration level.
feed disable Disables RSS feed.
feed enable Enables RSS feed.
max entries <number> Sets the maximum number of RSS feed entries.
persist disable Disables RSS feed data persistence.
persist enable Enables RSS feed data persistence.
show Displays the current configuration.
show history Displays the last 20 commands entered during the current
CLI session.
show status Display the RSS Feed status
write Stores the current configuration in permanent memory.

EDS Command Reference 39


3: Summary of CLI Commands

ssh Level Commands


Command Path: enable>ssh
Level Prompt: ssh
The following is a list of commands available in the ssh level.

ssh (ssh) level commands Description


client server <server> Set Client Server RSA or DSA key
client server <server> <key> Set Client Server RSA or DSA key
client user <user> <command> Set Client User, command and RSA or DSA keys
client user <user> <password> Set Client User with password, command and
<command> optional RSA or DSA keys
client user <user> Set Client User with password, command and
<password> <command> RSA or DSA keys
<public> <private>
client user <user> Generate DSA public and private keys
generate dsa 1024
client user <user> Generate DSA public and private keys
generate dsa 512
client user <user> Generate DSA public and private keys
generate dsa 768
client user <user> Generate RSA public and private keys
generate rsa 1024
client user <user> Generate RSA public and private keys
generate rsa 512
client user <user> Generate RSA public and private keys
generate rsa 768
clrscrn Clears the screen.
exit Exits to the enable level.
host Sets RSA or DSA public and/or private keys
host <key> Sets RSA or DSA public or private key
host <public> <private> Sets RSA or DSA public and private keys
host generate dsa 1024 Generate DSA public and private keys
host generate dsa 512 Generate DSA public and private keys
host generate dsa 768 Generate DSA public and private keys
host generate rsa 1024 Generate RSA public and private keys
host generate rsa 512 Generate RSA public and private keys
host generate rsa 768 Generate RSA public and private keys
host user <user> <password> Sets Host username and password
host user <user> <password> Sets Host username, password and either a RSA
<public> or DSA public key.
Place the entire contents of the file generated by
ssh-keygen within quotes.
host user <user> <password> Sets Host username, password and both RSA
<public> <public> and DSA public keys.
For each key, place the entire contents of the file
generated by ssh-keygen
within quotes.
no client server <server> Remove Client Server
no client server <server> dsa Remove Client Server DSA key
no client server <server> rsa Remove Client Server RSA key

EDS Command Reference 40


3: Summary of CLI Commands

ssh (ssh) level commands Description


no client user <user> Remove Client User
no client user <user> command Remove command from Client User
no client user <user> dsa Remove Client User DSA key
no client user <user> rsa Remove Client User RSA key
no host dsa Removes DSA public and private keys
no host rsa Removes RSA public and private keys
no host user <user> Remove a host user
show Show SSH settings
show client server <server> Show Client Server RSA and DSA keys
show client user <user> Show information for a client user
show history Displays the last 20 commands entered during
the current CLI session.
show host dsa Show full DSA public key
show host rsa Show full RSA public key
show host user <user> Show information for a host user
write Stores the current configuration in permanent
memory.

ssl Level Commands


Command Path: enable>ssl
Level Prompt: ssl
The following is a list of commands available at the ssl level.

ssl (ssl) level Description


commands
authority Adds an Authority Certificate.
clrscrn Clears the screen.
dsa Adds DSA Certificate and Private Key.
exit Exits to the enable level.
generate dsa Generates a new Self-Signed DSA Certificate.
generate rsa Generates a new Self-Signed RSA Certificate.
no dsa Removes DSA Certificate and Private Key
no intermediate Removes an Intermediate Authority Certificate.
authority <cert> <cert> = index displayed by "show authority" command.
no rsa Removes RSA Certificate and Private Key
no trusted Removes a Trusted Authority Certificate.
authority <cert> <cert> = index displayed by "show authority" command.
rsa Adds RSA Certificate and Private Key.
show Displays Certificate Information.
show authority Displays Authority Certificate Information.
show history Displays the last 20 commands entered during the current CLI
session.
write Stores the current configuration in permanent memory.

EDS Command Reference 41


3: Summary of CLI Commands

snmp Level Commands


Command Path: enable>configure>snmp
Level Prompt: config-snmp
Following are the commands available in the snmp level.

snmp level Description


commands
clrscrn Clears the screen.
community ro <string> Sets the SNMP read-only community string.
<string> = name of the read-only community string to be set.
community Sets the SNMP read-write community string.
rw <string> <string> = name of the read-write community string to be set.
contact <string> Sets the SNMP system contact information.
<string> = system contact information.
default description Restores the SNMP system description to its default.
description <string> Sets the SNMP system description.
<string> = description of device.
exit Returns to the config level.
host <ip address> Sets the primary SNMP trap host.
<ip address> = IP address of host running the SNMP trap.
host <ip address> Sets the primary and secondary SNMP trap hosts.
<ip address> <ip address> = IP address of primary host running the SNMP
trap.
<ip address> = IP address of secondary host running the
SNMP trap.
location <string> Sets the SNMP system location.
<string> = location of device.
name <string> Sets the SNMP system name.
<string> = SNMP system name.
no community ro Clears the SNMP read-only community.
no community rw Clears the SNMP read/write community.
no contact Clears the SNMP server contact.
no host <ip address> Deletes the designated SNMP server trap host.
<ip address> = IP address of an SNMP server.
no host Deletes the designated SNMP server trap hosts.
<ip address> <ip address> = IP address of an SNMP server.
<ip address>
no location Clears the SNMP server location.
no name Clears the SNMP server name.
server disable Disables the SNMP server.
server enable Enables the SNMP server.
show Displays the SNMP server settings.
show history Displays the last 20 commands entered during the current CLI
session.
traps disable Disables the sending of SNMP trap messages.
traps enable Enables the sending of SNMP trap messages.
write Stores the current configuration in permanent memory.

EDS Command Reference 42


3: Summary of CLI Commands

syslog Level Commands


Command Path: enable>configure>syslog
Level Prompt: config-syslog
Following are the commands available in the syslog level.

syslog level Description


commands
clrscrn Clears the screen.
default local port Restores the default syslog local port.
default remote port Restores the default syslog remote port.
exit Returns to the config level.
host <IP address> Sets the address of the syslog recipient.
<ip address> = IP address of the host.
level <severity> Sets the minimum severity of events that will be logged.
<severity> = level of system message. Select from the
following:
Emergency (highest)
Alert
Critical
Error
Warning
Notice
Information
Debug (lowest)
Events at the selected or at higher levels will be logged.
local port <number> Sets the syslog local port.
<number> = number of the local port used when making a
syslog connection.
no host Removes the address of the syslog recipient.
no level Disables logging of all events.
remote port <number> Sets the syslog remote port.
<number> = number of the remote port used when making
a syslog connection.
show Displays the syslog settings and statistics.
show history Displays the last 20 commands entered during the current
CLI session.
state disable Disables syslog logging.
state enable Enables syslog logging.
write Stores the current configuration in permanent memory.

EDS Command Reference 43


3: Summary of CLI Commands

tcp Level Commands


Command Path: enable>configure>tcp
Level Prompt: config-tcp
Following are the commands available in the tcp level.

tcp level Description


commands
ack limit Sets the number of packets that must be received before an ACK
<packets> is forced.
If there is a large amount of data to acknowledge, an ACK will be
forced
before this.
auto show stats Continuously shows TCP statistics
clear counters Zeros TCP counters
clrscrn Clears the screen.
default ack limit Restores the default ack limit of 3 packets.
default send data Sets TCP to send data in accordance with standards.
exit Exits to the configuration level.
no clear counters Unzeros TCP counters
resets disable Does not send TCP RSTs upon connection to unused ports.
resets enable Sends TCP RSTs upon connection to unused ports.
send data Sets TCP to send data whenever the window is sufficiently open,
expedited for improved
real-time performance.
send data Sets TCP to send data in accordance with standards.
standard
show Displays the current configuration.
show history Displays the last 20 commands entered during the current CLI
session.
show stats Shows TCP statistics
write Stores the current configuration in permanent memory.

terminal Level Commands


Command Path: enable>configure>terminal #
Level Prompt: config-terminal:#
Where # is the line number or “network”.

Following are the commands available in terminal <line> levels.

terminal level Description


commands
break duration Sets how long a break should last when it is being sent to the
<milliseconds> line.
<milliseconds> = number of milliseconds.

EDS Command Reference 44


3: Summary of CLI Commands

terminal level Description


commands
clrscrn Clears the screen.
default break Restores the break duration to the default value (500 ms).
duration
default terminal type Sets the default terminal type, "UNKNOWN".
echo disable Disables echoing of characters received on the line back to the
line.
echo enable Enables echoing of characters received on the line back to the
line.
exit Exits to the configuration level.
exit connect menu On the login connect menu, removes the menu item allowing
disable the user to exit
to the CLI.
exit connect menu On the login connect menu, inserts the menu item allowing the
enable user to exit
to the CLI.
line <line> Enters the line level.
<line> = number of the line (serial port) to be configured.
login connect menu Disables the login connect menu, so a user will get the CLI
disable immediately
after logging in.
login connect menu Enables the login connect menu, so a user will get the menu
enable rather than the
CLI immediately after logging in.
lpd <line> Enters the configure lpd level.
<line> = number of the line (lpd serial port) to be configured.
no send break Removes the configured send break character.
preview connect Shows the layout of the connect menu with current settings.
menu
send Sets the optional send break character.
break <control> <text> = the character.
The character may be input as text, control, decimal, or hex.
A control character has the form <control>C.
A decimal value character has the form \99.
A hex value character has the form 0xFF.
show Displays the current configuration.
show history Displays the last 20 commands entered during the current CLI
session.
terminal <line> Enters the configure-terminal level.
<line> = number of the terminal line (serial port) to be
configured.
terminal network Enters the configure-terminal level for the network.
terminal type <text> Sets the terminal type.
tunnel <line> Enters the tunnel level.
<line> = number of the tunnel line (serial port) to be configured.
write Stores the current configuration in permanent memory.

EDS Command Reference 45


3: Summary of CLI Commands

terminal network Level Commands


Command Path: enable>configure>terminal network
Level Prompt: config-terminal network:#
Where # is the line number or “network”.

Following are the commands available in the terminal network level.

terminal network Description


level commands
break duration Sets how long a break should last when it is being sent to the
<milliseconds> line.
<milliseconds> = number of milliseconds.
clrscrn Clears the screen.
default break Restores the break duration to the default value (500 ms).
duration
default terminal type Sets the default terminal type, "UNKNOWN".
echo disable Disables echoing of characters received on the line back to the
line.
echo enable Enables echoing of characters received on the line back to the
line.
exit Exits to the configuration level.
exit connect menu On the login connect menu, removes the menu item allowing
disable the user to exit
to the CLI.
exit connect menu On the login connect menu, inserts the menu item allowing the
enable user to exit
to the CLI.
line <line> Enters the line level.
<line> = number of the line (serial port) to be configured.
login connect menu Disables the login connect menu, so a user will get the CLI
disable immediately
after logging in.
login connect menu Enables the login connect menu, so a user will get the menu
enable rather than the
CLI immediately after logging in.
lpd <line> Enters the configure lpd level.
<line> = number of the line (lpd serial port) to be configured.
no send break Removes the configured send break character.
preview connect Shows the layout of the connect menu with current settings.
menu
send Sets the optional send break character.
break <control> <text> = the character.
The character may be input as text, control, decimal, or hex.
A control character has the form <control>C.
A decimal value character has the form \99.
A hex value character has the form 0xFF.
show Displays the current configuration.
show history Displays the last 20 commands entered during the current CLI
session.

EDS Command Reference 46


3: Summary of CLI Commands

terminal network Description


level commands
terminal <line> Enters the configure-terminal level.
<line> = number of the terminal line (serial port) to be
configured.
terminal network Enters the configure-terminal level for the network.
terminal type <text> Sets the terminal type.
tunnel <line> Enters the tunnel level.
<line> = number of the tunnel line (serial port) to be configured.
write Stores the current configuration in permanent memory.

tftp Level Commands


Command Path: enable>config>tftp
Level Prompt: tftp
The following is a list of commands available in the tftp level.

tftp level Description


commands
allow file creation Prohibits the TFTP server from creating files on the file system.
disable
allow file creation Enables the TFTP server to create files on the file system.
enable
clear counters Sets the TFTP counters to zero.
clrscrn Clears the screen.
exit Returns to the config level.
no clear counters Restores the TFTP counters to the aggregate values.
show Displays the TFTP settings and statistics.
show history Displays the last 20 commands entered during the current CLI
session.
state disable Disables the TFTP server.
state enable Enables the TFTP server.
write Stores the current configuration in permanent memory.

tunnel <line> Level Commands


Command Path: enable>tunnel #
Level Prompt: tunnel:#
Where # is the line number.

The following is a list of commands available in the tunnel level.

tunnel 1 level commands Description


accept Enters the accept level for this tunnel.
auto show statistics show connection statistics
clear accept counters Zeros accept counters
clear aggregate counters Zeros aggregate counters
clear all counters Zeros all tunnel counters
clear connect counters Zeros connect counters

EDS Command Reference 47


3: Summary of CLI Commands

tunnel 1 level commands Description


clrscrn Clears the screen.
connect Enters the connect level for this tunnel.
disconnect Enters the disconnect level for this tunnel.
echo start character disable Disables forwarding (tunneling) of the start character.
echo start character enable Enables forwarding (tunneling) of the start character.
echo stop character disable Disables forwarding (tunneling) of the stop character.
echo stop character enable Enables forwarding (tunneling) of the stop character.
exit Exits to the enable level.
line <line> Enters the line level.
<line> = number of the line (serial port) to be
configured.
lpd <line> Enters the configure lpd level.
<line> = number of the line (lpd serial port) to be
configured.
modem Enters the modem level for this tunnel.
no clear accept counters Unzeros accept counters
no clear aggregate counters Unzeros aggregate counters
no clear all counters Unzeros all tunnel counters
no clear connect counters Unzeros connect counters
no start character Removes the start character.
no stop character Removes the stop character.
packing Enters the packing level for this tunnel.
serial Enters the serial level for this tunnel.
show Displays tunneling configuration.
show history Displays the last 20 commands entered during the
current CLI session.
show statistics show connection statistics
start character <string> Sets the start character.
(Character: C, HEX: 0x##, Decimal: \###)
stop character <string> Sets the stop character.
(Character: C, HEX: 0x##, Decimal: \###)
terminal <line> Enters the configure-terminal level.
<line> = number of the terminal line (serial port) to be
configured.
terminal network Enters the configure-terminal level for the network.
tunnel <line> Enters the tunnel level.
<line> = number of the tunnel line (serial port) to be
configured.
write Stores the current configuration in permanent
memory.

udp Level Commands


Command Path:
enable>config>udp
Level Prompt: config-udp

EDS Command Reference 48


3: Summary of CLI Commands

The following is a list of commands available in the udp level.

udp level Description


commands
auto show stats Continuously shows UDP statistics
clear counters Zeros counters
clrscrn Clears the screen.
exit Exits to the configuration level.
no clear counters Unzeros IP counters
show history Displays the last 20 commands entered during the current CLI
session.
show stats Shows UDP statistics
write Stores the current configuration in permanent memory.

EDS Command Reference 49


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 file system. 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 (DTD)


An XML DTD is a description of the structure and content of an XML document. It can be
used to verify that a received document is valid.

XML Configuration Records are exported using the following DTD:

<!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 DTD states 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.

EDS Command Reference 50


4: Configuration Using XML

 A <value> element can have only data and can have a name attribute.

Notes: The name for each <configgroup> (specified with the name attribute) is the group
name listed in the Web Manager XCR groups. See the User Guide for more
information.

 An empty or missing <value> element in each present <configgroup> clears the


setting to its default.

Attributes
 Use the “name” attribute to identify a group, item, or value. It is always a quoted
string.

 Use the “instance” attribute to identify the specific option, like the serial port number.
The “instance” attribute is always a quoted string.

Quick Syntax Tour for XCRs


Figure 4-2 shows a simple XML Configuration Record example.

Figure 4-2. Simple XML Group Example


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

The first line:

<?xml version=”1.0” standalone=”yes”?>

is the “XML declaration.” It is required and indicates the XML version in use (normally
version 1.0).

EDS Command Reference 51


4: Configuration Using XML

The remainder of the file consists of nested “elements,” some of which have “attributes”
and “content.”

 An element typically consists of two tags, a “start tag” and an “end tag,” possibly
surrounding text and other elements.

 The start tag consists of a name surrounded by angle brackets, like


<configrecord>.

 The end tag consists of the same name surrounded by angle brackets, but with a
forward slash preceding the name, like </configrecord>.

 The element content is everything that appears between the start tag and end tag,
including text and other (child) elements.

In addition to content, an element can contain attributes—name-value pairs included in


the start tag after the element name.

 Attribute values must always be quoted, using single or double quotes.

 Each attribute name should appear only once in an element.


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

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 take the name
attribute. In our 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 has the instance “1” to indicate
serial port 1 or “2” to specify serial port 2.

The following figures show examples of XML configuration records and the use of the
<configrecord>, <configgroup>, <configitem>, and <value> XML elements.

Figure 4-3. XML Group Example


<?xml version=”1.0” standalone=”yes”?>

<configrecord>

<configgroup name = “serial command mode” instance = “1”>

<configitem name = “mode”>


<value>disable</value>

EDS Command Reference 52


4: Configuration Using XML

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

Figure 4-4. XML Example with Multiple Named Values


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

Figure 4-5. XML Example with Multiple Items


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

Figure 4-6. XML Example with Multiple Groups


<?xml version=”1.0” standalone=”yes”?>

<configgroup name = "ftp server">

<configitem name = "state">

<value>enable</value>

</configitem>

<configitem name = "admin username">

<value>admin</value>
</configitem>
<configitem name = "admin password">
<value><!-- configured and ignored --></value>
</configitem>
</configgroup>
<configgroup name = "tftp server">
<configitem name = "state">
<value>enable</value>
</configitem>

EDS Command Reference 53


4: Configuration Using XML

<configitem name = "allow file creation">


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

Importing and Exporting an XML Configuration File


An XML configuration record can be imported or exported using the following methods:

 Filesystem  XCRs can be saved to the device server’s file system and imported or
accessed as needed. See the Best Practices section below or the File System
Browser Page in the User Guide.

 CLI  an XML configuration record can be imported (captured) or exported


(dumped) directly to a Telnet, SSH, or serial line session. Capturing an XML
configuration record can be started by pasting a valid XCR directly into the CLI
prompt. Evolution OS will immediately process the configuration record, changing
any settings specified in the XCR. 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  the Web interface can be used to import and export an XCR to the
device server’s 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’s FTP server will export and import XCRs when a get or a
put on the file eds4100.xcr, edspr.xcr, or edsps.xcr (depending on the model) is
requested. On export (FTP get of eds4100.xcr, edspr.xcr, or edsps.xcr depending on
the model), the FTP server obtains the current XCR from Evolution OS™ and sends
it as a file. On import (FTP put of eds4100.xcr, edspr.xcr, or edsps.xcr depending on
the model), the FTP server processes the file by sending it directly to the XML
engine. In both cases the device server’s filesystem is not accessed. The file
eds4100.xcr, edspr.xcr, or edsps.xcr (depending on the model) is not read from, or
written to the file system. See the FTP Page in the User Guide.

Note: The Trivial File Transfer Protocol (TFTP) is not supported for importing XML
configuration files because it does not provide any security features.

Best Practices
Importing and Exporting Partial Configurations
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: Do not edit an XCR with Microsoft Word—you will not be able to import the
file, even if you save the document as Plain Text (.txt) or XML Document
(.xml) file. Use Microsoft Notepad instead.

The following syntax can be used to import configurations from a file on the device
server’s file system:
xcr import <file>
xcr import <file> <groups and/or group:instances>

EDS Command Reference 54


4: Configuration Using XML

The first line imports all groups specified in the XML config record named in <file>. Any
filename is valid, and the file name and extension are not important.

CAUTION: The file name eds4100.xcr, edspr.xcr, or edsps.xcr (depending on the model)
is not acceptable, since performing a FTP get on that name produces the
current configuration and does not get anything from the filesystem. Also, the
file name eds4100.xsr, edspr.xsr, or edsps.xsr (depending on the model) is
not acceptable, since performing a 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 will be 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.

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 4 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:4”
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 4 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:4"
The following example imports all tunneling settings and line settings for all serial ports
from a file named xcr_file:

EDS Command Reference 55


4: Configuration Using XML

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 4 to a file named tunnel_config_t1_l4.xcr on the device server
filesystem.
xcr export tunnel_config_t1_l4.xcr "tunnel accept:1, line:4"
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"
CAUTION: Do not edit an XCR with Microsoft Word—you will not be able to import the
file, even if you save the document as Plain Text (.txt) or XML Document
(.xml) file. Use Microsoft Notepad instead.

Including Passwords in the XML File


If you log in to a device server to which you will be pasting an XML configuration record,
you do not need to include passwords in the file, since you are already logged in to the
device. However, if you will be sending an XML configuration record to one or more
device server devices that are password protected, you can include the appropriate
passwords in the XML configuration record and forego the usual login steps.

The “xml paste passwords” <configgroup> name is used with the “passwords”
<configitem> name and “cli login” and “cli enable level” values to specify the passwords
to use when the device has been configured with password protection. The password
value is clear text. To protect the password, establish an SSH connection to the device
server.
<!—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>

Special XCR Items


The XML configuration record has several items that do not directly affect the device’s
configuration. These items generally provide functionality to control the device behavior
during XCR importing and are not exported (or are exported with blank values) when an
XCR is generated. Entries that are not exported are marked as Import only in the
“Import/Export column.”

XML Groups
Table 4-1 lists the EDS XML configuration record groups in alphabetical order. This table
indicates whether each item can be imported, exported, or exported with the placeholder:
<!--configured and ignored-->.

EDS Command Reference 56


4: Configuration Using XML

Table 4-1. EDS Import and Export Groups


Group Item Value Value Import/ Additional
Name Name Name Export Information
arp timeout import/export In seconds.
arp entry ip address Import Add a dynamic entry to
the ARP table.
mac import
address
arp delete import Remove an entry from the
ARP table. Specify the
entry by its IP address.
cli enable level import/export If configured and not
password Placeholder exporting secrets, exports
only a placeholder.
login import/export If configured and not
password Placeholder exporting secrets, exports
only a placeholder.
quit import/export Normally this will be a
connect line control key. For example,
<control>L
clock time zone zone import/export Time zone name such as
GMT.

offset import/export Time zone offset from


GMT as [-]HH:MM.

time set hours import

minutes import

seconds import

day of import
month

month import

year import

device long name import/export

serial export
number

short name import/export

firmware export
version
email to import/export Multiple to addresses may
be separated with
semicolons.
(Attribute of
“instance” is a from import/export
number.) reply to import/export
cc import/export Multiple cc address may
be separated with
semicolons.
subject import/export

EDS Command Reference 57


4: Configuration Using XML

Group Item Value Value Import/ Additional


Name Name Name Export Information
message import/export
file
local port import/export Either a specific number
or “Random”.
server port import/export
priority Very Low import/export
Low
Normal
High
Urgent
overriding import/export
domain

ethernet duplex auto import/export

full
(Attribute of half
“instance” is
“eth0”.) speed auto import/export

10
100
ftp server state enable import/export
disable
admin import/export
username
admin import/export If configured and not
password Placeholder exporting secrets, exports
only a placeholder.
host name import/export
protocol telnet import/export
(Attribute of ssh
“instance” is a
remote import/export
number.)
address
remote port import/export
ssh import/export Username must
username correspond to a
configured ssh client
user.

http realm import/export


authentication type import/export
uri
user password import/export If configured and not
(Attribute of Placeholder exporting secrets, exports
(Attribute of only a placeholder.
“instance”
“instance” is
is the user
the URI.)
name.)
user delete name Import Deletes the single named
user.

EDS Command Reference 58


4: Configuration Using XML

Group Item Value Value Import/ Additional


Name Name Name Export Information
http server state enable import/export

disable

port import/export

secure port import/export

secure ssl3 enable import/export


protocols
disable

ttls 1.0 enable import/export

disable

ttls 1.1 enable import/export

disable

max import/export
timeout
max bytes import/export
logging enable import/export
state
disable
log format import/export
max log import/export
entries
icmp state enable import/export
disable
interface bootp enable import/export
disable
(Attribute of dhcp enable import/export
“instance” is
disable
“eth0”.)
dhcp client import/export Set the identity of the
id client device.
domain import/export
hostname import/export
ip address import/export Specifies both the
address and mask. Use
CIDR form
(192.168.0.1/16) or
explicit mask (192.168.0.1
255.255.0.0)
default import/export
gateway
primary dns import/export
secondary import/export
dns
ip multicast import/export Specifies number of hops.
time to live

EDS Command Reference 59


4: Configuration Using XML

Group Item Value Value Import/ Additional


Name Name Name Export Information
ip filter delete enable import If enabled, deletes any
entries existing entries before
disable adding “filter entry”.

filter entry ip address import/export


net mask

filter delete ip address import Deletes a specific IP filter


entry.
net mask
line state enable import/export
disable
(Attribute of baud rate import/export Any value from 300 to
“instance” is a 230400 in bits per
number.) second.
data bits 7 import/export
8
parity none import/export
even
odd
stop bits 1 import/export
2
flow control hardware import/export
software
none
xon char import/export Set the x-on character.
Prefix hex with 0x (0x11)
or decimal with \(\17).
xoff char import/export Set the x-off character.
Prefix hex with 0x (0x11)
or decimal with \(\17).
name import/export
protocol none import/export
lpd
lpd or tunnel
tunnel
interface rs232 Import/export Some products and lines
rs485 half- only support RS-232.
duplex
rs485 full-
duplex

EDS Command Reference 60


4: Configuration Using XML

Group Item Value Value Import/ Additional


Name Name Name Export Information
lpd banner enable import/export

disable
(Attribute of binary enable import/export
“instance” is a
number.) disable

convert enable import/export


newline
disable

eoj enable import/export

disable

eoj text import/export

formfeed enable import/export

disable

queue import/export
name

soj enable import/export

disable
soj text import/export
query port state enable import/export
disable
rss feed enable import/export
disable
persist enable import/export
disable
max entries import/export
serial mode always import/export
command disable
mode
serial string
(Attribute of
“instance” is a
number.) echo serial enable import/export
string
disable
serial string import/export
signon import/export
message
wait time import/export Milliseconds.

EDS Command Reference 61


4: Configuration Using XML

Group Item Value Value Import/ Additional


Name Name Name Export Information
snmp state enable import/export

disable

system import/export
name

system import/export
contact

system import/export
description

system import/export
location

traps state enable import/export

disable

primary import/export
destination

secondary import/export
destination

read import/export If configured and not


community exporting secrets, exports
Placeholder only a placeholder.

write import/export If configured and not


community Placeholder exporting secrets, exports
only a placeholder.

EDS Command Reference 62


4: Configuration Using XML

Group Item Value Value Import/ Additional


Name Name Name Export Information
ssh client client user private dsa import/export If configured and not
key exporting secrets, exports
Placeholder only a placeholder.
(Attribute of public dsa import/export
“instance” key
is required
for the user private rsa import/export If configured and not
name) key exporting secrets, exports
Placeholder only a placeholder.

public rsa import/export


key

password import/export If configured and not


exporting secrets, exports
Placeholder only a placeholder.

remote import/export
command

known host public rsa import/export


key

public dsa import/export


(Attribute of key
“instance”
is required
for the
known host
name)

known host name import Deletes the named known


delete host.

client user name import Deletes the named client


delete user.

delete enable import If enabled, deletes any


known existing hosts before
hosts disable adding “known host”.

delete client enable import If enabled, deletes any


users existing client users
disable
before adding “client
user”.
ssh command max import/export
mode sessions
state enable import/export
disable
port import/export

EDS Command Reference 63


4: Configuration Using XML

Group Item Value Value Import/ Additional


Name Name Name Export Information
ssh server host rsa public key import/export
keys
private key import/export If configured and not
exporting secrets, exports
Placeholder only a placeholder.

host dsa public key import/export


keys
private key import/export If configured and not
exporting secrets, exports
Placeholder only a placeholder.

authorized password import/export If configured and not


user exporting secrets, exports
Placeholder only a placeholder.

public rsa import/export


(Attribute of key
“instance”
is required public dsa import/export
for the key
authorized
user name)

authorized name import Deletes the named SSH


user delete authorized user.

delete enable import If enabled, deletes any


authorized authorized users before
users disable adding “authorized user”.

delete host enable import If enabled, deletes any


keys existing host keys before
disable
adding “host X keys”.
ssl trusted ca import/export Enter the text of the
(Attribute of certificate.
“instance”
is a number
from 0 to N)
rsa certificate import/export Enter the certificate text.
certificate private key import/export Enter the text of the
Placeholder private key.
If configured and not
exporting secrets, exports
only a placeholder.
dsa certificate import/export Enter the text of the
certificate certificate.
private key import/export Enter the text of the
Placeholder private key.
If configured and not
exporting secrets, exports
only a placeholder.
delete all enable import If enabled, deletes any
cas existing trusted cas
disable before adding “trusted
ca”.

EDS Command Reference 64


4: Configuration Using XML

Group Item Value Value Import/ Additional


Name Name Name Export Information
syslog host import/export

local port import/export

remote port import/export


severity log emergency import/export
level alert
critical
error
warning
notice
information
debug
state enable import/export
disable
tcp resets enable import/export
disable
ack limit import/export Number of packets
received before an ACK is
forced.
send data standard import/export
expedited
telnet max import/export
command sessions
mode
state enable import/export
disable
port import/export
terminal break import/export milliseconds
duration

(Attribute of echo enable import/export


“instance” is disable
either
exit connect enable import/export
“network” or a
menu
number.) disable
login enable import/export
connect
disable
menu
send break import/export control character
terminal import/export
type
tftp server state enable import/export
disable
allow file enable import/export
creation
disable
tunnel accept accept always import/export
mode
disable
(Attribute of any character

EDS Command Reference 65


4: Configuration Using XML

Group Item Value Value Import/ Additional


Name Name Name Export Information
“instance” is a start
number.) character
modem
control
asserted
modem
emulation
aes decrypt import/export If configured and not
key Placeholder exporting secrets, exports
only a placeholder.
aes encrypt import/export If configured and not
key Placeholder exporting secrets, exports
only a placeholder.
local port import/export
protocol tcp import/export
tcp aes
ssh
ssl
telnet
flush serial enable import/export
disable
block serial enable import/export
disable
block enable import/export
network
disable
tcp keep import/export Milliseconds
alive
email import/export
connect
email import/export
disconnect
password prompt enable import/export
disable
password import/export If configured and not
Placeholder exporting secrets, exports
only a placeholder.
tunnel connect always import/export
connect mode
disable
any character
(Attribute of
start
“instance” is a
character
number.)
modem
control
asserted

modem
emulation

EDS Command Reference 66


4: Configuration Using XML

Group Item Value Value Import/ Additional


Name Name Name Export Information
aes decrypt import/export If configured and not
key Placeholder exporting secrets, exports
only a placeholder.

aes encrypt import/export If configured and not


key Placeholder exporting secrets, exports
only a placeholder.
local port import/export Either a specific number
or “Random”.
remote import/export
address
remote port import/export
protocol tcp import/export
udp
ssh
ssl
tcp aes
udp aes
telnet
reconnect import/export Milliseconds.
time
flush serial enable import/export
disable
ssh import/export Username must
username correspond to a
configured ssh client user.
block serial enable import/export
disable
block enable import/export
network disable
tcp keep import/export Milliseconds.
alive
email import/export
connect
email import/export
disconnect
tunnel character enable import/export
disconnect stop
disable
flush serial enable import/export
(Attribute of
disable
“instance” is a
number.) modem enable import/export
control
disable
timeout import/export Milliseconds. A value of 0
disables the timeout.

EDS Command Reference 67


4: Configuration Using XML

Group Item Value Value Import/ Additional


Name Name Name Export Information
tunnel echo pluses enable import/export
modem
disable

echo enable import/export


(Attribute of commands
“instance” is a disable
number.)
verbose enable import/export
response
disable
response text import/export
type
numeric
error enable import/export
unknown disable
commands
incoming disabled import/export
connection
automatic
manual
connect import/export
string
display enable import/export
remote ip
disable
tunnel packing disable import/export
packing mode
timeout
send
(Attribute of character
“instance” is a
timeout import/export Milliseconds.
number.)
threshold import/export Bytes.
send import/export
character
trailing import/export
character
tunnel serial buffer size import/export Bytes.
dtr asserted import/export
(Attribute of while
“instance” is a connected
number.) continuously
asserted
unasserted
tunnel start start import/export
character

(Attribute of echo enable import/export


“instance” is a disable
number.)
tunnel stop stop import/export
(Attribute of character
“instance” is a echo enable import/export
number.)
disable

EDS Command Reference 68


4: Configuration Using XML

Group Item Value Value Import/ Additional


Name Name Name Export Information
xml import restore enable import/export
control factory disable
configuratio
n

delete http enable import/export Deletes existing http


authenticati disable authentication uris before
on uris importing new ones.
http name import/export Deletes the specified http
authenticati authentication uri.
on uri
delete
reboot enable import/export Reboots after importing.
disable
xml paste passwords cli login import Used with the CLI capture
passwords feature. If pasting XML
into the CLI login
password prompt, this
field must be the correct
CLI login password.

cli enable import Same as above.


level

EDS Command Reference 69


4: Configuration Using XML

XSR Groups and Items


The table below lists the supported XML Status Record (XSR) groups and items. These
groups and items show the status of the device in XML form and can only be exported.

The XSR schema differs slightly from the XCR groups and items however, in that the
XSR allows groups within groups.

The only current use of groups within groups is the buffer pool group, which has the
following groups as sub groups:

 Protocol stack

 Ethernet driver

 Line

The CLI command usage is identical to the XCR export, dump, and list.

Table 4-2. EDS XSR Groups and Items

Group Name Item Name Value Name Valid


Values

Arp arp entry ip address

mac address
(Attribute of “instance” age
is “eth0”.)
type
buffer pool This group contains other groups: ethernet driver, line #, protocol stack.
clock time
date
timezone zone
offset
device product info product type
serial number
firmware version
uptime
permanent config saved
unsaved
email success sent

sent with retries


(Attribute of “instance” failed
is a number.) queued
email log entry time
log
(Attribute of “instance”
is a number.)

EDS Command Reference 70


4: Configuration Using XML

Group Name Item Name Value Name Valid


Values

ethernet driver buffer headers total


(within group “buffer free
pool”)
used
max used
cluster pool cluster size
total
free
used
filesystem filesystem size
available clean
available dirty
used total
used data
busy
entries file count
directory count
system count
open count
lock count
share count
banks current
firmware begin
firmware end
firmware erase cycles
bank a begin
bank a end
bank a erase cycles
bank b begin
bank b end
bank b erase cycles
ftp status enable

disable
admin username
connections rejected
accepted
last client ip address
port
hardware cpu type

EDS Command Reference 71


4: Configuration Using XML

Group Name Item Name Value Name Valid


Values

speed
memory flash size
ram size
http state enable
disable
ports http port
https port
max bytes
max timeout
logging state enable
disable
max entries
format
entries
bytes
http log entry

(Attribute of “instance” is a
number.)

totals entries

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

EDS Command Reference 72


4: Configuration Using XML

Group Name Item Name Value Name Valid


Values

destination unreachables
time exceeded messages
parameter problems
source quench requests
redirects
ping requests
ping replies
timestamp requests
timestamp replies
address mask requests
address mask replies
interface generic status
errors
(Attribute of “instance” ethernet speed
is “eth0”.)
duplex
arp encapsulation
type
timeout
default gateway
network mask
domain
mac address
hostname
ip address
last change
mtu
primary dns
secondary dns
transmit octets
unicast
non unicast
discards
errors
broadcast packets
multicast packets
filtered packets
deferred
multiple retries

EDS Command Reference 73


4: Configuration Using XML

Group Name Item Name Value Name Valid


Values

one retry
underflows
late collisions
retry errors
carrier lost errors
receive octets
unicast
non unicast
discards
errors
broadcast packets
multicast packets
filtered packets
unknown protocol
framing errors
overflows
crc errors
missed frame errors
ip state

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

EDS Command Reference 74


4: Configuration Using XML

Group Name Item Name Value Name Valid


Values

ip sockets ip socket protocol


rx queue
tx queue
local address
local port
remote address
remote port
state
line receiver bytes
breaks
(Attribute of “instance” parity errors
is a number.)
framing errors
overrun errors
no receive buffer errors
queued bytes
flow control
transmitter bytes
breaks
queued bytes
flow control
line levels cts
rts
dsr
dtr
line state
protocol
(within group “line”) baud rate
parity
data bits
stop bits
flow control
xon char
xoff char
line <number> buffer headers total
(within group “buffer free
pool”)
used

max used
cluster pool cluster size

EDS Command Reference 75


4: Configuration Using XML

Group Name Item Name Value Name Valid


Values

total
free
used
max used
lpd jobs printed
bytes printed
(Attribute of “instance” current client ip address
is a number.)
current client port
last client ip address
last client port
memory main heap condition
total memory
available memory
fragments
allocated blocks
processes process pid

cpu %

stacks

thread name
protocol stack buffer headers total
(within group “buffer free
pool”)
used

max used
cluster pool cluster size
total
free
used
max used
query port status
last connection ip address
port
in discoveries
unknown queries
erroneous packets
out discovery replies
errors
rss url

EDS Command Reference 76


4: Configuration Using XML

Group Name Item Name Value Name Valid


Values

data entries
bytes
sessions line baud
(Attribute of “instance” is a parity
number.)
data bits
stop bits
flow control
ssh local port
remote ip address
(Attribute of “instance” is the remote port
ssh session number.)
duration
telnet local port
remote ip address
(Attribute of “instance” is the remote port
telnet session number.)
duration
ssh state
local port
totals uptime
bytes in
bytes out
current connection local ip address
local port
remote ip address
remote port
uptime
bytes in
bytes out
last connection local ip address
local port
remote ip address
remote port
syslog state
host
severity to log
messages send
messages failed
tcp retransmission algorithm

timeout minimum

EDS Command Reference 77


4: Configuration Using XML

Group Name Item Name Value Name Valid


Values

timeout maximum
connections maximum
open active
open passive
failed
resets
established
segments in
out
retransmitted
resets in
out
errors in
telnet state
local port
totals uptime
bytes in
bytes out
last connection local ip address
local port
remote ip address
remote port
tftp state

creation

downloaded

uploaded
not found
errors read
write
unknown
last client ip address
port
tunnel aggregate completed connects
completed accepts
(Attribute of “instance” disconnects
is a number.)
dropped connects
dropped accepts
octets from serial

EDS Command Reference 78


4: Configuration Using XML

Group Name Item Name Value Name Valid


Values

octets from network


connect connection time
accept connection time
connect dns address changes
connect dns address invalids
current connect connections local ip address
local port
remote ip address
remote port
uptime
octets from serial
octets from network
connect dns address changes
connect dns address invalids
current accept connections local ip address
local port
remote ip address
remote port
uptime
octets from serial
octets from network
tunnel modem echo commands
(within group “tunnel”) verbose response
response type
error unknown commands
incoming connection
udp in unknown ports
in datagrams
in errors
out datagrams
xsr out bytes
lines
elements
errors

EDS Command Reference 79


Index

Index
Enable menu, 21
A Ethernet driver, 70
accept Level Commands, 12 ethernet link Level Commands, 32
arp Level Commands, 14 Exporting
system configuration record, 54
B
Best practices, XML, 54 F
buffer pool group, 70 filesystem Level Commands, 23
Filesystem menu, 23
C ftp Level Commands, 24
chem Level Commands, 14
CLI G
Device menu, 21 Groups, XML, 52
Serial port configuration, 6, 7
Summary of commands, 11 H
Telnet configuration, 6 host Level Commands, 25
CLI Command Index, 11 Host menu, 24, 25
CLI command usage, 70 http Level Commands, 25
CLI configuration, 6
CLI menus I
Configure, 15, 16 icmp Level Commands, 27
Device, 20, 21 if Interface Commands, 28
Enable, 21 Import and export
Filesystem, 23 XML groups, 56
Interface 1 Level, 28 XSR groups, 70
Line, 30 Import and Export Groups
SSH, 40 MatchPort AR, 57
SSL, 41 Importing
Tunnel, 47 system configuration record, 54
CLI,Navigating the, 7 Interface 1 Level menu, 28
Configuration record schema, 50 ip Level Commands, 29
Configuration Using XML, 50 Items, XML, 52
Configure menu, 15, 16
Connect Level Commands, 18 K
Keyboard Shortcut Commands, 10
D
device Level Commands, 20 L
Device menu, 20, 21 line Level Commands, 30
Device server Line menu, 30
Serial port configuration, 6, 7 login Level Commands, 33
Telnet configuration, 6 lpd Level Commands, 33, 34
XML configuration, 50
disconnect Level Commands, 21 M
modem Level Commands, 36
E
enable Level Commands, 21

EDS Command Reference 80


Index

P Telnet configuration, 6
packing Level Commands, 37 terminal Level Commands, 44, 46
Protocol stack, 70 tftp Level Commands, 47
tunnel Level Commands, 47
Q Tunnel menu, 47
query port Level Commands, 38
U
R udp Level Commands, 48
Records, XML, 52
Root Level Commands, 33 V
Root menu, 33 Values, XML, 52
rss Level Commands, 39
X
S XML
Schema, XML configuration record, 50 Partial Configurations, 54
serial Level Commands, 38 Passwords, 56
Serial port configuration, 6 XML
snmp Level Commands, 42 Best practices, 54
ssh Level Commands, 40 configuration, 50
SSH menu, 40 configuration record schema, 50
SSL Group Example, 51
menu, 41 Records, groups, items, and values, 52
ssl Level Commands, 41 syntax examples, 51
Summary of XML
CLI commands, 11 Import and export groups, 56
Syntax examples for XML, 51 XML declaration, 51
syslog Level Commands, 43 XML Group Example, 52
System configuration record XML pages
exporting, 54 Export system configuration record, 54
importing, 54 Import system configuration record, 54
XSR
T Import and export groups, 70
tcp Level Commands, 44

EDS Command Reference 81