Meru Networks AP100 802.11b Access Point User Manual CLIref BK
Meru Networks Inc. 802.11b Access Point CLIref BK
Contents
- 1. professional installation
- 2. users manual 2
professional installation
AR Meru Wireless Networking Product IN 1.0 Beta Command-Line Interface Reference PR EL IM July 2003 Document Number: xxxxxx Revision Date Revision Description July 2003 0.1 1.0 Beta release. Revision History AR Information in this document is provided in connection with Meru® products. No license, express or implied, by estoppel or otherwise, to any intellectual property rights is granted by this document. Except as provided in Meru’s Terms and Conditions of Sale for such products, Meru assumes no liability whatsoever, and Meru disclaims any express or implied warranty, relating to sale and/or use of Meru products including liability or warranties relating to fitness for a particular purpose, merchantability, or infringement of any patent, copyright or other intellectual property right. Meru products are not intended for use in medical, life saving, or life sustaining applications. Meru may make changes to specifications and product descriptions at any time, without notice. Designers must not rely on the absence or characteristics of any features or instructions marked “reserved” or “undefined.” Meru reserves these for future definition and shall have no responsibility whatsoever for conflicts or incompatibilities arising from future changes to them. The product may contain design defects or errors known as errata which may cause the product to deviate from published specifications. Current characterized errata are available on request. Meru Networks, Inc. might have patents or pending patent applications covering subject matter in this document. The furnishing of this document does not give any license to these patents. IN This document as well as the described in it are furnished under license and may only be used or copied in accordance with the terms of the license. The information in this document is furnished for informational use only, is subject to change without notice, and should not be construed as a commitment by Meru Networks, Inc.. Meru Networks, Inc. assumes no responsibility or liability for any errors or inaccuracies that may appear in this document or any software that may be provided in association with this document. Except as permitted by such license, no part of this document may be reproduced, stored in a retrieval system, or transmitted in any form or by any means without the express written consent of Meru Networks, Inc.. Contact your local Meru sales office or your distributor to obtain the latest specifications and before placing your product order. Copies of documents which have an ordering number and are referenced in this document, or other Meru literature may be obtained by calling or by visiting Meru’s website at http://www.merunetworks.com Copyright © Meru Networks, Inc., 2003. All rights reserved. *Other names and brands may be claimed as the property of others. PR EL This product includes software developed by parties other than Meru. See the back page of this document for a list of copyrights and license agreements. Y AR IN Contents IM About This Document . . . . . . . . . . . . . . . . . . vii EL Audience . . . . . . . . . . . In This Guide. . . . . . . . . . Other Sources of Information . . . Typographic Conventions . . . . Syntax Notation . . . . . . . Contacting Meru . . . . . . . . Web and Internet Sites . . . . Customer Support Technicians Chapter 1 vii vii viii viii ix ix ix .x Key Concepts . . . . . . . . . . . . . . . . . . . . . . . 1 PR Network Layout . . . . . . . . . . . Node Identification . . . . . . . . . . Serial Numbers and Node Numbers . Using the Controller Console and the CLI Chapter 2 .1 .2 .2 .2 CLI Command Reference . . . . . . . . . . . . . . . . . 1 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2 Alarms Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3 alarms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3 asc: Subcontroller Commands asc all . . . . . . . . . asc get . . . . . . . . . asc ids . . . . . . . . . asc set . . . . . . . . . Revision 0.1, July 2003 .5 .5 .5 .6 .7 Contents iii . auth: RADIUS Authentication Commands auth all . . . . . . . . . . . . . . . auth del. . . . . . . . . . . . . . . auth get. . . . . . . . . . . . . . . auth new . . . . . . . . . . . . . . auth set . . . . . . . . . . . . . . . authstats get. . . . . . . . . . . . . Channel BSSID Commands channel all . . . . . . channel get . . . . . . channel ids . . . . . . channel set . . . . . . connect or remote: Remote Connection Commands. {connect | remote} . . . . . . . . . . . . . . connect asc . . . . . . . . . . . . . . . . . connect ats . . . . . . . . . . . . . . . . . Console Commands console get . . . console paging. . console set . . . IM .8 .8 .8 .9 10 10 10 10 11 12 12 12 12 13 13 14 15 15 15 16 16 17 17 17 17 18 18 19 19 db: Configuration Backup Commands db backup . . . . . . . . . . . db delete . . . . . . . . . . . . db list . . . . . . . . . . . . . db restore . . . . . . . . . . . . 20 20 20 20 21 EL PR AR IN ats: Access Point Commands . ats all. . . . . . . . . . ats get . . . . . . . . . ats ids . . . . . . . . . ats images. . . . . . . . ats mappings . . . . . . ats scripts . . . . . . . . ats set . . . . . . . . . ats upgrade . . . . . . . Help Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22 help . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22 History Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . 23 history . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23 if...stats: Interface Statistics Commands . if80211stats all . . . . . . . . . . . if80211stats get . . . . . . . . . . if80211stats ids . . . . . . . . . . ifstats. . . . . . . . . . . . . . . ifstats all . . . . . . . . . . . . . ifstats get . . . . . . . . . . . . . ifstats ids . . . . . . . . . . . . . iv 24 24 24 25 25 26 26 27 Contents Revision 0.1, July 2003 . qoS or codec: Quality of Service Commands. qoscodec all . . . . . . . . . . . . . . qoscodec del . . . . . . . . . . . . . qoscodec get . . . . . . . . . . . . . qoscodec ids . . . . . . . . . . . . . qoscodec new . . . . . . . . . . . . . qosrule or ruleQoS: Rule Commands . qosrule all . . . . . . . . . . . qosrule del . . . . . . . . . . . qosrule get . . . . . . . . . . . qosrule ids . . . . . . . . . . . qosrule new . . . . . . . . . . . qosstats. . . . . . . . . . . . . qosvars . . . . . . . . . . . . . qosvars get . . . . . . . . . . . qosvars set . . . . . . . . . . . 29 29 29 29 30 31 32 32 32 32 33 34 36 36 36 36 38 38 39 40 40 40 AR if: Interface Commands {interface | ifc} . . interface all . . . . interface get . . . . interface ids . . . . interface set . . . . IM IN Quit Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42 quit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42 EL Reboot (or restart) Commands {reboot | restart} . . . . . reboot all . . . . . . . . reboot asc . . . . . . . . reboot ats . . . . . . . . reboot wnc . . . . . . . PR security: RADIUS Security Commands {security | sec} . . . . . . . . . security get . . . . . . . . . . . security set . . . . . . . . . . . SNMP Commands snmp del . . . snmp get . . . snmp new . . snmp set . . . 43 43 43 43 43 44 45 45 45 46 47 47 47 48 48 Station Commands . . . station all . . . . . . station del . . . . . station get . . . . . station set. . . . . . {stationstats | stastats} stationstats all . . . . 50 50 50 50 51 51 52 topo: Network Topology Commands . . . . . . . . . . . . . . . . . . . 53 Contents Revision 0.1, July 2003 . Watchdog Commands. {watchdog | wd}. . watchdog get . . . watchdog set . . . watchdog get . . . watchdog set . . . 53 53 53 54 54 54 55 55 55 57 57 57 57 58 58 59 59 59 61 61 AR {topoascats | ascats} topoascats all . . . topoats . . . . . . topoats all. . . . . {topoatsats | atsats} topoatsats all . . . {topostaats | staats} topostaats all . . . topostation all . . . IN wirelessif or wif: Wireless Interface Commands wirelessif all. . . . . . . . . . . . . . . wirelessif get . . . . . . . . . . . . . . wirelessif ids . . . . . . . . . . . . . . wirelessif set . . . . . . . . . . . . . . IM wnc: Controller Commands . . . . . . . . . . . . . . . . . . . . . . . 63 wnc get . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63 wnc set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64 Glossary . . . . . . . . . . . . . . . . . . . . . . . . . 67 EL Alphabetic List of Terms and Abbreviations . . . . . . . . . . . . . . . . 67 PR Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . .71 vi Contents Revision 0.1, July 2003 Y AR IN About This Document IM This document describes the command-line interface (CLI) commands for the Meru Wireless Networking Product. It briefly explains some of the concepts that you need to know before using the commands. EL Audience This guide is intended for network administrators who will install, configure, and maintain a Meru wireless network. It assumes that you are familiar with the following: Wireless networking PR Basic IP routing concepts In This Guide This guide includes the following chapters: Chapter 1, “Key Concepts,” which provides useful information about Meru wire- less networking Chapter 2, “CLI Command Reference,” which lists alphabetically all of the commands in the Meru command-line interface “Glossary” which defines some terms used in this document About This Document Revision 0.1, July 2003 vii Other Sources of Information Other Sources of Information This guide is part of the Meru wireless network documentation set, which also includes: Meru Wireless Networking Product Command-Line Interface Reference (CLI Reference), AR which describes the Meru wireless network (software development kit), including the <<>>, which consists of the <<>> Meru Wireless Networking Product System Administrator’s Guide, which provides <<>> using the Meru wireless network Meru Wireless Networking Product Release Notes (Release Notes), which lists informa- tion about the latest software release Meru wireless network for the controller board Installation and Quick Start Guide IN (Installation Guide), which describes how to install the Meru wireless network and set up the networking environment In addition, the Meru Web site provides valuable information on products, support, and the company. See “Contacting Meru” on page ix. IM Typographic Conventions This document uses the following typographic conventions to help you locate and identify information: Used for new terms, emphasis, and book titles; also identifies arguments in syntax descriptions. EL Italic text Bold text Identifies keywords and punctuation in syntax descriptions. Courier font Identifies file names, folder names, and text that either appears on the screen or that you are required to type. NOTE: Provides extra information, tips, and hints regarding the topic. PR CAUTION: Identifies important information about actions that could result in damage to or loss of data or could cause the application to behave in unexpected ways. WARNING! Identifies critical information about actions that could result in equipment failure or bodily injury. viii About This Document Revision 0.1, July 2003 Contacting Meru Syntax Notation Courier font is used for code. In syntax descriptions, bold indicates required keywords and a punctuation. In examples, bold highlights interesting parts. Italics Required keywords and a punctuation. italic Arguments. [ ] Optional elements are enclosed by square brackets. AR bold indicate values that are to be replaced, such as arguments or file names. Chocies among elements are separated by vertical bars. { } Required choice: Braces indicates that one of the enclosed elements must be used. … One or more of the preceding element is allowed. The following figure shows a sample of syntax notation. [ number_lines ] IN { history | h} Arguments Enclosed elements are optional Separates choices IM Keywords, required punctuation Choose one of enclosed elements EL Contacting Meru You can reach Meru’s automated support services 24 hours a day, every day at no charge. The services contain the most up-to-date information about Meru products. You can access installation instructions, troubleshooting information, and general product information. You can use the Internet to download software updates, troubleshooting tips, installation notes, and more. PR Web and Internet Sites For specific types of information and services, go to the following Web and Internet sites: Corporate: http://www.merunetworks.com Wireless networking products: http://www.merunetworks.com/ FTP host: download.merunetworks.com FTP directory: /support/network/ About This Document Revision 0.1, July 2003 ix Contacting Meru United States and Canada: (7:00 - 17:00 M-F Pacific Time) PR EL IM IN AR Customer Support Technicians About This Document Revision 0.1, July 2003 Y IM IN Key Concepts AR Chapter 1 EL Network Layout PR Controller (WNC) Corporate network Subcontroller (ASC) Ethernet Switch Access Point Access Point (ATS) Access Point Access Point Access Point Key Concepts Revision 0.1, month 2003 Node Identification Node Identification A node is a piece of equipment in a Meru wireless network. Each node is uniquely identified by two pieces of information: The node type: One of WNC (a controller), ASC (a subcontroller; contained AR within the controller), or ATS (an access point). The node number: An integer; unique within the node type. Many commands require only a node number because the command is specific to a node type. Other commands require both the node type and the node number. For example, if a network contains one controller (which always contains a subcontroller) and three access points, they are identified as follows: Node Number IN Controller Node Type WNC ASC ATS ATS IM Description Subcontroller First installed access point Second installed access point Third installed access point ATS If the first access point is removed from the network and a new one is installed, the new one becomes ATS 4, not ATS 1. When you connect an access point to your Meru wireless network, the controller automatically reads its serial number and assigns it a permanent node number. This node number acts as an alias for the serial number, so if an access point is unplugged and placed elsewhere in the network, the controller recognizes the access point as the same node number. EL Serial Numbers and Node Numbers PR When you configure an access point, the configuration in the controller belongs to the node number, so the configuration can follow the access point. Using the Controller Console and the CLI You can connect to the controller using one of three methods: SSH Telnet Serial port Your connection serves as the console for the controller. Logging in to the controller places you into the Meru command-line interface (CLI), which is similar to a command shell. The prompt for the CLI is Key Concepts Revision 0.1, month 2003 Using the Controller Console and the CLI wnc> Use the console command to adjust the appearance of the console display. wnc> history 1 help 2 console set columns=80 rows=60 3 history AR The CLI keeps a history of the commands typed during your current session. Use the history command to list these commands . For example: Each history line is displayed with a number. You can redisplay any previous command for editing by typing an exclamation point (!) followed by the line number. For example: IN wnc> !2 wnc> console set columns=80 rows=60 IM The cursor remains at the end of the redisplayed line so that you can edit the command. The CLI supports the following keystrokes to position the cursor for editing: Keyboard key Home End EL Right arrow ( ---> ) Position cursor at the beginning of the command line. Position cursor at the end of the command line. Move the cursor to the right. Move the cursor to the left. Backspace, Delete, Del Remove the characterto the left of the cursor position. Up arrow, down arrow Scroll through the command history and allow editing on whichever line the cursor is positioned. This command becomes your current command. ESC Clears the command line. PR Left arrow (<---) For example: wnc> history 1 help 2 console set columns=80 rows=60 3 history 4 console set columns=80 rows=20 Pressing the up arrow redisplays the preceding commands one at a time, in reverse order, on the command line. For example, if you scroll through the commands to the first command executed and then press return, it executes that command line, so your next command history is: Key Concepts Revision 0.1, month 2003 Using the Controller Console and the CLI help console set columns=80 rows=60 history console set columns=80 rows=20 help PR EL IM IN AR Key Concepts Revision 0.1, month 2003 Y AR Chapter 2 IM IN CLI Command Reference This chapter describes the syntax and operation of all CLI commands. Commands are organized alphabetically within categories. The categories are “Alarms Commands” on page 3 “asc: Subcontroller Commands” on page 5 EL “ats: Access Point Commands” on page 8 “auth: RADIUS Authentication Commands” on page 12 “Channel BSSID Commands” on page 15 “connect or remote: Remote Connection Commands” on page 17 “Console Commands” on page 18 PR “db: Configuration Backup Commands” on page 20 “Help Commands” on page 22 “History Commands” on page 23 “if...stats: Interface Statistics Commands” on page 24 “if: Interface Commands” on page 29 “qoS or codec: Quality of Service Commands” on page 32 “qosrule or ruleQoS: Rule Commands” on page 36 “Quit Commands” on page 42 “Reboot (or restart) Commands” on page 43 “security: RADIUS Security Commands” on page 45 CLI Command Reference Revision 0.1, July 2003 Overview “SNMP Commands” on page 47 “topo: Network Topology Commands” on page 53 “Watchdog Commands” on page 57 “Station Commands” on page 50 AR “wirelessif or wif: Wireless Interface Commands” on page 59 “wnc: Controller Commands” on page 63 Overview IN The CLI recognizes three classes of user. The ability to use commands in this chapter depends on the user’s class. Users can be: Description guest Can use only those commands that display information. admin Can use most commands, including all the commands that guest can use. Can use all commands. PR EL support IM User Class CLI Command Reference Revision 0.1, July 2003 Alarms Commands Alarms Commands AR These commands provide information about alarm or error status in the Meru wireless network. IN alarms Displays the controller’s alarm log. alarms Description Displays the controller’s alarm log file, showing the date and time of each event along with the originating node and the severity of the alarm. The log lists all alarms for all nodes in the Meru wireless network that have occurred since the controller’s most recent reboot. IM Syntax If there have been no alarms, the command displays EL No entries. Otherwise, the command lists the following information for each alarm: Description Time Date and time of the alarm in UTC (MM/DD hh:mm:ss), where: PR Information Node MM = Month number (01 - 12). DD = Day number. hh = Hour (00 - 23). mm = Minute. ss = Second. Consists of two parts: Node Type, one of ATS (an access point), ASC (a subcontroller), or WNC (a controller) Node number within that type: An integer CLI Command Reference Revision 0.1, July 2003 Alarms Commands Description Type Alarm type. One of the following: LINK DOWN ASC DOWN ATS DOWN WATCHDOG FAILURE The severity of the alarm, either CRITICAL or CLEAR (alarm state has been cleared To view the alarm log: wnc> alarms IN Example LINK UP AR Severity Information This produces output similar to the following: PR EL IM Time (UTC) Node Type Severity -------------- -------- ------------------------- ------------07/17 17:25:55 ATS 0001 LINK UP CLEAR CLI Command Reference Revision 0.1, July 2003 asc: Subcontroller Commands AR These commands manage aspects of subcontrollers. asc: Subcontroller Commands asc all Syntax IN Displays configuration information for all subcontrollers recognized by the controller. See asc get for details. IM asc all asc get asc get node_id [...] Argument Description node_id One or more node numbers identifying subcontrollers that are associated with this controller. Information is displayed for all the listed subcontrollers. PR Syntax EL Displays configuration information for one or more subcontrollers. Description NOTE: To list information for all subcontrollers, use asc all. Displays the following configuration information for each of the specified subcontrollers: Field Description Node ID The unique numeric ID of the subcontroller. Serial Number Serial number of the subcontroller. Description A text description of this subcontroller. CLI Command Reference Revision 0.1, July 2003 asc: Subcontroller Commands Description Uptime The uptime of the subcontroller, in hours, minutes, and seconds (hh:mm:ss). Location A text description of the location of this subcontroller. Contact Person or organization responsible for this subcontroller. Operational State The operational state of the subcontroller: Alarm State ENABLED: The subcontroller is operating correctly. DISABLED: The subcontrollers is found by the controller but it is not operating correctly. The availability of the subcontroller: OFFLINE: The controller cannot find the subcontroller. ONLINE: The controller can find the subcontroller. The severity of the current alarm on the subcontroller. If more than one alarm is current, the highest severity is displayed. In order of increasing severity, the states are NO ALARM: The subcontroller is not in an alarm state. IM MINOR MAJOR CRITICAL. The virtual MAC address of the wireless network to which this subcontroller belongs. This value is set with the wnc set command. EL Virtual MAC Address IN Availability Status AR Field The version of the software running on the subcontroller. PR Software Version asc ids Displays the node numbers for all known subcontrollers. Syntax asc ids Description Displays a list of node numbers of type ASC that are associated with this controller. Numbers are displayed one on each output line. CLI Command Reference Revision 0.1, July 2003 asc: Subcontroller Commands asc set AR Example Sets one or more of the configuration values for the specified subcontroller. Syntax Description node_id The unique numeric ID of the subcontroller. desc A text description for this subcontroller contact IM Argument location A text description of the location of this subcontroller. Text name for the person or organization responsible for this subcontroller. You must specify at least one configuration value. PR EL Description IN asc set node_id [ desc=] [ location= ] [ contact= ] [ {wncdns= | dns= } ] CLI Command Reference Revision 0.1, July 2003 ats: Access Point Commands ats: Access Point Commands AR These commands manage aspects of access points. ats all Syntax IN Displays configuration information for all access point recognized by the controller. See ats get for details. IM ats all ats get ats get node_id [...] Argument Description node_id One or more node numbers identifying access points that are associated with this controller. Information is displayed for all the listed access point. PR Syntax EL Displays configuration information for one or more access points. Description NOTE: To list information for all access points, use ats all. Displays the following configuration information for each of the specified access points: Field Description Node ID The unique numeric ID of the access point. Serial Number Serial number of the access point. Description A text description for this access point. CLI Command Reference Revision 0.1, July 2003 ats: Access Point Commands Description Uptime The uptime of the access point, in hours, minutes, and seconds (hh:mm:ss). Location Text description of the location of this access point. Contact Person or organization responsible for this access point. Operational State The operational state of the access point: ENABLED: The access point is operating correctly. DISABLED: The access point is known by the controller but it is not operating correctly. The availability of the access point: OFFLINE: The controller cannot find the access point. ONLINE: The controller can find the access point. The severity of the current alarm on the access point. If more than one alarm is current, the highest severity is displayed. In order of increasing severity, the states are NO ALARM, MINOR, MAJOR, or CRITICAL. IM Alarm State IN Availability Status AR Field The subcontroller node ID to which the access point is bound. Security Mode The security mode that the access point is in; either OPEN or 802.1x. Privacy Bit The privacy state that the access point is in; one of ON, OFF, or AUTO. Boot Script The script to run when the access point boots. EL Bound to ASC Virtual MAC Address The virtual MAC address of the access point. The version of the ROM boot image on the access point. Runtime Image Version The version of the runtime image on the access point. FPGA Version The version of the FPGA chip on the access point. PR Boot Image Version ats ids Displays the node numbers for all known access points. Syntax ats ids CLI Command Reference Revision 0.1, July 2003 ats: Access Point Commands Displays a list of node numbers of type ATS that are associated with this controller. Numbers are displayed one on each output line. Description AR ats images IN Lists access point upgrade image versions that have been copied to the controller. ats mappings ats scripts IM Displays access point comm node and nms node ID mappings. EL Lists available access point boot scripts. PR See wnc set for information on how to assign a default script for all access points. See ats set for how to assign a script to a specific access point. ats set Sets one or more of the configuration values for the specified access point. Syntax 10 ats set [ desc=text_desc ] [ location=text_loc ] [ contact=text_contact ] [ bootscript=script_name ] CLI Command Reference Revision 0.1, July 2003 ats: Access Point Commands Description desc Text description for this access point. location Text description of the location of this access point. contact Person or organization responsible for this access point. bootscript The name of the script to run when the access point boots. Use ats scripts to display the names of valid scripts. See wnc set for additional information. IN AR Argument ats upgrade IM Installs upgraded software onto the ATS. Syntax ats upgrade { | all} [noreboot | ] PR EL To upgrade the software on an ATS, enter its node id and the version that was previously downloaded onto the WNC. Available images may be listed using the 'ats images' command. After the upgrade the ATS will reboot immediately when the upgrade is complete, unless the 'noreboot' option or a delay (in seconds) is given as the last argument. CLI Command Reference Revision 0.1, July 2003 11 AR auth: RADIUS Authentication Commands auth: RADIUS Authentication Commands These commands allow a user to manage RADIUS authentication information (authentication secret and RADIUS IP address). IN auth all Syntax auth all EL auth del IM Displays configuration information for all RADIUS authentications. See auth get for details. Deletes the authentications specified by the authentication IDs. auth del [...] PR Syntax auth get Displays configuration information for one or more authentications. Syntax 12 auth get [...] CLI Command Reference Revision 0.1, July 2003 auth: RADIUS Authentication Commands Description auth_id One or more numbers identifying authentications that are associated with this controller. Information is displayed for all the listed items. Argument Displays the following fields for each of the authentications requested: Field Description Authentication ID A unique alphanumeric ID of the RADIUS server information. RADIUS Server Secret The string to hold the RADIUS secret key. IP address of the RADIUS server in nnn.nnn.nnn.nnn format. IM RADIUS Server IP Address IN Description AR NOTE: To list information for all subcontrollers, use auth all. auth new auth new [ {radiussecret= | secret= } ] [ {radiusip= | ip= } ] Argument Description {radiussecret= | secret= } The string to hold the RADIUS secret key. {radiusip= | ip= } IP address of the RADIUS server in nnn.nnn.nnn.nnn format. PR Syntax EL Create a new authentication. auth set Sets one or more of the configuration values for the specified authentication. CLI Command Reference Revision 0.1, July 2003 13 auth: RADIUS Authentication Commands Syntax auth set [ {radiussecret= | secret= } ] [ {radiusip= | ip= } ] Description {radiussecret= | secret= } The string to hold the RADIUS secret key. {radiusip= | ip= } IP address of the RADIUS server in nnn.nnn.nnn.nnn format. IN authstats get AR Argument Display authentication statistics. authstats get Description Displays information about Web and 802.1x authentication requests. IM Syntax EL Displays the number of web and 802.1x authentication requests. The number of successes and failures is less than or equal to the number of requests for each originating method. The station count is the number of stations that are currently authorized by the indicated method. 802.1x Authorization Request Count. 802.1x Authorization Success Count. PR 802.1x Authorization Failure Count. 802.1x Authorization Station Count. WWW Authorization Request Count. WWW Authorization Success Count. WWW Authorization Failure Count. WWW Authorization Station Count. 14 CLI Command Reference Revision 0.1, July 2003 Channel BSSID Commands Channel BSSID Commands AR These commands allow a user to manage channel BSSID assignments. channel all Syntax IN Displays configuration information for all channels. See channel get for details. channel get IM channel all channel get [...] Argument Description channel_number One or more numbers identifying channels that are associated with this controller. Information is displayed for all the listed items. PR Syntax EL Displays configuration information for one or more channels. Description NOTE: To list information for all channels, use channel all. Displays the following fields for each of the channels requested: Field Description Channel Number: The unique numeric channel number in the channel table. BSSID: The BSS (Basic Service Set) identifier assigned to the channel. Active: Indicates whether the channel is active ('on') or inactive ('off'). CLI Command Reference Revision 0.1, July 2003 15 Channel BSSID Commands Displays the channel numbers for all known channels. channel ids channel ids Description Displays a list of channel numbers. Numbers are displayed one on each output line. AR Syntax IN channel set Sets one or more of the configuration values for the specified channel. channel set [ bssid= ] [ active= ] Argument IM Syntax Description The BSS (Basic Service Set) identifier assigned to the channel. active= Indicates whether the channel is active ('on') or inactive ('off'). PR EL bssid= 16 CLI Command Reference Revision 0.1, July 2003 connect or remote: Remote Connection Commands AR connect or remote: Remote Connection Commands {connect | remote} Syntax connect asc IM {connect | remote} IN Connects to a remote ats or asc node. Use 'exit' or 'quit' to disconnect. Connects to remote asc node . Syntax EL connect asc PR connect ats Syntax connect ats Connects to remote ats node . CLI Command Reference Revision 0.1, July 2003 17 Console Commands AR These commands manage display format and wrapping. Console Commands console get IN For additional information about using the console, see “Using the Controller Console and the CLI” on page 2. Displays format and scrolling configuration information for the console. {console | cons} get Description Displays the following fields: Field Description The column width of the display. This should be set to match the actual screen width to insure proper word wrap on many of the output from many of the commands. A 0 (zero) sets width to an arbitrarily large value. The default is 80. EL Columns IM Syntax PR Rows 18 The row height of the display. This should be set to match the actual screen height to insure proper operation of 'more' processing of many lines of text. A 0 (zero) set the height to an arbitrarily large value. The default is 24. Radix (base 10) The radix or base in which numeric values should be displayed. The output of some commands, but not all, is affected by this. Also note that input radix is also not affected by this. The default is 10 Output Style The style (or type of consumer) in which output should be presented. Valid styles are 'c', 'h', or 's' where 'c' is the default 'console' style intended for human readers, 'h' indicates HTML tags will be output, and 's' indicates a style that could be fed back into the command line interface. The default is C. CLI Command Reference Revision 0.1, July 2003 Console Commands Enable (on) or disable (off) screen output paging. Syntax AR {console | cons} paging {on | off} console paging console set IN Sets one or more of the configuration values for the controller’s console. Syntax IM {console | cons} set {columns= | cols= } {rows= | lines= } {radix= | base= } {output= | style= } Description {columns | cols} The column width of the display. This should be set to match the actual screen width to insure proper word wrap on many of the output from many of the commands. A 0 (zero) sets width to an arbitrarily large value. {rows | lines} The row height of the display. This should be set to match the actual screen height to insure proper operation of 'more' processing of many lines of text. A 0 (zero) set the height to an arbitrarily large value. {radix | base} The radix or base in which numeric values should be displayed. The output of some commands, but not all, is affected by this. Also note that input radix is also not affected by this. {output | style} The style (or type of consumer) in which output should be presented. Valid styles are 'c', 'h', or 's' where 'c' is the default 'console' style intended for human readers, 'h' indicates HTML tags will be output, and 's' indicates a style that could be fed back into the command line interface. PR EL Argument Description These values remain in effect only during the current logged-in session. They are reset to defaults when you log out (exit the CLI; see the quit command). CLI Command Reference Revision 0.1, July 2003 19 db: Configuration Backup Commands db: Configuration Backup Commands AR These commands allow a user to perform backup and restore of the system's configuration. Backups are made to local flash files which may be listed and deleted. IN db backup Syntax db {backup | b} [ ] IM Backup current configuration database to the default location or to the given filename. db delete db {delete | d} EL Syntax Delete the given backup file. PR db list Syntax db {list | l} List the available database backup files. 20 CLI Command Reference Revision 0.1, July 2003 db: Configuration Backup Commands Syntax db restore db {restore | r} [ ] Restore the configuration database from the default location or from the PR EL IM IN AR given filename. CLI Command Reference Revision 0.1, July 2003 21 Help Commands help Syntax {help | ?} [all | ] AR Help Commands IN If no arguments are given, then this command prints one line summaries of command categories. If one or more arguments are given, then it prints out detailed decriptions of those categories. PR EL IM If 'all' is supplied as the first argument then it prints out a detailed description of all command categories. 22 CLI Command Reference Revision 0.1, July 2003 History Commands history Syntax {history | h} [ ] AR History Commands PR EL IM IN If no arguments are given, then this command prints all the command lines that have been entered since the start of the session. If the argument number-lines is provided then the last number-lines from the history are printed. CLI Command Reference Revision 0.1, July 2003 23 if...stats: Interface Statistics Commands if...stats: Interface Statistics Commands AR These commands display the 802.11 interface statistics in the system. To get statistics on a single 802.11 interface, use the 'get' command and enter the node ID. IN if80211stats all Displays configuration information for all wireless interfaces recognized by the controller. See if80211stats get for details. if80211stats all if80211stats get IM Syntax if80211stats get [...] Argument Description node_id One or more numbers identifying access points that are associated with this controller. Information is displayed for all the listed items. PR Syntax EL Displays statistics for the wireless interfaces for one or more access points. NOTE: To list information for all access points, use if80211stats all. The following information is displayed for each node or interface: Field Descrition Node ID TX Fragment Count MCast TX Frame Count 24 CLI Command Reference Revision 0.1, July 2003 if...stats: Interface Statistics Commands Field Descrition Failed Count IF Retry Count Multiple Retry Count AR Frame Duplicate Count RTS Success Count RTS Failure Count ACK Failure Count MCast RCV Frame Count FCS Frame Count TX Frame Count IN RCV Fragment Count IM WEP Undecryptable Count EL if80211stats ids Displays the interface numbers for the wireless interfaces on all access points known to this controller. Syntax Displays a list of node numbers of type ATS that are associated with this controller. Numbers are displayed one on each output line. PR Description if80211stats ids ifstats Syntax ifstats CLI Command Reference Revision 0.1, July 2003 25 if...stats: Interface Statistics Commands AR The interface commands allow a user to display the statistics on the system's Ethernet interfaces. To display statistics on a single interface, the user must enter node type ('wnc', 'asc', or 'ats'), the node id, and the interface number on that node. The definitions of these fields may be found in IETF 1213. ifstats all Displays configuration information for all interfaces recognized by the controller. See ifstats get for details. Syntax IM ifstats get IN ifstats all Displays statistics for one or more interfaces. ifstats get [...] EL Syntax Argument Description node_id One or more numbers identifying interfaces that are associated with this controller. Information is displayed for all the listed items. NOTE: To list information for all interfaces, use ifstats all. PR node_type See “Node Identification” on page 2 for more information on these arguments. index Displays the following fields for each of the nodes requested: 26 Field Description Node Type Identifies the type of node this interface belongs to ('WNC', 'ASC' or 'ATS'). Node ID The unique numeric ID of the node. CLI Command Reference Revision 0.1, July 2003 if...stats: Interface Statistics Commands Description Index The unique numeric index of the ethernet interface in the interface statistics table. Description The descriptive name of the ethernet interface. In Octets Number of bytes received by the interface, including framing bytes. AR Field In Unicast Pack- Number of unicast packets received by the interface and delivered to a ets higher-layer protocol. In Non Unicast Packets Number of non unicast packets received by the interface and delivered to a higher-layer protocol. In Discard Pack- Number of non-errored packets received and discarded by the interface ets (e.g. buffer overflow prevents delivery to higher-layer protocol). IN In Error Packets Number of errored packets received by the interface. In Unknown Pro- Number of packets received and discarded because they were of unknown tocols or unsupported protocols. Number of bytes sent by the interface, including framing bytes. Out Unicast Packets Number of unicast packets that higher-layer protocols requested to be sent by the interface. IM Out Octets Out Non Unicast Number of non unicast packets that higher-layer protocols requested to be Packets sent by the interface. Number of non-errored outbound packets discarded by the interface due to problems such as buffer overflows. EL Out Discard Packets Out Error Pack- Number of outbound packets that could not be sent because of errors. ets PR Out Queue Packet Length ifstats ids Displays the node type, node number, and interface numbers for all Ethernet interfaces known to the controller. Syntax ifstats ids CLI Command Reference Revision 0.1, July 2003 27 if...stats: Interface Statistics Commands Displays a list of interface information for Ethernet interfaces that this controller knows about. This includes such interfaces on the controller, subcontrollers, and access points. The values for one interface are displayed on each output line. PR EL IM IN AR Description 28 CLI Command Reference Revision 0.1, July 2003 if: Interface Commands if: Interface Commands {interface | ifc} Syntax EL interface all IM {interface | ifc} IN AR These commands allow a user to set and display the attributes of ethernet interfaces in the system. Each interface is represented as a row in a table with the attributes as column or field values. Each row is uniquely identified by the node type, node ID, and interface index. Displays configuration information for all interfaces recognized by the controller. See interface get for details. interface all PR Syntax interface get Displays configuration information for one or more interfaces. Syntax interface get [...] CLI Command Reference Revision 0.1, July 2003 29 if: Interface Commands Description node_type See ifstats get. node_id One or more numbers identifying interfaces that are associated with this controller. Information is displayed for all the listed items. AR Argument NOTE: To list information for all interfaces, use ifstats all. index Displays the following fields for each of the rows requested: Description Node Type Identifies the type of node this interface belongs to ('WNC', 'ASC' or 'ATS'). Node ID The unique numeric ID of the node. Index The unique numeric index of the ethernet interface in the interface table. Description The descriptive name of the ethernet interface. Type IN Field IM Description The ARP type of the interface. Typically Typically 'Ethernet' or '802.11'. Maximum Trans- The MTU of the ethernet interface. From 0 to 65536 bytes. Node must be fer Unit (bytes) rebooted for a new value to take effect. EL Interface Speed The speed of the ethernet interface, in megabits/second. (Mbits/sec) Physical Address The MAC address of the ethernet interface. Node must be rebooted for a new value to take effect. Operational Sta- The operational status of the interface: 'UP' or 'DOWN'. tus Time of last operational state change of the interface. PR Last Change Time Default Gateway Default gateway (in nnn.nnn.nnn.nnn format) for the node on which this interface exists. Node must be rebooted for a new value to take effect. interface ids Displays the node type, node number, and interface numbers for all Ethernet interfaces known to the controller. 30 CLI Command Reference Revision 0.1, July 2003 if: Interface Commands interface ids Description Displays a list of interface information for Ethernet interfaces that this controller knows about. This includes such interfaces on the controller, subcontrollers, and access points. The values for one interface are displayed on each output line. AR Syntax interface set Sets one or more of the configuration values for the specified interface. Syntax IN interface set {mtu= | m= } {physaddress= | p= } {defaultgateway= | g= } Description mtu The MTU of the ethernet interface. From 0 to 65536 bytes. Node must be rebooted for a new value to take effect. IM Argument The MAC address of the ethernet interface. Node must be rebooted for a new value to take effect. defaultgateway Default gateway (in nnn.nnn.nnn.nnn format) for the node on which this interface exists. Node must be rebooted for a new value to take effect. PR EL physaddress CLI Command Reference Revision 0.1, July 2003 31 qoS or codec: Quality of Service Commands AR qoS or codec: Quality of Service Commands qoscodec all IN These commands manage codec-to-flow-spec mapping rules. Each rule is uniquely identified by its rule ID. The definition and meaning of most of these fields are clarified in IETF RFC 2210. Displays configuration information for all codecs. See qoscodec get for details. {qoscodec | codec} all IM Syntax EL Returns all the fields for all the rows in the table. qoscodec del Deletes the rows specified by the row IDs. {qoscodec | codec} del [...] PR Syntax qoscodec get Displays configuration information for one or more codec rules. Syntax 32 {qoscodec | codec} get [...] CLI Command Reference Revision 0.1, July 2003 qoS or codec: Quality of Service Commands Description rule_id One or more numbers identifying codec flow-spec mapping rules that are associated with this controller. Information is displayed for all the listed items. Argument Displays the following fields for each of the rules requested: Field Description Rule ID The unique numeric ID of the QoS codec flow spec mapping rule. Codec The codec type. Possible values are: default, g711u, 1016, g721, gsm, g723.1, dv14, dv14-2, lpc, g711a, g722, g722.1, mpa, g728, g729, 97red, siren, h261, or h263. QoS Protocol QoS protocol - sip, http or h323. IN Description AR NOTE: To list information for all codecs, use qoscodec all. IM Traffic Spec Token The traffic spec token bucket rate. From 0 to 1,000,000 bytes/secBucket Rate (bytes/sec) ond. Token bucket size in bytes. From 0 to 16,000 bytes. Traffic Spec Peak Rate (bytes/sec) Traffic spec peak rate. From 0 to 1,000,000 bytes/second. Max Datagram Size (bytes) Max datagram size. From 0 to 1,500 bytes. EL Token Bucket Size (bytes) Min Policed Unit (bytes) Minimum policed units. From 0 to 1,500 bytes. Reservation Spec Rate Reservation spec rate. From 0 to 1,000,000 bytes/second. (bytes/sec) PR Reservation Spec Slack Reservation spec slack. From 0 to 1,000,000 microseconds. (microsec) Sample Rate (bytes/sec) Sample rate. From 0 to 200 bytes/second. qoscodec ids Displays the mapping rule numbers for all defined rules. CLI Command Reference Revision 0.1, July 2003 33 qoS or codec: Quality of Service Commands {qoscodec | codec} ids Description Displays a list of rule numbers that are defined for this controller. Numbers are displayed one on each output line. AR Syntax qoscodec new Creates a new codec-to-flow-spec mapping . Description Description EL Argument IM IN {qoscodec | codec} new codec= {qosprotocol= | qp= } {tokenbucketrate= | tbr= } {maxdatgramsize= | max_pkt= } {minpolicedunit= | min_unit= } {samplerate= | sample= } [tokenbucketsize= | tbs= ] [peakrate= | peak= ] [rspecrate= | rrate= ] [rspecslack= | rslack= ] The codec type. Possible values are: default, g711u, 1016, g721, gsm, g723.1, dv14, dv14-2, lpc, g711a, g722, g722.1, mpa, g728, g729, 97red, siren, h261, or h263. {qosprotocol | qp} QoS protocol - sip, http or h323. {tokenbucketrate | tbr} The traffic spec token bucket rate. From 0 to 1,000,000 bytes/second. PR codec {maxdatgramsize | Max datagram size. From 0 to 1,500 bytes. max_pkt} 34 {minpolicedunit | min_unit} Minimum policed units. From 0 to 1,500 bytes. {samplerate | sample} Sample rate. From 0 to 200 bytes/second. tokenbucketsize | tbs Defaults to "8". Token bucket size in bytes. From 0 to 16,000 bytes. peakrate | peak Defaults to "0". Traffic spec peak rate. From 0 to 1,000,000 bytes/second. CLI Command Reference Revision 0.1, July 2003 qoS or codec: Quality of Service Commands Description rspecrate | rrate Defaults to "0". Reservation spec rate. From 0 to 1,000,000 bytes/second. rspecslack | rslack Defaults to "0". Reservation spec slack. From 0 to 1,000,000 microseconds. PR EL IM IN AR Argument CLI Command Reference Revision 0.1, July 2003 35 qosrule or ruleQoS: Rule Commands qosrule or ruleQoS: Rule Commands AR These commands manage Quality of Service (QoS) rules. Each rule is uniquely identified by its rule ID. IN qosrule all Displays configuration information for all QoS rules defined on the controller. See qosrule get for details. {qosrule | rule} all qosrule del IM Syntax {qosrule | rule} del [...] PR Syntax EL Deletes the rows specified by the row IDs. qosrule get Displays information about QoS rules. Syntax 36 {qosrule | rule} get [...] CLI Command Reference Revision 0.1, July 2003 qosrule or ruleQoS: Rule Commands Description rule_id One or more numbers identifying QoS rules that are associated with this controller. Information is displayed for all the listed items. Argument Displays the following fields for each of the rules requested: Field Description Rule ID The unique numeric ID of the QoS rule. Destination IP Address The destination IP address. Destination Port The destination IP port. IN Description AR NOTE: To list information for all rules, use qosrule all. Destination Netmask The destination address netmask. The source IP address. IM Source IP Address The source IP port. Source Netmask The source address netmask. Network Protocol Network protocol: 'udp' or 'tcp'. QoS Protocol QoS protocol: 'sip', 'none', or 'h.323'. EL Source Port VLAN ID The virtual LAN ID: from 0 to 4095. Average Packet Rate Average packet rate: from 0 to 200 packets per second. Action Action: - 'forward', 'capture' (default) or 'drop'. Drop Policy. Drop Policy - tail, head. PR TSpec Token Bucket TSpec Token Bucket rate, from 0 to 1,000,000 bytes per second rate Priority value 0-low 8-high) The number (0-8) that specifies best effort priority queue where 0 is default (no priority) and 8 is highest priority Traffic Control Polici- Valid values are 0 (zero) which turns it off, and P, which turns it on. By ing default is not set < CLI Command Reference Revision 0.1, July 2003 37 qosrule or ruleQoS: Rule Commands qosrule ids Displays the rule numbers for all qos mapping rules defined for this controller. {qosrule | rule} ids Description Displays a list of rule numbers that are associated with this controller. Numbers are displayed one on each output line. qosrule new Creates a new QoS rule. {qosrule | rule} new {dstip= | di= } {dstport= | dp= } {dstmask= | dm= } {srcip= | si= } {srcport= | sp= } {srcmask= | sm= } {netprotocol= | nprot= } {qosprotocol= | qprot= } [vlanid= | vl= ] [avgpktrate= | avg= ] [action= | act= ] [droppolicy= | dr= ] [tokenbucketrate= | tbr= ] [priority= ] [traficcontrol= | tc= ] PR EL IM Syntax IN AR Syntax Description See qosrule get for details. 38 Argument Description {dstip | di} The destination IP address. {dstport | dp} The destination IP port. {dstmask | dm} The destination address netmask. {srcip | si} The source IP address. CLI Command Reference Revision 0.1, July 2003 qosrule or ruleQoS: Rule Commands Description {srcport | sp} The source IP port. {srcmask | sm} The source address netmask. {netprotocol | nprot} Network protocol: 'udp' or 'tcp'. {qosprotocol | qprot} QoS protocol: 'sip', 'http', or 'h.323'. vlanid | vl Defaults to "0". The virtual LAN ID: from 0 to 4095. AR Argument avgpktrate | avg Defaults to "0". Average packet rate: from 0 to 200. Defaults to "capture". Action: - 'forward', 'capture' (default) or 'drop'. droppolicy | dr Defaults to "tail". Drop Policy - tail, head. IN action | act tokenbucketrate Defaults to "0". TSpec Token Bucket rate | tbr Defaults to "0". The number (0-8) that specifies best effort priority queue where 0 is default (no priority) and 8 is highest priority IM priority Defaults to "0". The only current value is [P]olicing that will turn on the flag By default is not set EL traficcontrol | tc qosstats Displays QoS global statistics. qosstats {get | g} PR Syntax Description Displays the following QoS global statistics: H.323, SIP, and total session counts. H.323, SIP, and total rejected counts. H.323, SIP, and total pending counts. QoS active flow count. Qos pending flow count. CLI Command Reference Revision 0.1, July 2003 39 qosrule or ruleQoS: Rule Commands qosvars AR These commands manages Quality of Service (QoS) by setting global parameters. qosvars get Displays information about QoS variables. qosvars get Description Displays the following fields: IN Syntax Description QoS State QoS state: 'on' or 'off'. IM Field Admission Control Admission Control: admitall, pending, reject Drop Policy Drop Policy - tail, head Time to live Default UDP time to live, in seconds. EL UDP time to live Default time to live, in seconds. Default TCP time to live, in seconds. Steal time Default steal time, in seconds. UDP steal time UDP steal time, in seconds. TCP steal time TCP steal time, in seconds. Bandwith Scaling Scale factor for Tspec bandwith in percent. May range from 1% to as high as 100,000%, although 100% is typical. PR TCP time to live qosvars set Sets one or more of the configuration values for the specified interface. Syntax 40 qosvars set CLI Command Reference Revision 0.1, July 2003 For details, see qosvars get. Description onoff QoS state ON or OFF admission Admission Control. Valid values are IN Argument admitall pending reject IM Description AR [onoff= ] [admission= [{droppolicy= | drop= }] [ttl= ] [udpttl= ] [tcpttl= ] [stealtime= [{udpstealtime= | udpsteal= }] [{tcpstealtime= | tcpsteal= }] [{percentbwscaling= | bwscaling= }] qosrule or ruleQoS: Rule Commands droppolicy ( or drop) Drop Policy. Valid values are tail or head ttl udpttl Default UDP time to live Default TCP time to live EL tcpttl Default time to live in seconds stealtime Default steal time {udpstealtime | udp- UDP steal time steal} {tcpstealtime | tcpsteal} TCP steal time PR {percentbwscaling | Scale factor for Tspec bandwith bwscaling} CLI Command Reference Revision 0.1, July 2003 41 Quit Commands quit Exit the command line interface. {quit | exit} PR EL IM IN Syntax AR Quit Commands 42 CLI Command Reference Revision 0.1, July 2003 Reboot (or restart) Commands AR Reboot (or restart) Commands {reboot | restart} Reboot one or all the nodes in the network. Syntax IN {reboot | restart} IM reboot all Reboot all the nodes in the WLAN infrastructure. Syntax EL reboot all reboot asc Syntax reboot asc PR Reboot the ASC node indicated by the argument . reboot ats Reboot the ATS node indicated by the argument . Syntax reboot ats CLI Command Reference Revision 0.1, July 2003 43 Reboot (or restart) Commands reboot wnc Reboot the WNC node indicated by the optional argument , otherwise reboot the current WNC node. reboot wnc [ ] PR EL IM IN AR Syntax 44 CLI Command Reference Revision 0.1, July 2003 security: RADIUS Security Commands AR security: RADIUS Security Commands {security | sec} Syntax {security | sec} security get IM IN These commands allow a user to set and query RADIUS and related security and authentication information. Syntax EL Displays configuration information for how a controller interfaces with a RADIUS server. security get Displays the following fields: Description Node ID The unique numeric ID of the node. Privacy Bit The privacy state that the ATSs should use; either ON, OFF, or AUTO. Security Mode The security mode that the ATSs should use; either OPEN or 802.1x. RADIUS Server IP Address IP address of the RADIUS server in nnn.nnn.nnn.nnn format. RADIUS Server Port Port number to use to connect to the RADIUS server. RADIUS Secret The RADIUS secret. Rekey Period (seconds) The rekey period, in seconds. PR Field CLI Command Reference Revision 0.1, July 2003 45 Y security: RADIUS Security Commands AR security set Sets one or more of the configuration values for security. security set [privacy= ] [{securitymode= | mode= }] [{radiusip= | ip= }] [{radiusport= | port= }] [{radiussecret= | secret= }] [rekeyperiod= | rekey= }] Description Sets one or more of the following values: privacy Description IM Argument IN Syntax The privacy state that the ATSs should use; valid values are ON, OFF, or AUTO. The security mode that the ATSs should use; either OPEN or 802.1x. radiusip (or ip) IP address of the RADIUS server in nnn.nnn.nnn.nnn format. The controller must be rebooted for this to take effect. radiusport (or port) Port number to use to connect to the RADIUS server. The controller must be rebooted for this to take effect. radiussecret (or secret) The RADIUS secret. The controller must be rebooted for this to take effect. rekeyperiod (or rekey) The rekey period, in seconds. The controller must be rebooted for this to take effect. PR EL securitymode (or mode) Description 46 The controller must be reooted for the changes to take effect. CLI Command Reference Revision 0.1, July 2003 SNMP Commands SNMP Commands AR These commands manage SNMP access privileges and trap destinations. snmp del IN Delete an existing SNMP community or trap destination entry. snmp del {community | trap } Description When deleting a community entry, you must supply the of the entry to delete. When deleting a trap destination entry, you must supply the in dot format. IM Syntax EL snmp get Displays one or all existing SNMP community or trap destination entries. snmp get {community [ ] | trap [ ]} PR Syntax Argument Description communityName One or more numbers identifying SNMP entries that are managing or monitoring this controller. Information is displayed for all the listed items. NOTE: To list information for all SNP entries, use snmp get community. ipAddress CLI Command Reference Revision 0.1, July 2003 47 SNMP Commands AR To display one community entry, you must supply the , otherwise all entries are displayed. To display one trap destination entry, you must supply the in dot format, otherwise all entries are displayed. snmp new Create a new SNMP community or trap destination entry. Syntax snmp new {community | trap } IM IN When adding a new community entry, you must supply a new , the (RW or RO) and allowed , which must be dot format or 'any' for any IP addresses. When adding a new trap destination entry, you must supply in dot format and a that is accepted by the receiver. EL snmp set Sets one or more of the configuration values for the specified SNMP management community. Syntax snmp set {community |trap } PR Set either the SNMP community authentication and trap destination values. When changing community information you must supply an existing community Argument Description ( ) and the the new values for both and 48 is RW or RO, and must be in dot format, or 'any' for any IP addresses. When changing trap destinations, you need to supply CLI Command Reference Revision 0.1, July 2003 SNMP Commands Description ditto is the trap receiver IP address and is is accepted by the receiver. PR EL IM IN AR Argument CLI Command Reference Revision 0.1, July 2003 49 Station Commands Station Commands AR The station commands manage stations. Each station is uniquely identified by a MAC address. IN station all Displays configuration information for all stations. See station get for details. station all station del IM Syntax Syntax EL Deletes the rows specified by the row IDs. station del [...] PR station get Displays configuration information for one or more stations. Syntax station get [...] Argument Description macaddress One or more MAC addresses that are associated with this controller. Information is displayed for all the listed items. NOTE: To list information for all stations, use station all. 50 CLI Command Reference Revision 0.1, July 2003 Station Commands Displays the following fields for each of the stations requested: Description MAC Address The MAC address of the station. Description The descriptive name of the ethernet interface. Assignment Type The mechanism by which the IP address was assigned, either STATIC or DYNAMIC. IP Address The IP address assigned to the station. ATS Node The ATS node associated with the station. ASC Node The ASC node associated with the station. Availability Status The availability of the node: 'OFFLINE' or'ONLINE'. station set IN AR Field IM Description Sets one or more of the configuration values for the station that has the specified MAC address. EL station set desc= {ipaddress= | ip= } Argument Description desc The descriptive name of the ethernet interface. ipaddress (or ip) The IP address assigned to the station. PR Syntax {stationstats | stastats} Displays station statistics. Syntax {stationstats | stastats} CLI Command Reference Revision 0.1, July 2003 51 Station Commands Field Description Station's MAC address. Number of successful address changes. Number of seamless (voluntary) handoffs. Number of disassociated (involuntary) handoffs. SIP video reserved bandwidth, in bytes per second. SIP video flows. IN SIP video actual bandwidth, in bytes per second. AR Number of successful DHCP requests. Displays the following station statistics: SIP audio reserved bandwidth, in bytes per second. IM SIP audio actual bandwidth, in bytes per second. SIP audio flows. H.323 video reserved bandwidth, in bytes per second. H.323 video actual bandwidth, in bytes per second. EL H.323 video flows. H.323 audio reserved bandwidth, in bytes per second. H.323 audio actual bandwidth, in bytes per second. PR H.323 audio flows. stationstats all Displays statistical information for all stations. See {stationstats | stastats} for details. Syntax 52 stationstats all CLI Command Reference Revision 0.1, July 2003 topo: Network Topology Commands AR topo: Network Topology Commands {topoascats | ascats} Displays all subcontroller-access point relationships. {topoascats | ascats} Description Display ASC-ATS relationships. Each row displays the ASC and ATS node IDs and the relationship between each pair. The relationship can be 'None', 'Bound', or 'Visible'. topoascats all IM IN Syntax Syntax EL Displays information about relationship between subcontrollers and access points. topoascats all PR topoats Display access points seen by the controller. Each row displays the following: Syntax topoats Field Description NodeID The ATS node ID. RsrcRqst Fraction of bandwidth, in microseconds per second, for that ATS. RsrcAllcd Fraction of bandwidth, in microseconds per second, for the group. CLI Command Reference Revision 0.1, July 2003 53 topo: Network Topology Commands Description NghbrCnt Number of visible ATS neighbors. AttchCnt Number of stations probed and associated. AssgdCnt Number of stations that have been associated. RsrcAllcFrqcy Resource allocation frequency, in times per second. Typically between 10 and 50. AR Field IN topoats all Displays information about all access points and summary information about their neighboring access points. topoats all IM Syntax Syntax EL {topoatsats | atsats} {topoatsats | atsats} PR Display the Received Signal Strength Indicator (RSSI) between all pairs of ATSs that are within range of each other. Each entry displays the RSSI of the source (HeadID) at the receiving end (TailID). The RSSI is a unitless value with typical values between 17 and 42. topoatsats all Displays information about relationship among access points. Syntax 54 topoatsats all CLI Command Reference Revision 0.1, July 2003 topo: Network Topology Commands {topostaats | staats} Display station/ats edge records. Syntax {topostaats | staats} IN AR An entry will be displayed for every station that is within range of an ATS. In addition to the station MAC address and ATS ID, a flag is displayed indicating which ATS the station has been assigned to. The Received Signal Strength Indicator (RSSI) for the station at the ATS is also displayed. RSSI values (a relative, and therefore unitless, measure) typically range from 17 to 42. topostaats all Syntax IM Displays information about relationship between stations and access points. topostaats all EL topostation all Displays information about relationship among stations that are known by the controller. {topostation | toposta} all PR Syntax Field Description MAC Station's MAC address. RsrcRqst Fraction of bandwidth, in microseconds per second. AssgnATS The ATS to which the station is assigned. Handoff Time Date and time of last handoff. DataRate Data rate in megabits per second. #ATSAtch The ATS to which the station is attached. PwerSvMde Power save mode; 'on' or 'off'. CLI Command Reference Revision 0.1, July 2003 55 topo: Network Topology Commands Description AssocState Current association state between the station and attached ATS: 'probe' (probing), 'auth' (authenticating), or 'assoc' (associated). Chnl Channel in use (1 to 11). LastActiveTime Time of last activity seen from station. LastPollTime Last time that station polled the ATS. PR EL IM IN AR Field 56 CLI Command Reference Revision 0.1, July 2003 Watchdog Commands AR Watchdog Commands {watchdog | wd} Syntax {watchdog | wd} watchdog get IM IN To disable the watchdog, set the polling period to zero. To enable the watchdog, set the polling rate to any period larger than zero. Displays the current state of the watchdog. watchdog get EL Syntax PR watchdog set Set the heartbeat polling period to seconds. Setting the polling-time to zero disables the watchdog Syntax watchdog set CLI Command Reference Revision 0.1, July 2003 57 Watchdog Commands watchdog get Displays the current state of the watchdog. watchdog get AR Syntax watchdog set Syntax IN Set the heartbeat polling period to seconds. watchdog set PR EL IM Setting the polling-time to zero disables the watchdog 58 CLI Command Reference Revision 0.1, July 2003 wirelessif or wif: Wireless Interface Commands AR wirelessif or wif: Wireless Interface Commands wirelessif all IN These commands manage 802.11 wireless interfaces (the antennae on access points) Each interface is uniquely identified by a node ID. Displays configuration information for all wireless interfaces managed by the controller. See wirelessif get for details. Syntax EL wirelessif get IM wirelessif all Displays configuration information for one or more wireless interfaces. wirelessif get [...] PR Syntax Description Argument Description node_id One or more node numbers identifying wireless interfaces that are associated with this controller. Information is displayed for all the listed interfaces. NOTE: To list information for all wireless interfaces, use wirelessif all. Displays the following fields for each of the nodes requested: CLI Command Reference Revision 0.1, July 2003 59 wirelessif or wif: Wireless Interface Commands Description Node ID The unique numeric ID of the node. Description A text description for this entry. Operational Status The operational status of the interface: 'UP' or 'DOWN'. Last Change Time Time of last operational state change of the interface. Type The type of the wireless interface. BSSID The Basic Service Set ID of the wireless interface. ESSID The Extended Service Set ID of the wireless interface. Channel The channel number the wireless interface is to use. Low Transmit Power (dBm): The low transmission power of the wireless interface, from 12 dBm to 22 dBm. Medium Transmit Power (dBm): The medium transmission power of the wireless interface, from 12 dBm to 22 dBm. High Transmit Power (dBm): The high transmission power of the wireless interface, from 12 dBm to 22 dBm. Antenna Set: The antenna set, either 'internal' or 'external', to use. Antenna Number: The antenna to use, either '1', '2', or 'both'. Base Transmit Rate 1 (Mbits/sec): First base transmit rate, in megabits per second. Base Transmit Rate 2 (Mbits/sec): Second base transmit rate, in megabits per second. Base Transmit Rate 3 (Mbits/sec): Third base transmit rate, in megabits per second. Base Transmit Rate 4 (Mbits/sec): Fourth base transmit rate, in megabits per second. Supported Transmit Rate 1 (Mbits/sec): First supported transmit rate, in megabits per second. Supported Transmit Rate 2 (Mbits/sec): Second supported transmit rate, in megabits per second. Supported Transmit Rate 3 (Mbits/sec): Third supported transmit rate, in megabits per second. Supported Transmit Rate 4(Mbits/sec): Fourth supported transmit rate, in megabits per second. PR EL IM IN AR Field 60 CLI Command Reference Revision 0.1, July 2003 wirelessif or wif: Wireless Interface Commands Displays the node numbers for all known subcontrollers. wirelessif ids wirelessif ids Description Displays a list of node numbers for wireless interfaces known by this controller. Numbers are displayed one on each output line. IN AR Syntax wirelessif set Sets one or more of the configuration values for the specified interface. wirelessif set desc= channel= {lowpower= | low= } {mediumpower= | medium= } {highpower= | high= } antennaset= antennanum= {baserate1= | rate1= } {baserate2= | rate2= } {baserate3= | rate3= } {baserate4= | rate4= } txrate1= txrate2= txrate3= txrate4= PR EL IM Syntax Description For details, see wirelessif get. Argument Description desc A text description for this entry. channel The channel number the wireless interface is to use. {lowpower | low} The low transmission power of the wireless interface, from 12 dBm to 22 dBm. CLI Command Reference Revision 0.1, July 2003 61 wirelessif or wif: Wireless Interface Commands Description {mediumpower | medium} The medium transmission power of the wireless interface, from 12 dBm to 22 dBm. {highpower | high} The high transmission power of the wireless interface, from 12 dBm to 22 dBm. antennaset The antenna set, either 'internal' or 'external', to use. antennanum The antenna to use, either '1', '2', or 'both'. {baserate1 | rate1} First base transmit rate. {baserate2 | rate2} Second base transmit rate. {baserate3 | rate3} Third base transmit rate. {baserate4 | rate4} Fourth base transmit rate. txrate1 First supported transmit rate. txrate2 Second supported transmit rate. txrate3 Third supported transmit rate. AR IN IM Fourth supported transmit rate. PR EL txrate4 Argument 62 CLI Command Reference Revision 0.1, July 2003 wnc: Controller Commands wnc: Controller Commands AR These commands manage information about the operation of the controller and certain global system parameters. IN wnc get Displays configuration information for the controller. Syntax wnc get Field Node ID IM Displays the following fields: Description The unique numeric ID of the node. A text description for this entry. Uptime The uptime of the node, in hours, minutes, and seconds (hh:mm:ss). EL Description Description of the location of this controller. Contact Person or organization responsible for this controller. Operational Status The operational state of the controller: PR Location Availability Status ENABLED: The controller is operating correctly. DISABLED: The controller is known by the controller but it is not operating correctly. The availability of the controller: OFFLINE: The controller cannot find the controller. ONLINE: The controller can find the controller. Alarm State The severity of the current alarm on the controller. If more than one alarm is current, the highest severity is displayed. In order of increasing severity, the states are NO ALARM, MINOR, MAJOR, or CRITICAL. Beacon Interval (msec) Beacon Interval in milleseconds. CLI Command Reference Revision 0.1, July 2003 63 wnc: Controller Commands Description Assignment Algorithm Assignment Algorithm. Virtual IP Subnet Address This value, when masked by the virtual netmask value, specifies the virtual IP subnet for mobile clients. All nodes must be rebooted for a new value to take effect. Virtual Netmask This value is used to mask the virtual IP subnet address to specify the virtual IP subnet for mobile clients. All nodes must be rebooted for a new value to take effect. DHCP Server IP Address IP address of the DHCP server. AR Field Virtual MAC Address The one virtual MAC address for all access points (ATSs). The Extended Service Set ID for the network. Default ATS Init Script Default ATS init script. Statistics Polling Period Statistics polling period, in seconds (0 = no polling). IM IN ESSID EL wnc set Sets one or more of the configuration values for the specified controller. wnc set desc= location= contact= {beaconinterval= | beacon= } {assignmentalgo= | assign= } virtualip= virtualnetmask= dhcp= virtualmac= essid= atsscript= polling= audit= PR Syntax 64 CLI Command Reference Revision 0.1, July 2003 wnc: Controller Commands Description desc A user provided description for this entry. location Description of the location of this piece of equipment. contact Person or organization responsible for this piece of equipment. beaconinterval | beacon Beacon Interval in milleseconds. assignmentalgo | assign Assignment Algorithm. For internal use only. virtualip This value, when masked by the virtual netmask, specifies the virtual IP subnet for mobile clients. You must reboot the controller for this to take effect. virtualnetmask This value is used to mask the virtual IP subnet address to specify the virtual IP subnet for mobile clients.You must reboot the controller for this to take effect. AR IN IM dhcp Argument The one virtual MAC address for all access points (ATSs) managed by this controller.You must reboot the controller for this to take effect. The default is For more information, see “Roaming Using Shared Virtual MAC Address” on page 65. Because all controllers use the same default value, if you have more than one Meru wireless network with overlapping ranges and you do not want mobile stations to roam transparently between the networks, you can prevent it by changing this value for one of the controllers. EL virtualmac IP address of the DHCP server.You must reboot the controller for this to take effect. The Extended Service Set ID for the network You must reboot the controller for this to take effect. atsscript Default access point initialzation script. See ats scripts for more information. PR essid polling Statistics polling period, in seconds (0 = no polling). How often the controller updates information about the number of packets passed or dropped and so on. audit Audit polling period, in seconds (0 = no audit). How often the controller updates information about Roaming Using Shared Virtual MAC Address To enable the Meru wireless network to easily handle roaming mobile stations, all access points managed by a single controller use the same virtual MAC address. Therefore, all access points look like essentially the same access point, so that a mobile station’s transfer from one access point to the next is quick and seamless. CLI Command Reference Revision 0.1, July 2003 65 PR EL IM IN AR wnc: Controller Commands 66 CLI Command Reference Revision 0.1, July 2003 Y AR IN Glossary IM This glossary contains a collection of terms and abbreviations used in this document. Alphabetic List of Terms and Abbreviations A fast Ethernet standard that uses two pairs of twisted wire and allows up to 100 megabits per second (Mbps). EL 100baseT access point ANC Obsolete term for access point. PR ATS Obsolete term for subcontroller. BSSID Basic Service Set ID, a means of uniquely identifying an access point, usually intended for machine use rather than human use. See also ESSID. CLI Command-line interpreter. Similar to a shell for giving instructions to a controller. Glossary Revision 0.1, month 2003 67 Alphabetic List of Terms and Abbreviations controller Dynamic Host Configuration Protocol. A protocol that allows a network administrator to manage and automatically assign IP numbers to client computers. IP numbers are released to client machines with a lease time. The lease time determines how long the client can retain the IP number without using it. AR DHCP The extended service set identifier (ID) for one or more access points. This is a string of up to 32 characters that is intended to be viewed by humans. A set of access points can share an ESSID. In this case, a mobile station can roam among the access points. See also BSSID. IN ESSID IM Also called an IP address. A 32-bit binary number used to identify senders and receivers of traffic across the Internet. It is usually expressed in the form nnn.nnn.nnn.nnn where nnn is a number from 0 to 256. EL IP Number PR Mbps 68 Million bits (megabits) per second. Glossary Revision 0.1, month 2003 Alphabetic List of Terms and Abbreviations mobile station Network address translation. A system for converting the IP numbers used on one network to the IP numbers used in another network. Usually one network is the inside network and one network is the outside network. Usually the IP numbers on the inside network form a relatively large set of IP numbers, which must be compressed into a small set of IP numbers on the outside network. AR NAT Public Switched Telephone Network. The usual way of making telephone calls in the late 20th century, designed around the idea of using wires and switches. Perhaps to be supplanted by VoIP in the 21st century. IN PSTN IM Quality of Service. A set of technologies for managing and allocating Internet bandwidth, often used to ensure timely delivery of multmedia traffic. QoS Session Initiation Procotol. SIP is a protocol for finding users, usually human, and setting up multimedia communication among them, typically a VoIP phone call. PR SIP Remote Authentication Dial-In User Service. A service that authorizes connecting users and allows them access to requested systems or services. The Microsoft ISA server is a RADIUS server. EL RADIUS ssh Secure SHell. A terminal-emulation program that allows users to log onto a remote device and execute commands. It encrypts the traffic between the client and the host. subcontroller UTC Abbreviation for Coordinated Universal Time (as defined by the International Telecommunication Union (ITU). Also known as Greenwich Mean Time. The time is not adjusted for time zones or for daylight savings time. Glossary Revision 0.1, month 2003 69 Alphabetic List of Terms and Abbreviations (VPN) VoIP Voice over IP. A set of protocols for phone calls where the Internet, rather than the PSTN, is used to connect users. VPN Abbreviation for virtual private network. AR virtual private network Wired Equivalent Privacy. A means of encrypting data broadcast over a wireless link. WEP can be based on either a 64-bit or a 128-bit key and is part of the 802.11 standard. WNC Obsolete term for controller. IN WEP IM PR EL 70 Glossary Revision 0.1, month 2003 Y AR Index alpha listing 67 typographical conventions viii alarms command 3 alphabetical listing of terms 67 asc all command 5 ASC definition 2 asc get command 5 asc ids command 6 ATS definition 2 IN WXYZ warning, explanation of viii wirelessif all command 59 wirelessif set command 61 WNC definition 2 wnc get command 63 wnc> prompt 2 EL command prompt 2 connect command 17 cons command 18 console command 18 conventions, typographical viii cross-reference formats 3 IM key point, explanation of viii note, explanation of viii PR prompt for CLI 2 reference, explanation of viii remote command 17 symbols viii terminology Index Revision 0.1, July 2003 71 Y AR IN IM EL PR 72 Index Revision 0.1, July 2003 re License Agreement (Site) READ BEFORE COPYING, INSTALLING OR USING. associated materials (collectively, the “Software”) until you have carefully By loading or using the Software, you agree to the terms of this Agreement. tall or use the Software. AR u Networks, Inc. (“Meru”) grants to you the following non-exclusive, non-assignable, The Software may include portions offered on terms in addition to those set out here, ons: entation, installation or development utilities, and other materials, including but not r access points. Developer tools are provided in binary format. You may use them ware as licensed hereunder, but you may not redistribute them. ibraries. Libraries may be provided in source code and binary formats. You may use ose of using the Software as licensed hereunder, but you may not redistribute source. ry only with your products that use Meru processors (controller, access point). require an additional license. provided in binary format only. You may copy and distribute Licensed Binaries with LI IN e provided in source or binary format. You may use Meru Source internally for the reunder, but you may not redistribute source code. You may copy and distribute Meru at use Meru . Distribution with non-Meru products may require an additional license. development by Meru or Meru’s suppliers, including the . Trial Software may be ay use Trial software solely for internal test and evaluation purposes for sixty (60) days . To continue use after sixty (60) days you may need to purchase a license from Meru e Trial Software, except that you may copy and distribute compiled, binary versions network processors. materials intended for end users. You may copy, modify, and distribute them. on this CD, which may be subject to different licensing requirements and restrictions Software will be governed by the terms and conditions contained in the licensing.txt her Software. You hereby acknowledge that all files and directories that do not ately are subject to the terms of this Agreement. orts to discontinue distribution of the portions of the Software that you are licensed an update, upgrade, or new version of the Software and to make reasonable efforts to ons to your customers who have received the Software herein. , or otherwise reverse-engineer any software provided solely in binary form. following limitations: you (i) are solely responsible to your customers for any update arise from the distribution, (ii) do not make any statement that your product is , by Meru, (iii) do not use Meru's name or trademarks to market your product without bly and reverse engineering, and (v) shall indemnify, hold harmless, and defend Meru r lawsuits, including attorney's fees, that arise or result from your distribution of any GHTS. Title to all copies of the Software remains with Meru or its suppliers. The ws of the United States and other countries, and by international treaty provisions. You Software. Meru may make changes to the Software, or to items referenced therein, at support or update the Software. Except as otherwise expressly provided, Meru grants , copyrights, trademarks, or other intellectual property rights. You may transfer the bound by these terms and if you retain no copies of the Software. e has been delivered by Meru on physical media, Meru warrants the media to be free nety days after delivery by Meru. If such a defect is found, return the media to Meru ware as Meru may select. ept as provided above, the software is provided “as is” without any express or nties of merchantability, noninfringement, or fitness for a particular purpose. Meru he accuracy or completeness of any information text graphics links or other items PR EL IM IN AR GOVERNMENT RESTRICTED RIGHTS. The Software is provided with "RESTRICTED RIGHTS." Use, duplication, or disclosure by the Government is subject to restrictions as set forth in FAR52.227-14 and DFAR252.227-7013 et seq. or its successor. Use of the Software by the Government constitutes acknowledgment of Meru's proprietary rights therein. Contractor or Manufacturer is Meru Networks, Inc., , CA . Meru Networks, Inc. www.merunetworks.com Revision 0.1, July 2003
Source Exif Data:
File Type : PDF File Type Extension : pdf MIME Type : application/pdf PDF Version : 1.3 Linearized : No Modify Date : 2003:07:21 19:24:55Z Create Date : 2003:07:21 17:54:43Z Page Count : 88 Creation Date : 2003:07:21 17:54:43Z Mod Date : 2003:07:21 19:24:55Z Producer : Acrobat Distiller 5.0.5 for Macintosh Author : Ellen Finch Metadata Date : 2003:07:21 19:24:55Z Creator : Ellen Finch Title : CLIref.BK Page Mode : UseNoneEXIF Metadata provided by EXIF.tools