Page 2 - Company Confidential
Company Confidential Quatech, Inc. 2 Airborne CLI Reference Manual 100-8081-100 <Page Intentionally Left Blank>
Page 3 - Quatech Confidential; QUATECH
Quatech, Inc. Company Confidential 100-8081-100 Airborne CLI Reference Manual 3 Quatech Confidential Copyright © 2009 QUATECH ® Inc. ALL RIGHTS RESERVED. No part of this publication may be copied in any f orm, by photocopy, microfilm, retrieval system, or by any other means now known or hereaf ter i...
Page 5 - Contents
Quatech, Inc. Company Confidential 100-8081-100 Airborne CLI Reference Manual 5 Contents 1.0 Overview ...................................................................................................................................................................... 9 2.0 Conventions ................
Page 7 - Figures
Quatech, Inc. Company Confidential 100-8081-100 Airborne CLI Reference Manual 7 Figures Figure 1 - Bridging from the Serial Interf ace Manually Using the pass Command ................................................................ 25 Figure 2 - Bridging from the Serial Interf ace Automatically at S...
Page 9 - Quatech’s exclusive Airborne Device Server
Quatech, Inc. Company Confidential 100-8081-100 Airborne CLI Reference Manual 9 1.0 Overview Airborne is a line of highly integrated 802.11 radios and device servers, designed to address the demands of the complex M2M market. Utilizing the latest 802.11, CPU and network technologies, the Airborne fa...
Page 10 - Terminology; document, after this section the term; Notes
Company Confidential Quatech, Inc. 10 Airborne CLI Reference Manual 100-8081-100 2.0 Conventions The following section outlines the conventions used within the document, where conv ention is deviated from the deviation takes precedence and should be followed. If you hav e any question related to the...
Page 11 - Courier Typeface; Courier
Quatech, Inc. Company Confidential 100-8081-100 Airborne CLI Reference Manual 11 2.5 Courier Typeface Commands and other input that a user is to provide are indicated with Courier typeface. For example, typing the following command and pressing the Enter key displays the result of a command: wl-info...
Page 12 - Overview
Company Confidential Quatech, Inc. 12 Airborne CLI Reference Manual 100-8081-100 3.0 Scope The CLI Reference Manual documents the Command Line Interface (CLI) for the Airborne Device Server family of products. This document is an addendum to the Airborne CLI reference manual and describes the comman...
Page 14 - Supported Devices; Description
Company Confidential Quatech, Inc. 14 Airborne CLI Reference Manual 100-8081-100 4.0 Supported Devices This manual supports the Enterprise set of CLI commands across all platforms. Not all commands are supported on all platforms; the command descriptions in Section 14.0 provide guidance on which dev...
Page 15 - The; AirborneTM WLN Module; includes a; UART; Serial; Default settings; Ethernet
Quatech, Inc. Company Confidential 100-8081-100 Airborne CLI Reference Manual 15 5.0 Overview The Airborne™ WLN Module includes a Command Line Interface (CLI) Serv er. The CLI Server is the primary user interface for configuring, controlling, and monitoring Airborne™ WLN Modules. Users and OEM appli...
Page 16 - The interface supports the following settings:
Company Confidential Quatech, Inc. 16 Airborne CLI Reference Manual 100-8081-100 The interface supports the following settings: Auto Negotiate, 10Mbps Half Duplex, 10Mbps Full Duplex, 100Mbps Half Duplex, 100Mbps Full Duplex Rx+, Rx-, Tx+ and Tx- Default settings : Auto Negotiate.
Page 17 - Understanding the CLI; Connecting to the CLI Server; DO; CLI Security
Quatech, Inc. Company Confidential 100-8081-100 Airborne CLI Reference Manual 17 6.0 Understanding the CLI CLI Sessions established to the CLI Server may operate in one of three modes: CLI, PASS, or LISTEN. Not all modes are supported on all interfaces of the device. A CLI Session established on the...
Page 18 - auth; Ln; logout; CLI Session Modes; pass
Company Confidential Quatech, Inc. 18 Airborne CLI Reference Manual 100-8081-100 Lev el 1 (L1) = connection, not logged in (default) Lev el 2 (L2) = data Lev el 3 (L3) = config Lev el 4 (L4) = OEM Lev el 5 (L5) = MFG Lev el 0 is the connectionless access lev el. Access ov er UDP will use t...
Page 19 - PASS Mode for the Serial Interface
Quatech, Inc. Company Confidential 100-8081-100 Airborne CLI Reference Manual 19 6.3.3 PASS Mode for the Serial Interface When the CLI Session on the serial interface attempts a transition to PASS Mode, the CLI Server establishes an outbound connection from the Airborne™ WLN Module to a user-specifi...
Page 20 - CLI Server Escape Processing; escape; Detecting and Executing the Escape Sequence
Company Confidential Quatech, Inc. 20 Airborne CLI Reference Manual 100-8081-100 The CLI Session on the serial interface startup behavior is determined by the value of the serial-default parameter. CLI Sessions on the wireless interface using the TCP port specified by wl- telnet-port always star...
Page 21 - CLI Conventions
Quatech, Inc. Company Confidential 100-8081-100 Airborne CLI Reference Manual 21 If the escape sequence is the BREAK signal, the BREAK receiv ed on the serial interface is not transmitted to the wireless interface, but the transition takes place internally. The CLI Session that detects the escap...
Page 22 - ASCHEX vs. Binary Values; error text
Company Confidential Quatech, Inc. 22 Airborne CLI Reference Manual 100-8081-100 6.7 ASCHEX vs. Binary Values Data can be sent to the Module as either binary data or a hexadecimal representation of the actual data being transmitted. When a LAN device or serial port Host issues a pass command, the da...
Page 23 - A Typical Development System; A typical evaluation system includes:
Quatech, Inc. Company Confidential 100-8081-100 Airborne CLI Reference Manual 23 7.0 A Typical Development System A typical evaluation system includes: A Serial Host: A computer connected to the serial port of the Airborne™ WLN Module. A LAN Host: A computer that communicates wirelessly with the...
Page 24 - Serial Device Server Use; Data Bridging; , from a TCP connection on the; Bridging from the Serial Interface; parameter set to “pass” or by manually issuing the; CLI command. Prior to esta
Company Confidential Quatech, Inc. 24 Airborne CLI Reference Manual 100-8081-100 8.0 Serial Device Server Use In this section the base functionality of the Serial/UART device server will be described and examples of use and configuration will be provided to highlight the best use of the module and C...
Page 26 - Default Command; A user or OEM application connected over TCP to the
Company Confidential Quatech, Inc. 26 Airborne CLI Reference Manual 100-8081-100 Figure 2 - Bridging from the Serial Interface Automatically at Startup Using the Serial- Default Command 8.1.2 Bridging from a TCP connection on the wl-telnet-port A user or OEM application connected over TCP to the wl-...
Page 27 - Figure 3 - Bridging from a TCP Connection on the wl-telnet-port; tcp
Quatech, Inc. Company Confidential 100-8081-100 Airborne CLI Reference Manual 27 Figure 3 - Bridging from a TCP Connection on the wl-telnet-port 8.1.3 Bridging from a TCP connection on the wl-tunnel-port The Module supports a tunneling feature that allows bridging between a specific TCP address/port...
Page 28 - close
Company Confidential Quatech, Inc. 28 Airborne CLI Reference Manual 100-8081-100 The data bridge may terminate for any one of the following reasons: The close CLI command is issued from a secondary network CLI session. The radio-off CLI command is issued from a secondary network CLI session. The n...
Page 29 - Figure 4 - Bridging From a TCP Connection on the wl-tunnel-port; parameter or the
Quatech, Inc. Company Confidential 100-8081-100 Airborne CLI Reference Manual 29 Figure 4 - Bridging From a TCP Connection on the wl-tunnel-port 8.1.4 Bridging Using UDP The Module supports UDP tunneling. This allows the Module to forward data from the serial interface to a specific serv er listenin...
Page 30 - is used to enable UDP transmission of data from the serial; Data Bridging with XMODEM Guidelines; None
Company Confidential Quatech, Inc. 30 Airborne CLI Reference Manual 100-8081-100 wl-xmit-type is used to enable UDP transmission of data from the serial interface. wl-udp-xmit is used to enable unicast, or broadcast UDP datagram transmission, or both. wl-udp-ip/wl-udp-port is used to set the U...
Page 31 - Ethernet Bridge Use; Network Address Translation; (NAT) is the process of modifying network address; Figure 5 - Ethernet Bridge Functionality
Quatech, Inc. Company Confidential 100-8081-100 Airborne CLI Reference Manual 31 9.0 Ethernet Bridge Use The Airborne Ethernet Bridge is a fully functional NAT Lev el 3 router, supporting a public IP address for the wireless interface and a private network for the attached devices on the wired inter...
Page 32 - Zero security footprint on the private network host.; Public Network Interface; Table 1 - Public Network Configuration; Command
Company Confidential Quatech, Inc. 32 Airborne CLI Reference Manual 100-8081-100 The Private network is the wired interface provided by the bridge. This interface includes a DHCP serv er and supports dynamic and static IP address assignment. This means any Ethernet client supporting DHCP can be conn...
Page 33 - Figure 6 - Airborne Ethernet Bridge IP Configuration
Quatech, Inc. Company Confidential 100-8081-100 Airborne CLI Reference Manual 33 Command Description Security (various commands) It is necessary to configure this interface for the appropriate security profile required for authentication to the target network. Please see section 10.0 for details on ...
Page 34 - Private Network Interface; Table 2 - Private Network Interface Configuration; address
Company Confidential Quatech, Inc. 34 Airborne CLI Reference Manual 100-8081-100 The public network interface supports the Airborne discov ery protocol and will respond to discov ery requests issued on the public network. 9.2 Private Network Interface The priv ate network interface is on the Etherne...
Page 36 - Table 3 - WEP Configuration Parameters
Company Confidential Quatech, Inc. 36 Airborne CLI Reference Manual 100-8081-100 10.0 WLAN Security The Airborne Enterprise Wireless Device Server family supports all the latest WiFi security interoperability requirements for 802.11 products; this includes WEP, WPA and WPA2. The Airborne product fam...
Page 41 - Managing Certificates and Private Keys; Table 11 - Certificate Delivery Commands
Quatech, Inc. Company Confidential 100-8081-100 Airborne CLI Reference Manual 41 Command Description priv-key-filename [client private key name].pem Identif ies he client private key f ile to be used. Replace [client private key name].pem with the required f ilename (no parenthesis). The private key...
Page 43 - Figure 7 - Certificate and Private Key Delivery Methods
Quatech, Inc. Company Confidential 100-8081-100 Airborne CLI Reference Manual 43 Figure 7 - Certificate and Private Key Delivery Methods Control of the certificate and private key files is handled by separate group of commands these are described in Table 12. Table 12 - Certificate Management Comman...
Page 46 - When configured for Infrastructure mode using the; Table 13 - Commands that Affect Roaming
Company Confidential Quatech, Inc. 46 Airborne CLI Reference Manual 100-8081-100 11.0 WLAN Roaming When configured for Infrastructure mode using the wl-type command, the Module supports roaming in accordance with the IEEE 802.11 specification. The following set of commands affect the Module’s roamin...
Page 47 - any
Quatech, Inc. Company Confidential 100-8081-100 Airborne CLI Reference Manual 47 Command Description wl-beacons-missed Conf igures the number of missed beacons, from an associated AP, that are missed before a roam is attempted. The number of beacons can range from 0-256, the default is six (6). It i...
Page 48 - FTP Configuration; Table 14 - FTP Configuration Commands; Table 15 - FTP Upload Commands
Company Confidential Quatech, Inc. 48 Airborne CLI Reference Manual 100-8081-100 12.0 FTP Configuration The Airborne Enterprise Device Serv er family includes an FTP capability for delivery of files to the device. The embedded FTP client is capable of authenticating with a network based FTP serv er ...
Page 49 - Table 16 – Power-Save Modes
Quatech, Inc. Company Confidential 100-8081-100 Airborne CLI Reference Manual 49 13.0 Power Save Control of the operating and standby power of the module can be critical in many applications; the Airborne Enterprise Device Server family offers various levels of control through the CLI interface, the...
Page 50 - Command Descriptions
Company Confidential Quatech, Inc. 50 Airborne CLI Reference Manual 100-8081-100 14.0 Command Descriptions The following section will describe the commands relating specifically to the Airborne Enterprise Device Server and Ethernet Bridge family. The CLI interface provides the following on-line he...
Page 66 - help
Company Confidential Quatech, Inc. 66 Airborne CLI Reference Manual 100-8081-100 help Command help Arguments none Device Type All Default none Description This command provides text help. When used by itself at the command prompt it will cause the device server to display all available commands. The...
Page 76 - clear
Company Confidential Quatech, Inc. 76 Airborne CLI Reference Manual 100-8081-100 clear Command clear Arguments ca-cert-filename | ca-cert2-filename | client-cert-filename | client-cert2-filename | priv-key-filename | priv-key2-filename | dh-parm-filename | dh-parm2-filename | priv-key-password | pri...
Page 83 - stats
Quatech, Inc. Company Confidential 100-8081-100 Airborne CLI Reference Manual 83 stats Command stats Arguments radio | ethernet Device Type All Default radio Description Displays statistics for the specified interface. radio Displays radio statistics. ethernet Displays wired Ethernet statistic. Only...
Page 119 - The following table indicates all changes made to this document:
Quatech, Inc. Company Confidential 100-8081-100 Airborne CLI Reference Manual 119 15.0 Change Log The following table indicates all changes made to this document: Version Date Section Change Description Author 1.0 04/16/2009 - Preliminary Release. ACR
Page 120 - 675 Hudson Industrial Parkway
QUATECH ® Inc. 5675 Hudson Industrial Parkway Hudson, OH 44236 USA Telephone: 330.655.9000 Toll Free (USA): 800.553.1170 Fax: 330.655.9010 Technical Support: 714.899.7543 E-mail Support : [email protected] Web Site: www.quatech.com