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.
Company Confidential Quatech, Inc.
Company Confidential Quatech, Inc. Quatech Confidential Copyright © 2009 QUATECH ® Inc. ALL RIGHTS RESERVED. No part of this publication may be copied in any form, by photocopy, microfilm, retrieval ® system, or by any other means now known or hereafter invented without the prior written permission of QUATECH Inc.. This document may not be used as the basis for manufacture or sale of any items without the prior written consent of QUATECH Inc.. QUATECH Inc. is a registered trademark of QUATECH Inc..
Company Confidential Quatech, Inc.
Company Confidential Quatech, Inc. Contents 1.0 Overview ...................................................................................................................................................................... 9 2.0 Conventions ............................................................................................................................................................... 10 2.1 Terminology .........................................................................................
Company Confidential Quatech, Inc. ca-cert-filename .............................................................................................................................................................. 57 ca-cert2-filename ............................................................................................................................................................ 58 client-cert-filename .................................................................................................
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 ...........................................................................................
Company Confidential Quatech, Inc.
Company Confidential Quatech, Inc. 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 family of products provide a broad, encompassing solution for wireless applications requiring performance, reliability and advanced technology.
Company Confidential 2.0 Quatech, Inc. Conventions The following section outlines the conventions used within the document, where convention is deviated from the deviation takes precedence and should be followed. If you have any question related to the conventions used or clarification of indicated deviation please contact Quatech Sales or Wireless Support. 2.
Company Confidential Quatech, Inc. 2.5 Courier Typeface Commands and other input that a user is to provide are indicated with Courier typeface.
Company Confidential 3.0 Quatech, Inc. 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 commands introduced with the Enterprise Class product family. The Enterprise Addendum should be used in conjunction with the Airborne CLI Reference Manual for a full description of the available Command Line Interface.
Company Confidential Quatech, Inc. 3.5 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. 3.6 WLAN Security This section will cover the use of the advanced security features available in the Airborne Enterprise module.
Company Confidential 4.0 Quatech, Inc. 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 devices support it. At the time of writing, the CLI command list represents the v1.03 release of the WLRGXX-DP500 series of Airborne Device Server firmware.
Company Confidential Quatech, Inc. 5.0 Overview The Airborne™ WLN Module includes a Command Line Interface (CLI) Server. The CLI 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. This document describes the CLI in full.
Company Confidential Quatech, Inc. 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.
Company Confidential Quatech, Inc. 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 serial interface may operate in any of the three modes. CLI Sessions established on the wireless interface are restricted to CLI or PASS Modes. 6.
Company Confidential Quatech, Inc. Level 1 (L1) = connection, not logged in (default) Level 2 (L2) = data Level 3 (L3) = config Level 4 (L4) = OEM Level 5 (L5) = MFG Level 0 is the connectionless access level. Access over UDP will use this access level. The L0 level provides access to the name query services. It is not an authenticated level. Level 1 is the default security level for CLI Sessions over TCP or the serial interface.
Company Confidential 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. Once a connection is established, data bridging becomes possible between the CLI Session on the serial interface and the TCP Server and/or UDP server.
Company Confidential 6.4 Quatech, Inc. 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 wltelnet-port always start in CLI Mode. CLI Sessions on the wireless interface using the TCP port specified by the wl-tunnel-port or the UDP port specified by wl-udp-rxport, always start in PASS Mode.
Company Confidential 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” response on its interface if the escape sequence caused the CLI Session to transition to the CLI Mode. Escape detection does not close the TCP connection. It only terminates the data bridge.
Company Confidential 6.7 Quatech, Inc. 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 data is transmitted as binary data. By comparison, when the command putget or putexpect is issued, the senddata content must be encoded as ASCII hexadecimal digit pairs.
Company Confidential Quatech, Inc. 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 Module through an Access Point (AP). An Access Point. An Airborne™ WLN Module.
Company Confidential 8.0 Quatech, Inc. 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 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.
Company Confidential Quatech, Inc.
Company Confidential Quatech, Inc. Figure 2 - Bridging from the Serial Interface Automatically at Startup Using the SerialDefault 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-telnet-port of the Module may create a data bridge to the serial interface by issuing the pass command. The pass command will succeed if there is no other data bridge active and the CLI Session on the serial interface is in LISTEN Mode.
Company Confidential 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 by the wl-tunnel, wl-tcp-mode, and wl-tunnel-port commands. The rules for TCP connections to the wl-tunnel-port are as follows: wl-tunnel must be enabled (set to 1).
Company Confidential Quatech, Inc. 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 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.
Company Confidential 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. This also allows the Module to forward data received on its specified UDP receive port to the serial interface.
Company Confidential Quatech, Inc. 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 UDP transmission destination IP address/port. wl-udp-rxport sets the UDP port that the Module will receive data on for the bridge. If wl-xmit-type is set for both, then the TCP bridge must remain active for the UDP bridge to remain active.
Company Confidential Quatech, Inc. 9.0 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.
Company Confidential Quatech, Inc. The Private network is the wired interface provided by the bridge. This interface includes a DHCP server and supports dynamic and static IP address assignment. This means any Ethernet client supporting DHCP can be connected to the wired interface without any configuration changes. The private network host can communicate with the Airborne Bridge using the bridges Ethernet IP address on the private network.
Company Confidential Quatech, Inc. 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 configuring the security profile. This parameter allows directed traffic on the http port 80 to be directed to either the Airborne device server or the device connected on the wired port.
Company Confidential Quatech, Inc. The public network interface supports the Airborne discovery protocol and will respond to discovery requests issued on the public network. 9.2 Private Network Interface The private network interface is on the Ethernet port of the Airborne Bridge. The interface supports a single Ethernet client with either a static or DHCP sourced IP address. This interface needs minimal configuration and requires the parameters in Table 2 to be configured.
Company Confidential 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.
Company Confidential Quatech, Inc. 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 family supports both Personal and Enterprise versions of WPA2, allowing delivery and storage of certificates and private keys to the module.
Company Confidential Quatech, Inc. Command Description wl-def-key 1 Configures the default WEP key to be used. wl-key-1 12345678901234567890123456 Defines the 128 bit key as 26 hex digits. This key must match the key on the AP. 10.2.1 WPA Migration Mode Cisco infrastructure supports a migration mode that allows both legacy WEP and WPA client can coexist on the same network.
Company Confidential 10.4 Quatech, Inc. Command Description pw-leap MyUserPassword Defines the password for the user name defined by user-leap. This must match the password on the RADIUS authentication server. WPA2 Security WiFi Protected Access 2 (WPA2) is a compatibility certification program created by the WiFi Alliance to indicate compliance to a minimum set of security and functional capabilities for 802.11 devices.
Company Confidential 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.
Company Confidential Quatech, Inc. Table 9 - EAP-TTLS/MSCHAPV2 Configuration Command Description wl-security ttls Sets the EAP authentication process to be used. eap-ident [client username from RADIUS server] Sets the username for the client. There must be a valid username on the RADIUS server that matches this name. Replace the [client username from RADIUS server] with the user name (no parenthesis). eap-password [Password for client username] Sets the password for the client.
Company Confidential Quatech, Inc. Command Description priv-key-filename [client private key name].pem Identifies he client private key file to be used. Replace [client private key name].pem with the required filename (no parenthesis). The private key file must be saved to the module with the name identified by this command. It is important to know that there are many variations and additional configurations that the Airborne Device server supports.
Company Confidential Quatech, Inc. Command Description get-cert Will cause the device server to retrieve a certificate from the FTP server identified by the parameters associated with the following commands: ftp-server-path ftp-server-address ftp-user ftp-password ftp-filename 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. No file path should be included.
Company Confidential Quatech, Inc. 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 Commands Command Description list-cert This provides a list of certificates resident on the module, including files that have been transferred but not yet saved to the module. The command will list files that have been delivered but not saved.
Company Confidential Quatech, Inc. Command Description clear-cred This command allows the credentials stored in the module to be cleared prior to any new ones being applied. The use of this command is recommended to guarantee that no artifacts of a previous security configuration impact the success of any new applied configuration.
Company Confidential Quatech, Inc. Command Description save This command moves any uploaded certificates or private keys to permanent storage, making them persistent across restarts or power cycles. Issuing save after del-cert makes any certificate deletions permanent. 100-8081-100 The Airborne Enterprise Device Server is capable of storing multiple certificates.
Company Confidential Quatech, Inc. 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 roaming capabilities: Table 13 - Commands that Affect Roaming Command Description wl-type This determines the network type being used by the device server, roaming applies to Infrastructure type only.
Company Confidential Quatech, Inc. Command Description wl-beacons-missed Configures 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 is not recommended to set this parameter to zero (0). This parameter will impact the roaming aggressiveness of the device server, the smaller the number the faster the device will attempt to roam.
Company Confidential Quatech, Inc. 12.0 FTP Configuration The Airborne Enterprise Device Server 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 server and transferring a file to the device using the FTP protocol. Table 14 - FTP Configuration Commands Command ftp-server-address Description This defines the IP address of the target FTP server. The address must be in the standard format XXX.XXX.XXX.XXX.
Company Confidential 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. Table 16 – Power-Save Modes Command Description Enables power to the 802.11b/g radio. The radio will utilize the power profile defined by pm-mode.
Company Confidential Quatech, Inc. 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 help support: 1. Trailing a command with a ? will return a description of the command function and valid argument list e.g. pm-mode ? returns… Usage: pm-mode [active | doze] Sets the Module's power-management mode. Parameters are active and doze.
Company Confidential Quatech, Inc. dev-type Command dev-type Arguments none Device Type All Default 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: 100-8081-100 0 802.11b Airborne UART Module, WPA Security WLNB-AN-DP1XX 1 802.11b Airborne UART Module, LEAP Security WLNB-AN-DP5XX 2 802.
Company Confidential Quatech, Inc. wl-security Command wl-security Arguments disable | wep64 |wep128 | wpa-psk | wpa-leap | wpa-leap64 | wpa-leap128| wpa-psk64 | wpa-psk128 | wpa2-psk | tls | ttls | peap Device Type All Default disable Description Selects the Wireless Security method for Authentication and Encryption. 52 disable Security is disabled.
Company Confidential Quatech, Inc. get-cert Command get-cert Arguments [ASCII Text – filename] Device Type All 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 ftp-password ftp-filename 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.
Company Confidential Quatech, Inc. get-cfg Command get-cfg Arguments [ASCII Text – filename] Device Type All Default [blank] Description Will cause the device server to retrieve a configuration file from the FTP server identified in the parameters defined by the following commands: ftp-server-path ftp-server-address ftp-user ftp-password Once the download is complete it is necessary for the save command to be issued, this will cause the configuration file to be stored to the device server.
Company Confidential Quatech, Inc. put-cert Command put-cert Arguments [ASCII text: filename.extension] Device Type All 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. It is required that the host use Xmodem 1K or Xmodem 1K-CRC.
Company Confidential Quatech, Inc. put-cfg Command put-cfg Arguments user_config.txt | OEM_config.txt Device Type All Default none Description Will cause the device server to wait for an Xmodem file transfer of the configuration file 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 configuration file to be stored to the device server.
Company Confidential Quatech, Inc. ca-cert-filename Command ca-cert-filename Arguments [ASCII Text: CA filename.extension] Device Type All 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. A trusted CA certificate should always be configured when using EAP-TLS, EAP-TTLS or PEAP.
Company Confidential Quatech, Inc. ca-cert2-filename Command ca-cert2-filename Arguments [ASCII Text: CA filename.extension] Device Type All Default none Description This command defines a second Certificate Authority (CA) filename to be used with the chosen authentication method. The certificate can contain one or more trusted CA certificates. A trusted CA certificate should always be configured when using EAP-TLS, EAP-TTLS or PEAP.
Company Confidential Quatech, Inc. client-cert-filename Command client-cert-filename Arguments [ASCII Text: filename.extension] Device Type All 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.
Company Confidential Quatech, Inc. client-cert2-filename Command client-cert2-filename Arguments [ASCII Text: filename.extension] Device Type All Default none Description 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.
Company Confidential Quatech, Inc. priv-key-filename Command priv-key-filename Arguments [ASCII Text: filename.extension] Device Type All 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. The file must be in PEM or DER format for the device server to recognize it as a valid private key.
Company Confidential Quatech, Inc. priv-key2-filename Command priv-key2-filename Arguments [ASCII Text: filename.extension] Device Type All Default none Description This command defines a second 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. The file must be in PEM or DER format for the device server to recognize it as a valid private key.
Company Confidential Quatech, Inc. priv-key-password Command priv-key-password Arguments [ASCII Text: password] Device Type All 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.
Company Confidential Quatech, Inc. priv-key2-password Command priv-key2-password Arguments [ASCII Text: password] Device Type All Default [blank] Description 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.
Company Confidential Quatech, Inc. ? [Question Mark] Command ? [Question Mark] Arguments none Device Type All 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. The list is not device functionality sensitive. This response is identical to the help command.
Company Confidential Quatech, Inc. 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 list is not device functionality sensitive. This response is identical to the ? command, when used without a command.
Company Confidential Quatech, Inc. dh-parm-filename Command dh-parm-filename Arguments [Private Key filename] with PEM extension. Device Type All 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. However, it is possible to setup RSA to use ephemeral DH key exchange.
Company Confidential Quatech, Inc. eap-password Command eap-password Arguments [ASCII Text String] or [32hex Digits] Device Type All Default [blank] Description Password string for EAP. Max length of 64 ASCII characters. This field can include either the plaintext password (using ASCII or hex string) or a NtPasswordHash (16byte MD4 hash of password) in hash:<32 hex digits> format.
Company Confidential Quatech, Inc. eap-ident Command eap-ident Arguments [text string] Device Type All Default [blank] Description Identity string for EAP. Typically the RADIUS server user login name. Max length of 64 ASCII characters.
Company Confidential Quatech, Inc. eap-anon-ident Command eap-anon-ident Arguments [text string] Device Type All 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.
Company Confidential 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 All Default [blank] Description Phase1 (outer authentication, i.e., TLS tunnel) parameters. peaplable=0 Forces a new label to be used during key derivation when PEAPv1 or newer is being utilized.
Company Confidential Quatech, Inc. eap-phase2 Command eap-phase2 Arguments auth=MSCHAPV2 | autheap=MSCHAPV2 | autheap=MD5 Device Type All Default [blank] Description Phase2 (inner authentication used with TLS tunnel) parameters. auth=MSCHAPV2 autheap=MSCHAPV2 autheap=MD5 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.
Company Confidential Quatech, Inc. subject-match Command subject-match Arguments [ASCII Text String] Device Type All 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 Example: EMAIL:server@example.com Example: DNS:server.
Company Confidential Quatech, Inc. subject-match2 Command subject-match2 Arguments [ASCII Text String] Device Type All 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 Example: EMAIL:server@example.
Company Confidential Quatech, Inc. clear-cred Command clear-cred Arguments none Device Type All 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.
Company Confidential Quatech, Inc.
Company Confidential Quatech, Inc. del-cert Command del-cert Arguments [ASCII Text string] Device Type All 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. del-cert *.* : Will delete all certificates. del-cert user*.
Company Confidential Quatech, Inc. clear-wep Command clear-wep Arguments none Device Type All Default [blank] Description Removes all WEP keys from the module. You must commit the changes in order for the WEP keys to be permanently removed from the module. 78 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.
Company Confidential Quatech, Inc. default-cfg Command default-cfg Arguments none Device Type All 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. All user settings will be lost if you issue this command and commit the changes.
Company Confidential Quatech, Inc. radio-on Command radio-on Arguments none Device Type All Default none Description Turns on power to the radio. The radio will attempt to regain a wireless network connection.
Company Confidential Quatech, Inc. radio-off Command radio-off Arguments none Device Type All 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.
Company Confidential Quatech, Inc. ping Command ping Arguments [IPAddress] | [ASCII Text: URL] Device Type All Default [blank] 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.
Company Confidential Quatech, Inc. stats Command stats Arguments radio | ethernet Device Type All Default radio Description Displays statistics for the specified interface. Displays radio statistics. radio Displays wired Ethernet statistic. ethernet Only applies to Ethernet device.
Company Confidential Quatech, Inc. ftp-server-address Command ftp-server-address Arguments [Valid IP address] Device Type All Default Description This value defines the IP address of the target FTP server used for firmware, certificate or configuration file download. The IP address format follows the standard ASCII format XXX.XXX.XXX.
Company Confidential Quatech, Inc. ftp-server-path Command ftp-server-path Arguments [ASCII text: directory path] Device Type All Default 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.
Company Confidential Quatech, Inc. ftp-user Command ftp-user Arguments [ASCII text: username] Device Type All Default Description 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.
Company Confidential Quatech, Inc. ftp-password Command ftp-password Arguments [ASCII text: password] Device Type All Default Description Defines the password for the FTP account, associated to the FTP server defined by ftp-serveraddress.
Company Confidential Quatech, Inc. ftp-filename Command ftp-filename Arguments [filename].[extension] Device Type All Default Description 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.
Company Confidential Quatech, Inc. save Command save Arguments none Device Type All Default 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.
Company Confidential Quatech, Inc. telnet-port Command telnet-port Arguments disable | enable Device Type Ethernet Default enable Description Enables or disables access to the modules telnet port via the wireless interface. This is similar to port filtering, when enabled the module will transfer all telnet (port 23) traffic to its internal IP stack, when disabled all telnet traffic will be forwarded to the wired interface.
Company Confidential 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.
Company Confidential Quatech, Inc. eth-ip Command eth-ip Arguments [Valid IP address] Device Type Ethernet Default 192.168.2.100 Description Configures the IP address of the wired interface client. If the wired interface client is using DHCP, the module will lease this address to the client in response to the DHCP request. If the client is not using DHCP, this address must match the static IP address on the client so that IP routing will work correctly.
Company Confidential 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.
Company Confidential Quatech, Inc. 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.
Company Confidential 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.
Company Confidential Quatech, Inc. wl-specific-scan Command wl-specific-scan Arguments 0|1 Device Type All Default 0 Description Controls how the module scans for Access Points. 0 Use Broadcast Probes to attempt to find an Access Point. 1 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. Some network administrators disable responses to Broadcast Probes on the Access Point.
Company Confidential Quatech, Inc. apply-cfg Command apply-cfg Arguments serial | radio | ethernet | ports Device Type All Default 0 Description Applies the selected settings immediately, without requiring a restart. serial Applies following serial port settings: bit-rate parity flow data-bits stop-bit input-size intf-type serial-assert This parameter only applies to the Serial and UART devices.
Company Confidential ports Quatech, Inc. Applies the following port settings: telnet-port http-port 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.
Company Confidential Quatech, Inc. wl-assoc-backoff Command wl-assoc-backoff Arguments [Integer] Range: 0 -20000 Device Type All Default 10000 Description The amount of time in milliseconds to backoff after three (3) failed association attempts.
Company Confidential Quatech, Inc. arp-reachable-time Command arp-reachable-time Arguments [integer] Device Type All Default 120 Description The average amount of time before sending an ARP to each device in the ARP table. The actual rate is a random amount of time between 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.
Company Confidential Quatech, Inc. arp-staleout-time Command arp-staleout-time Arguments [integer] Device Type All Default 120 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. The device server requires a restart or power cycle for this parameter change to take effect.
Company Confidential Quatech, Inc. del-cfg Command del-cfg Arguments [ASCII Text – filename] Device Type All Default Description Deletes the specified configuration file form the module. Once the download is complete it is necessary for the save command to be issued, this will cause the configuration file to be deleted permanently from the device server. The following files can be deleted using this command: 102 user_config.txt User configuration file.
Company Confidential Quatech, Inc. discover Command discover Arguments none Device Type All Default 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: Device Name IP Address MAC Address Device Type FW Ver ----------------------------------------------------------------------------------------Veyron_1 192.168.1.
Company Confidential Quatech, Inc. intf-type Command intf-type Arguments rs232 | rs422 | rs485 Device Type Serial Default rs232 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).
Company Confidential Quatech, Inc. list-cfg Command list-cfg Arguments None Device Type All Default Description Displays a list of all the configuration files resident on the device server, including files that have been loaded but not saved.
Company Confidential Quatech, Inc. ssh-keygen Command ssh-keygen Arguments none Device Type All Default Description Generates the SSH keys, using the key length specified by ssh-keysize. You must issue a commit or save to store the generated keys, once generated. 106 Key generation may take several seconds, the OK response will be returned by the device server when the keys have been generated.
Company Confidential Quatech, Inc. ssh-keysize Command ssh-keysize Arguments [integer] Device Type All 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 remove the existing keys using clear ssh-key and to reissue ssh-keygen to generate new SSH keys This command is used by ssh-keygen.
Company Confidential Quatech, Inc. startup-text Command startup-text Arguments [ASCII Text] Device Type All Default “Ready” Description ACSII Text message that is displayed when the device server has completed a restart or power cycle. Once displayed the device is available for interaction using CLI. The ASCII text message can be a maximum of 31 characters terminated by /. For the message to be displayed startup-msg must be enabled.
Company Confidential Quatech, Inc. startup-msg Command startup-msg Arguments 0|1 Device Type All Default 0 (disable) Description Displays a start-up message, defined by startup-text, once the device server has completed a restart or power cycle. 0 Disables the start-up text. No message will be displayed after a restart or power cycle. 1 Enables the start-up text. The startup-msg text message will be displayed after a restart or power cycle.
Company Confidential Quatech, Inc. ver-fw Command Ver-fw Arguments none Device Type All Default Description Returns the current version of firmware loaded on the module.
Company Confidential Quatech, Inc. ver-radio Command ver-radio Arguments none Device Type All Default Description Returns the current version of radio firmware being run on the device servers’ radio.
Company Confidential Quatech, Inc. ver-uboot Command ver-uboot Arguments none Device Type All Default Description Returns the version of uboot loader code resident on the device server.
Company Confidential Quatech, Inc. wl-dhcp-vendorid Command wl-dhcp-vendorid Arguments [ASCII Text] Device Type All 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.
Company Confidential Quatech, Inc. wl-udp-ping Command wl-udp-ping Arguments 0|1 Device Type All Default 0 Description 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.
Company Confidential Quatech, Inc. wl-wins1 Command wl-wins1 Arguments [IP Address] Device Type All 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). Default is 0.0.0.0.
Company Confidential Quatech, Inc. wl-wins2 Command wl-wins1 Arguments [IP Address] Device Type All Default 0.0.0.0 Description 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.
Company Confidential Quatech, Inc. cfg-dump Command cfg-dump Arguments [ASCII Text] Device Type All Default Description Lists current configuration of the module. The command lists all parameter settings including those not yet committed. 100-8081-100 [no parameter] Lists current configuration (all parameters). active Lists the current active configuration (all parameters). factory Lists the factory default configuration (all parameters).
Company Confidential Quatech, Inc.
Company Confidential Quatech, Inc. 15.0 Change Log The following table indicates all changes made to this document: 100-8081-100 Version Date Section Change Description Author 1.0 04/16/2009 - Preliminary Release.
QUATECH ® Inc. 5675 Hudson Industrial Parkway Hudson, OH 44236 USA Telephone: Toll Free (USA): Fax: Technical Support: E-mail Support : Web Site: 330.655.9000 800.553.1170 330.655.9010 714.899.7543 wirelesssupport@quatech.com www.quatech.
