Lantronix 900-691-R manual Understanding the CLI Level Hierarchy, Configuration Using XML

Page 73

 

 

Appendix A: Command Reference

 

 

 

 

 

Key Combination (continued)

Description

 

 

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

 

 

 

 

 

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 root level. This level can be password protected and provides access to high level status, a few diagnostic commands, and the file system level. Further device information and configuration 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 xPico Wi-Fi embedded device server. There are commands 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.

Commands at the root level (see Figure A-2 Root Level Commands below) do not affect current configuration settings and are not displayed initially. If you type ?, you will see the login sub- commands. These commands provide diagnostic and status information only.

 

Figure A-2 Root Level Commands

>?

file system

config

help

status

tlog

wlan scan [network-name]

xml

exit

Configuration Using XML

The xPico Wi-Fi embedded device server provides an Extensible Markup Language (XML) interface that you can use to configure xPico Wi-Fi embedded device servers. Every configuration setting, excluding XML import and export, that can be issued from the xPico Wi-Fi Web Manager and CLI can be specified using XML.

The XPico Wi-Fi embedded 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 or the xPico Wi-Fi embedded device server filesystem. An XCR can contain many configuration settings or just a few. For example, it might change all of the configurable

xPico® Wi-Fi® Embedded Device Server User Guide

73

Image 73 Contents
Embedded Device Server User Guide Intellectual Property WarrantyContacts DisclaimerTable of Contents Tunnel Settings Interface SettingsConfigurable Pin Manager Services SettingsAdvanced Settings Maintenance and Diagnostics SettingsBranding the xPico Wi-Fi Unit MonitorAppendix B WebAPI 100 Updating FirmwareAppendix C Technical Support 103 105Appendix E Binary to Hexadecimal Conversions 112 List of Figures XPico Wi-Fi Product LabelList of Tables XPico Wi-Fi Embedded Device Server User Guide Purpose and Audience Using This GuideSummary of Chapters Chapter DescriptionDocument Description Additional DocumentationIntroduction Key FeaturesProtocol Support Troubleshooting CapabilitiesAddresses and Port Numbers Configuration MethodsProduct Information Label XPico Wi-Fi Product Label Accessing Web Manager Configuration Using Web ManagerStatus StatusNavigating Web Manager Web Manager ComponentsHelp Area Web Manager Description See Web Manager PagesNetwork 1 Interface ap0 Configuration Network SettingsTo Configure Network 1 Interface Settings Network Interface SettingsNetwork 1 ap0 Link Settings Network 1 ap0 Link SettingsNetwork 1 ap0 Link Description Settings To View Network 1 Interface StatusTo View Network 1 Link Status To Configure Network 1 Link SettingsMode UptimeTo Configure Network 2 Interface Settings Network 2 wlan0 Interface ConfigurationNetwork Interface Description Settings Wlan Profiles Network 2 wlan0 Link StatusTo View Network 2 Interface Status To View Network 2 Link StatusTo Configure Wlan Profile Settings To Configure Wlan ProfilesWlan Profile Basic Settings Description Creating, Deleting or Enabling Wlan ProfilesWlan Profile Description Security Settings Wlan Profile Security SettingsWlan Profile Advanced Settings To Configure Wlan Quick ConnectWlan Profile Advanced Settings Description Wlan Quick ConnectWlan Quick Connect Wlan Quick Connect Description SettingsScan network Ssid Network Name linkLine Settings Interface SettingsLine Configuration Settings Line Settings DescriptionGap Timer To Configure Line SettingsTo View Line Status Xoff CharTo Configure SPI Settings Serial Perpheral Interface SPI SettingsSPI Configuration Settings To View SPI Status Line Settings Tunnel SettingsTo View Tunnel Serial Settings Tunnel Line SettingsTunnel Packing Mode Settings Packing ModeTunnel Packing Mode Description Settings Accept Mode To Configure Tunnel Packing Mode SettingsTunnel Accept Mode Settings Tunnel Accept Mode Description SettingsTo Configure Tunnel Accept Mode Settings Tunnel Connect Mode Settings Connect ModeTunnel Connect Description Mode Settings Disconnect Mode To Configure Tunnel Connect Mode SettingsTunnel Disconnect Mode Settings Tunnel Disconnect Description Mode SettingsTo Configure Tunnel Disconnect Mode Settings Modem Emulation SettingsModem Emulation Settings StatisticsModem Emulation Commands and Descriptions Tunnel SettingsCommand Description ATZ Configurable Pin Status Configurable Pin ManagerCurrent Configurable Pins CP StatusActive in Role RolesRole Configuration To Configure CPM SettingsCPM Role Current Description Configuration Http Settings Services SettingsTo Configure Http Settings and Access Control Http SettingsTo View Http Status File System Settings Maintenance and Diagnostics SettingsFile System Statistics File DisplayDevice Management Settings Device SettingsFile Manipulation To Transfer or Modify File System FilesTo Configure Admin User on the Device Admin UserAdmin User Settings To View Hardware Status Diagnostics SettingsTo View IP Socket Status To View Buffer Pool StatusTo Import or Export XML Configuration Advanced SettingsXML Import and XML Export Performance Settings Performance SettingsModem Emulation Settings Description To Configure Performance Monitor Explorer Settings Monitor SettingsExplorer Settings Description MonitorDisplay Rule NumberMonitor Initialization Settings ConfigurationMonitor Control Settings Initialization Description SettingsMonitor Filter Settings Monitor Poll SettingsPoll Settings Description DelayMonitor Data Settings To Configure MonitorData Settings Description Selector NumberInitialization Example Data Capture on a Serial DeviceMonitor Polling 1 Polling10 Monitor Filtering 1 Filtering12 Monitor Data Mining 1 Data MiningPresenting Data Capture on SPI Web Manager Customization Branding the xPico Wi-Fi UnitChanging the Presentation Path FormatOther Overridable Files Obtaining Firmware Loading New Firmware through Web Manager Updating Firmware Updating Firmware Conventions Appendix a Command ReferenceXML Architecture and Device Control Convention DescriptionSerial Command Mode Configuration Using Serial PortBoot to CLI Navigating the CLI Hierarchy Using Keyboard Shortcuts and CLITable A-1 Keyboard Shortcuts Key Combination DescriptionAppendix a Command Reference Configuration Using XMLUnderstanding the CLI Level Hierarchy Figure A-3 DTD for XCRs XML Configuration Record Document Type DefinitionDeclaration Quick Tour of XML SyntaxElement Start and End Tags Element AttributesFigure A-5 XML Example Record, Group, Item, and Value TagsConfiggroup Access Point XML for xPicoWi-Fi Embedded Device ServerConfiggroup CPM Configitem State Configgroup Http ServerConfigitem Port Configitem Inactivity TimeoutConfigitem Access Control Configgroup InterfaceConfigitem Dhcp Client Configgroup Line Configitem Protocol Configitem NameConfigitem Baud Rate Configitem ParityConfiggroup Performance Configitem Maximum Time Powered Down Configgroup SPIConfigitem Wkup Pin Power Up Configitem Time Powered UpConfiggroup Users Configitem Instance Configgroup Wlan ProfileConfigitem Password Configitem BasicConfiggroup XML Import Control Configgroup Modem Emulation Configgroup Monitor Initialization Value Timeout Configgroup Monitor ControlValue Length Configitem Delay Configgroup Monitor PollConfigitem Rule Configgroup Monitor FilterConfiggroup Tunnel Accept Configgroup Monitor DataConfigitem Selector Configitem Local PortConfigitem Flush Start Character Configitem Start CharacterConfigitem Flush Line Configitem Block LineConfigitem Block Network Configgroup Tunnel LineConfigitem Prompt for Password Configitem DTRConfigitem Host Configgroup Tunnel ConnectValue Address Configitem Reconnect Time Configitem ConnectionsValue Port Value ProtocolConfigitem Stop Character Configgroup Tunnel DisconnectConfigitem Flush Stop Character Configitem Modem ControlConfigitem Send Character Configgroup Tunnel PackingConfigitem Trailing Character Appendix B WebAPI Export Configuration GroupExport Status Group Appendix B WebAPI Take Status ActionCurl example configuration as part of command Import Configuration GroupNorth America Appendix C Technical SupportEurope, Middle East, Africa Emea Japan Asia / Pacific ApacLatin America & Caribbean Online Appendix D Compliance Country SpecificationTable D-1 Country Certifications Table D-2 Country Transmitter IDsTable D-4 Europe EU Declaration of Conformity Table D-3 SafetyRadiation Exposure Statement Federal Communication Commission Interference StatementEnd Product Labeling Industry Canada StatementManual Information To the End User Déclaration dexposition aux radiationsPlaque signalétique du produit final Antenna Requirement Manuel dinformation à lutilisateur finalTable D-5 Approved Antennas List Type Gain BrandRoHS Notice Manufacturers ContactConverting Binary to Hexadecimal Appendix E Binary to Hexadecimal ConversionsConversion Table Scientific CalculatorAppendix E Binary to Hexadecimal Conversions