Quatech WLNG-AN-DP500 Series Reference Manual

Airborne command line interface (cli) enterprise addendum
Table of Contents

Advertisement

Quick Links

Reference Manual

Airborne Command Line Interface (CLI)
Enterprise Addendum
WLNG-SE/SP/AN/ET-DP500 Series
Revision 1.0
April 09
File name: airborne enterprise command line reference guide.doc
Document Number: 100-8081-100

Advertisement

Table of Contents
loading
Need help?

Need help?

Do you have a question about the WLNG-AN-DP500 Series and is the answer not in the manual?

Questions and answers

Subscribe to Our Youtube Channel

Summary of Contents for Quatech WLNG-AN-DP500 Series

  • Page 1: Reference Manual

    Reference Manual Airborne Command Line Interface (CLI) Enterprise Addendum WLNG-SE/SP/AN/ET-DP500 Series Revision 1.0 April 09 File name: airborne enterprise command line reference guide.doc Document Number: 100-8081-100...
  • Page 2 Company Confidential Quatech, Inc. <Page Intentionally Left Blank> Airborne CLI Reference Manual 100-8081-100...
  • Page 3 Inc. has made commercially reasonable efforts to ensure that the information contained in this document is accurate and reliable. However, the information is subject to change without notice. No responsibility is assumed by QUATECH for the use of the information or for infringements of patents or other rights of third parties. This document is ®...
  • Page 4 Company Confidential Quatech, Inc. <Page Intentionally Left Blank> Airborne CLI Reference Manual 100-8081-100...
  • Page 5: Table Of Contents

    Quatech, Inc. Contents Overview ... 9 Conventions ... 10 Terminology ... 10 Notes ... 10 Caution ... 10 File Format ... 10 Courier Typeface ... 11 Scope ... 12 Overview ... 12 Understanding the CLI... 12 Typical Development System... 12 Serial Device Server Use ...
  • Page 6 ... 108 startup-msg ... 109 ver-fw... 110 ver-radio ... 111 ver-uboot ... 112 wl-dhcp-vendorid ... 113 wl-udp-ping... 114 wl-wins1 ... 115 wl-wins2 ... 116 cfg-dump ... 117 15.0 Change Log ... 119 Airborne CLI Reference Manual Quatech, Inc. 100-8081-100...
  • Page 7 Company Confidential Quatech, Inc. Figures Figure 1 - Bridging from the Serial Interface Manually Using the pass Command ... 25 Figure 2 - Bridging from the Serial Interface Automatically at Startup Using the Serial-Default Command ... 26 Figure 3 - Bridging from a TCP Connection on the wl-telnet-port ... 27 Figure 4 - Bridging From a TCP Connection on the wl-tunnel-port ...
  • Page 8 Company Confidential Quatech, Inc. <Page Intentionally Left Blank> Airborne CLI Reference Manual 100-8081-100...
  • Page 9: Overview

    With flexibility and performance the WLNG-XX-DP500 series lets you decide how you want to use it. Designed by the Quatech Engineers specifically to meet the demands of the industrial, automotive and medical markets, the Airborne device server has the widest operating temperature range and highest level of reliability available, all backed by a lifetime warranty.
  • Page 10: Conventions

    If you have any question related to the conventions used or clarification of indicated deviation please contact Quatech Sales or Wireless Support. Terminology Airborne Enterprise Device Server and AirborneDirect Enterprise Device...
  • Page 11: Courier Typeface

    Quatech, Inc. 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 <cr> Module Firmware Version:...
  • Page 12: Scope

    CLI. Refer to this section to understand the differences between a command port, data tunnel, TCP/IP vs. UDP use and server vs. device operation. Airborne CLI Reference Manual Quatech, Inc. 100-8081-100...
  • Page 13: Ethernet Bridge Use

    Quatech, Inc. Ethernet Bridge Use A full description of the operation of the Airborne Ethernet Bridge, its place in the network infrastructure and the required parameters will be covered in this section. WLAN Security This section will cover the use of the advanced security features available in the Airborne Enterprise module.
  • Page 14: Supported Devices

    802.11b/g to RS232/422/485 Device Server, Enterprise Class 802.11b/g to 10/100 Ethernet Bridge (NAT Level3), Enterprise Class 802.11b/g to RS232/422/485 Heavy Duty Device Server, Enterprise Class 802.11b/g to 10/100 Heavy Duty Ethernet Bridge (NAT Level3), Enterprise Class Airborne CLI Reference Manual Quatech, Inc. 100-8081-100...
  • Page 15: Overview

    Quatech, Inc. Overview Airborne™ WLN Module Server is the primary user interface for configuring, controlling, and monitoring Airborne™ WLN Modules. Users and OEM applications can establish CLI Sessions to the CLI Server via the serial interface or a TCP connection on the wireless interface.
  • Page 16 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. Airborne CLI Reference Manual Quatech, Inc. 100-8081-100...
  • Page 17: Understanding The Cli

    Quatech, Inc. 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 serial interface may operate in any of the three modes. CLI Sessions established on the wireless interface are restricted to CLI or PASS Modes.
  • Page 18: Cli Session Modes

    See section “CLI Session Startup Modes” for details on startup modes. The transition from CLI Mode into PASS Mode differs depending on the attributes of the CLI session. The following sections describe the two PASS Modes. Airborne CLI Reference Manual Quatech, Inc. pass 100-8081-100...
  • Page 19: Pass Mode For The Serial Interface

    Quatech, Inc. 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-specified TCP server and/or UDP server on the wireless interface.
  • Page 20: Cli Server Escape Processing

    CLI Session transition. This allows the other end to parse the received data and determine when the data bridge is shutdown. escape CLI command. When escape processing is Airborne CLI Reference Manual Quatech, Inc. 100-8081-100...
  • Page 21: Cli Conventions

    Quatech, Inc.  If the escape sequence is the BREAK signal, the BREAK received on the serial interface is not transmitted to the wireless interface, but the transition takes place internally.  The CLI Session that detects the escape sequence will post an “OK”...
  • Page 22: Aschex Vs. Binary Values

    Otherwise, it returns an error response. Error responses are returned in the following general format: Error 0xhhhh: error text<CR><LF> In the response the aschex value is the error code. A summary of error code can be found in section TBD. Airborne CLI Reference Manual Quatech, Inc. 100-8081-100...
  • Page 23: A Typical Development System

    Quatech, Inc. 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 Module through an Access Point (AP).
  • Page 24: Serial Device Server Use

    The following examples illustrate how to configure the Module to initiate a connection to a TCP server: , from a TCP connection on the wl-udp-rxport parameter set to “pass” or by manually issuing the Airborne CLI Reference Manual Quatech, Inc. wl-tunnel-port 100-8081-100...
  • Page 25: Figure 1 - Bridging From The Serial Interface Manually Using The Pass Command

    Company Confidential Quatech, Inc. Figure 1 - Bridging from the Serial Interface Manually Using the pass Command 100-8081-100 Airborne CLI Reference Manual...
  • Page 26: Bridging From A Tcp Connection On The Wl-Telnet-Port

    Company Confidential Quatech, Inc. 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 wl-telnet-port A user or OEM application connected over TCP to the...
  • Page 27: Bridging From A Tcp Connection On The Wl-Tunnel-Port

    Quatech, Inc. 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 and the Module’s serial port. TCP port tunneling is supported...
  • Page 28 The radio-off CLI command is issued from a secondary network CLI session. The network server or host terminates the TCP/IP or UDP session. The TCP/IP connection inactivity timer (wl-tcp-timeout) expires. The escape sequence is detected. Airborne CLI Reference Manual Quatech, Inc. 100-8081-100...
  • Page 29: Bridging Using Udp

    Quatech, Inc. 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 server listening on a specified UDP port or to broadcast a UDP datagram on a specific UDP port.
  • Page 30: Data Bridging With Xmodem Guidelines

    During transmission, XMODEM pads files to the nearest 128 bytes. As a result, original file sizes are not retained.  These guideline apply to the use of Xmodem during firmware, certificate, Private key and configuration file upload to the device server. None Airborne CLI Reference Manual Quatech, Inc. 100-8081-100...
  • Page 31: Ethernet Bridge Use

    Quatech, Inc. Ethernet Bridge Use The Airborne Ethernet Bridge is a fully functional NAT Level 3 router, supporting a public IP address for the wireless interface and a private network for the attached devices on the wired interface. Network Address Translation (NAT) is the process of modifying network address information in datagram packet headers while in transit across a traffic routing device for the purpose of remapping a given address space into another.
  • Page 32: Public Network Interface

    If DHCP is not being used it is necessary to configure the following parameters: Module Static IP address wl-ip wl-gateway Network gateway IP address Primary DNS server IP wl-dns1 address Secondary DNS server IP wl-dns2 address Airborne CLI Reference Manual Quatech, Inc. 100-8081-100...
  • Page 33: Figure 6 - Airborne Ethernet Bridge Ip Configuration

    Quatech, Inc. Command Security (various commands) http-port telnet-port The public address becomes the target address for all accesses to the host device connected to the private network. In the example shown in Figure 6, any device on the public network wanting to communicate with the Host device (IP: 192.168.2.100), would use the IP address 123.45.67.89, the Airborne Ethernet...
  • Page 34: Private Network Interface

    10half 10full 10Mbps, full duplex 100half 100Mbps, half duplex 100Mbps, full duplex 100full It is recommended that auto be used as this will provided the greatest level of compatibility on the Ethernet interface. Airborne CLI Reference Manual Quatech, Inc. 100-8081-100...
  • Page 35 Quatech, Inc. Any traffic between the Airborne Ethernet Bridge ethernet interface and Ethernet client, on the private network, will not be broadcast on to the public network unless it is directed at the public network. For most users there will be no modification of the private network settings needed and if the target Ethernet client uses DHCP to obtain an IP address, no change in configuration will be required either.
  • Page 36: Wlan Security

    14.0: Command wl-security wep128 wl-auth auto Table 3 - WEP Configuration Parameters Description Defines WEP with a 128 bit key. Allows the client and AP to decide the most appropriate authentication type. Airborne CLI Reference Manual Quatech, Inc. 100-8081-100...
  • Page 37: Wpa Migration Mode

    Cisco infrastructure supports a migration mode that allows both legacy WEP and WPA client can coexist on the same network. Quatech has developed and provides a number of options for support of the WPA migration mode, if it is being used by the target infrastructure. These optional parameters are fully described in section 14.0.
  • Page 38: Wpa2 Security

    Description Defines the password for the user name defined by user-leap. This must match the password on the RADIUS authentication server. Airborne CLI Reference Manual Quatech, Inc. 100-8081-100...
  • Page 39: Table 6 - Wpa2-Personal (Psk) Ascii Psk Configuration

    Quatech, Inc. The certificates are typically owned and generated by the Information Technology (IT) department of the organization that owns the infrastructure. The certificates have standard formats. It is critical to make sure that all certificates are in the appropriate format for the client to utilize.
  • Page 40: Table 9 - Eap-Ttls/Mschapv2 Configuration

    Identifies the client certificate name to be used. Replace [client cert name].pem with the required filename (no parenthesis). The certificate must be saved to the module with the name identified by this command. Airborne CLI Reference Manual Quatech, Inc. 100-8081-100...
  • Page 41: Managing Certificates And Private Keys

    It is important to know that there are many variations and additional configurations that the Airborne Device server supports. Please contact Quatech Technical Support if your configuration is not covered by the documentation. There are additional parameters available these are listed in section 14.0.
  • Page 42 Defines the password for the FTP account, associated to the FTP server defined by ftp-server-address. Defines the name of the certificate or private key file to be uploaded or downloaded. The file extension must be included. The filename does not support wildcards. Airborne CLI Reference Manual Quatech, Inc. 100-8081-100...
  • Page 43: Figure 7 - Certificate And Private Key Delivery Methods

    Quatech, Inc. Control of the certificate and private key files is handled by separate group of commands these are described in Table 12. Command list-cert del-cert [cert name] 100-8081-100 Figure 7 - Certificate and Private Key Delivery Methods Table 12 - Certificate Management Commands...
  • Page 44 The following commands can be cleared: 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 priv-key2-password eapfast-pac-filename eap-password eap-ident eap-anon-ident eap-phase1 eap-phase2 subject-match subject-match2 alt-subject-match alt-subject-match2 user-wpa-supp-filename ftp-server-address ftp-server-path ftp-user ftp-password ftp-filename ssh-key Airborne CLI Reference Manual Quatech, Inc. 100-8081-100...
  • Page 45 Quatech, Inc. Command save The Airborne Enterprise Device Server is capable of storing multiple certificates. The number of certificates is limited only by available resources; typically up to twenty (20) certificates can be held by the device server at any one time.
  • Page 46: Wlan Roaming

    The number of attempts can range from 0-32, the default is three (3). This parameter will impact the aggressiveness of the association process for a device server in fringe coverage or noisy environments. Airborne CLI Reference Manual Quatech, Inc. command, the Module 100-8081-100...
  • Page 47 Quatech, Inc. Command wl-beacons-missed If wl-ssid is set to the value attempt to associate with the first open AP that responds quickest to a request to associate, this is typically the AP with the strongest signal strength. The use of the any SSID allows the Device Server to associate with any open AP that is in range.
  • Page 48: Ftp Configuration

    Uploads user or OEM configuration files from the designated FTP server. Requires the Certificate or Private Key file name as a parameter. Uploads Airborne Device Server firmware image from the designated FTP server. Airborne CLI Reference Manual Quatech, Inc. 100-8081-100...
  • Page 49: Power Save

    Quatech, Inc. 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 following power save options are currently supported.
  • Page 50: Command Descriptions

    Entering a ? after authentication will provide a full list of the available CLI commands. pm-mode ? returns… Usage: pm-mode [active | doze] Sets the Module's power-management mode. Parameters are active and doze. Default is active. Airborne CLI Reference Manual Quatech, Inc. 100-8081-100...
  • Page 51: Dev-Type

    Quatech, Inc. dev-type Command dev-type Arguments none Device Type Default <empty> Description Identifies the Airborne device type. The device type specifies the hardware configuration and the functionality of the module, the following list identifies the possible responses: 802.11b Airborne UART Module, WPA Security 802.11b Airborne UART Module, LEAP Security...
  • Page 52: Wl-Security

    WPA/WPA2 with EAP-TLS authentication, also known as WPA-Enterprise (TKIP/AES) and WPA2-Enterprise TLS WPA/WPA2 with EAP-TTLS authentication, also known as WPA-Enterprise (TKIP/AES) and WPA2-Enterprise TTLS WPA/WPA2 with PEAP authentication, also known as WPA-Enterprise (TKIP/AES) and WPA2-Enterprise PEAP v0 Airborne CLI Reference Manual Quatech, Inc. 100-8081-100...
  • Page 53: Get-Cert

    Quatech, Inc. get-cert Command get-cert Arguments [ASCII Text – filename] Device Type Default [blank] Description Will cause the device server to retrieve a certificate for the FTP server identified in the parameters defined by the following commands: ftp-server-path ftp-server-address ftp-user...
  • Page 54: Get-Cfg

    User configuration file. This file contains the user configuration commands and parameters. OEM default configuration file. This contains the OEM default settings for the device server. These settings are installed upon the issuing of a factory reset command or hardware factory reset input. Airborne CLI Reference Manual Quatech, Inc. 100-8081-100...
  • Page 55: Put-Cert

    Quatech, Inc. put-cert Command put-cert Arguments [ASCII text: filename.extension] Device Type Default none Description Will cause the device server to wait for an X-modem file transfer of certificate from the host device connected to the serial interface. Once the download is complete it is necessary for the save command to be issued, this will cause the certificate to be stored to the device server.
  • Page 56: Put-Cfg

    OEM default configuration file. This contains the OEM default settings for the device server. These settings are installed upon the issuing of a factory reset command or hardware factory reset input. Airborne CLI Reference Manual Quatech, Inc. 100-8081-100...
  • Page 57: Ca-Cert-Filename

    Quatech, Inc. ca-cert-filename Command ca-cert-filename Arguments [ASCII Text: CA filename.extension] Device Type Default none Description This command defines the Certificate Authority (CA) filename to be used with the chosen authentication method. The certificate can contain one or more trusted CA certificates.
  • Page 58: Ca-Cert2-Filename

    A trusted CA certificate should always be configured when using EAP-TLS, EAP-TTLS or PEAP. The file must be in PEM or DER format for the device server to recognize it as a valid certificate. Airborne CLI Reference Manual Quatech, Inc. 100-8081-100...
  • Page 59: Client-Cert-Filename

    Quatech, Inc. client-cert-filename Command client-cert-filename Arguments [ASCII Text: filename.extension] Device Type Default none Description This command defines the Client certificate filename to be used with the chosen authentication method. A client certificate should always be configured when using EAP-TLS. The file must be in PEM or DER format for the device server to recognize it as a valid certificate.
  • Page 60: Client-Cert2-Filename

    This command defines a second Client certificate filename to be used with the chosen authentication method. A client certificate should always be configured when using EAP-TLS. The file must be in PEM or DER format for the device server to recognize it as a valid certificate. Airborne CLI Reference Manual Quatech, Inc. 100-8081-100...
  • Page 61: Priv-Key-Filename

    Quatech, Inc. priv-key-filename Command priv-key-filename Arguments [ASCII Text: filename.extension] Device Type Default none Description This command defines the Client Private Key filename to be used with the chosen authentication method. When PKCS#12/PFX files are used the ca-cert-filename should not be used.
  • Page 62: Priv-Key2-Filename

    When PKCS#12/PFX files are used the ca-cert-filename should not be used. The file must be in PEM or DER format for the device server to recognize it as a valid private key. Airborne CLI Reference Manual Quatech, Inc. 100-8081-100...
  • Page 63: Priv-Key-Password

    Quatech, Inc. priv-key-password Command priv-key-password Arguments [ASCII Text: password] Device Type Default [blank] Description This command defines the Client Private Key password to be used with the Private Key file identified by the priv-key-filename command. The private key is an ASCII text string provided by the generator of the Private Key file.
  • Page 64: Priv-Key2-Password

    This command defines the Client Private Key password to be used with the Private Key file identified by the priv-key2-filename command. The private key is an ASCII text string provided by the generator of the Private Key file. Airborne CLI Reference Manual Quatech, Inc. 100-8081-100...
  • Page 65: [Question Mark]

    Quatech, Inc. ? [Question Mark] Command ? [Question Mark] Arguments none Device Type Default none Description This command provide text help and supports two use cases: When used by itself at the command prompt it will cause the device server to display all available commands.
  • Page 66: Help

    When used by itself at the command prompt it will cause the device server to display all available commands. The list is not device functionality sensitive. This response is identical to the ? command, when used without a command. Airborne CLI Reference Manual Quatech, Inc. 100-8081-100...
  • Page 67: Dh-Parm-Filename

    Quatech, Inc. dh-parm-filename Command dh-parm-filename Arguments [Private Key filename] with PEM extension. Device Type Default [blank] Description DH/DSA parameters file name (in PEM format). This is an optional configuration file for setting parameters for an ephemeral DH key exchange. In most cases, the default RSA authentication does not use this configuration.
  • Page 68: Eap-Password

    NtPasswordHash can only be used when the password is for MSCHAPv2 or MSCHAP (EAP-MSCHAPv2, EAP-TTLS/MSCHAPv2, EAP-TTLS/MSCHAP, LEAP). EAP-PSK (128-bit PSK), EAP-PAX (128-bit PSK), and EAP-SAKE (256-bit PSK) is also configured using this field. For EAP-GPSK, this is a variable length PSK. Airborne CLI Reference Manual Quatech, Inc. 100-8081-100...
  • Page 69: Eap-Ident

    Quatech, Inc. eap-ident Command eap-ident Arguments [text string] Device Type Default [blank] Description Identity string for EAP. Typically the RADIUS server user login name. Max length of 64 ASCII characters. 100-8081-100 Airborne CLI Reference Manual...
  • Page 70: Eap-Anon-Ident

    Device Type Default [blank] Description Anonymous identity string for EAP. Max length of 64 ASCII characters. Used as the unencrypted identity with EAP types that support different tunneled identity, e.g., EAP-TTLS. Typical format anonident@example.com. Airborne CLI Reference Manual Quatech, Inc. 100-8081-100...
  • Page 71: Eap-Phase1

    Quatech, Inc. eap-phase1 Command eap-phase1 Arguments peaplabel=0 | peaplabel=1| peapver=0 | peapver=1 | peap_outer_success=0 | include_tls_length=1| result_ind=1 | crypto_binding=0 | crypto_binding=1 | crypto_binding=2 | Device Type Default [blank] Description Phase1 (outer authentication, i.e., TLS tunnel) parameters. peaplable=0 peaplabel=1 peapver=0 peapver=1...
  • Page 72: Eap-Phase2

    Sets the inner encryption to MSCHAPv2. Required for EAP-PEAPv0 or EAP-PEAPv1. Sets the inner encryption to MSCHAPv2. Required for EAP-TTLS/MSCHAPv2 Sets the inner encryption to MD5. Required for EAP-TTLS/MD5. Airborne CLI Reference Manual Quatech, Inc. 100-8081-100...
  • Page 73: Subject-Match

    Quatech, Inc. subject-match Command subject-match Arguments [ASCII Text String] Device Type Default [blank] Description Substring to be matched against the subject of the authentication server certificate. If this string is set, the server certificate is only accepted if it contains this string in the subject. The subject string is in following format: /C=US/ST=CA/L=San Francisco/CN=Test AS/emailAddress=as@example.com...
  • Page 74: Subject-Match2

    The subject string is in following format: /C=US/ST=CA/L=San Francisco/CN=Test AS/emailAddress=as@example.com Example: EMAIL:server@example.com Example: DNS:server.example.com;DNS:server2.example.com Following types are supported: EMAIL, DNS, URI Airborne CLI Reference Manual Quatech, Inc. 100-8081-100...
  • Page 75: Clear-Cred

    Quatech, Inc. clear-cred Command clear-cred Arguments none Device Type Default [blank] Description Removes all user credentials. You must save the changes in order for the user credentials to be permanently removed from the module. The affected parameters are: wl-security ca-cert-filename...
  • Page 76: Clear

    Removes specified parameter value from the user configuration. You must commit the changes in order for the user credentials to be permanently cleared from the module.  Clearing any single security credential from the device server may impact your ability to regain a wireless network connection.. Airborne CLI Reference Manual Quatech, Inc. 100-8081-100...
  • Page 77: Del-Cert

    Quatech, Inc. del-cert Command del-cert Arguments [ASCII Text string] Device Type Default [blank] Description Removes user certificates and private keys. The argument can be a filename or a wildcard for a group of one or more certificates to be deleted. You must save the changes in order for the user credentials to be permanently removed from the module.
  • Page 78: Clear-Wep

    You must commit the changes in order for the WEP keys to be permanently removed from the module.  If you remove all the WEP keys from the module, you may be unable to regain a wireless network connection if the access points require them. Airborne CLI Reference Manual Quatech, Inc. 100-8081-100...
  • Page 79: Default-Cfg

    Quatech, Inc. default-cfg Command default-cfg Arguments none Device Type Default [blank] Description This will set the module configuration to the factory default settings. The settings in memory will be set to default values. You must commit the changes if you desire them to remain in the default state after a module restart.
  • Page 80: Radio-On

    Command radio-on Arguments none Device Type Default none Description Turns on power to the radio. The radio will attempt to regain a wireless network connection. Airborne CLI Reference Manual Quatech, Inc. 100-8081-100...
  • Page 81: Radio-Off

    Quatech, Inc. radio-off Command radio-off Arguments none Device Type Default none Description Disables power to the 802.11b/g radio. After the command is issued the device server will close all TCP/IP and UDP connections and power down the radio. When in this state the device server will no longer be associated with a wireless network and any network based communication will not be possible.
  • Page 82: Ping

    Description This command sends an ICMP ECHO_REQUEST to the specified destination address, and displays various statistics for the result. The destination address can be an IP address or a website name (URL), such as www.quatech.com. Example: ping www.quatech.com PING www.quatech.com (69.36.15.130): 56 data bytes 64 bytes from 69.36.15.130: seq=0 ttl=50 time=98.835 ms...
  • Page 83: Stats

    Quatech, Inc. stats Command stats Arguments radio | ethernet Device Type Default radio Description Displays statistics for the specified interface. radio ethernet Example: stats radio Rx Packets: Rx Bytes: Rx Errors: Rx Dropped: Rx Overruns: Tx Packets: Tx Bytes: Tx Errors:...
  • Page 84: Ftp-Server-Address

    The IP address format follows the standard ASCII format XXX.XXX.XXX.XXX, where XXX = 1-254 Must be specified in order for the following commands to function correctly: update ftp get-cert get-cfg Airborne CLI Reference Manual Quatech, Inc. 100-8081-100...
  • Page 85: Ftp-Server-Path

    Quatech, Inc. ftp-server-path Command ftp-server-path Arguments [ASCII text: directory path] Device Type Default <blank> Description The path on the target FTP server that contains the firmware, certificate or configuration files to be downloaded. This does not need to be set if the file is in the default directory for the specified ftp-user.
  • Page 86: Ftp-User

    Defines the username for the FTP account, associated to the FTP server defined by ftp-server-address. Must be specified in order for the following commands to function correctly: update ftp get-cert get-cfg Please note that anonymous user credentials are not supported. Airborne CLI Reference Manual Quatech, Inc. 100-8081-100...
  • Page 87: Ftp-Password

    Quatech, Inc. ftp-password Command ftp-password Arguments [ASCII text: password] Device Type Default <blank> Description Defines the password for the FTP account, associated to the FTP server defined by ftp-server- address. Must be specified in order for the following commands to function correctly:...
  • Page 88: Ftp-Filename

    Defines the name of the firmware, certificate or configuration file to be uploaded or downloaded. If not specified, update ftp will uploaded the newest file in the target directory. Must be specified in order for the following command to function correctly: update ftp Airborne CLI Reference Manual Quatech, Inc. 100-8081-100...
  • Page 89: Save

    Quatech, Inc. save Command save Arguments none Device Type Default <blank> Description Saves all user uploaded certificates, private keys and configuration files to flash. If save is not issued after uploading files, all files uploaded after the last save command, will be discarded and require uploading after next restart or power cycle.
  • Page 90: Telnet-Port

    This will restrict the management options available The module will transfer all telnet (port 23) traffic to the wired Ethernet interface. The module will transfer all telnet (port 23) traffic to its internal IP stack. Airborne CLI Reference Manual Quatech, Inc. 100-8081-100...
  • Page 91: Http-Port

    Quatech, Inc. http-port Command http-port Arguments disable | enable Device Type Ethernet Default enable Description Enables or disables access to the modules web browser (Port 80) via the wireless interface. This is similar to port filtering, when enabled the module will transfer all HTTP traffic (port 80) traffic to its internal HTTP server, when disabled all HTTP traffic will be forwarded to the wired interface.
  • Page 92: Eth-Ip

     The subnet for the wired IP and gateway IP addresses (Ethernet) and public IP address (802.11), obtained by the module via the wireless interface, and must not be the same. Airborne CLI Reference Manual Quatech, Inc. 100-8081-100...
  • Page 93: Eth-Gateway

    Quatech, Inc. eth-gateway Command eth-gateway Arguments [Valid IP address] Device Type Ethernet Default 192.168.2.1 Description Configures the IP address of the Ethernet gateway. This is the IP address used by the client to communicate with the gateway (module). The IP address of the client and the Ethernet gateway must be in the same subnet for IP routing to work correctly.
  • Page 94: Eth-Subnet

    Command eth-subnet Arguments [Valid subnet mask] Device Type Ethernet Default 255.255.255.0 Description Configures the subnet mask for the Ethernet gateway and wired interface client. Airborne CLI Reference Manual Quatech, Inc. 100-8081-100...
  • Page 95: Eth-Mode

    Quatech, Inc. eth-mode Command eth-mode Arguments auto | 10half |10full | 100half | 100full Device Type Ethernet Default auto Description Configures the connection rate for the wired Ethernet interface. auto 10half 10full 100half 100full 100-8081-100 Auto negotiate 10Mbps, half duplex...
  • Page 96: Wl-Specific-Scan

    Use Broadcast Probes to attempt to find an Access Point. Use Directed Probes to attempt to find an Access Point. In this mode only AP’s with matching SSID’s to the module will be probed. Airborne CLI Reference Manual Quatech, Inc. 100-8081-100...
  • Page 97: Apply-Cfg

    Quatech, Inc. apply-cfg Command apply-cfg Arguments serial | radio | ethernet | ports Device Type Default Description Applies the selected settings immediately, without requiring a restart. serial radio ethernet 100-8081-100 Applies following serial port settings: bit-rate parity flow data-bits stop-bit...
  • Page 98 Any settings applied with this command are temporary and will not be persistent across a restart or power cycle. Any settings applied by this command can be made persistent across restarts and power cycles by issuing the commit command. Applies the following port settings: telnet-port http-port Airborne CLI Reference Manual Quatech, Inc. 100-8081-100...
  • Page 99: Wl-Assoc-Backoff

    Quatech, Inc. wl-assoc-backoff Command wl-assoc-backoff Arguments [Integer] Range: 0 -20000 Device Type Default 10000 Description The amount of time in milliseconds to backoff after three (3) failed association attempts. Range 0 - 20000 milliseconds (0 to 20 seconds) 100-8081-100 Airborne CLI Reference Manual...
  • Page 100: Arp-Reachable-Time

    0.5 and 1.5 times this value. Value has the range of 1-254 seconds. The default time is 120 seconds. The device server requires a restart or power cycle for this parameter change to take effect. Airborne CLI Reference Manual Quatech, Inc. 100-8081-100...
  • Page 101: Arp-Staleout-Time

    Quatech, Inc. arp-staleout-time Command arp-staleout-time Arguments [integer] Device Type Default Description The amount of time since the last observation of the IP address before scheduling that entry for removal from the device severs internal ARP table. Value has the range of 1-254 seconds. The default time is 120 seconds.
  • Page 102: Del-Cfg

    OEM default configuration file. This contains the OEM default settings for the device server. These settings are installed upon the issuing of a factory reset command or hardware factory reset input. Airborne CLI Reference Manual Quatech, Inc. 100-8081-100...
  • Page 103: Discover

    Quatech, Inc. discover Command discover Arguments none Device Type Default <none> Description Initiates discovery of and lists all Airborne device servers. The device servers must be on the same physical network as the device that initiated the process. A typical response will be:...
  • Page 104: Intf-Type

    Description Sets the serial interface for RS-232, RS-422, or RS-485 communications. Enables interface pins 17, 19 and 22. (See 802.11b/g High Performance Device Server Product Specification for detailed description of pin function). Airborne CLI Reference Manual Quatech, Inc. 100-8081-100...
  • Page 105: List-Cfg

    Quatech, Inc. list-cfg Command list-cfg Arguments None Device Type Default <none> Description Displays a list of all the configuration files resident on the device server, including files that have been loaded but not saved. 100-8081-100 Airborne CLI Reference Manual...
  • Page 106: Ssh-Keygen

    You must issue a commit or save to store the generated keys, once generated.  Key generation may take several seconds, the OK response will be returned by the device server when the keys have been generated. Airborne CLI Reference Manual Quatech, Inc. 100-8081-100...
  • Page 107: Ssh-Keysize

    Quatech, Inc. ssh-keysize Command ssh-keysize Arguments [integer] Device Type Default 1024 Description Defines the size of the SSH RSA key. The key length must be from 1024-2048 and MUST be divisable by 8. The default is 1024. If you change the ssh-keysize and SSH keys already exist, you will be prompted to ...
  • Page 108: Startup-Text

    Once displayed the device is available for interaction using CLI. The ASCII text message can be a maximum of 31 characters terminated by <CR>/<LF>. For the message to be displayed startup-msg must be enabled. Airborne CLI Reference Manual Quatech, Inc. 100-8081-100...
  • Page 109: Startup-Msg

    Quatech, Inc. startup-msg Command startup-msg Arguments 0 | 1 Device Type Default 0 (disable) Description Displays a start-up message, defined by startup-text, once the device server has completed a restart or power cycle. Once the message is displayed the device server is available for interaction on the CLI interface.
  • Page 110: Ver-Fw

    Command Ver-fw Arguments none Device Type Default <none> Description Returns the current version of firmware loaded on the module. Airborne CLI Reference Manual Quatech, Inc. 100-8081-100...
  • Page 111: Ver-Radio

    Quatech, Inc. ver-radio Command ver-radio Arguments none Device Type Default <none> Description Returns the current version of radio firmware being run on the device servers’ radio. 100-8081-100 Airborne CLI Reference Manual...
  • Page 112: Ver-Uboot

    Command ver-uboot Arguments none Device Type Default <none> Description Returns the version of uboot loader code resident on the device server. Airborne CLI Reference Manual Quatech, Inc. 100-8081-100...
  • Page 113: Wl-Dhcp-Vendorid

    Quatech, Inc. wl-dhcp-vendorid Command wl-dhcp-vendorid Arguments [ASCII Text] Device Type Default Empty String Description Configures the DHCP Vendor Class ID String to use in the DHCP requests. Parameter can by up to 31 ASCII characters long. 100-8081-100 Airborne CLI Reference Manual...
  • Page 114: Wl-Udp-Ping

    Periodically ping the configured UDP server. This causes the ARP cache to be periodically refreshed to prevent unnecessary ARPs from being transmitted. Since ARPs are broadcast and pings are unicast packets, total network overhead is reduced if pings are used instead of ARPs. Disabled Enabled Airborne CLI Reference Manual Quatech, Inc. 100-8081-100...
  • Page 115: Wl-Wins1

    Quatech, Inc. wl-wins1 Command wl-wins1 Arguments [IP Address] Device Type Default 0.0.0.0 Description Configures the Primary WINS Server Address. This value is used for WINS lookups, if the lookup fails using the value from wl-dns1 or wl-dns2. If the DHCP Client is enabled, the wl-wins1 value will be updated (if the DHCP Server provides one).
  • Page 116: Wl-Wins2

    Configures the Secondary WINS Server Address. This value is used for WINS lookups, if the lookup fails using the value from wl-dns1 or wl-dns2. If the DHCP Client is enabled, the wl-wins1 value will be updated (if the DHCP Server provides one). Default is 0.0.0.0. Airborne CLI Reference Manual Quatech, Inc. 100-8081-100...
  • Page 117: Cfg-Dump

    Quatech, Inc. cfg-dump Command cfg-dump Arguments [ASCII Text] Device Type Default <none> Description Lists current configuration of the module. The command lists all parameter settings including those not yet committed. [no parameter] active factory user 100-8081-100 Lists current configuration (all parameters).
  • Page 118 Company Confidential Quatech, Inc. Comments/Notes: Airborne CLI Reference Manual 100-8081-100...
  • Page 119: Change Log

    Quatech, Inc. 15.0 Change Log The following table indicates all changes made to this document: Version Date 04/16/2009 100-8081-100 Section Change Description Preliminary Release. Airborne CLI Reference Manual Author...
  • Page 120 ® QUATECH Inc. 5675 Hudson Industrial Parkway Hudson, OH 44236 Telephone: 330.655.9000 Toll Free (USA): 800.553.1170 Fax: 330.655.9010 Technical Support: 714.899.7543 E-mail Support : wirelesssupport@quatech.com Web Site: www.quatech.com...

Table of Contents