EDS_CR

EDS Device Servers and Terminal Servers

Command Reference • EDS4100

• EDS8PR

• EDS16PR

• EDS32PR

• EDS8PS

• EDS16PS

Part Number 900-455 Revision E May 2009

EDS Command Reference 2

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

http://www.lantronix.com/support

http://www.lantronix.com/about/contact

http://www.lantronix.com/support/documentation.html


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

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


11:: IInnttrroodduuccttiioonn 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.


22:: CCoonnffiigguurraattiioonn UUssiinngg TTeellnneett oorr aa SSeerriiaall PPoorrtt 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.

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:



Figure 2-1. CLI Hierarchy



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.



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


33:: SSuummmmaarryy ooff CCLLII CCoommmmaannddss

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

accept 12

arp 14

chem 14

cli 15

configure 16

connect 18

device 20

disconnect 21

enable 21

ethernet link 32

filesystem 23

ftp 24

host 25

http 25

icmp 27

if 28

ip 29

ip filter 29

Command Level Page

line 30

login (root) 33

lpd 33

modem 36

packing 37

query port 38

root 39

rss 39

serial 38

ssh 40

ssl 41

snmp 42

syslog 43

tcp 44

terminal 44

tftp 47

tunnel 47

udp 48

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 asserted

Enables the tunneling server to accept tunneling connections when the modem

accept mode modem emulation

Enables modem emulation for accept mode tunneling.

accept mode start character Enables accept mode tunneling when the configured start character

aes decrypt key binary <binary>

Sets the accept tunnel AES decrypt key allowing for binary characters.

aes decrypt key set <text> Sets the accept tunnel AES decrypt key with text. aes encrypt key binary <binary>

Sets the accept tunnel AES encrypt key allowing for 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 <email profile>

Sets an email profile to use to send an email alert upon establishing

email disconnect <email profile>

Sets an email profile to use to send an email alert 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.



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.



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> <MAC address>

Adds an entry to the ARP table, mapping an IP address to 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 commands

Description

auto show statistics Continuously displays email statistics. cc <email addresses>

Sets Cc addresses for email alerts. <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 <email address>

Sets the From address for email alerts. <email address> = email address to list in the From field of the email alert.



chem. level commands

Description

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 counters

Restores the email counters to the aggregate values.

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

Sets a domain name that will be used when connecting to an SMTP server to send an email alert instead of the device’s domain name in EHLO. <domain> = domain name to override the current domain name in EHLO.

priority high Sets X-Priority for email alerts to 2. priority low Sets X-Priority for email alerts to 4. priority normal Sets X-Priority for email alerts to 3. priority urgent Sets X-Priority for email alerts to 1. priority very low Sets X-Priority for email alerts to 5. Reply to <email address>

Sets Reply-To address for email alerts. <email address> = email address to list in the Reply-To field of the email alert.

send Sends an email using the current settings. server port <number> Sets the port used by the SMTP server.

<number> = port used for SMTP on the server side. show Displays email settings. show history Displays the last 20 commands entered during the current CLI

session. show log Displays the email log. show statistics Displays email statistics. subject <string> Sets the subject for email alerts.

<string> = text to placed as the subject. to <email addresses>

Sets email address to which the email alerts will be sent. <email addresses> = a quoted, semi-colon separated list of email addresses.

write 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



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 line <string>

Sets the string used to quit the "connect line <line>" 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 sessions <number>

Sets the maximum allowed concurrent incoming SSH 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 sessions <number>

Sets the maximum concurrent incoming Telnet sessions. <numbers> = number of sessions.

telnet port <number> Sets the local port that the Telnet server uses. <number> = local port number.


configure Level Commands Command Path: enable>config

Level Prompt: config

The following commands are available in the configure level.

config level commands

Description

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 set <time(hh:mm:ss)> <day (1-31)> <month text> <year>

Sets the system clock.



config level commands

Description

clock timezone Shows possible time zone names. clock timezone <time zone> <hour offset>

Sets the timezone to be displayed.

clock timezone <time zone> <hour offset> <minute offset>

Sets the timezone to be displayed.

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.



connect Level Commands

Command Path: enable>tunnel #> connect

Level Prompt: connect


The following commands are available in the connect level.

connect level commands

Description

aes decrypt key binary <hexadecimal>

Sets the connect tunnel AES decrypt key with up to 16 bytes. 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 set <text>

Sets the connect tunnel AES decrypt key with up to 16 bytes. Each byte is represented by a single character. Note that quotes must enclose the value if it contains spaces.

aes encrypt key binary <hexadecimal>

Sets the connect tunnel AES encrypt key with up to 16 bytes. 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 set <text>

Sets the connect tunnel AES encrypt key with up to 16 bytes. 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 character

Enables the tunneling server to establish a tunneling connection when a character is received on the corresponding line (serial port).

connect mode disable Disables connect mode tunneling. connect mode modem control asserted

Enables the tunneling server to make tunneling connections when the modem control pin is asserted.

connect mode modem emulation

Enables modem emulation for connect mode tunneling.

connect mode start character

Enables connect mode tunneling when the configured start 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".




Description

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

Sets an email profile to use to send an email alert upon establishing a connect mode tunnel. <number> = the number of the email profile to use.

email disconnect <number>

Sets an email profile to use to send an email alert upon closing 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 <milliseconds>

Sets the reconnect time value for tunneling connections 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.




Description

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

Sets the SSH user name for use when establishing tunneling connections with other devices. <text> = SSH user name.

tcp keep alive <milliseconds>

Enables TCP keep alive for connect mode tunneling and sets the timer. <milliseconds> = timer value, in milliseconds.


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 memory <code filename>

Displays memory utilization by line reference for one 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.



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


The following commands are available in the disconnect level.

disconnect level commands

Description

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

Disconnects when no data has been received on the line (serial port) for the specified length of time. <milliseconds> = timeout in milliseconds.


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.




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

Ping destination n times with x timeout (in seconds)

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

Begin session on network <host>:<port> as <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.





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> <destination file>

Copy an existing 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



filesystem level commands Description

<destination file> <host> tftp get ascii <source file> <destination file> <host> <port>

Get an ascii file using TFTP

tftp get binary <source file> <destination file> <host>

Get a binary file using TFTP

tftp get binary <source file> <destination file> <host> <port>

Get a binary file using TFTP

tftp put ascii <source file> <destination file> <host>

Put an ascii file using TFTP

tftp put ascii <source file> <destination file> <host> <port>

Put an ascii file using TFTP

tftp put binary <source file> <destination file> <host>

Put a binary file using TFTP

tftp put binary <source file> <destination file> <host> <port>

Put a binary file using TFTP

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.



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.


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




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

Creates or modifies a user for an HTTP server authentication directive. <uri> = URI of the server. <user> = username. <password> = password associated with the username.

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 user <uri> <user>

Deletes an existing user for an HTTP Server 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




%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 commands

Description

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



icmp level commands

Description

exit Exits to the configuration level. no clear counters

Unzeros IP 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



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 live

Restores the default IP multicast time to live, which is one hop.

exit Exits to the configuration level. multicast time to live <hops>

Sets the IP multicast time to live. <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 commands

Description



ip filter level commands

Description

add <ip address> <subnet mask>

Adds an entry to the IP filter table.

clrscrn Clears the screen.

exit Returns to the config level.

remove <ip address> <subnet mask>

Removes an entry from the IP filter table.

show Displays the IP filter table.



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 string disable

Disables user-defined serial boot string to be echoed in the CLI.

command mode echo serial string enable

Enables user-defined serial boot string to be echoed in the CLI.

command mode serial string Enables user to enter a custom string at boot time to enter command mode.

command mode serial string <string>

Sets a string that can be entered at boot time to enter command mode. <string> = text.

command mode serial string binary <string>

Sets a binary string that can be entered at boot time 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




message <string> serial port when the device boots and when the line is in command mode. <string> = text.

command mode signon message binary <string>

Sets a binary sign-on message that is sent from the 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 time <milliseconds>

Sets boot-up wait time for command mode serial 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 string

Prevents the user-defined serial boot string from being used to enter command mode in the CLI.

no command mode signon message

Clears the signon message displayed at boot time 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.




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.


terminal network Enters the configure-terminal level for the network. tunnel <line> Enters the tunnel level.



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 commands

Description

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.



link level commands

Description

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

Ping destination n times with x timeout (in seconds)

show Show system information show eds8pr Show system information


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.



� 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 commands

Description

auto show <line>

Continuously displays lpd status for the specified 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 commands

Description

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.




Description

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.




Description

<number of lines> <number of lines> = number of lines to print. tunnel <line> Enters the tunnel level.



modem Level Commands

Command Path: enable>tunnel #>modem

Level Prompt: tunnel-modem:#


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

modem level commands

Description

clrscrn Clears the screen.

connect string <text> Sets the CONNECT string used in modem emulation. <string> = connect string.

default incoming connection

Default disables incoming network connections.

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 disable

Returns OK on unknown AT commands.

error unknown commands enable

Returns an error upon unknown AT commands.

exit Returns to the tunnel level. incoming connection automatic

Automatically answer incoming network connections.

incoming connection disabled

Disable incoming network connections.

incoming connection manual

Wait for an ATA command before answering an incoming 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.




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:#


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

packing level commands

Description

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 character

Sets packing mode to accumulate data and transmit it 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.


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 character <control>

Sets the trailing 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.


serial Level Commands

Command Path: enable>tunnel #>serial

Level Prompt: tunnel-serial:#


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

serial level commands

Description

buffer size <bytes>

Sets the size of the buffer for data read from the serial port. <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 connected

Asserts DTR whenever a connect or accept mode tunnel connection is active.

dtr continuously asserted

Asserts DTR regardless of any connections.

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 level commands

Description

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.



root Level Commands The following commands are available at the root level.

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

Ping destination n times with x timeout (in seconds).

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.



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

Set Client User with password, command and optional RSA or DSA keys

client user <user> <password> <command> <public> <private>

Set Client User with password, command and RSA or DSA keys

client user <user> generate dsa 1024

Generate DSA public and private keys





client user <user> generate rsa 1024

Generate RSA public and private keys





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

Sets Host username, password and either a RSA or DSA public key. Place the entire contents of the file generated by ssh-keygen within quotes.

host user <user> <password> <public> <public>

Sets Host username, password and both RSA 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



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 commands

Description

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 authority <cert>

Removes an Intermediate Authority Certificate. <cert> = index displayed by "show authority" command.

no rsa Removes RSA Certificate and Private Key no trusted authority <cert>

Removes a Trusted Authority Certificate. <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.




snmp Level Commands Command Path: enable>configure>snmp

Level Prompt: config-snmp

Following are the commands available in the snmp level.

snmp level commands

Description

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 rw <string>

Sets the SNMP read-write community 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> <ip address>

Sets the primary and secondary SNMP trap hosts. <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 <ip address> <ip address>

Deletes the designated SNMP server trap hosts. <ip address> = IP address of an SNMP server.

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.



syslog Level Commands Command Path: enable>configure>syslog

Level Prompt: config-syslog

Following are the commands available in the syslog level.

syslog level commands

Description

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.



tcp Level Commands

Command Path: enable>configure>tcp

Level Prompt: config-tcp

Following are the commands available in the tcp level.

tcp level commands

Description

ack limit <packets>

Sets the number of packets that must be received before an ACK 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 expedited

Sets TCP to send data whenever the window is sufficiently open, for improved real-time performance.

send data standard

Sets TCP to send data in accordance with standards.

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 commands

Description

break duration <milliseconds>

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



terminal level commands

Description

clrscrn Clears the screen. default break duration

Restores the break duration to the default value (500 ms).

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 disable

On the login connect menu, removes the menu item allowing the user to exit to the CLI.

exit connect menu enable

On the login connect menu, inserts the menu item allowing the user to exit to the CLI.


login connect menu disable

Disables the login connect menu, so a user will get the CLI immediately after logging in.

login connect menu enable

Enables the login connect menu, so a user will get the menu rather than the CLI immediately after logging in.


no send break Removes the configured send break character. preview connect menu

Shows the layout of the connect menu with current settings.

send break <control>

Sets the optional send break character. <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.


session. terminal <line> Enters the configure-terminal level.


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.



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 level commands

Description

break duration <milliseconds>

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

clrscrn Clears the screen. default break duration

Restores the break duration to the default value (500 ms).

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 disable

On the login connect menu, removes the menu item allowing the user to exit to the CLI.

exit connect menu enable

On the login connect menu, inserts the menu item allowing the user to exit to the CLI.


login connect menu disable

Disables the login connect menu, so a user will get the CLI immediately after logging in.

login connect menu enable

Enables the login connect menu, so a user will get the menu rather than the CLI immediately after logging in.


no send break Removes the configured send break character. preview connect menu

Shows the layout of the connect menu with current settings.

send break <control>

Sets the optional send break character. <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.


session.



terminal network level commands

Description

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 commands

Description

allow file creation disable

Prohibits the TFTP server from creating files on the file system.

allow file creation enable

Enables the TFTP server to create files on the file system.

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:#


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



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.


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.


terminal network Enters the configure-terminal level for the network. tunnel <line> Enters the tunnel level.



udp Level Commands Command Path: enable>config>udp

Level Prompt: config-udp



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

udp level commands

Description

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.


44:: CCoonnffiigguurraattiioonn UUssiinngg XXMMLL 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.

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:


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



The remainder of the file consists of nested “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


<configrecord>

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

<configitem name = “mode”>


</configitem>

</configgroup>

</configrecord>

Figure 4-4. XML Example with Multiple Named Values


<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


<configgroup name = "email" instance = "1">

<configitem name = "to">

<value>[email protected]</value>

</configitem>

<configitem name = "from">

<value>[email protected]</value>

</configitem>

</configgroup>

Figure 4-6. XML Example with Multiple Groups


<configgroup name = "ftp server">

<configitem name = "state">

<value>enable</value>

</configitem>

<configitem name = "admin username">

<value>admin</value>

</configitem>

<configitem name = "admin password">

<value></value>

</configitem>

</configgroup>

<configgroup name = "tftp server">

<configitem name = "state">

<value>enable</value>

</configitem>



<configitem name = "allow file creation">


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



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, lin e:4"

The following example imports all tunneling settings and line settings for all serial ports from a file named xcr_file:

xcr import xcr_file "tunnel accept, tunnel connect, tunnel disconnect, tunnel modem, tunnel packing, tunnel se rial, 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 ca pture --> <configgroup name = "xml paste passwords"> <configitem name = "passwords"> <value name = "cli login"></value> <value name = "cli enable level"></valu e> </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: .



Table 4-1. EDS Import and Export Groups

Group Name

Item Name

Value Name

Value Import/ Export

Additional Information

timeout import/export In seconds.

ip address Import arp entry

mac address

import

Add a dynamic entry to the ARP table.

arp

arp delete import Remove an entry from the

ARP table. Specify the entry by its IP address.

enable level password

import/export Placeholder

If configured and not exporting secrets, exports only a placeholder.

login password



cli

quit connect line

import/export Normally this will be a control key. For example, <control>L

zone import/export Time zone name such as GMT.

time zone

offset import/export Time zone offset from GMT as [-]HH:MM.

hours import

minutes import

seconds import

day of month

import

month import

clock

time set

year import

long name

import/export

serial number

export

short name

import/export

device

firmware version

export

to import/export Multiple to addresses may be separated with semicolons.

from import/export

reply to import/export

cc import/export Multiple cc address may be separated with semicolons.

email

(Attribute of “instance” is a number.)

subject import/export



Group Name

Item Name

Value Name



message file

import/export

local port import/export Either a specific number or “Random”.

server port import/export

Very Low

Low

Normal

High

priority

Urgent

import/export

overriding domain

import/export

auto

full

duplex

half

import/export

auto

10

ethernet

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

100

import/export

enable state

disable

import/export

admin username

import/export

ftp server

admin password



name import/export

telnet protocol

ssh

import/export

remote address

import/export

remote port import/export

host


ssh username

import/export Username must correspond to a configured ssh client user.

realm import/export

type import/export

user

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

password import/export Placeholder


http authentication uri

(Attribute of “instance” is the URI.)

user delete name Import Deletes the single named

user.



Group Name

Item Name

Value Name



enable state

disable

import/export

port import/export

secure port import/export

enable ssl3

disable

import/export

enable ttls 1.0

disable

import/export

enable

secure protocols

ttls 1.1

disable

import/export

max timeout

import/export

max bytes import/export

enable logging state

disable

import/export

log format import/export

http server

max log entries

import/export

enable icmp

state

disable

import/export

enable bootp

disable

import/export

enable dhcp

disable

import/export

dhcp client id

import/export Set the identity of the 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 gateway

import/export

primary dns import/export

interface

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

secondary dns

import/export

ip multicast time to live

import/export Specifies number of hops.



Group Name

Item Name

Value Name



enable delete entries

disable

import If enabled, deletes any existing entries before adding “filter entry”.

ip address filter entry

net mask

import/export

ip address

ip filter

filter delete

net mask

import Deletes a specific IP filter entry.

enable state

disable

import/export

baud rate import/export Any value from 300 to 230400 in bits per second.

7 data bits

8

import/export

none

even

parity

odd

import/export

1 stop bits

2

import/export

hardware

software

flow control

none

import/export

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

none

lpd

lpd or tunnel

protocol

tunnel

import/export

rs232

rs485 half-duplex

line


interface

rs485 full-duplex

Import/export Some products and lines only support RS-232.



Group Name

Item Name

Value Name



enable banner

disable

import/export

enable binary

disable

import/export

enable convert newline

disable

import/export

enable eoj

disable

import/export

eoj text import/export

enable formfeed

disable

import/export

queue name

import/export

enable soj

disable

import/export

lpd


soj text import/export

enable query port state

disable

import/export

enable feed

disable

import/export

enable persist

disable

import/export

rss

max entries import/export

always

disable

mode

serial string

import/export

enable echo serial string

disable

import/export

serial string import/export

signon message

import/export

serial command mode


wait time import/export Milliseconds.



Group Name

Item Name

Value Name



enable state

disable

import/export

system name

import/export

system contact

import/export

system description

import/export

system location

import/export

enable state

disable

import/export

primary destination

import/export

traps

secondary destination

import/export

read community

import/export

Placeholder


snmp

write community





Group Name

Item Name

Value Name



private dsa key

import/export

Placeholder


public dsa key

import/export

private rsa key

import/export

Placeholder


public rsa key

import/export

password import/export

Placeholder


client user

(Attribute of “instance” is required for the user name)

remote command

import/export

public rsa key

import/export known host

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

public dsa key

import/export

known host delete

name import Deletes the named known host.

client user delete

name import Deletes the named client user.

enable delete known hosts

disable

import If enabled, deletes any existing hosts before adding “known host”.

enable

ssh client

delete client users

disable

import If enabled, deletes any existing client users before adding “client user”.

max sessions

import/export

enable state

disable

import/export

ssh command mode

port import/export



Group Name

Item Name

Value Name



public key import/export host rsa keys

private key import/export

Placeholder


public key import/export host dsa keys


Placeholder



Placeholder


public rsa key

import/export

authorized user

(Attribute of “instance” is required for the authorized user name)

public dsa key

import/export

authorized user delete

name import Deletes the named SSH authorized user.

enable delete authorized users

disable

import If enabled, deletes any authorized users before adding “authorized user”.

enable

ssh server

delete host keys

disable

import If enabled, deletes any existing host keys before adding “host X keys”.

trusted ca

(Attribute of “instance” is a number from 0 to N)

import/export Enter the text of the certificate.

certificate import/export Enter the certificate text. rsa certificate private key import/export

Placeholder

Enter the text of the private key.


certificate import/export Enter the text of the certificate.

dsa certificate


Placeholder

Enter the text of the private key.


enable

ssl

delete all cas

disable

import If enabled, deletes any existing trusted cas before adding “trusted ca”.



Group Name

Item Name

Value Name



host import/export

local port import/export


emergency

alert

critical

error

warning

notice

information

severity log level

debug

import/export

enable

syslog

state

disable

import/export

enable resets

disable

import/export

ack limit import/export Number of packets received before an ACK is forced.

standard

tcp

send data

expedited

import/export

max sessions

import/export

enable state

disable

import/export

telnet command mode

port import/export

break duration

import/export milliseconds

enable echo

disable

import/export

enable exit connect menu

disable

import/export

enable login connect menu

disable

import/export

send break import/export control character

terminal

(Attribute of “instance” is either “network” or a number.)

terminal type

import/export

enable state

disable

import/export

enable

tftp server

allow file creation

disable

import/export

always

disable

tunnel accept

(Attribute of

accept mode

any character

import/export



Group Name

Item Name

Value Name



start character

modem control asserted

modem emulation

aes decrypt key



aes encrypt key



local port import/export

tcp

tcp aes

ssh

ssl

protocol

telnet

import/export

enable flush serial

disable

import/export

enable block serial

disable

import/export

enable block network

disable

import/export

tcp keep alive

import/export Milliseconds

email connect

import/export

email disconnect

import/export

enable prompt

disable

import/export

“instance” is a number.)

password


Placeholder


always

disable

any character

start character

modem control asserted

tunnel connect


connect mode

modem emulation

import/export



Group Name

Item Name

Value Name



aes decrypt key



aes encrypt key



local port import/export Either a specific number or “Random”.

remote address

import/export


tcp

udp

ssh

ssl

tcp aes

udp aes

protocol

telnet

import/export

reconnect time

import/export Milliseconds.

enable flush serial

disable

import/export

ssh username

import/export Username must correspond to a configured ssh client user.

enable block serial

disable

import/export

enable block network

disable

import/export

tcp keep alive

import/export Milliseconds.

email connect

import/export

email disconnect

import/export

enable character stop

disable

import/export

enable flush serial

disable

import/export

enable modem control

disable

import/export

tunnel disconnect


timeout

import/export Milliseconds. A value of 0 disables the timeout.



Group Name

Item Name

Value Name



enable echo pluses

disable

import/export

enable echo commands

disable

import/export

enable verbose response

disable

import/export

text response type

numeric

import/export

enable error unknown commands

disable

import/export

disabled

automatic

incoming connection

manual

import/export

connect string

import/export

enable

tunnel modem


display remote ip

disable

import/export

disable

timeout

packing mode

send character

import/export

timeout import/export Milliseconds.

threshold import/export Bytes.

send character

import/export

tunnel packing


trailing character

import/export

buffer size import/export Bytes.

asserted while connected

continuously asserted

tunnel serial


dtr

unasserted

import/export

start character

import/export

enable

tunnel start


echo

disable

import/export

stop character

import/export

enable

tunnel stop


echo

disable

import/export



Group Name

Item Name

Value Name



enable restore factory configuration

disable

import/export

enable delete http authentication uris

disable

import/export Deletes existing http authentication uris before importing new ones.

http authentication uri delete

name import/export Deletes the specified http authentication uri.

enable

xml import control

reboot

disable

import/export Reboots after importing.

cli login import Used with the CLI capture feature. If pasting XML into the CLI login password prompt, this field must be the correct CLI login password.

xml paste passwords

passwords

cli enable level

import Same as above.



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

ip address

mac address

age

Arp


arp entry

type

buffer pool This group contains other groups: ethernet driver, line #, protocol stack.

time

date

zone

clock

timezone

offset

product type

serial number

firmware version

uptime

saved

device product info

permanent config

unsaved

sent success

sent with retries

failed

email

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

time email log


entry

log




total

free

used

buffer headers

max used

cluster size

total

free

ethernet driver

(within group “buffer pool”)

cluster pool

used

size

available clean

available dirty

used total

used data

filesystem

busy

file count

directory count

system count

open count

lock count

entries

share count

current

firmware begin

firmware end

firmware erase cycles

bank a begin

bank a end

bank a erase cycles

bank b begin

bank b end

filesystem

banks

bank b erase cycles

enable status

disable

admin username

rejected connections

accepted

ip address

ftp

last client

port

hardware cpu type




speed

flash size memory

ram size

enable state

disable

http port ports

https port

max bytes

max timeout

enable state

disable

max entries

format

entries

http

logging

bytes

entry


entries

http log

totals

bytes

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

in

address mask replies

messages

messages discarded

icmp

out

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

status generic

errors

speed ethernet

duplex

encapsulation

type

arp

timeout

default gateway

network mask

domain

mac address

hostname

ip address

last change

mtu

primary dns

secondary dns

octets

unicast

non unicast

discards

errors

broadcast packets

multicast packets

filtered packets

deferred

interface


transmit

multiple retries




one retry

underflows

late collisions

retry errors

carrier lost errors

octets

unicast

non unicast

discards

errors

broadcast packets

multicast packets

filtered packets

unknown protocol

framing errors

overflows

crc errors

receive

missed frame errors

state

default ttl

forwarded

route discards

receives

header errors

address errors

unknown protocols

discarded

in

delivered

requests

discards

out

discards no route

timeout

needed

success

reassembly

failures

needed

failures

ip

fragments

success




protocol

rx queue

tx queue

local address

local port

remote address

remote port

ip sockets ip socket

state

bytes

breaks

parity errors

framing errors

overrun errors

no receive buffer errors

queued bytes

receiver

flow control

bytes

breaks

queued bytes

transmitter

flow control

cts

rts

dsr

line


line levels

dtr

state

protocol

baud rate

parity

data bits

stop bits

flow control

xon char

line

(within group “line”)

xoff char

total

free

used

buffer headers

max used

line <number>


cluster pool cluster size




total

free

used

max used

jobs printed

bytes printed

current client ip address

current client port

last client ip address

lpd


last client port

condition

total memory

available memory

fragments

memory main heap

allocated blocks

pid

cpu %

stacks

processes process

thread name

total

free

used

buffer headers

max used

cluster size

total

free

used

protocol stack


cluster pool

max used

status

ip address last connection

port

discoveries

unknown queries

in

erroneous packets

discovery replies

query port

out

errors

rss url




entries data

bytes

baud

parity

data bits

stop bits

line


flow control

local port

remote ip address

remote port

ssh

(Attribute of “instance” is the ssh session number.)

duration

local port

remote ip address

remote port

sessions

telnet

(Attribute of “instance” is the telnet session number.)

duration

state

local port

uptime

bytes in

totals

bytes out

local ip address

local port

remote ip address

remote port

uptime

bytes in

current connection

bytes out

local ip address

local port

remote ip address

ssh

last connection

remote port

state

host

severity to log

messages send

syslog

messages failed

algorithm tcp retransmission

timeout minimum




timeout maximum

maximum

open active

open passive

failed

resets

connections

established

in

out

segments

retransmitted

in resets

out

errors in

state

local port

uptime

bytes in

totals

bytes out

local ip address

local port

remote ip address

telnet

last connection

remote port

state

creation

downloaded

uploaded

not found

read

write

errors

unknown

ip address

tftp

last client

port

completed connects

completed accepts

disconnects

dropped connects

dropped accepts

tunnel


aggregate

octets from serial




octets from network

connect connection time

accept connection time

connect dns address changes

connect dns address invalids

local ip address

local port

remote ip address

remote port

uptime

octets from serial

octets from network

connect dns address changes

current connect connections

connect dns address invalids

local ip address

local port

remote ip address

remote port

uptime

octets from serial

current accept connections

octets from network

echo commands

verbose response

response type

error unknown commands

tunnel modem

(within group “tunnel”)

incoming connection

in unknown ports

in datagrams

in errors

udp

out datagrams

bytes

lines

out

elements

xsr

errors

Index


IInnddeexx

A accept Level Commands, 12 arp Level Commands, 14

B Best practices, XML, 54 buffer pool group, 70

C chem Level Commands, 14 CLI

Device menu, 21 Serial port configuration, 6, 7 Summary of commands, 11 Telnet configuration, 6

CLI Command Index, 11 CLI command usage, 70 CLI configuration, 6 CLI menus

Configure, 15, 16 Device, 20, 21 Enable, 21 Filesystem, 23 Interface 1 Level, 28 Line, 30 SSH, 40 SSL, 41 Tunnel, 47

CLI,Navigating the, 7 Configuration record schema, 50 Configuration Using XML, 50 Configure menu, 15, 16 Connect Level Commands, 18

D device Level Commands, 20 Device menu, 20, 21 Device server

Serial port configuration, 6, 7 Telnet configuration, 6 XML configuration, 50

disconnect Level Commands, 21

E enable Level Commands, 21

Enable menu, 21 Ethernet driver, 70 ethernet link Level Commands, 32 Exporting

system configuration record, 54

F filesystem Level Commands, 23 Filesystem menu, 23 ftp Level Commands, 24

G Groups, XML, 52

H host Level Commands, 25 Host menu, 24, 25 http Level Commands, 25

I icmp Level Commands, 27 if Interface Commands, 28 Import and export

XML groups, 56 XSR groups, 70

Import and Export Groups MatchPort AR, 57

Importing system configuration record, 54

Interface 1 Level menu, 28 ip Level Commands, 29 Items, XML, 52

K Keyboard Shortcut Commands, 10

L line Level Commands, 30 Line menu, 30 login Level Commands, 33 lpd Level Commands, 33, 34

M modem Level Commands, 36

Index


P packing Level Commands, 37 Protocol stack, 70

Q query port Level Commands, 38

R Records, XML, 52 Root Level Commands, 33 Root menu, 33 rss Level Commands, 39

S Schema, XML configuration record, 50 serial Level Commands, 38 Serial port configuration, 6 snmp Level Commands, 42 ssh Level Commands, 40 SSH menu, 40 SSL

menu, 41 ssl Level Commands, 41 Summary of

CLI commands, 11 Syntax examples for XML, 51 syslog Level Commands, 43 System configuration record

exporting, 54 importing, 54

T tcp Level Commands, 44

Telnet configuration, 6 terminal Level Commands, 44, 46 tftp Level Commands, 47 tunnel Level Commands, 47 Tunnel menu, 47

U udp Level Commands, 48

V Values, XML, 52

X XML

Partial Configurations, 54 Passwords, 56

XML Best practices, 54 configuration, 50 configuration record schema, 50 Group Example, 51 Records, groups, items, and values, 52 syntax examples, 51

XML Import and export groups, 56

XML declaration, 51 XML Group Example, 52 XML pages

Export system configuration record, 54 Import system configuration record, 54

XSR Import and export groups, 70

EDS_CR

Documents

Transcript of EDS_CR