Lantronix PremierWave XC Installationshandbuch

Part Number 900-599

Revision B May 2014

PremierWave XC

Intelligent Gateway

Command Reference

PremierWave® XC Intelligent Gateway Command Reference 2

Intellectual Property

or reproduced in any form or by any means without the written permission of Lantronix.

Lantronix and PremierWave are registered trademarks of Lantronix, Inc. in the United States and

other countries. DeviceInstaller is atrademark of Lantronix, Inc. U.S. Patents 8,024,446;

8,219,661; 7,698,405. Additional patents pending.

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

Inc. All other trademarks and trade names are the property of their respective holders.

Contacts

Lantronix, Inc. Corporate Headquarters

167 Technology Drive

Irvine, CA 92618, USA

Toll Free: 800-526-8766

Phone: 949-453-3990

Fax: 949-453-3995

Technical Support

Online: www.lantronix.com/support

Sales Offices

For a current list of our domestic and international sales offices, go to the Lantronix web site at

www.lantronix.com/about/contact.

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

June 2012 A Initial document for firmware release 7.2.0.0.

May 2014 BUpdated for firmware release 7.8.0.0.

PremierWave® XC Intelligent Gateway Command Reference 3

Table of Contents

Intellectual Property ________________________________________________________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 Serials ___________________________________________________9

Navigating the CLI Hierarchy ________________________________________________10

Using Keyboard Shortcuts and CLI ____________________________________________11

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 _________________________________________35

5: Commands and Levels 45

PremierWave® XC Intelligent Gateway Command Reference 4

List of Figures

Figure 3-2 CLI Level Hierarchy______________________________________________________12

Figure 3-3 Login Level Commands___________________________________________________13

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® XC Intelligent Gateway Command Reference 5

List of Tables

Table 3-1 Keyboard Shortcuts ______________________________________________________11

Table 4-7 XCR Groups ____________________________________________________________20

Table 4-8 XSR Group and Items ____________________________________________________35

Table 5-1 Commands and Levels____________________________________________________52

PremierWave® XC Intelligent Gateway Command Reference 6

1: About This Guide

This guide describes how to configure the PremierWave XC intelligent gateway using the

Command Line Interface (CLI) and/or Extensible Markup Language (XML). CLI provides an

interactive mode for accessing the device configuration and management interface. It is most

suited for system and network administrators comfortable with using similar interfaces on

Enterprise IT and Networking products. It is also helpful as a quick tool for access via the

product's serial ports or console/management ports.

XML provides an extensible mode for software developers interfacing with the device and system

integrators performing batch provisioning/updates.

Chapter Summaries

This table lists and summarizes content of each chapter.

Conventions

The table below lists and describes the conventions used in this book.

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 XC device.

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

configure the PremierWave XC device.

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

to the corresponding command details.

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.

1: About This Guide

PremierWave® XC Intelligent Gateway Command Reference 7

Additional Documentation

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

documentation and the following additional documentation.

Document Description

PremierWave XC Intelligent

Gateway User Guide Describes how to configure and use the PremierWave XC device.

PremierWave XC Quick Start

Guide Instructions for getting the PremierWave XC up and running.

Com Port Redirector

Quick Start and Online Help Instructions for using the Lantronix Windows-based utility to create

virtual com ports.

DeviceInstaller Online Help Instructions for using the Lantronix Windows-based utility to locate

the PremierWave XC device and to view its current settings.

PremierWave® XC Intelligent Gateway Command Reference 8

2: Overview

PremierWave XC intelligent gateway supports three convenient configuration methods: Web

Manager, Command Line Interface (CLI) and Extensible Markup Language (XML). For more

information about the Web Manager, see the PremierWave XC Intelligent Gateway 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 XC device supports XML configuration records that make configuring the intelligent

gateway easy for users and administrators. XML configuration records are easy to edit with 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, the PremierWave XC intelligent gateway uses

industry-standard tools for configuration, communication, and control. For example, the

PremierWave XC device 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 intelligent gateway.

PremierWave® XC Intelligent Gateway Command Reference 9

3: Command Line Interface

This chapter describes accessing the PremierWave XC intelligent gateway by using Telnet, SSH,

or USB serial ports to configure the device, navigating the Command Line Interface (CLI), typing

keyboard shortcuts, and moving between the levels.

It contains the following sections:

Configuration Using Telnet

Configuration Using Serials

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 intelligent gateway 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 the DeviceInstaller utility. See the DeviceInstaller Online Help for more

information, available on our website www.lantronix.com/support/downloads.

To access the PremierWave XC intelligent gateway 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) in a Windows/Linux command prompt.

The PremierWave XC device is online when the command prompt (>) displays. You are at the

root level of the CLI.

Note: Depending on the level of security, a password may be required.

Configuration Using Serials

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.

Intelligent Gateway 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

PremierWave® XC Intelligent Gateway Command Reference 10

To configure the Lantronix locally using a serial port:

1. Connect a terminal or a PC running a terminal emulation program to one of the '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 1 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 and press the Enter key. Typing exit at the

as Always, a new session starts immediately.

To view the current configuration at any level—Type show.

To view the list of commands available at the current level—Type the question mark "?". Items

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

To view the available commands and explanations—Type the asterisk (*).

To view the list of commands available for a partial command—Type the partial command

followed by the question mark "?". For example: <tunnel-1>#show? displays a list of all

show 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

show commands and descriptions at the tunnel level.

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

Andere Handbücher für PremierWave XC

Inhaltsverzeichnis

Andere Lantronix Tor Handbücher

Lantronix

Lantronix SGX 5150 Bedienungs- und Wartungsanleitung

Lantronix

Lantronix G528 Bedienungsanleitung

Lantronix

Lantronix EDS-MD Series Installationshandbuch

Lantronix

Lantronix PremierWave 2050 Bedienungsanleitung

Lantronix

Lantronix X300 Bedienungsanleitung

Lantronix

Lantronix PREMIERWAVE XC HSPA+ Bedienungsanleitung

Lantronix

Lantronix PremierWave XN Bedienungsanleitung

Lantronix

Lantronix EMG 8500 Bedienungsanleitung

Lantronix

Lantronix EMG 8500 Bedienungsanleitung

Lantronix

Lantronix PREMIERWAVE XC HSPA+ Bedienungsanleitung

Lantronix

Lantronix xPico 900-619 Kurzanleitung zur Einrichtung

Lantronix

Lantronix EMG Series Bedienungsanleitung

Lantronix

Lantronix PremierWave 2050 Kurzanleitung zur Einrichtung

Lantronix

Lantronix PREMIERWAVE XC HSPA+ Bedienungsanleitung

Lantronix

Lantronix X303 Bedienungsanleitung

Lantronix

Lantronix X303 Bedienungsanleitung

Lantronix

Lantronix X304 Bedienungsanleitung

Lantronix

Lantronix SGX 5150 Installationshandbuch

Lantronix

Lantronix G526 Bedienungsanleitung

Lantronix

Lantronix FOX3-2G Series Bedienungsanleitung

Lantronix

Lantronix EMG 8500 Bedienungsanleitung

Lantronix

Lantronix DeviceLinx XPort Direct Bedienungsanleitung

Lantronix

Lantronix G520 Series Bedienungsanleitung

Lantronix

Lantronix EMG 7500 Bedienungsanleitung

Beliebte Tor Handbücher anderer Marken

LST

LST M500RFE-AS Bedienungsanleitung

Kinnex

Kinnex Media Gateway Bedienungsanleitung

2N Telekomunikace

2N Telekomunikace 2N StarGate Bedienungsanleitung

Mitsubishi Heavy Industries

Mitsubishi Heavy Industries Superlink SC-WBGW256 Bedienungsanleitung

ZyXEL Communications

ZyXEL Communications ZYWALL2 ET 2WE Bedienungsanleitung

Telsey

Telsey CPVA 500 - SIP Bedienungsanleitung

RTA

RTA 460A-NNA4 Technisches Datenblatt

Shaw

Shaw Gateway HDPVR Bedienungsanleitung

ABB

ABB VSN900 Kurzanleitung

Commander

Commander Pulse Bedienungsanleitung

2N Telekomunikace

2N Telekomunikace ATEUS EasyGate 501309E Bedienungsanleitung

NETGEAR

NETGEAR C6300BD Bedienungsanleitung

Amit

Amit CDW531AM Bedienungsanleitung

HMS

HMS Netbiter EasyConnect EC150 Bedienungsanleitung

Huawei

Huawei EchoLife HG620 Bedienungsanleitung

AT&T

AT&T U-verse 3801 Gebrauchs- und Pflegehandbuch

Logic IO

Logic IO RTCU MX2 turbo Bedienungsanleitung

Suttle

Suttle MediaMAX MXM-521 Bedienungsanleitung