Summary of the content on the page No. 1
®
IntelliBox -I/O 2100
Command Reference
Part Number 900-475
Revision B March 2012
Summary of the content on the page No. 2
Copyright and Trademark © 2012 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 written permission of Lantronix. Printed in the United States of America. Ethernet is a trademark of XEROX Corporation. UNIX is a registered trademark of The Open Group. Windows is a trademark of Microsoft Corporation. Contacts Lantronix Corporate Headquarters 167 Technology Drive Irvine, CA 92618, USA Toll Free: 800-526-
Summary of the content on the page No. 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 _____________________
Summary of the content on the page No. 4
List of Figures Figure 3-1 CLI Level Hierarchy ______________________________________________________12 Figure 3-2 Login Level Commands___________________________________________________12 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 ____________________________
Summary of the content on the page No. 5
List of Tables Table 4-8 XCR Groups ____________________________________________________________20 Table 4-9 XSR Groups and Items____________________________________________________34 Table 5-1 Commands and Levels ____________________________________________________49 IntelliBox-I/O 2100 Command Reference 5
Summary of the content on the page No. 6
1: About This Guide This guide describes how to configure the IntelliBox-I/O 2100 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 each chapter and appendix. Chapter Summary Gives an overview of CLI and XML. Chapter 2: Overview Chapter 3: Command Line Interface Lists commands and describes how to use CLI to configure the IntelliBox. Chapter 4: Configu
Summary of the content on the page No. 7
1: About This Guide Additional Documentation Visit the Lantronix web site at www.lantronix.com/support/documentation for the latest documentation and the following additional documentation. Document Description IntelliBox-I/O 2100 User Guide Information about the IntelliBox hardware, testing the IntelliBox, and integrating the IntelliBox device into your product. DeviceInstaller Online Help Instructions for using the Lantronix Windows-based utility to locate the IntelliBox and to view its cur
Summary of the content on the page No. 8
2: Overview Evolution OS™ 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 IntelliBox-I/O 2100 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 th
Summary of the content on the page No. 9
3: Command Line Interface This chapter describes accessing the IntelliBox by using Telnet, SSH, or serial ports to configure the IntelliBox, 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
Summary of the content on the page No. 10
3: Command Line Interface 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
Summary of the content on the page No. 11
3: Command Line Interface Using Keyboard Shortcuts and CLI One useful shortcut built into Evolution OS™ 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. Typing the first few characters of a command, then hitting the key
Summary of the content on the page No. 12
3: Command Line Interface Figure 3-1 CLI Level Hierarchy chem (login) enable configure arp device cli eventtrak match filesystem (number) io task line ftp lpd host ssh http ssl icmp tunnel accept if 1 ethernet link connect ip disconnect ip filter modem lpd packing modbus serial query port rss snmp syslog tcp terminal tftp udp Commands at the login level, shown in Figure 3-2, do not affect current configuration settings and
Summary of the content on the page No. 13
3: Command Line Interface To configure the , you must be in the enable level and any of its sub-levels. Figure 3-3 shows the enable level commands. Figure 3-3 Enable Level Commands >enable #? auto show interfaces auto show processes auto show xsr chem clear interfaces counters clear query port counters clear xsr counters clrscrn configure connect connect line device disable exit filesystem io kill line kill ssh kill telnet line lpd no c
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 Notes: 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 IntelliBox-I/O 2100 User Guide for more information about the Web Manager 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
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 john.doe@somewhere.com> evolution@intellibox.com> Figure 4-6 XML Example with Multiple Groups
Summary of the content on the page No. 18
4: Configuration Using XML 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 from an external source such as your local hard drive. FTP—The device server FTP server can export and import XCRs when an FTP ge
Summary of the content on the page No. 19
4: Configuration Using XML 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 will export all configuration settings to the file. If instances are specified after the groups, only those group instances are written. If no
Summary of the content on the page No. 20
4: Configuration Using XML The “xml paste passwords” name is used with the “passwords” name and “cli login” and “cli enable level” values to specify the passwords to use when the device has been configured with password protection. The password value is clear text. To protect the password, establish an SSH connection to the device server. Figure 4-7 shows an example. Figure 4-7 XML Example of Supplying Passwords
