Lantronix MatchPort b/g Pro Installationshandbuch

Part Number 900-534

Revision D May 2013

MatchPort b/g Pro

Embedded Device Server

Command Reference

MatchPort®b/g Pro Embedded Device Server Command Reference 2

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

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

other countries. Evolution OS® is a registered trademark of Lantronix, Inc. in the United States.

DeviceInstaller™ is a trademark of Lantronix, Inc.

Windows® and Internet Explorer® are registered trademark 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-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. For the latest revision of this product

document, please check our online documentation at www.lantronix.com/support/documentation.

Revision History

Date Rev. Comments

April 2008 A Initial Document

September 2008 B Technical updates throughout, corresponding to firmware release

1.1.0.0.R6.

March 2009 C Updated to firmware release 1.3.0.0R5, added bridging information.

May 2013 D Updated to firmware release 5.2.0.3R2, adding wireless information.

MatchPort®b/g Pro Embedded Device Server Command Reference 3

Table of Contents

List of Figures _____________________________________________________________4

List of Tables ______________________________________________________________5

1: About This Guide 6

Chapter Summaries ________________________________________________________6

Conventions ______________________________________________________________6

Additional Documentation ____________________________________________________7

2: Overview 8

XML Architecture and Device Control ___________________________________________8

Command Line Interface _____________________________________________________8

3: Command Line Interface 9

Configuration Using Telnet ___________________________________________________9

Configuration Using Serial Ports _______________________________________________9

Serial Command Mode ___________________________________________________9

Serial Recovery ________________________________________________________9

Navigating the CLI Hierarchy ________________________________________________10

Using Keyboard Shortcuts and CLI ____________________________________________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 _______________________________17

Best Practices ____________________________________________________________18

Importing _____________________________________________________________18

Exporting ____________________________________________________________19

Passwords in the XML File _______________________________________________19

XML Configuration Groups __________________________________________________20

XML Status Record Groups and Items _________________________________________33

5: Configuration Using XML 44

MatchPort®b/g Pro Embedded Device Server Command Reference 4

List of Figures

Figure 3-1 CLI Level Hierarchy______________________________________________________12

Figure 3-2 Login Level Commands___________________________________________________13

Figure 3-3 Enable Level Commands__________________________________________________13

Figure 4-1 DTD for XCRs __________________________________________________________14

Figure 4-2 XML Example __________________________________________________________15

Figure 4-3 XML Group Example _____________________________________________________16

Figure 4-4 XML Example of Multiple Named Values _____________________________________16

Figure 4-5 XML Example of Multiple Items_____________________________________________17

Figure 4-6 XML Example with Multiple Groups _________________________________________17

Figure 4-7 XML Example of Supplying Passwords_______________________________________20

MatchPort®b/g Pro Embedded Device Server Command Reference 5

List of Tables

Table 4-8 XCR Groups ____________________________________________________________20

Table 4-9 XSR Groups and Items____________________________________________________33

Table 5-1 Commands and Levels____________________________________________________47

MatchPort®b/g Pro Embedded Device Server Command Reference 6

1: About This Guide

This guide describes how to configure the MatchPort® b/g Pro embedded device server 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 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 each chapter and appendix.

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 MatchPort b/g Pro.

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

XCRs to configure the MatchPort b/g Pro.

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.

1: About This Guide

MatchPort®b/g Pro Embedded Device Server Command Reference 7

Additional Documentation

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

documentation and the following additional documentation.

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.

Document Description

MatchPort b/g Pro Embedded

Device Server User Guide Describes how to configure and use the MatchPort b/g Pro

MatchPort b/g Pro Embedded

Device Server Integration Guide Contains information about the MatchPort b/g Pro hardware, the

MatchPort b/g Pro demonstration board, and integrating MatchPort

into your product.

MatchPort b/g Pro Embedded

Device Server Getting Started

Guide

Describes how to get the MatchPort b/g Pro demonstration board

up and running.

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

the MatchPort b/g Pro and to view its current settings.

Secure Com Port Redirector

User Guide Instructions for using the Lantronix Windows-based utility to create

secure virtual com ports.

Com Port Redirector

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

create virtual com ports.

Convention Description

MatchPort®b/g Pro Embedded Device Server Command Reference 8

2: Overview

Evolution OS® software is the Lantronix® cutting-edge operating system that supports three

convenient configuration methods: Web Manager, Command Line Interface (CLI), and Extensible

Markup Language (XML). For more information about the Web Manager, see the MatchPort b/g

Pro User Guide at the Lantronix website.

XML Architecture and Device Control

XML is a fundamental building block for the future growth of Machine-to-Machine (M2M) networks.

Evolution supports XML configuration records that make configuring the device server easy for

users and administrators. XML configuration records are easy to edit with a standard text editor or

an XML editor.

For a brief overview of XML, see Chapter 4: Configuration Using XML . It provides rules on basic

XML syntax, a guide to the specific XML tags used, and a guide to using XML configuration

records.

Command Line Interface

Making the edge-to-enterprise vision a reality, Evolution OS uses industry-standard tools for

configuration, communication, and control. For example, the Evolution OS uses a command line

interface (CLI) whose syntax is very similar to that used by data center equipment such as routers

and hubs.

For details of the CLI, see Chapter 5: Commands and Levels. It provides an index of the CLI

Command Hierarchy with links to the corresponding command details. The CLI provides

commands for configuring, monitoring, and controlling the device server.

MatchPort®b/g Pro Embedded Device Server Command Reference 9

3: Command Line Interface

This chapter describes accessing the MatchPort® b/g Pro embedded device server by using

Telnet, SSH, or serial ports to configure the MatchPort, 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 MatchPort b/g Pro 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 MatchPort b/g Pro is online when

the command prompt (>) displays. You are at the root level of the CLI.

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

Configuration Using Serial Ports

Serial Command Mode

The serial port can be configured to operate in command mode permanently or to be triggered

under specified conditions. See the line <line> Level command description for more

information.

Serial Recovery

In this mode, the normal boot process is interrupted, allowing recovery from unknown or incorrect

configuration settings. While the back door is active, the CLI prompt is changed to “>>” (instead of

“>”) and the Web Manager is inaccessible. These serve as an important indication that the device

boot processes has been temporarily halted. To complete the boot process, terminate the serial

CLI session (with the exit command).

3: Command Line Interface

MatchPort®b/g Pro Embedded Device Server Command Reference 10

To configure the Lantronix device server locally using a serial port, connect a terminal or a PC

running a terminal emulation program to one of the device server's serial ports. Configure the

terminal for 9600 baud, 8-bit, no parity, 1 stop bit, and no flow control.

1. Power off the device.

2. Press and hold down the exclamation point (!) key.

3. Power on the device. After about ten seconds, the exclamation point will display on the

terminal or PC screen.

4. Type xyz within 5 seconds to display the CLI prompt.

Navigating the CLI Hierarchy

The CLI is organized into a hierarchy of levels. Each level has a group of commands for a specific

purpose. For example, to configure a setting for the FTP server, one would navigate to the FTP

level, which is under the configuration level.

To move to a different level—Enter the name of the level from within its parent level. For

example, to enter the tunnel level, type tunnel <number> at the enable prompt. This

displays: <enable> tunnel <number>#.

To exit and return to one level higher—Type exit and press the Enter key. Typing exit at the

specified 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>#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.

Andere Handbücher für MatchPort b/g Pro

Inhaltsverzeichnis

Andere Lantronix Server Handbücher

Lantronix

Lantronix xDirect-IAP Bedienungsanleitung

Lantronix

Lantronix EDS8PS Bedienungsanleitung

Lantronix

Lantronix MSS1-T Bedienungsanleitung

Lantronix

Lantronix Micro125 Bedienungsanleitung

Lantronix

Lantronix MSS Bedienungsanleitung

Lantronix

Lantronix SCS100 Bedienungsanleitung

Lantronix

Lantronix xPort Pro XPP1004000-02R Kurzanleitung zur Einrichtung

Lantronix

Lantronix XPort Direct+ Bedienungsanleitung

Lantronix

Lantronix MSS4-D Bedienungsanleitung

Lantronix

Lantronix ETS Bedienungsanleitung

Lantronix

Lantronix XPress DR+ Bedienungsanleitung

Lantronix

Lantronix xport pro Installationshandbuch

Lantronix

Lantronix Com Port Redirector Bedienungsanleitung

Lantronix

Lantronix EDS-MD Series Bedienungsanleitung

Lantronix

Lantronix xDirect Bedienungsanleitung

Lantronix

Lantronix MSS4 Bedienungsanleitung

Lantronix

Lantronix PremierWave XC Bedienungsanleitung

Lantronix

Lantronix SLC48 Bedienungsanleitung

Lantronix

Lantronix I/O 2100 Bedienungsanleitung

Lantronix

Lantronix CoBox E2 01 Bedienungsanleitung

Lantronix

Lantronix EDS4100 Bedienungsanleitung

Lantronix

Lantronix SLC 8000 Bedienungsanleitung

Lantronix

Lantronix EDS4100 Bedienungsanleitung

Lantronix

Lantronix CoBox-FL Bedienungsanleitung

Beliebte Server Handbücher anderer Marken

HP AlphaServer ES47 Bedienungsanleitung

Dell

Dell PowerEdge R410 Bedienungsanleitung

PowerNAS

PowerNAS CMA Bedienungsanleitung

Supero

Supero FatTwin F617R3-FT Bedienungsanleitung

MSI

MSI P1-109N-L70 Bedienungsanleitung

Dell

Dell PowerEdge XE9640 Handbuch

Dell

Dell PS4100 Montageanleitung

EtroVISION

EtroVISION EV3151 Bedienungsanleitung

NEC

NEC Express5800/T110j Bedienungsanleitung

HP ProLiant Gen9 Bedienungsanleitung

Compaq

Compaq ProLiant 3000 Handbuch

Dell

Dell PowerEdge 3YPMN Bedienungsanleitung

iRobo

iRobo IPC2U Bedienungsanleitung

Nortel

Nortel 1000 Con?guration guide Bedienungsanleitung

Asus

Asus AP7500 Bedienungs- und Wartungshandbuch

Avid Technology

Avid Technology AirSpeed 5000 Bedienungsanleitung

HP Integrity rx2600 Installationsanleitung

Milestone

Milestone Husky IVO 350T Bedienungsanleitung