EDS Command Reference EDS4100 EDS8PR EDS16PR EDS32PR EDS8PS EDS16PS

Transcription

1 EDS Command Reference EDS4100 EDS8PR EDS16PR EDS32PR EDS8PS EDS16PS Part Number Revision F February 2011

2 Copyright and Trademark Contacts Disclaimer 2011 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 is a trademark of Microsoft Corporation. Lantronix Corporate Headquarters 167 Technology Drive Irvine, CA 92618, USA Toll Free: Phone: Fax: Technical Support Online: Sales Offices For a current list of our domestic and international sales offices, go to the Lantronix web site at 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 Revision History Date Rev. Comments October 2006 A Initial Document. January 2007 B Updates EDSPR and EDS4100 to version October 2007 C Updates EDSPR and EDS4100 to version November 2008 D Introduces EDSPS release and updates EDSPR and EDS4100 to release May 2009 E Updates EDSPR and EDS4100 to version February 2011 F Updated for firmware v r20. Includes the new Modbus feature. EDS Command Reference 2

3 Table of Contents Table of Contents 3 List of Figures 4 List of Tables 5 1: About This Guide 6 Chapter Summaries 6 Conventions 6 Additional Documentation 7 2: Overview 8 XML Architecture and Device Control 8 Command Line Interface 8 3: Command Line Interface 9 Configuration Using Telnet 9 Configuration Using Serial Ports 9 Serial Command Mode 9 Serial Recovery 9 Navigating the CLI Hierarchy 10 Using Keyboard Shortcuts and CLI 10 Understanding the CLI Level Hierarchy 11 4: Configuration Using XML 14 XML Configuration Record Document Type Definition 14 Quick Tour of XML Syntax 15 Declaration 15 Element Start and End Tags 15 Element Attributes 15 Record, Group, Item, and Value Tags 16 Importing and Exporting an XML Configuration File 17 Best Practices 18 Importing 18 Exporting 19 Passwords in the XML File 19 XML Configuration Groups 20 XML Status Record Groups and Items 35 5: Commands and Levels 49 EDS Command Reference 3

4 List of Figures Figure 3-1 CLI Level Hierarchy 12 Figure 3-2 Login Level Commands 13 Figure 3-3 Enable Level Commands 13 Figure 4-1 DTD for XCRs 14 Figure 4-2 XML Example 15 Figure 4-3 XML Example 16 Figure 4-4 XML Example of Multiple Named Values 16 Figure 4-5 XML Example of Multiple Items 17 Figure 4-6 XML Example with Multiple Groups 17 Figure 4-7 XML Example of Supplying Passwords 20 EDS Command Reference 4

5 List of Tables Table 4-8 XCR Groups 20 Table 4-9 XSR Groups and Items 35 Table 5-1 Commands and Levels 52 EDS Command Reference 5

6 1: About This Guide This guide describes how to configure the EDS using the Command Line Interface (CLI) and/or Extensible Markup Language (XML). It is written for software developers and system integrators. Chapter Summaries This table lists and summarizes each chapter and appendix. Chapter Chapter 2: Overview Chapter 3: Command Line Interface Chapter 4: Configuration Using XML Chapter 5: Commands and Levels Summary Gives an overview of CLI and XML. Lists commands and describes how to use CLI to configure the EDS. Lists XCR groups and items and describes how to use XCRs to configure the EDS. Provides an index of the CLI Command Hierarchy with hyperlinks to the corresponding command details. Conventions The table below lists and describes the conventions used in this book. Convention Bold text Italic text Brackets [ ] Angle Brackets < > Pipe Description Default parameters. Required values for parameters Optional parameters. Possible values for parameters. Choice of parameters. Warning Warning: Means that you are in a situation that could cause equipment damage or bodily injury. Before you work on any equipment, you must be aware of the hazards involved with electrical circuitry and familiar with standard practices for preventing accidents. Note Note: Means take notice. Notes contain helpful suggestions, information, or references to material not covered in the publication. Caution Caution: Means you might do something that could result in faulty equipment operation, or loss of data. Screen Font (Courier New) CLI terminal sessions and examples of CLI input. EDS Command Reference 6

7 1: About This Guide Additional Documentation Visit the Lantronix web site at for the latest documentation and the following additional documentation. Document EDS 8/16/32PR Quick Start EDS 8/16PS Quick Start EDS4100 Quick Start EDS User Guide Description Information about the EDS hardware installation and initial configuration of your EDS8PR, EDS16PR or EDS32PR. Information about the EDS hardware installation and initial configuration of your EDS8PS or EDS16PS. Information about the EDS hardware installation and initial configuration of your EDS4100. Describes how to install, configure and use the EDS4100, EDS8PR, EDS16PR, EDS32PR, EDS8PS and EDS16PS. Com Port Redirector Quick Start and Online Help DeviceInstaller Online Help Instructions for using the Lantronix Windows-based utility to create virtual com ports. Instructions for using the Lantronix Windows-based utility to locate the EDS and to view its current settings. EDS Command Reference 7

8 2: Overview Evolution OS is the Lantronix cutting-edge operating system that supports three convenient configuration methods: Web Manager, Command Line Interface (CLI), and Extensible Markup Language (XML). For more information about the Web Manager, see the EDS User Guide at the Lantronix website. XML Architecture and Device Control XML is a fundamental building block for the future growth of Machine-to-Machine (M2M) networks. Evolution supports XML configuration records that make configuring the device server easy for users and administrators. XML configuration records are easy to edit with a a standard text editor or an XML editor. For a brief overview of XML, see Chapter 4: Configuration Using XML. It provides rules on basic XML syntax, a guide to the specific XML tags used, and a guide to using XML configuration records. Command Line Interface Making the edge-to-enterprise vision a reality, Evolution OS uses industry-standard tools for configuration, communication, and control. For example, the Evolution OS uses a command line interface (CLI) whose syntax is very similar to that used by data center equipment such as routers and hubs. For details of the CLI, see Chapter 5: Commands and Levels. It provides an index of the CLI Command Hierarchy with links to the corresponding command details. The CLI provides commands for configuring, monitoring, and controlling the device server. EDS Command Reference 8

9 3: Command Line Interface This chapter describes accessing the EDS by using Telnet, SSH, or serial ports to configure the EDS, navigating the Command Line Interface (CLI), typing keyboard shortcuts, and moving between the levels. It contains the following sections: Configuration Using Telnet Configuration Using Serial Ports Navigating the CLI Hierarchy Using Keyboard Shortcuts and CLI Understanding the CLI Level Hierarchy Refer to Chapter 5: Commands and Levels for a complete list of levels, commands, and descriptions. Configuration Using Telnet To access and configure the device server by using a Telnet session over the network, you must first establish a Telnet connection. You can also establish a Telnet connection by clicking the Telnet Configuration tab in DeviceInstaller. See the DeviceInstaller Online Help for more information, available on our website To access the EDS by using Telnet, perform the following steps. 1. Click Start > Run. The Run dialog box displays. 2. Type telnet x.x.x.x (x.x.x.x is the IP address). The EDS is online when the command prompt (>) displays. You are at the root level of the CLI. Note: Depending on the level of security, a password may be required. Configuration Using Serial Ports Serial Command Mode The serial port can be configured to operate in command mode permanently or to be triggered under specified conditions. See the line <line> Level command description for more information. Serial Recovery In this mode, the normal boot process is interrupted, allowing recovery from unknown or incorrect configuration settings. While the back door is active, the CLI prompt is changed to >> (instead of > ) and the Web Manager is inaccessible. These serve as an important indication that the device boot processes has been temporarily halted. To complete the boot process, terminate the serial CLI session (with the command). EDS Command Reference 9

10 3: Command Line Interface 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. The exclamation point displays on the terminal or PC screen. 4. Type xyz within 5 seconds to display the CLI prompt. Navigating the CLI Hierarchy The CLI is organized into a hierarchy of levels. Each level has a group of commands for a specific purpose. For example, to configure a setting for the FTP server, one would navigate to the FTP level, which is under the configuration level. To move to a different level Enter the name of the level from within its parent level. For example, to enter the tunnel level, type tunnel <number> at the enable prompt. This displays: <enable> tunnel <number>#. To and return to one level higher Type and press the Enter key. Typing at the login level or the enable level will close the If Line Command Mode is specified as Always, a new session starts immediately. To view the current configuration at any level Type. To view the list of commands available at the current level Type the question mark "?". Items within < > (e.g. <string>) are required parameters. To view the available commands and explanations Type the asterisk ( *). To view the list of commands available for a partial command Type the partial command followed by the question mark "?". For example: <tunnel-1>#echo? displays a list of all echo commands at the tunnel level. To view available commands and their explanations for a partial command Type the partial command followed by the asterisk ( *). For example: <tunnel-1>#echo* displays a list of all echo commands and descriptions at the tunnel level. To view the last 20 commands entered at the CLI Type. Using Keyboard Shortcuts and CLI One useful shortcut built into Evolution OS is that the complete text of a command does not have to be entered to issue a command. Typing just enough characters to uniquely identify a command, then hitting enter, can be used as a short cut for a command. For example, at the enable level, "sh" can be used for the "" command. Tab Completion is also available. Typing the first few characters of a command, then hitting the <tab> key displays the first command that begins with those characters. Hitting the <tab> key again displays the next command that begins with the original characters typed. You can press <Enter> to execute the command or you can backspace to edit any parameters. The following key combinations are allowed when configuring the device server using the CLI: Ctrl + a: place cursor at the beginning of a line EDS Command Reference 10

11 3: Command Line Interface 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 command Esc + b: move cursor back one word Esc + f: move cursor forward one word Understanding the CLI Level Hierarchy The CLI hierarchy is a series of levels. Arranging commands in a hierarchy of levels provides a way to organize and group similar commands, provide different levels of security, and reduce the comply and number commands and options presented to a user at one time. When you start a command line session, you begin at the login level. This level can be password protected and provides access to high level status, a few diagnostic commands, and the enable level. Further device information and configuration are accessed via the enable level. The enable level can also be password protected and is the gateway to full configuration and management of the device server. There are commands for gathering and effecting all elements of device status and configuration, as well as commands that take you to additional levels. For instance, tunnel specific status and configuration is found under the "tunnel" level, and network specific status and configuration commands are found under the "configuration" level. An overview of the levels in the EDS is presented in Figure 3-1. EDS Command Reference 11

12 3: Command Line Interface Figure 3-1 CLI Level Hierarchy (login) enable configure device dns Filesystem line <line> lpd ssh ssl tunnel <line> accept connect arp cli diagnostics ftp host http icmp If 1 ip ip filter lpd <number> modbus query port ssh telnet Ethernet link Not available in EDS8PR, EDS16PR, EDS32PR, EDS8PS & EDS32PS disconnect rss modem rtc packing smtp serial snmp xml syslog tcp terminal <line> terminal network tftp udp vip Commands at the login level, n in Figure 3-2, do not affect current configuration settings and are not displayed initially. If you type <?>, you will see the login sub-commands. These commands provide diagnostic and status information only. EDS Command Reference 12

13 3: Command Line Interface >? ping <host> <count> trace route <host> > Figure 3-2 Login Level Commands enable ping <host> ping <host> <count> <timeout> eds4100 lines Note: Replace eds4100 in Figure 3-2 and Figure 3-3 with the appropriate product name as needed: eds8pr, eds16pr, eds32pr, eds8ps or eds16ps. To configure the EDS, you must be in the enable level and any of its sub-levels. Figure 3-3 s the enable level commands. Figure 3-3 Enable Level Commands >enable (enable)#? auto interfaces auto processes clear interfaces counters configure connect connect line <line> device disable dns <number> filesystem kill ssh <session> kill telnet <session> line <line> lpd no clear interfaces counters ping <host> ping <host> <count> ping <host> <count> <timeout> reload reload factory defaults eds4100 interfaces ip sockets lines processes sessions ssh ssh <optclientusername> <host> ssh <optclientusername> <host> <port> ssl telnet <host> telnet <host> <port> trace route <host> tunnel <line> xml See the Chapter 5: Commands and Levels at the end of this document for a complete list of levels, commands, and descriptions. EDS Command Reference 13

14 4: Configuration Using XML The device server provides an Extensible Markup Language (XML) interface that you can use to configure device server devices. Every configuration setting that can be issued from the device server Web Manager and CLI can be specified using XML. The device server can import and export configuration settings as an XML document known as an XML Configuration Record (XCR). An XCR can be imported or exported via the CLI, a Web browser, FTP, or the device server filesystem. An XCR can contain many configuration settings or just a few. For example, it might change all of the configurable parameters for a device server, or it may only change the baud rate for a single serial line. Using XCRs is a straightforward and flexible way to manage the configuration of multiple device server devices. XML Configuration Record Document Type Definition An XML document type definition (DTD) is a description of the structure and content of an XML document. It verifies that a document is valid. XCRs are exported using the DTD n in Figure 4-1. Figure 4-1 DTD for XCRs <!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 rules state the following: The XML document element is a <configrecord> element. This is the root element. A <configrecord> must have one or more <configgroup> elements and can have a version attribute. A <configgroup> must have one or more <configitem> elements and can have name and instance attributes. A <configitem> element must have one or more <value> elements and can have a name attribute. A <value> element can have only data and can have a name attribute. The name attribute identifies a group, item, or value. It is always a quoted string. The instance attribute identifies the specific option, like the serial port number. The instance attribute is always a quoted string. EDS Command Reference 14

15 4: Configuration Using XML Notes: The name for each <configgroup> (specified with the name attribute) is the group name listed in the Web Manager XCR groups or with the xcr list CLI command. See the EDS User Guide for more information about the Web Manager XCR groups. An empty or missing <value> element in each present <configgroup> clears the setting to its default. Quick Tour of XML Syntax Declaration The first line, <?xml version= 1.0 standalone= yes?>, is called the XML declaration. It is required and indicates the XML version in use (normally version 1.0). The remainder of the file consists of nested XML elements, some of which have attributes and content. Element Start and End Tags An element typically consists of two tags: start tag and an end tag that surrounds text and other elements (element content). The start tag consists of a name surrounded by angle brackets, for example <configrecord>. The end tag consists of the same name surrounded by angle brackets, but with a forward slash preceding the name, for example </configrecord>. The element content can also contain other child elements. Element Attributes The XML element attributes that are name-value pairs included in the start tag after the element name. The values must always be quoted, using single or double quotes. Each attribute name should appear only once in an element. Figure 4-2 s an XML example which consists of a declaration (first line), nested elements with attributes and content. Figure 4-2 XML 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 Evolution OS uses the attributes in the following subsections to label the group configuration settings. EDS Command Reference 15

16 4: Configuration Using XML Record, Group, Item, and Value Tags A <configgroup> is a logical grouping of configuration parameters and must contain one or more <configitem> elements. It must have a name attribute and may have an instance attribute. A <configitem> is a specific grouping of configuration parameters relevant to its parent group. An item takes the name attribute and must contain one or more value elements. For example, the line group might have parameters such as baud rate, data bits, and parity. A value may specify the value of a configuration parameter. It may contain the name attribute. In this example, a value of 9600 might be specified for baud rate; 7 may be specified for data bits, and even may be specified for parity. A name attribute identifies the group, item, or value. It is always quoted (as are all XML attributes). For example, a group that contains serial port parameters has the name line. An instance attribute identifies which of several instances is being addressed. It is always quoted. For example, the serial port name (in the line configgroup) has the instance 1 to indicate serial port 1 or 2 to specify serial port 2. The following figures examples of XML configuration records and the use of the <configrecord>, <configgroup>, <configitem>, and <value> XML elements. Figure 4-3 XML Example <?xml version= 1.0 standalone= yes?> <configrecord> <configgroup name = serial command mode instance = 1 > <configitem name = mode > <value>disable</value> </configitem> </configgroup> </configrecord> Figure 4-4 XML Example of Multiple Named Values <?xml version= 1.0 standalone= yes?> <configgroup name = ssh server <configitem name = host rsa keys > <value name = public key ></value> <value name = private key ></value> </configitem> </configgroup> EDS Command Reference 16

17 4: Configuration Using XML Figure 4-5 XML Example of Multiple Items <?xml version= 1.0 standalone= yes?> <configgroup name = instance = 1 > <configitem name = to > <value>john.doe@somewhere.com></value> </configitem> <configitem name = from > <value>evolution@eds4100.com></value> </configitem> </configgroup> Note: Replace eds4100 above with the appropriate product name as needed: eds8pr, eds16pr, eds32pr, eds8ps or eds16ps. Figure 4-6 XML Example with Multiple Groups <?xml version= 1.0 standalone= yes?> <configgroup name = "ftp server"> <configitem name = "state"> <value>enable</value> </configitem> <configitem name = "admin username"> <value>admin</value> </configitem> <configitem name = "admin password"> <value><!-- configured and ignored --></value> </configitem> </configgroup> <configgroup name = "tftp server"> <configitem name = "state"> <value>enable</value> </configitem> <configitem name = "allow file creation"> <value>disable</value> </configitem> </configgroup> Importing and Exporting an XML Configuration File An XCR can be imported or exported using the following methods: Filesystem XCRs can be saved to the device server file system and imported or accessed as needed. See Best Practices or the Filesystem Browser section in the EDS User Guide. CLI XCRs can be imported (captured) or exported (dumped) directly to a Telnet, SSH, or serial line Capturing an XCR can be started by pasting a valid XCR directly into EDS Command Reference 17

18 4: Configuration Using XML the CLI prompt. Evolution OS immediately processes the configuration record, changing any settings specified. This can be done on any level, including the root. Special tags in the XML allow for providing root and enable level passwords so that this can also be done at the password prompt. Web browser Web Manager can be used to import and export an XCR to the device server file system. It can also be used to import an XCR from an external source such as your local hard drive. FTP The device server FTP server can export and import XCRs when an FTP get or put command on the filename eds[4100,8pr,16pr,32pr].xcr is requested. On export (FTP get of eds[4100,8pr,16pr,32pr].xcr), the FTP server obtains the current XCR from Evolution OS and sends it as a file. On import (FTP put of eds[4100,8pr,16pr,32pr].xcr), the FTP server processes the file by sending it directly to the XML engine. In both cases the device server filesystem is not accessed. The file eds[4100,8pr,16pr,32pr].xcr is not read from or written to the file system. See FTP in the EDS User Guide. TFTP TFTP supports XCR importing. Due to limited security capabilities of TFTP, the option is disabled by default. Best Practices You can import or export an entire XCR, or just a portion of it, by specifying the group name and/or group instances. In the examples below, import and export operations are performed from the CLI on the local filesystem and require a XCR on the local filesystem. The Web Manager provides the same functionality. Caution: Using Microsoft Word to edit and save an XCR will change the format of the file and make it incompatible with Evolution OS. This is true even if the file is saved as Plain Text (.txt) or an XML Document (.xml). Notepad, a third party text editor, or a specialized XML editor should be used instead. Importing The following syntax can be used to import configurations from a file: xcr import <file> xcr import <file> <groups and/or group:instances> The first line imports all groups specified in the XML config record named in <file>. Any filename is valid, and the file name and extension are not important. Caution: In the second line: The filename eds[4100,8pr,16pr,32pr].xcr is not acceptable, because performing a FTP get on that name produces the current configuration and does not perform an FTP from the filesystem. Also, the filename eds[4100,8pr,16pr,32pr].xsr is not acceptable, because performing an FTP get on that name produces the current status and does not get anything from the filesystem. 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. EDS Command Reference 18

19 4: Configuration Using XML Only the named groups get imported, even if the XCR contains additional XCR groups. The following syntax can be used to export configurations to a file on the device server s file system: xcr export <file> xcr export <file> <groups and/or group:instances> The same guidelines above regarding importing configurations also apply to exporting configurations. If no groups are specified, then the export command will export all configuration settings to the file. If instances are specified after the groups, only those group instances are written. If no instance is specified, all instances of that group are written. Exporting The following example exports only the accept mode tunneling settings for line 1 to the file tunnel_1.xcr on the device server filesystem: xcr export tunnel_1.xcr tunnel accept:1 The following example exports only the connect mode tunneling settings for all ports to the file tunnel_all.xcr on the device server filesystem: xcr export tunnel_all.xcr tunnel connect The following example imports only the settings for line 2 from a XCR named factory_config.xcr on the device server filesystem. If factory_config.xcr has other configuration settings, they are ignored: xcr import factory_config.xcr line:2 The following example imports only line settings for all ports from a configuration record on the device server filesystem named foobar.xcr : xcr import foobar.xcr line To import only disconnect mode tunneling settings for port 1 and serial line settings for port 2 from an XML configuration record named production.xcr that contains these settings (and possibly more), issue the following command: xcr import production.xcr "tunnel disconnect:1, line:2" The following example imports all tunneling settings and line settings for all serial ports from a file named xcr_file: xcr import xcr_file "tunnel accept, tunnel connect, tunnel disconnect, tunnel modem, tunnel packing, tunnel serial, tunnel start, tunnel stop, line" The following example exports only accept mode tunneling settings on serial port 1, and line settings on serial port 2 to a file named tunnel_config_t1_l2.xcr on the device server filesystem. xcr export tunnel_config_t1_l2.xcr "tunnel accept:1, line:2" The following example exports connect mode tunneling and line settings for all ports to the file tunnel_config.xcr on the device server filesystem: xcr export tunnel_config.xcr "tunnel, line" Passwords in the XML File If you log in to a device server to which you will be pasting an XCR, you do not need to include passwords in the file, because you are already logged into the device. However, if you send an EDS Command Reference 19

20 4: Configuration Using XML XCR to one or more devices that are password protected, you can include the appropriate passwords in the XCR and skip the 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. Figure 4-7 s an example. Figure 4-7 XML Example of Supplying Passwords <! To supply passwords when importing via cli capture --> <configgroup name = "xml paste passwords"> <configitem name = "passwords"> <value name = "cli login"></value> <value name = "cli enable level"></value> </configitem> </configgroup> XML Configuration Groups Table 4-8 lists the EDS XCR groups in alphabetical order. This table indicates the various group items, as well as some possible value names and options. Note: Modbus, as described in the table below, is only available on the EDS4100 and is not supported in the EDS8PR, EDS16PR, EDS32PR, EDS8PS and EDS16PS. Note: Any instance of < in the table may be read as < (the html encoded form for less than) and any instance of > may be read as > (the html encoded form for greater than). Table 4-8 XCR Groups Group Name Group Item Value Name Value Options Additional Information arp arp delete ip address Remove an entry from the ARP table. Specify the entry by its IP address. arp entry ip address mac address timeout Default: 60 seconds EDS Command Reference 20

21 4: Configuration Using XML Group Name Group Item Value Name Value Options Additional Information cli login password Value is SECRET, hidden from user view. enable level password quit connect line Value is SECRET, hidden from user view. Accepts text containing control characters, for example, <control> A represents control-a Default: <control>l inactivity timeout <None>,... Default: 15 minutes clock time zone zone import/export Time zone name such as GMT. device offset import/export Time zone offset from GMT as [-]HH:MM time set hours import short name long name serial number firmware version minutes seconds day of month month year import import import import import diagnostics log output disable, filesystem, line <number> max length severity level debug, information, notice, warning, error Read only. Read only. Default: disable Default: 50 Kbytes Default: debug EDS Command Reference 21

22 4: Configuration Using XML Group Name Group Item Value Name Value Options Additional Information (Attribute of instance is a number.) ethernet (Attribute of instance is eth0.) to cc from reply to subject message file overriding domain Multiple addresses may be separated with semicolons. Multiple addresses may be separated with semicolons. server port Default: 25 local port priority <Random>,... urgent, high, normal, low, very low Default: <Random> Default: normal speed auto, 10, 100 Default: auto duplex auto, half, full Default: auto ftp server state enable, disable Default: enable host (Attribute of instance is a number.) http authentication uri (Attribute of instance is the URI.) admin username admin password name Default: admin Value is SECRET, hidden from user view. protocol telnet, ssh Default: telnet ssh username remote address remote port Default: 0 user delete name Deletes an HTTP Authentication URI user. The value element is used to specify the user for deletion. realm type user (Attribute of instance is the user name.) password EDS Command Reference 22

23 4: Configuration Using XML Group Name Group Item Value Name Value Options Additional Information http server state enable, disable Default: enable port <None>,... Default: 80 secure port <None>,... Default: 443 secure protocols ssl3, tls1.0, tls1.1 May contain zero, one, or more of the values, separated by commas. Default: ssl3, tls1.0, tls1.1 max timeout Default: 10 seconds max bytes Default: logging state enable, disable Default: enable max log entries Default: 50 log format Default: %h %t "%r" %s %B "%{Referer}i" "%{User-Agent}i" authentication timeout Default: 30 minutes icmp state enable, disable Default: enable EDS Command Reference 23

24 4: Configuration Using XML Group Name Group Item Value Name Value Options Additional Information interface (Attribute of instance is eth0 ) bootp enable, disable Default: disable dhcp enable, disable Default: enable ip address <None>,... Accepts an IP address and mask as either: (1) IP address only ( ) gets a default mask, (2) CIDR ( /24), or (3) Explicit mask ( ). default gateway <None>,... Accepts in IP address in dotted notation, like hostname domain dhcp client id Set the identity of the client device. primary dns <None>,... Accepts in IP address in dotted notation, like secondary dns <None>,... Accepts in IP address in dotted notation, like mtu Default: 1500 bytes ip ip time to live Default: 64 hops multicast time to live Default: 1 hops ip filter delete entries enable, disable If enabled, deletes any existing entries before adding filter entry. filter delete ip address Deletes a specific IP filter entry. net mask Deletes a specific IP filter entry. filter entry ip address If configured, is a specific IP address. net mask If configured, is a specific net mask. EDS Command Reference 24

25 4: Configuration Using XML Group Name Group Item Value Name Value Options Additional Information line (Attribute of instance is a number.) lpd (Attribute of instance is a number.) name interface rs232, rs485 halfduplex, rs485 fullduplex Default: termination enable, disable Default: disable state enable, disable Default: depends on instance protocol baud rate none, modbus rtu, modbus ascii, tunnel, ppp, lpd, lpd or tunnel Default: Default: 9600 bits per second parity even, none, odd Default: none data bits 7, 8 Default: 8 stop bits 1, 2 Default: 1 flow control xon char xoff char none, hardware, software Default: none Accepts a control character, for example, <control> A represents control-a Default: <control>q Accepts a control character, for example, <control> A represents control-a Default: <control>s gap timer <None>,... Default: <None> threshold Default: 56 bytes banner enable, disable Default: enable binary enable, disable Default: disable soj enable, disable Default: disable eoj enable, disable Default: disable formfeed enable, disable Default: disable convert newline enable, disable Default: disable soj text eoj text queue name EDS Command Reference 25

26 4: Configuration Using XML Group Name Group Item Value Name Value Options Additional Information managelinx plaintext dsm credentials encrypted dsm credentials managelinx common managelinx network interface dna.xml.replication.protocol. version dna.capabilities.tcp.connect. fail dna.dsc.auth.tunnel.userna me dna.dsc.auth.ssh.pub dna.dsc.auth.ssh.priv device.dna.dsc.tunnel.portlis t.list device.dna.dsc.tunnel.ip.ad dr device.dna.dsc.tunnel.ip.list device.dna.dsc.tunnel.ssh.p ublic device.dnaid device.dna.dsc.tunnel.portlis t.httpconnect device.dna.dsc.tunnel.proxy. host device.dna.dsc.tunnel.proxy. port device.dna.dsc.tunnel.proxy. enable device.dna.system.change.n umber device.config.name device.dna.system.change.ti mestamp device.dna.dsc.replication.p eriod device.dna.system.network.i face.name device.dna.system.network.i face.ipaddress device.dna.system.network.i face.vip.pool device.viproute.target.name enable, disable Default: disable Default: 1800 seconds Default: 0 modbus tcp server state enable, disable Default: disable query port additional port <None>,... Default: <None> response timeout Default: 3000 milliseconds rss trace input enable, disable Default: disable state EDS Command Reference 26

27 4: Configuration Using XML Group Name Group Item Value Name Value Options Additional Information rss feed enable, disable Default: disable serial command mode (Attribute of instance is a number.) smtp persist enable, disable Default: disable max entries Default: 100 mode echo serial string serial string signon message wait time relay address relay port Default: 25 snmp state enable, disable Default: enable read community community system contact system name system description system location Value is SECRET, hidden from user view. Default: public Value is SECRET, hidden from user view. Default: private Default: <Default> Default: <Default> traps state enable, disable Default: enable primary destination secondary destination ssh state enable, disable Default: enable port Default: 22 max sessions Default: 3 EDS Command Reference 27

28 4: Configuration Using XML Group Name Group Item Value Name Value Options Additional Information ssh client delete known hosts known host delete known host (Attribute of instance is required for the known host name) delete client users client user delete client user (Attribute of instance is required for the user name) name public rsa key public dsa key name password remote command public rsa key private rsa key public dsa key private dsa key ssh server host rsa keys public key host dsa keys delete authorized users authorized user delete authorized user (Attribute of instance is required for the authorized user name) private key public key private key name password public rsa key public dsa key enable, disable enable, disable If enabled, deletes any existing hosts before adding known host. Specify the known host to delete. If enabled, deletes any existing client users before adding client user. Specify the user to delete. EDS Command Reference 28

29 4: Configuration Using XML Group Name Group Item Value Name Value Options Additional Information ssl RSA certificate certificate Enter the text of the certificate. private key Enter the text of the private key. If configured and not exporting secrets, exports only a placeholder. DSA certificate certificate Enter the text of the certificate. private key Enter the text of the private key. If configured and not exporting secrets, exports only a placeholder. delete all cas enable, disable If enabled, deletes any existing trusted cas before adding trusted ca. syslog state enable, disable Default: disable host local port Default: 514 remote port Default: 514 severity log level none, emergency, alert, critical, error, warning, notice, information, debug Default: none tcp resets enable, disable Default: enable ack limit Number of packets received before an ACK is forced. Default: 3 packets send data standard, expedited Default: standard telnet state enable, disable Default: enable port Default: 23 max sessions Default: 3 EDS Command Reference 29

30 4: Configuration Using XML Group Name Group Item Value Name Value Options Additional Information terminal (Attribute of instance is either network or a number.) terminal type login connect menu connect menu send break enable, disable enable, disable Default: UNKNOWN Default: disable Default: disable Accepts a control character, for example, <control> A represents control-a break duration Default: 500 milliseconds echo enable, disable Default: enable tftp server state enable, disable Default: enable allow file creation allow firmware update enable, disable enable, disable Default: disable Default: disable allow xcr import enable, disable Default: disable EDS Command Reference 30

31 4: Configuration Using XML Group Name Group Item Value Name Value Options Additional Information tunnel accept (Attribute of instance is a number.) tunnel connect (Attribute of instance is a number.) accept mode start character flush start character disable, always, any character, start character, modem control asserted, modem emulation enable, disable Default: always Accepts a control character, for example, <control> A represents control-a Default: <control>b Default: enable local port <None>,... Default: <None> protocol tcp, ssh, telnet, tcp aes, ssl Default: tcp tcp keep alive <None>,... Default: milliseconds aes encrypt key aes decrypt key Value is SECRET, hidden from user view. Value is SECRET, hidden from user view. flush serial enable, disable Default: disable block serial enable, disable Default: disable block network enable, disable Default: disable password password Value is SECRET, hidden from user view. prompt enable, disable Default: disable connect <None>,... Default: <None> disconnect <None>,... Default: <None> connect mode start character flush start character disable, always, any character, start character, modem control asserted, modem emulation enable, disable Default: disable Accepts a control character, for example, <control> A represents control-a Default: <control>b Default: enable EDS Command Reference 31

32 4: Configuration Using XML Group Name Group Item Value Name Value Options Additional Information tunnel disconnect (Attribute of instance is a number.) local port <Random>,... Default: <Random> host vip enable, disable Default: disable host mode vip name address port <None>,... Default: <None> protocol ssh username tcp, udp, ssh, telnet, tcp aes, udp aes, ssl Default: tcp Username must correspond to a configured ssh client user. validate certificate enable, disable Default: enable tcp keep alive <None>,... Default: milliseconds aes encrypt key aes decrypt key sequential, simultaneous Value is SECRET, hidden from user view. Value is SECRET, hidden from user view. Default: sequential reconnect time Default: milliseconds flush serial enable, disable Default: disable block serial enable, disable Default: disable block network enable, disable Default: disable connect <None>,... Default: <None> disconnect <None>,... Default: <None> stop character flush stop character enable, disable Accepts a control character, for example, <control> A represents control-a Default: enable modem control enable, disable Default: disable timeout Default: 0 milliseconds flush serial enable, disable Default: disable EDS Command Reference 32

33 4: Configuration Using XML Group Name Group Item Value Name Value Options Additional Information tunnel modem (Attribute of instance is a number.) tunnel packing (Attribute of instance is a number.) tunnel serial (Attribute of instance is a number.) tunnel start (Attribute of instance is a number. tunnel stop (Attribute of instance is a number. echo pluses enable, disable Default: disable echo commands enable, disable Default: enable verbose response enable, disable Default: enable response type text, numeric Default: text error unknown commands incoming connection connect string display remote ip packing mode enable, disable disabled, automatic, manual enable, disable disable, timeout, send character Default: disable Default: disabled Default: disable Default: disable timeout Default: 1000 milliseconds threshold send character trailing character dtr start character asserted while connected, continuously asserted, unasserted, truport Default: 512 bytes Accepts a control character, for example, <control> A represents control-a Default: <control>m Accepts a control character, for example, <control> A represents control-a Default: asserted while connected import/export echo enable import/export start character disable import/export echo enable import/export disable vip state enable, disable default: disable EDS Command Reference 33

34 4: Configuration Using XML Group Name Group Item Value Name Value Options Additional Information xml import control restore factory configuration delete http authentication uris http authentication uri delete name enable, disable Deletes existing http authentication uris before importing new ones. Deletes the specified http authentication uri. reboot enable, disable Reboots after importing. EDS Command Reference 34

35 4: Configuration Using XML XML Status Record Groups and Items Table 4-9 lists the supported XML Status Record (XSR) groups and items. These groups and items the status of the device in XML form and can only be exported. The XSR schema differs slightly from the XCR groups and items in that the XSR allows groups within groups. Currently, the only XSR groups that contain any sub groups are buffer pools and tunnel. The buffer pools group has the following sub groups: Protocol stack Ethernet driver Line The tunnel group has the following sub groups: Tunnel Modem Note: Modbus, as described in the table below, is only available on the EDS4100 and is not supported in the EDS8PR, EDS16PR, EDS32PR, EDS8PS and EDS16PS. Table 4-9 XSR Groups and Items Group Name Item Name Value Name Valid Values arp (Attribute of instance is eth0.) arp entry ip address mac address age type dynamic static buffer/protocol stack buffer headers total free used max used cluster pool cluster size total free used max used buffer pool this group contains other groups: ethernet driver, line #, protocol stack. clock time date timezone zone offset EDS Command Reference 35

36 4: Configuration Using XML Group Name Item Name Value Name Valid Values device product info product type (Attribute of instance is a number.) log (Attribute of instance is a number.) ethernet driver (Within group buffer pool.) success failed queued entry buffer headers cluster pool serial number firmware version uptime permanent config sent sent with retries time log total free used max used cluster size total free used max used saved unsaved EDS Command Reference 36

37 4: Configuration Using XML Group Name Item Name Value Name Valid Values filesystem filesystem size banks current A B firmware begin firmware end firmware erase cycles bank a begin bank a end bank a erase cycles bank b begin bank b end bank b erase cycles available space clean space dirty space file and dir space used data space used number of files number of directories number of system files opened files locked files opened for sharing busy no yes ftp status running inactive connections rejected accepted last client ip address port hardware cpu type speed memory flash size ram size http state enabled disabled logging entries bytes EDS Command Reference 37

38 4: Configuration Using XML Group Name Item Name Value Name Valid Values http log entry (Attribute of instance is a number.) totals entries bytes icmp in messages messages discarded errors destination unreachable time exceeded messages parameter problems source quench requests redirects ping requests ping replies timestamp requests timestamp replies address mask requests address mask replies out messages messages discarded errors destination unreachables time exceeded messages parameter problems source quench requests redirects ping requests ping replies timestamp requests timestamp replies address mask requests address mask replies interface (Attribute of instance is eth0.) generic status no link link up disabled unknown errors (error text) none EDS Command Reference 38

39 4: Configuration Using XML Group Name Item Name Value Name Valid Values interface (Attribute of instance is eth0.) (Continued.) ethernet (Present only for eth0.) speed 10 duplex 100 full half arp encapsulation ARPA default gateway network mask domain mac address hostname ip address last change mtu primary dns secondary dns transmit type timeout octets unicast non unicast discards errors broadcast packets multicast packets filtered packets deferred multiple retries one retry underflows late collisions retry errors carrier lost errors ARPA EDS Command Reference 39

40 4: Configuration Using XML Group Name Item Name Value Name Valid Values interface (Attribute of instance is eth0.) (Continued.) receive octets unicast non unicast discards errors broadcast packets multicast packets filtered packets unknown protocol framing errors overflows crc errors missed frame errors ip state enabled disabled default ttl forwarded route discards in receives header errors address errors unknown protocols discarded delivered out requests discards discards no route reassembly timeout needed success failures fragments needed failures success EDS Command Reference 40

41 4: Configuration Using XML Group Name Item Name Value Name Valid Values ip sockets ip socket protocol UDP TCP rx queue tx queue local address local port remote address remote port state line (Attribute of instance is a number.) receiver bytes breaks parity errors framing errors overrun errors no receive buffer errors queued bytes flow control n/a stop go transmitter bytes breaks queued bytes flow control n/a stop go line levels cts asserted not asserted rts asserted not asserted dsr asserted not asserted dtr asserted not asserted EDS Command Reference 41

42 4: Configuration Using XML Group Name Item Name Value Name Valid Values line <number> (within group buffer pool.) line (With no instance.) (Within group line with instance.) lpd (Attribute of instance is a number.) buffer headers cluster pool state protocol total free used max used cluster size total free used max used enable disable none ppp tunnel baud rate Any value from 300 to parity even none odd data bits 7 8 stop bits 1 2 flow control hardware none software xon char xoff char jobs printed bytes printed current client ip address current client port last client ip address last client port lpd EDS Command Reference 42

43 4: Configuration Using XML Group Name Item Name Value Name Valid Values memory main heap condition clean total memory available memory fragments allocated blocks modbus local slave totals pdus in pdus out exceptions modbus tcp server (Attribute of instance is permanent or additional.) state processes local port totals last connection current connection process (Attribute of instance is a number.) uptime pdus in pdus out connections local ip address local port remote ip address remote port local ip address local port remote ip address remote port uptime pdus in pdus out cpu % stack used stack size thread name corrupt down up binding no port EDS Command Reference 43