Lantronix 900-581 User Manual

PremierWave EN

Command Reference

Part Number 900-581

Revision C March 2013

Copyright and Trademark

Lantronix® and PremierWaveare registered trademarks and DeviceInstaller™ is a trademar k of Lantronix, Inc.

Windows® and Internet Explorer® are a registered trademarks of Microsoft Corporation. Mozilla® and Firefox® are registered trademarks of the Mozilla Foundation. Chrome™ is a trademark of Google. Opera™ is a trademark of Opera Software ASA. Tera Term is a registered trademark of Vector, Inc. All other trademarks and trade names are the property of their respective holders.

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

January 2011 A Initial Document. July 2011 B Updated for release 7.2.0.0. Includes the new Bridging feature. March 2013 C

Updated for firmware release 7.3.0.1R7.

PremierWave EN Command Reference 2

Copyright and Trademark ____________________________________________________2 Contacts _________________________________________________________________2 Disclaimer ________________________________________________________________2 Revision History ______________________________ _____________________________2 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 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 _______________________________18 Best Practices ____________________________________________________________18

Importing _____________________________________________________________18

Exporting ____________________________________________________________19 XML Configuration Groups __________________________________________________20 XML Status Record Groups and Items _________________________________________34

4: Commands and Levels 45

PremierWave EN Command Reference 3

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

PremierWave EN Command Reference 4

List of Tables

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

PremierWave EN Command Reference 5

1: About This Guide

This guide describes how to configure the PremierWave EN 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 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 configure the

Chapter 4: Configuration Using XML Lists XCR groups and items and describes how to use XCRs to

Chapter 5: Commands and Levels Provides an index of the CLI Command Hierarchy with hyperlinks

Conventions

PremierWave EN.

configure the PremierWave EN.

to the corresponding command details.

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

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.

PremierWave EN Command Reference 6

Additional Documentation

Visit the Lantronix website at www.lantronix.com/support/documentation for the latest documentation and the following additional documentation.

Document Description

PremierWave EN User Guide Describes how to configure and use the PremierWave EN. PremierWave EN Integration Guide Contains information about the PremierWave hardware, the

PremierWave Evaluation Board Quick Start Guide

PremierWave Evaluation Board User Guide

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

PremierWave evaluation board, and integrating the PremierWave EN into your product.

Instructions for getting the PremierWave EN evaluation board up and running.

Information for using the PremierWave EN module on the evaluation board.

Instructions for using the Lantronix Windows-based utility to create virtual com ports.

the PremierWave EN and to view its current settings.

PremierWave EN Command Reference 7

2: Overview

PremierWave EN support three convenient configuration methods: Web Man ager, Command Line Interface (CLI) and Extensible Markup Language (XML). For more info rmation about the Web Manager, see the PremierWave EN 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. PremierWave 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, PremierWave EN uses industry-standard tools for configuration, communication, and control. For example, the PremierWave EN 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.

PremierWave EN Command Reference 8

3: Command Line Interface

This chapter describes accessing the PremierW av e EN by us ing Telne t, SSH, or ser ial po rts to configure the PremierWave EN, 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 www.lantronix.com/support/downloads

To access the PremierWave EN 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 PremierWave EN 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 requ 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.

See the PremierWave EN User Guide for directions on connecting the USB port prior to configuration.

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.

PremierWave EN Command Reference 9

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 10 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 re tu rn to o ne leve l hi ghe r—Type exit and pr ess 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 level—Type show.  To view the list of commands a vailable at the curr ent level—Type the question mar k "?". Items

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

 To view the available commands and explan ations—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>#show? 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>#show* displays a list of all echo commands and descriptions at the tunnel level.

 To view the last 20 commands e ntered at the CLI—Type show history.

PremierWave EN Command Reference 10

Using Keyboard Shortcuts and CLI

One useful shortcut built into PremierWave EN is that the co mp le te te xt of a comma nd do es 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.

PremierWave EN Command Reference 11

3: Command Line Interface

(login) enable

ssl

ethernet

link

If 1

query port

syslog

cpm

line <line>

filesystem

configure

device

ssh

telnet

rss

dns

wlan link

edit

email <number>

ssh

bridge

arp

diagnostics

ftp

host

http

smtp

wlan

profiles

vip

terminal

<line>

terminal network

tunnel <line>

xml

client

server

credentials

trusted

authorities

connect

disconnect

modem

packing

serial

icmp

If 2

cli

cp output password cp output

host

An overview of the levels in the PremierWave EN 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 subcommands. 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

PremierWave EN Command Reference 12

Figure 3-3 Login Level Commands

3: Command Line Interface

Note: >To configure the PremierWave EN, you must be in the enable level and any of its

sub-levels. Figure 3-4 below shows the enable level commands.

Figure 3-4 Enable Level Comman ds

>enable (enable)#? auto show interfaces auto show processes clrscrn configure connect connect line <line> cpm 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 ssh <optClientUsername> <host> ssh <optClientUsername> <host> <port> ssl telnet <host> telnet <host> <port> trace route <host> 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.

PremierWave EN 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+,configgroup*)> <!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

nd instance attributes.

 A <configitem> element must have one or more <value> elements and can have a name

ttribute.

 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"

ttribute is always a quoted string.

PremierWave EN 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 PremierWave EN User Guide for more information about the XCR groups.

 An empty or missing <va lue> 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.

Figure 4-2 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>

<value>disable</value>

</configitem>

</configgroup>

</configrecord>

The PremierWave EN uses the attributes in the following subsections to label the group configuration settings.

PremierWave EN 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 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 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.

4: Configuration Using XML

Figure 4-3 XML Example

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

<value>disable</value>

</configitem>

</configgroup>

</configrecord>

Figure 4-4 XML Example of Multiple Named Values

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

</configgroup>

PremierWave EN 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>

PremierWave EN Command Reference 17

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 PremierWave EN User Guide.

 CLI-XCRs can be imported (capture d) 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. PremierWave EN 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 Manage r 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 ser ve r FTP server can export and import XCRs when an FTP get or put

command on the filename (pwen.xcr for export, pwen_import.xcr for import; both are un der the pwxcr directory) is requested. On export (FTP get of pwen.xcr), the FTP server obtains the current XCR from the PremierWave EN and sends it as a file. On import (FTP put of pwen_import.xcr), the FTP server proc es se s the file by sending it directly to the XML engine. In both cases the device server filesystem is not accessed. The files pwen.xcr and pwen_import.xcr are not read from or written to the file system. See FTP in the PremierWave

EN User Guide.

4: Configuration Using XML

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 provide s th e same functionality.

Caution: Using Microsoft Word to edit and save an XCR will change the format of

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.

the file and make it incompatible with Pre mierWave EN. 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.

PremierWave EN Command Reference 18

4: Configuration Using XML

 Any white space requires the list of grou ps 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>

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 line2 fr om a n XCR named "factor y_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 tunnel settings for port 1 and all serial line tunne l settin gs fo r po rt 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"

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"

PremierWave EN Command Reference 19

4: Configuration Using XML

XML Configuration Groups

Table 4-7 lists the PremierWave EN 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

alarm barrel connector

power

input <instance> connect <instance>

terminal block power connect reminder

analog input (Attribute of “instance” is a number.)

adjustment simple offset, scale

alarm high Default: 0.0 alarm low Default: 0.0 alarm type none, high, low, high

decimal point Default: 5 delay Default: 0 seconds display enable, disable Default: enable input high Default: +1.0 input low Default: 0.0 offset range 100mv, 1v, 10v,

reading high Default: +1.0 reading low Default: 0.0 title units Default: V

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

interval connect <instance> email

Default: simple offset

and offset

Default: none

and low

Default: 10v

20ma

PremierWave EN Command Reference 20

4: Configuration Using XML

Group Name (continued)

arp arp delete ip address Remove an entry from

bridge state enable, disable Default: disable

cli enable level

cp group (Attribute of an

instance is “line1_modem_ctl_i n”, “line1_modem_ctrl_ out”, “line2_modem_ctl_i n”, “line2_modem_ctrl_ out”, “line2_rs485_hdpx”” , “line2_rs485_select”

device firmware version Read only.

diagnostics log max length Default: 50 KB

Group Item Value Name Value Options Additional

Information

the ARP table. Specify the entry by its IP address.

arp entry ip address

mac address

bridging mac address

Value is SECRET,

password inactivity timeout Default: 15 minutes line authentication enable, disable Default: disable login password Value is SECRET,

quit connect line Accepts text containing

cp (Attribute of an instance is a number)

state

long name serial number Read only. short name

bit type assert low

output disable, filesystem,

line <number>

hidden from user view.

hidden from user view. Default: PASS

control characters, for example, <control>A represents control-A Default: <control>L

Default: disable

PremierWave EN Command Reference 21

4: Configuration Using XML

Group Name (continued)

diagnostics (continued)

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

Group Item Value Name Value Options Additional

Information

managelinx network interface

cc message file priority urgent, high, normal,

reply to subject to from overriding domain Default: 25 server port local port <Random>,

device.dna.system.ne twork.iface.ipaddres

device.dna.system.ne twork.iface.name

device.dna.system.ne twork.iface.vip.pool

device.viproute.target .name

Default: normal

low, very low

Default: <Random>

...

cp group

trigger value Default: 0

ethernet duplex auto, half, ful l Default: auto

speed auto, 10, 100 Default: auto ftp server state host

(Attribute of “instance” is a number.)

http authentication uri

name

protocol telnet, ssh Default: telnet

ssh username

remote address

remote port Default: 0

realm

type

user (instance is

“admin”)

user delete name Deletes an HTTP

password

Authentication URI user. The value element is used to specify the user for deletion.

PremierWave EN Command Reference 22

4: Configuration Using XML

Group Name (continued)

http server state enable, disable Default: enable

icmp state enable, disable Default: enable interface

(Attribute of an “instance” is “eth0”, and “wlan0”)

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 state

Default: 30 minutes

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.

PremierWave EN Command Reference 23

4: Configuration Using XML

Group Name (continued)

ip ip time to live Default: 64 hops

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

Group Item Value Name Value Options Additional

Information

multicast time to live Default: 1 hops name interface rs232, rs485 half-

duplex, rs485 full-

duplex, usb-cdc-acm termination enable, disable Default: disable state enable, disable Default: depends on

protocol none, tunnel Default: baud rate Default: 9600 bits per

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:

instance

second

Default: none

character, for example, <control>A represents control-A Default: <control>Q

character, for example, <control>A represents control-A Default: <control>S

PremierWave EN Command Reference 24

4: Configuration Using XML

Group Name (continued)

managelinx plaintext dsm

query port state enable, disable Default: enable

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 (Attribute of an “instance” is a number).

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

PremierWave EN Command Reference 25

4: Configuration Using XML

Group Name (continued)

rss feed enable, disable Default: disable

serial command mode (Attribute of

“instance” is a number.)

smtp relay address

ssh state enable, disable Default: enable

Group Item Value Name Value Options Additional

Information

persist enable, disable Default: disable max entries Default: 100

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

PremierWave EN Command Reference 26

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

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

PremierWave EN Command Reference 27

4: Configuration Using XML

Group Name (continued)

ssl credentials rsa certificate

syslog state enable, disable Default: disable

telnet state enable, disable Default: enable

terminal (Attribute of “instance” is a number or

“network”)

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 (attribute of an “instance” is a number)

intermediate authority (attribute of an “instance” is a number)

delete all credentials enable, disable If enabled, deletes any

delete all cas enable, disable If enabled, deletes any

host remote port Default: 514 severity log level none, emergency,

port Default: 23 max sessions Default: 3 authentication enable, disable Default: disable terminal type Default: UNKNOWN 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

certificate

existing credentials

before adding

"credentials".

existing trusted cas

before adding "trusted

ca".

Default: none

alert, critical, error, warning, notice, information, debug

character, for example,

<control>A

represents control-A

milliseconds

PremierWave EN Command Reference 28

4: Configuration Using XML

Group Name (continued)

tunnel accept (Attribute of “instance” is a number.)

tunnel connect (Attribute of “instance” is a number.)

Group Item Value Name Value Options Additional

Information

accept mode disable, always Default: always

start character Accepts a control

character, for example,

<control>A

represents control-A

Default: <control>B

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> cp output group

connection value Default: 0

disconnection value Default: 0 connect mode disable, always, any

character, start character, modem control asserted, modem emulation

start character Accepts a control

flush start character enable, disable Default: enable local port <Random>,

...

Default: tcp

milliseconds

hidden from user view.

Default: disable

character, for example, <control>A represents control-A Default: <control>B

Default: <Random>

PremierWave EN Command Reference 29

4: Configuration Using XML

Group Name (continued)

tunnel connect (Attribute of “instance” is a number.)

(continued)

tunnel disconnect (Attribute of “instance” is a number.)

Group Item Value Name Value Options Additional

Information

host (Attribute of an “stance”s a number)

host mode sequential,

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> cp output group

stop character Accepts a control

flush stop character enable, disable Default: enable modem control enable, disable Default: disable timeout Default: 0 milliseconds flush serial enable, disable Default: disable

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,

simultaneous

connection value Default: 0 disconnection value Default: 0

Default: tcp

milliseconds

hidden from user view.

hidden from user view. Default: sequential

milliseconds

character, for example, <control>A represents control-A

PremierWave EN Command Reference 30

+ 182 hidden pages

Lantronix 900-581 User Manual

Copyright and Trademark

Contacts

Disclaimer

Revision History

Table of Contents

List of Figures

List of Tables

1: About This Guide

Chapter Summaries

Conventions

Additional Documentation

2: Overview

XML Architecture and Device Control

Command Line Interface

3: Command Line Interface

Configuration Using Telnet

Configuration Using Serial Ports

Navigating the CLI Hierarchy

Using Keyboard Shortcuts and CLI

Understanding the CLI Level Hierarchy

4: Configuration Using XML

XML Configuration Record Document Type Definition

Quick Tour of XML Syntax

Declaration

Element Start and End Tags

Element Attributes

Record, Group, Item, and Value Tags

Importing and Exporting an XML Configuration File

Best Practices

Importing

Exporting

XML Configuration Groups