Summary of the content on the page No. 1
PremierWave EN
Command Reference
Part Number 900-581
Revision C March 2013
Summary of the content on the page No. 2
Copyright and Trademark © 2013 Lantronix, Inc. 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. Lantronix® and PremierWave are registered trademarks and DeviceInstaller™ is a trademark 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
Summary of the content on the page No. 3
Table of Contents Copyright and Trademark ____________________________________________________2 Contacts _________________________________________________________________2 Disclaimer ________________________________________________________________2 Revision History ___________________________________________________________2 List of Figures _____________________________________________________________4 List of Tables ______________________________________________________________5 1: About This G
Summary of the content on the page No. 4
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 __________________________________
Summary of the content on the page No. 5
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
Summary of the content on the page No. 6
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 PremierWave EN. Chapter 4: Configurati
Summary of the content on the page No. 7
1: About This Guide 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, and integrating the PremierWave EN into your product. PremierWave Evaluation Board In
Summary of the content on the page No. 8
2: Overview PremierWave EN support three convenient configuration methods: Web Manager, Command Line Interface (CLI) and Extensible Markup Language (XML). For more information 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 growth of Machine-to-Machine (M2M) networks. PremierWave supports XML configuration records that make configuring the device server easy for users and
Summary of the content on the page No. 9
3: Command Line Interface This chapter describes accessing the PremierWave EN by using Telnet, SSH, or serial ports 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
Summary of the content on the page No. 10
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 ter
Summary of the content on the page No. 11
3: Command Line Interface Using Keyboard Shortcuts and CLI One useful shortcut built into PremierWave EN 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 "show" command. Tab Completion is also available using the Tab and Enter keys on the keyboard. Typing the first few chara
Summary of the content on the page No. 12
3: Command Line Interface 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 (login) enable configure arp bridge cpm device cli ssh dns telnet email diagnostics cp filesystem ftp host line ssh client http server icmp ethernet ssl credentials If 1 link trusted If 2 wlan link authorities ip tunnel accept cp output query port password rss connect cp output host smtp
Summary of the content on the page No. 13
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 Commands >enable (enable)#? auto show interfaces auto show processes clrscrn configure connect connect line cpm device disable dns email exit filesystem kill ssh kill telnet line ping ping ping reload reload
Summary of the content on the page No. 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
Summary of the content on the page No. 15
4: Configuration Using XML Note: The name for each (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 PremierWave EN User Guide for more information about the XCR groups. An empty or missing element in each present clears the setting to its default. Quick Tour of XML Syntax Declaration The first line, , is called the XML declarati
Summary of the content on the page No. 16
4: Configuration Using XML Record, Group, Item, and Value Tags A is a logical grouping of configuration parameters and must contain one or more elements. It must have a name attribute and may have an instance attribute. A 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
Summary of the content on the page No. 17
4: Configuration Using XML Figure 4-5 XML Example of Multiple Items disable
Summary of the content on the page No. 18
4: Configuration Using XML 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 (captured) or exported (dumped) directly to a Telnet, SSH, or serial line CLI session. Capturing an XCR can be started by pasting a
Summary of the content on the page No. 19
4: Configuration Using XML 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 xcr export The same guidelines above regarding importing configurations also apply to exporting configurations. If no groups are specified, then the export command
Summary of the content on the page No. 20
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 connect (Attribute of power “instance” is
