WLAN Location Engine 2340 Using the Command Line Interface

WLAN Location Engine 2340 Using the Command Line Interface Avaya WLAN 2300 Release 6.0 Document Status: Standard Document Number: NN47250-505 Document Version: 01.02

2010 Avaya Inc. All Rights Reserved. Notices While reasonable efforts have been made to ensure that the information in this document is complete and accurate at the time of printing, Avaya assumes no liability for any errors. Avaya reserves the right to make changes and corrections to the information in this document without the obligation to notify any person or organization of such changes. Documentation disclaimer Avaya shall not be responsible for any modifications, additions, or deletions to the original published version of this documentation unless such modifications, additions, or deletions were performed by Avaya. End User agree to indemnify and hold harmless Avaya, Avaya s agents, servants and employees against all claims, lawsuits, demands and judgments arising out of, or in connection with, subsequent modifications, additions or deletions to this documentation, to the extent made by End User. Link disclaimer Avaya is not responsible for the contents or reliability of any linked Web sites referenced within this site or documentation(s) provided by Avaya. Avaya is not responsible for the accuracy of any information, statement or content provided on these sites and does not necessarily endorse the products, services, or information described or offered within them. Avaya does not guarantee that these links will work all the time and has no control over the availability of the linked pages. Warranty Avaya provides a limited warranty on this product. Refer to your sales agreement to establish the terms of the limited warranty. In addition, Avaya s standard warranty language, as well as information regarding support for this product, while under warranty, is available to Avaya customers and other parties through the Avaya Support Web site: http:// www.avaya.com/support Please note that if you acquired the product from an authorized reseller, the warranty is provided to you by said reseller and not by Avaya. Licenses THE SOFTWARE LICENSE TERMS AVAILABLE ON THE AVAYA WEBSITE, HTTP://SUPPORT.AVAYA.COM/ LICENSEINFO/ ARE APPLICABLE TO ANYONE WHO DOWNLOADS, USES AND/OR INSTALLS AVAYA SOFTWARE, PURCHASED FROM AVAYA INC., ANY AVAYA AFFILIATE, OR AN AUTHORIZED AVAYA RESELLER (AS APPLICABLE) UNDER A COMMERCIAL AGREEMENT WITH AVAYA OR AN AUTHORIZED AVAYA RESELLER. UNLESS OTHERWISE AGREED TO BY AVAYA IN WRITING, AVAYA DOES NOT EXTEND THIS LICENSE IF THE SOFTWARE WAS OBTAINED FROM ANYONE OTHER THAN AVAYA, AN AVAYA AFFILIATE OR AN AVAYA AUTHORIZED RESELLER, AND AVAYA RESERVES THE RIGHT TO TAKE LEGAL ACTION AGAINST YOU AND ANYONE ELSE USING OR SELLING THE SOFTWARE WITHOUT A LICENSE. BY INSTALLING, DOWNLOADING OR USING THE SOFTWARE, OR AUTHORIZING OTHERS TO DO SO, YOU, ON BEHALF OF YOURSELF AND THE ENTITY FOR WHOM YOU ARE INSTALLING, DOWNLOADING OR USING THE SOFTWARE (HEREINAFTER REFERRED TO INTERCHANGEABLY AS "YOU" AND "END USER"), AGREE TO THESE TERMS AND CONDITIONS AND CREATE A BINDING CONTRACT BETWEEN YOU AND AVAYA INC. OR THE APPLICABLE AVAYA AFFILIATE ("AVAYA"). Copyright Except where expressly stated otherwise, no use should be made of the Documentation(s) and Product(s) provided by Avaya. All content in this documentation(s) and the product(s) provided by Avaya including the selection, arrangement and design of the content is owned either by Avaya or its licensors and is protected by copyright and other intellectual property laws including the sui generis rights relating to the protection of databases. You may not modify, copy, reproduce, republish, upload, post, transmit or distribute in any way any content, in whole or in part, including any code and software. Unauthorized reproduction, transmission, dissemination, storage, and or use without the express written consent of Avaya can be a criminal, as well as a civil offense under the applicable law. Third Party Components Certain software programs or portions thereof included in the Product may contain software distributed under third party agreements ("Third Party Components"), which may contain terms that expand or limit rights to use certain portions of the Product ("Third Party Terms"). Information regarding distributed Linux OS source code (for those Products that have distributed the Linux OS source code), and identifying the copyright holders of the Third Party Components and the Third Party Terms that apply to them is available on the Avaya Support Web site: http:// support.avaya.com/copyright. Trademarks The trademarks, logos and service marks ("Marks") displayed in this site, the documentation(s) and product(s) provided by Avaya are the registered or unregistered Marks of Avaya, its affiliates, or other third parties. Users are not permitted to use such Marks without prior written consent from Avaya or such third party which may own the Mark. Nothing contained in this site, the documentation(s) and product(s) should be construed as granting, by implication, estoppel, or otherwise, any license or right in and to the Marks without the express written permission of Avaya or the applicable third party. Avaya is a registered trademark of Avaya Inc. All non-avaya trademarks are the property of their respective owners. Downloading documents For the most current versions of documentation, see the Avaya Support. Web site: http://www.avaya.com/support Contact Avaya Support Avaya provides a telephone number for you to use to report problems or to ask questions about your product. The support telephone number is 1-800-242-2121 in the United States. For additional support telephone numbers, see the Avaya Web site: http://www.avaya.com/support

3 WiFi Certification NN47250-505 Avaya WLAN Location Engine 2340 Using the Command line Interface

4 NN47250-505 Avaya WLAN Location Engine 2340 Release 6.0 Standard 01.02 July 2010

5 Contents Customer service............................................ 7 Using the Command-Line Interface............................. 9 Secure Shell (SSH) Access........................................... 9 Serial Console Access.............................................. 10 CLI Conventions.................................................. 11 Command prompts............................................. 11 Syntax Notation................................................ 11 Command-Line Editing............................................. 12 Keyboard Shortcuts............................................. 12 History Buffer................................................. 12 Tabs......................................................... 12 Single-Asterisk (*) Wildcard Character.............................. 13 Double-Asterisk (**) Wildcard Characters............................ 13 Using CLI Help................................................... 13 Understanding Command Descriptions................................. 14 Access Commands......................................... 15 System Commands......................................... 19 Sensors Commands........................................ 23 Logs Commands........................................... 25 Interface Commands........................................ 27 Avaya WLAN Location Engine 2340 Using the Command Line Interface

6 Contents NN47250-505 (324123-A Version 01.02)

7 Customer service Visit the Avaya Web site to access the complete range of services and support that Avaya provides. Go to www.avaya.com or go to one of the pages listed in the following sections. Navigation Getting technical documentation on page 7 Getting product training on page 7 Getting help from a distributor or reseller on page 7 Getting technical support from the Avaya Web site on page 7 Getting technical documentation To download and print selected technical publications and release notes directly from the Internet, go to www.avaya.com/support. Getting product training Ongoing product training is available. For more information or to register, you can access the Web site at www.avaya.com/support. From this Web site, you can locate the Training contacts link on the left-hand navigation pane. Getting help from a distributor or reseller If you purchased a service contract for your Avaya product from a distributor or authorized reseller, contact the technical support staff for that distributor or reseller for assistance. Getting technical support from the Avaya Web site The easiest and most effective way to get technical support for Avaya products is from the Avaya Technical Support Web site at www.avaya.com/support. Avaya WLAN Location Engine 2340 Using the Command Line Interface

8 Customer service NN47250-505 (324123-A Version 01.02)

9 Using the Command-Line Interface WLAN Location Engine 2340 software operates an Avaya WLAN Location Engine 2340 (WLE2340). You can configure the WLE2340 with set, clear, and show commands. Use set commands to change parameters. Use clear commands to reset parameters to their defaults. In many cases, you can overwrite a parameter with another set command. Use show commands to display the current configuration and monitor the status of network operations. The WLE2340 supports two connection modes: Secure Shell (SSH) Serial Console Secure Shell (SSH) Access You can access the CLI through SSH. Password is not required for SSH access. Use the following command to access the SSH: ssh admin@<appliance address> Example: set ssh enable/disable It can enable/disable the ssh access. Note. If ssh access is disabled, you must access the appliance through the serial port in order to re-enable ssh access. Avaya WLAN Location Engine 2340 Using the Command Line Interface

10 Using the Command-Line Interface Syntax set ssh {enable disable} Access Enabled History Introduced in version 6.0. Examples The following example enables the ssh. Serial Console Access You can also access the CLI through Serial Console. To do this, connect the provided Serial Cable to a machine running appropriate terminal emulation software that is, Hyperterm. You can configure the terminal emulation software setting as follows: At the login prompt, enter admin and password is not required. NN47250-505 (324123-A Version 01.02)

Using the Command-Line Interface 11 CLI Conventions You should be aware of the following WLE2340 Software CLI conventions for command entry: Command prompts on page 11 Syntax Notation on page 11 Command prompts By default, the WLE CLI provides the following prompt. For ease of presentation, this manual shows the enabled prompts as follows: WLE> WLE# For information about changing the CLI prompt on a WLE, see set prompt. Syntax Notation The WLE2340 Software CLI uses standard syntax notation: Bold monospace font identifies the command and keywords you must type. For example: Syntax set enable A vertical bar ( ) separates mutually exclusive options within a list of possibilities. For example, you enter either enable or disable, not both, in the following command: Syntax set ssh {enable disable} Avaya WLAN Location Engine 2340 Using the Command Line Interface

12 Using the Command-Line Interface Command-Line Editing WLE2340 Software editing functions are similar to those of many other network operating systems. Keyboard Shortcuts The following table lists the keyboard shortcuts for entering and editing CLI commands: Keyboard Shortcut(s) Ctrl+A Ctrl+B or Left Arrow key Ctrl+C Ctrl+D Ctrl+E Ctrl+F or Right Arrow key Ctrl+K Ctrl+L or Ctrl+R Ctrl+N or Down Arrow key Ctrl+P or Up Arrow key Ctrl+U or Ctrl+X Ctrl+W Esc B Esc D Delete key or Backspace key Function Jumps to the first character of the command line. Moves the cursor back one character. Escapes and terminates prompts and tasks. Deletes the character at the cursor. Jumps to the end of the current command line. Moves the cursor forward one character. Deletes from the cursor to the end of the command line. Repeats the current command line on a new line. Enters the next command line in the history buffer. Enters the previous command line in the history buffer. Deletes characters from the cursor to the beginning of the command line. Deletes the last word typed. Moves the cursor back one word. Deletes characters from the cursor forward to the end of the word. Erases mistake made during command entry. Reenter the command after using this key. History Buffer The history buffer stores the last 63 commands you entered during a terminal session. You can use the Up Arrow and Down Arrow keys to select a command that you want to repeat from the history buffer. Tabs The WLE2340 Software CLI uses the Tab key for command completion. You can type the first few characters of a command and press the Tab key to display the command(s) that begin with those characters. NN47250-505 (324123-A Version 01.02)

Using the Command-Line Interface 13 Single-Asterisk (*) Wildcard Character You can use the single-asterisk (*) wildcard character in wildcarding. Double-Asterisk (**) Wildcard Characters The double-asterisk (**) wildcard character matches all usernames. Using CLI Help The CLI provides online help. To see the full range of commands available at your access level, type the help command. For example: wle# help Table 1: Commands available help quit logout exit history enable disable show show system show system uptime show system version show system status show sensors show logs show logs appliance show logs system show logs system controller show logs system agent show interface show serial-number ping Shows available commands. Disconnect. Disconnect. Exit from the current mode. Shows a list of previously run commands. Turn on the privileged commands. Turn off privileged commands. Show, use show help for more information. Send echo packets to host. Avaya WLAN Location Engine 2340 Using the Command Line Interface

14 Using the Command-Line Interface reset reset system set set ssh Table 1: Commands available Understanding Command Descriptions Each command description in the Avaya WLAN Location Engine Command Reference contains the following elements: A command name, which shows the keywords but not the variables. A brief description of the command s functions. The full command syntax. Any command defaults. The command access, which is either enabled or all. All indicates that anyone can access this command. Enabled indicates that you must enter the enable password before entering the command. The command history, which identifies the WLE2340 Software version in which the command was introduced and the version numbers of any subsequent updates. Special tips for command usage. These are omitted if the command requires no special usage. One or more examples of the command in context, with the appropriate system prompt and response. One or more related commands. NN47250-505 (324123-A Version 01.02)

15 Access Commands Use access commands to control access to the WLAN Location Engine 2340 (WLE2340) (CLI). This chapter presents access commands alphabetically. Use the following table to locate commands in this chapter based on their use. Access Privileges enable on page 15 disable on page 15 history on page 17 reset system [shutdown] on page 17 disable It changes the CLI session from enabled mode to restricted mode. Syntax disable Defaults None. Access Enabled. Examples The following command restricts access to the CLI for the current session: wle2340-39> disable See Also enable on page 15 enable Places the CLI session in enabled mode, which provides access to all commands required for configuring and monitoring the system. Using this, you can enter the privileged mode. To enter, you must enter the appliance administration password. Syntax enable Access All Avaya WLAN Location Engine 2340 Using the Command Line Interface

16 Access Commands Examples The following command plus the enable password provides enabled access to the CLI for the current sessions: wle2340-39> enable Password: password NN47250-505 (324123-A Version 01.02)

Access Commands 17 history Displays the list of previously run commands. Syntax History Defaults None. Access All. quit It exits the appliance from the CLI session. Syntax quit Defaults None. Access All. Examples To end the administrator s session, type the following command: wle2340-39> quit reset system [shutdown] Reboots or shutdown the Avaya WLAN Location Engine. To reboot the Location Engine: Avaya WLAN Location Engine 2340 Using the Command Line Interface

18 Access Commands To shutdown the Location Engine: show Show command displays the available choices for the show command. Note. You cannot see the "?" character on the CLI prompt. Syntax show Usage You can view all the commands listed under show. Examples To view the commands listed under show, type the following: NN47250-505 (324123-A Version 01.02)

19 System Commands Use system commands to view the details of the appliance. This chapter presents system commands alphabetically. Use the following table to locate commands in this chapter based on their use. System show system on page 19 show status on page 19 Show uptime on page 20 show version on page 21 show system Displays all the available choices for the show system command. Syntax show system Access Enabled. History Introduced in Version 6.0. Examples The following command shows the system information: show status Displays the diagnostic information about the current running processes on the system. Syntax show system status Access Enabled. History Introduced in Version 6.0. Avaya WLAN Location Engine 2340 Using the Command Line Interface

20 System Commands Examples The following commands displays the information about the current running information process on the system. Show uptime Displays last time, the appliance was restarted. Syntax show system uptime Access Enabled. History Introduced in Version 6.0. Examples The following command displays the uptime information: NN47250-505 (324123-A Version 01.02)

System Commands 21 show version Displays the appliance firmware release version. Syntax show system version Access Enabled. History Introduced in Version 6.0. Examples The following command displays the firmware release information. Avaya WLAN Location Engine 2340 Using the Command Line Interface

22 System Commands NN47250-505 (324123-A Version 01.02)

23 Sensors Commands Use sensors commands to view the details of the appliance. Shows statistics on all enabled sensors (Location APs). This detail includes: Operational status: true false Number of devices reported Received TZSP packet count Syntax show sensors Access Enabled. History Introduced in version 6.0. Examples The following command displays the detail of all the enabled sensors. Avaya WLAN Location Engine 2340 Using the Command Line Interface

24 Sensors Commands NN47250-505 (324123-A Version 01.02)

25 Logs Commands Use logs commands to view the details of the appliance, controller, and agent. This chapter presents logs commands alphabetically. Use the following table to locate commands in this chapter based on their use. Logs show appliance on page 25 show agent on page 25 show controller on page 25 show logs on page 25 show appliance Displays the appliance logs. show agent Displays the agent logs. show controller Displays the system controller logs. show logs Displays the previous 100 logs. Syntax show logs Access Enabled. History Introduced in version 6.0. Avaya WLAN Location Engine 2340 Using the Command Line Interface

26 Logs Commands Examples The following command displays the 100 logs. NN47250-505 (324123-A Version 01.02)

27 Interface Commands Using the Interface commands, you can know the available network interface. show interface Displays information about the network interface connection settings. Syntax show interface Access Enabled. History Introduced in version 6.0. Examples The following commands displays the available network interface. Note. You can view the detailed interface of eth0, eth1, eth2, and eth3. show eth Displays the detailed information about the network interfaces on the appliance that has been added to the CLI. This information includes: Link status (UP/DOWN) RX/TX packet recv/error/dropped/overrun/collision counts RX/TX byte counts Avaya WLAN Location Engine 2340 Using the Command Line Interface

28 Interface Commands Syntax show interface eth {eth0 eth1 eth2 eth3} [detailed] Access Enabled. History Introduced in version 6.0. Examples The following command displays the detailed information about the eth0 network interface. show serial-number Displays the system serial-number. Syntax show serial-number Access Enabled. History Introduced in version 6.0. Examples The following command displays the serial number. NN47250-505 (324123-A Version 01.02)

Interface Commands 29 ping Diagnosing network connectivity issues. Syntax ping Defaults None. Access Enable Avaya WLAN Location Engine 2340 Using the Command Line Interface

30 Interface Commands NN47250-505 (324123-A Version 01.02)