How it Works
Lantronix
Loading...
EDS-MD16
User Manual
98 pgs920.53 Kb0
User Manual 2
338 pgs4.85 Mb0
Table of contents
Loading...

Lantronix EDS-MD16, EDS-MD4, EDS-MD8 User Manual 2

EDS-MD
TM
Command Reference
EDS-MD4 EDS-MD8 EDS-MD16
Part Number 900-592
Revision A September 2011

Copyright and Trademark

© 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 wr itten permission of Lantron ix. Printed in the United States of America.
Ethernet is a trademark of XEROX Corporation. Windows is a trademark of the Microsoft Corporation.

Contacts

Lantronix Corporate Headquarters
167 Technology Drive Irvine, CA 92618, USA Toll Free: 800-526-8766 Phone: 949-453-3990 Fax: 949-450-7249
Technical Support
Online: www.lantronix.com/support
Sales Offices
For a current list of our domestic and international sales offices, go to the Lantronix web site at
www.lantronix.com/about/contact

Disclaimer

The information in this guide may change without notice. The manufacturer assumes no responsibility for any errors that may appear in this guide.

Revision History

Date Revision Comments
September 2011 A Initial Document. Created for the 7.2.0.0 release.
.

Table of Contents

Copyright and Trademark ____________________________________________________2 Contacts _________________________________________________________________2 Disclaimer ________________________________________________________________2 Revision History ______________________________ _____________________________2 List of Figures _____________________________________________________________4 List of Tables ______________________________________________________________5
About This Guide 6
Chapter Summaries ________________________________________________________6 Conventions ______________________________________________________________6 Additional Documentation ____________________________________________________7
Overview 8
XML Architecture and Device Control ___________________________________________8 Command Line Interface _____________________________________________________8
Command Line Interface 9
Configuration Using Telnet ___________________________________________________9 Configuration Using Serial Ports _______________________________________________9
Serial Command Mode ___________________________________________________9
Serial Recovery ________________________________________ ________________9 Navigating the CLI Hierarchy ________________________________________________10 Using Keyboard Shortcuts and CLI ____________________________________________11 Understanding the CLI Level Hierarchy ________________________________________11
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 XML Configuration Groups __________________________________________________20 XML Status Record Groups and Items _________________________________________31
Commands and Levels 41

List of Figures

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

List of Tables

Table 3-1 Keyboard Shortcuts ______________________________________________________11 Table 4-7 XCR Groups ____________________________________________________________20 Table 4-8 XSR Group and Items ____________________________________________________31 Table 5-1 Commands and Levels____________________________________________________47

1: About This Guide

This guide describes how to configure the EDS-MD4, EDS-MD8 and EDS-MD16 using the Command Line Interface (CLI) and/or Extensible Markup Language (XML). It is written for software developers and system integrators.
Note: EDS-MD device servers (which include models EDS-MD4, EDS-MD8 and
EDSMD16) are commonly referred to as either EDS-MD4/8/16 or as EDS-MD when mentioned within a description equally applicable to any of the three models.

Chapter Summaries

This table lists and summarizes content of each chapter.
Chapter Summary
Chapter 2: Overview Gives an overview of CLI and XML. Chapter 3: Command Line Interface Lists commands and describes how to use CLI to
Chapter 4: Configuration Using XML Lists XCR groups and items and describes how to use
Chapter 5: Commands and Levels Provides an index of the CLI Command Hierarchy with
configure the EDS-MD4/8/16.
XCRs to configure the EDS-MD4/8/16.
hyperlinks to the corresponding command details.

Conventions

The table below lists and describes the conventions used in this book.
Convention Description
Bold text Default parameters. Italic text Required values for parameters Brackets [ ] Optional parameters.
Angle Brackets < > Possible values for parameters. Pipe | Choice of parameters. Warning Warning: Means that you are in a situation that could cause
Note Note: Means take notice. Notes contain helpful suggestions, information,
Caution Caution: Means you might do something that could result in faulty
Screen Font (Courier New)
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.
or references to material not covered in the publication.
equipment operation, or loss of data.
CLI terminal sessions and examples of CLI input.

Additional Documentation

Visit the Lantronix website at www.lantronix.com/support/documentation for the latest documentation and the following additional documentation.
Document Description
EDS-MD User Guide Describes how to configure and use the EDS-MD4/8/16. EDS-MD Quick Start Guide Instructions for getting the EDS-MD4/8/16 up and running. Com Port Redirector
Quick Start and Online Help DeviceInstaller Online Help Instructions for using the Lantronix Windows-based utility to locate
1: About This Guide
Instructions for using the Lantronix Windows-based utility to create virtual com ports.
the EDS-MD4/8/16 and to view its current settings.

2: Overview

EDS-MD4/8/16 supports three convenient configuration methods: Web Manager, Command Line Interface (CLI) and Extensible Markup Language (XML). For more info rmation about the Web Manager, see the EDS-MD User Guide on the Lantronix website.

XML Architecture and Device Control

XML is a fundamental building block for the future gr owth of Machine-to-Machine (M2 M) networks. EDS-MD4/8/16 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, EDS-MD4/8/16 uses industry-standard tools for configuration, communication, and control. For example, the EDS-MD 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.

3: Command Line Interface

This chapter describes accessing the EDS-MD4/ 8/16 by usin g Te ln et , SSH, or seria l por ts to configure the EDS-MD, navigating the Command Line Interface (CLI), typing keyboar d 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 www.lantronix.com/support/downloads
.
To access the EDS-MD by using Telnet, perform the following steps.
1. Click Start > Run. The Run dialog box displays.
2. Type cmd in the dialog box and press OK.
3. Type telnet x.x.x.x (x.x.x.x is the IP address). The EDS-MD is online when the command prompt (>) displays. You are at the root level of the CLI.
Note: Depending on the level of secu rit y, a pa ssw or d ma y be req u ire d.

Configuration Using Serial Ports

Serial Command Mode

The serial port can be configured to operate in command mode permanently or to be triggered under specified conditions. See the line <line> Level command description for more information.

Serial Recovery

Serial Recovery mode will temporarily override the line and tunnel settings for the serial line to allow configuration changes to be made. The line and tunnel settings will be restored once the user exits the Serial Recovery mode CLI.
3: Command Line Interface
To configure the Lantronix device server locally using a serial port:
1. Connect a terminal or a PC running a terminal emulation program to one of the device server's serial ports.
2. Configure the terminal to the following settings:
9600 baud 8-bit No parity 1 stop bit No flow control.
3. Power off the device.
4. Press and hold down the exclamation point (!) key.
5. Power on the device. After about 20 seconds, the exclamation point will display on the terminal or PC screen.
6. 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 exit and return to one level higher—Type exit an d press the Enter key. Typing exit at the
login level or the enable level will close the CLI session. If Line - Command Mode is specified as Always, a new session starts immediately.
To view the current configuration at any lev el—Type show. To view the list of commands available at the current level—Type the question mar k "?". Items
within < > (e.g. <string>) are required parameters.
To view the available commands and explanations—Type the asterisk ( *). To view the list of commands available for a partial command—Type the partial command
followed by the question mark "?". For example: <tunnel-1>#echo? displays a list of all echo commands at the tunnel level.
To view available commands and their explanations for a partial command—Type the partial
command followed by the asterisk (*). For example: <tunnel-1>#echo* displays a list of all echo commands and descriptions at the tunnel level.
To view the last 20 commands entered at the CLI—Type show history.
EDS-MD Command Reference 10

Using Keyboard Shortcuts and CLI

One useful shortcut built into EDS-MD4/8/16 is that the complete text of a comma nd does not have to be entered to issue a command. Typing just enough characters to uniquely identify a command, then hitting enter, can be used as a short cut for a command. For example, at the enable level, "sh" can be used for the "show" command.
Tab Completion is also available using the Tab and Enter keys on the keyboard. 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:
Table 3-1 Keyboard Shortcuts
Key Combination Description
Ctrl + a Places cursor at the beginning of a line Ctrl + b Backspaces one character Ctrl + d Deletes one character Ctrl + e Places cursor at the end of the line Ctrl + f Moves cursor forward one character Ctrl + k Deletes from the current position to the end of the line Ctrl + l Redraws the command line Ctrl + n Displays the next line in the history Ctrl + p Displays the previous line in the history Ctrl + u Deletes entire line and places cursor at start of prompt Ctrl + w Deletes one word back Ctrl + z Exits the current CLI level Esc + b Moves cursor back one word Esc + f Moves cursor forward one word
3: Command Line Interface

Understanding the CLI Level Hierarchy

The CLI hierarchy is a series of levels. Arranging commands in a hierarchy of levels provides a way to organize and group similar commands, provide different levels of security, and reduce the complexity and number commands and options presented to a user at one time.
When you start a command line session, you begin at the login level. This level can be password protected and provides access to hig h lev el sta tu s, a few diag no stic commands, and the enable level. Further device information and configuratio n are accessed via the enable level.
The enable level can also be password protected and is the gateway to full configuration and management of the device server. There are comma nds for gathering and effecting all elements of device status and configuration, as well as commands that take you to additional levels. For instance, tunnel specific status and configuration is found under the "tunnel" level, and network specific status and configuration commands are found under the "configuration" level.
EDS-MD Command Reference 11
3: Command Line Interface
(login)
enable
ssl
ethernet
link
query port
smtp
line <line>
filesystem
configure
device
ssh
telnet
rss
dns
email
<number>
ssh
arp
diagnostics
ftp
host
<number>
http
ip
rtc
terminal network
syslog
terminal
<line>
tunnel <line>
xml
client
server
credentials
trusted
authorities
accept
connect
disconnect
modem
packing
serial
icmp
cli
If 1
vip
log
An overview of the levels in the EDS-MD is presented in Figure 3-2 CLI Level Hierarchy below.
Figure 3-2 CLI Level Hierarchy
Commands at the login level (see Figure 3-3 Login Level Commands below) 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.
>? clrscrn exit ping <host> ping <host> <count> ping <host> <count> <timeout> show show history show lines trace route <host> trace route <host> <method> enable >
Note: To configure the EDS-MD4/8/16, you must be in the enable level and any of its
sub-levels. Figure 3-4 below shows the enable level commands.
EDS-MD Command Reference 12
Figure 3-3 Login Level Commands
3: Command Line Interface
>enable
Figure 3-4 Enable Level Comman ds
(enable)#? auto show interfaces auto show processes clrscrn configure connect connect line <line> device disable dns email <number> exit filesystem kill ssh <session> kill telnet <session> line <line> ping <host> ping <host> <count> ping <host> <count> <timeout> reload reload factory defaults show show history show interfaces show ip sockets show lines show processes show sessions ssh <optClientUsername> <host>
ssh
ssh <optClientUsername> <host> <port> ssl telnet <host> telnet <host> <port> trace route <host> trace route <host> <method> tunnel <line> write xml
<enable>#
See the Chapter 5: Commands and Levels at the end of this document for a complete list o f levels, commands, and descriptions.
EDS-MD Command Reference 13

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 docu ment known as an XML Configuration Record (XCR). An XCR can be imported or exported via the CLI, a Web browser, FTP, or the device server filesystem. An XCR can contain many configuration settings or just a few. For example, it might change all of the configurable parameters fo r a device server, or it may only change the baud rate for a single serial line. Using XCRs is a straightforward and flexible way to manage the configuration of multiple device server devices.

XML Configuration Record Document Type Definition

An XML document type definition (DTD) is a description of the str uct ur e an d cont en t of an XML document. It verifies that a document is valid. XCRs are exported using the DTD as shown in
Figure 4-1 DTD for XCRs.
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-MD Command Reference 14
Note:
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 comma nd. Se e the EDS-MD User Guide for more information about the 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 (norm ally 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 ta g con sis ts of a na m e su rr ou nd e d by an g le br ackets, 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.
4: Configuration Using XML

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.
XML Example shows 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 EDS-MD4/8/16 uses the attributes in the following subsections to label the group configuration settings.
EDS-MD Command Reference 15

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 na m e attribute and may have an instance attribute.
A <configitem> is a specific grouping of configuration parameters relevant to its parent group. An item takes the name attribute and must contain one or more value elements. For example, the line group might have parameters such as baud rate, data bits, and parity.
A value may specify the value of a configuration parameter. It may contain the name attribute. In this example, a value of 9600 might be specified for baud rate; 7 may be specified for data bits, and even may be specified for parity.
A name attribute identifies the group, item, or value. It is always quoted (as are all XML attributes). For example, a group that contains serial port parameters has the name "line".
An instance attribute identifies which of several instances is being addressed. It is always quoted. For example, the serial port name (in the line configgroup) has the instance "1" to indicate serial port 1 or "2" to specify serial port 2.
The following figures show examples of XML conf igu ra tio n reco rd s an d th e us e of th e <configrecord>, <configgroup>, <configitem>, and <value> XML elements.
Figure 4-3 XML Example
4: Configuration Using XML
<?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 = "ethernet" instance = "eth0"> <configitem name = "speed"> <value>Auto</value> </configitem> <configitem name = "duplex"> <value>Auto</value> </configitem> </configgroup>
EDS-MD Command Reference 16
4: Configuration Using XML
Figure 4-5 XML Example of Multiple Items
<configgroup name="ssh server"> <configitem name="host rsa keys"> <value name="public key"/> <value name="private key"/> </configitem> <configitem name="host dsa keys"> <value name="public key"/> <value name="private key"/> </configitem> <configitem name="delete authorized users"> <value>disable</value> </configitem> <configitem name="authorized user delete"> <value name="name"/> </configitem> <configitem name="authorized user" instance=""> <value name="password"/> <value name="public rsa key"/> <value name="public dsa key"/> </configitem> </configgroup>
Figure 4-6 XML Example with Multiple Groups
<?xml version="1.0" standalone="yes"?> <configgroup name = "telnet"> <configitem name = "state"> <value>enable</value> </configitem> <configitem name = "authentication"> <value>disable</value> </configitem> </configgroup> <configgroup name = "ssh"> <configitem name = "state"> <value>enable</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 on page 18 or the Filesystem Browser section in the EDS-MD User Guide.
EDS-MD Command Reference 17
CLI-XCRs can be imported (captured) or exported (dumped) directly to a Telnet, SSH, or
serial line CLI session. Capturing an XCR can be started by pasting a valid XCR directly into the CLI prompt. EDS-MD4/8/16 immediately processes the configuration record, cha nging 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 fr om an extern al source such as you r local hard drive.
FTP-The device server FTP server can export and import XCRs when an FTP get or put
command on the filename (edsmd.xcr for export, edsmd_import.xcr for import; both are under the pwxcr directory) is requested. On export (FTP get of edsmd.xcr), the FTP server obtains the current XCR from the EDS-MD and sends it as a file. On import (FTP put of edsmd_import.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 files edsmd.xcr and edsmd_import.xcr are not read from or written to the file system. See FTP in the EDS-MD User Guide.

Best Practices

4: Configuration Using XML
You can import or export an entire XCR, or just a portion of it, by specifying the group name and/or group instances. In the examples below, import and export operations are performed from the CLI on the local filesystem and require a XCR on the local filesystem. The Web Manager provide s th e same functionality.
Caution: Using Microsoft Word to edit and save an XCR will change the format of
the file and make it incompatib le wi t h EDS-MD4/8/1 6. This is t rue even if the file is saved as Plain Text (.txt) or an XML Docu ment (.xml). Notepa d, a third party text editor, or a specialized XML editor should be used instead.

Importing

The following syntax can be used to import configurations from a file:
xcr import <file> xcr import <file> <groups and/or group:instances>
The first line imports all groups specified in the XML config record named in <file>. Any fil ename is valid, and the file name and extension are not important.
In the second line:
Instance follows group with a colon (see the third example on the next page). Multiple groups are separated with a comma. Any white space requires the list of groups to be quoted. Only the named groups get imported, even if the XCR contains additional XCR groups.
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>
EDS-MD Command Reference 18
4: Configuration Using XML
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"
EDS-MD Command Reference 19
4: Configuration Using XML

XML Configuration Groups

Table 4-7 lists the EDS-MD XCR groups in alphabetical order. This table indicates the various
group items, as well as some possible value names and options.
Note: Any instance of < in the table may be read as "less than" and any instance of
> may be read as "greater than".
Table 4-7 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
cli login password Value is SECRET,
hidden from user view. Default: PASS
enable level password
quit connect line Accepts text containing
inactivity timeout <None>, ... Default: 15 minutes line authentication enable, disable Default: disable
clock time zone zone
offset
time set hours
Value is SECRET, hidden from user view.
control characters, for example, <control>A represents control-A Default: <control>L
minutes seconds day of month year
device short name
long name serial number Read only. firmware version Read only.
EDS-MD Command Reference 20
4: Configuration Using XML
Group Name (continued)
diagnostics log output disable, filesystem,
email to
ethernet speed auto, 10, 100 Default: auto
host name
http authentication uri
Group Item Value Name Value Options Additional
Information
Default: disable
line <number>
max length Default: 50 KB
cc from reply to subject message file overriding domain server port Default: 25 local port <Random>,
...
priority urgent, high, normal,
low, very low
duplex auto, half, ful l Default: auto
protocol telnet, ssh Default: telnet ssh username remote address remote port Default: 0 user delete name Deletes an HTTP
realm type user password
Default: <Random>
Default: normal
Authentication URI user. The value element is used to specify the user for deletion.
EDS-MD Command Reference 21
4: Configuration Using XML
Group Name (continued)
http server state enable, disable Default: enable
icmp state enable, disable Default: enable interface state enable, disable Default: depends on
Group Item Value Name Value Options Additional
Information
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 secure credentials max timeout Default: 10 seconds max bytes Default: 40960 logging state enable, disable Default: enable max log entries Default: 50 log format Default: %h %t "%r"
%s %B "%{Referer}i"
"%{User-Agent}i" authentication
timeout
bootp enable, disable Default: disable dhcp enable, disable Default: enable ip address <None>, ... Accepts an IP address
default gateway <None>, ... Accepts in IP address
hostname domain dhcp client id primary dns <None>, ... Accepts in IP address
secondary dns <None>, ... Accepts in IP address
mtu Default: 1500 bytes
Default: 30 minutes
instance
and mask as either: (1)
IP address only
(192.168.1.1) gets a
default mask, (2) CIDR
(192.168.1.1/24), or (3)
Explicit mask
(192.168.1.1
255.255.255.0).
in dotted notation, like
192.168.1.1.
in dotted notation, like
192.168.1.1.
in dotted notation, like
192.168.1.1.
EDS-MD Command Reference 22
4: Configuration Using XML
Group Name (continued)
ip ip time to live Default: 64 hops
line name
Group Item Value Name Value Options Additional
Information
multicast time to live Default: 1 hops
interface rs232 Default: termination enable, disable Default: disable state enable, disable Default: depends on
instance protocol none, tunnel Default: baud rate 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 none, hardware,
software
xon char Accepts a control
xoff char Accepts a control
gap timer <None>, ... Default: <None> threshold Default: 56 bytes
Default: none
character, for example,
<control>A
represents control-A
Default: <control>Q
character, for example,
<control>A
represents control-A
Default: <control>S
EDS-MD Command Reference 23
4: Configuration Using XML
Group Name (continued)
managelinx plaintext dsm
query port state enable, disable Default: enable rss feed enable, disable Default: disable
Group Item Value Name Value Options Additional
Information
dna.xml.replication.pr
credentials
encrypted dsm credentials
managelinx common device.dna.system.ch
managelinx network interface
persist enable, disable Default: disable max entries Default: 100
otocol.version dna.capabilities.tcp.c
onnect.fail dna.dsc.auth.tunnel.u
sername dna.dsc.auth.ssh.pub dna.dsc.auth.ssh.priv device.dna.dsc.tunnel
.portlist.list device.dna.dsc.tunnel
.ip.addr device.dna.dsc.tunnel
.ip.list device.dna.dsc.tunnel
.ssh.public device.dnaid device.dna.dsc.tunnel
.portlist.httpconnect device.dna.dsc.tunnel
.proxy.host device.dna.dsc.tunnel
.proxy.port device.dna.dsc.tunnel
.proxy.enable
ange.number device.config.name device.dna.system.ch
ange.timestamp device.dna.dsc.replic
ation.period device.dna.system.ne
twork.iface.name device.dna.system.ne
twork.iface.ipaddress device.dna.system.ne
twork.iface.vip.pool device.viproute.target
.name
enable, disable Default: disable
Default: 1800 seconds
Default: 0
EDS-MD Command Reference 24
4: Configuration Using XML
Group Name (continued)
serial command mode
smtp relay address
ssh state enable, disable Default: enable
Group Item Value Name Value Options Additional
Information
mode always, serial string,
disable echo serial string enable, disable Default: enable serial string Sets a string that can
signon message Sets a sign-on
wait time Default: 5000
relay port Default: 25
port Default: 22 max sessions Default: 3
Default: disable
be entered at boot time to enter command mode. This text may specify binary characters. Within [] use binary decimal up to 255 or hex up to 0xFF. Within {} specify decimal milliseconds time delay.
message that is sent from the serial port when the device boots and when the line is in command mode. This text may specify binary characters. Within [] use binary decimal up to 255 or hex up to 0xFF.
milliseconds
EDS-MD Command Reference 25
4: Configuration Using XML
Group Name (continued)
ssh client delete known hosts enable, disable If enabled, deletes any
ssh server host rsa keys public key
Group Item Value Name Value Options Additional
Information
existing hosts before adding "known host".
known host delete name Specify the known host
to delete.
known host public rsa key
public dsa key
delete client users enable, disable If enabled, deletes any
existing client users before adding "client user".
client user delete name Specify the user to
delete.
client user password
remote command public rsa key private rsa key public dsa key private dsa key
client user password
remote command public rsa key private rsa key public dsa key private dsa key
private key
host dsa keys public key
private key
delete authorized users
authorized user delete
authorized user password
name
public rsa key public dsa key
EDS-MD Command Reference 26
4: Configuration Using XML
Group Name (continued)
ssl credentials rsa certificate
syslog state enable, disable Default: disable
tcp resets enable, disable Default: enable
telnet state enable, disable Default: enable
terminal terminal type Default: UNKNOWN
Group Item Value Name Value Options Additional
Information
rsa private key Value is SECRET,
hidden from user view. dsa certificate dsa private key Value is SECRET,
hidden from user view.
trusted authority certificate intermediate authority certificate delete all credentials enable, disable If enabled, deletes any
existing credentials
before adding
"credentials".
delete all cas enable, disable If enabled, deletes any
existing trusted cas
before adding "trusted
ca".
host remote port Default: 514 severity log level none, emergency,
alert, critical, error, warning, notice, information, debug
ack limit Default: 3 packets send data standard, expedited Default: standard max retrans Default: 12 max retrans syn ack Default: 2 max timeout Default: 60 seconds
port Default: 23 max sessions Default: 3 authentication enable, disable Default: disable
login connect menu enable, disable Default: disable exit connect menu enable, disable Default: disable send break Accepts a control
break duration Default: 500
echo enable, disable Default: enable
Default: none
character, for example,
<control>A
represents control-A
milliseconds
EDS-MD Command Reference 27
4: Configuration Using XML
Group Name (continued)
tunnel accept accept mode disable, always, any
tunnel connect connect mode disable, always, any
Group Item Value Name Value Options Additional
character, start character, modem control asserted, modem emulation
start character Accepts a control
flush start character enable, disable Default: enable local port Default: 0 protocol tcp, ssh, telnet, tcp
aes, ssl credentials tcp keep alive <None>, ... Default: 45000
aes encrypt key Value is SECRET,
aes decrypt key Value is SECRET,
flush serial enable, disable Default: disable block serial enable, disable Default: disable block network enable, disable Default: disable password password Value is SECRET,
prompt enable, disable Default: disable email connect <N one>, ... Default: <None> email disconnect <None>, ... Default: <None>
character, start character, modem control asserted, modem emulation
start character Accepts a control
flush start character enable, disable Default: enable local port <Random>,
...
Information
Default: always
character, for example, <control>A represents control-A Default: <control>B
Default: tcp
milliseconds
hidden from user view.
hidden from user view.
hidden from user view.
Default: disable
character, for example, <control>A represents control-A Default: <control>B
Default: <Random>
EDS-MD Command Reference 28
4: Configuration Using XML
Group Name (continued)
tunnel disconnect stop character Accepts a control
tunnel modem echo pluses enable, disable Default: disable
Group Item Value Name Value Options Additional
Information
host vip enable, disable Default: disable
vip name
address
port <None>, ... Default: <None>
protocol tcp, udp, ssh, telnet,
tcp aes, udp aes, ssl ssh username credentials validate certificate enable, disable Default: enable tcp keep alive <None>, ... Default: 45000
aes encrypt key Value is SECRET,
aes decrypt key Value is SECRET,
host mode sequential,
simultaneous
reconnect time Default: 15000
flush serial enable, disable Default: disable block serial enable, disable Default: disable block network enable, disable Default: disable email connect <N one>, ... Default: <None> email disconnect <None>, ... Default: <None>
flush stop character enable, disable Default: enable modem control enable, disable Default: disable timeout Default: 0 milliseconds flush serial enable, disable Default: disable
echo commands enable, disable Default: enable verbose response enable, di sable Default: enable response type text, numeric Default: text error unknown
commands incoming connection disabled, automatic,
connect string display remote ip enable, disable Default: disable
enable, disable Default: disable
manual
Default: tcp
milliseconds
hidden from user view.
hidden from user view. Default: sequential
milliseconds
character, for example, <control>A represents control-A
Default: disabled
EDS-MD Command Reference 29
4: Configuration Using XML
Group Name (continued)
tunnel packing packing mode disable, timeout, send
tunnel serial dtr asserted while
vip state enable, disable Default: disable xml import control restore factory
Group Item Value Name Value Options Additional
Information
Default: disable
character
timeout Default: 1000
milliseconds threshold Default: 512 bytes send character Accepts a control
character, for example,
<control>A
represents control-A
Default: <control>M trailing character Accepts a control
character, for example,
<control>A
represents control-A
Default: asserted while
connected, continuously asserted, unasserted, truport
enable, disable
configuration delete http
authentication uris
http authentication uri delete
reboot enable, disable Reboots after
name Deletes the specified
enable, disable Deletes existing HTTP
connected
authentication URIs
before importing new
ones.
HTTP authentication
URI.
importing.
EDS-MD Command Reference 30
Loading...
+ 308 hidden pages
Buy Points How it Works FAQ Contact Us Questions and Suggestions Privacy Policy Cookie Policy Terms of Use