Extreme Networks, Inc. reserves the right to make changes in specifications and other
information contained in this document and its website without prior notice. The reader
should in all cases consult representatives of Extreme Networks to determine whether any
such changes have been made.
The hardware, firmware, software or any specifications described or referred to in this
document are subject to change without notice.
Trademarks
Extreme Networks and the Extreme Networks logo are trademarks or registered
trademarks of Extreme Networks, Inc. in the United States and/or other countries.
All other names (including any product names) mentioned in this document are the
property of their respective owners and may be trademarks or registered trademarks of
their respective companies/owners.
For additional information about Extreme Networks trademarks, go to:
www.extremenetworks.com/company/legal/trademarks/
Support
For product support, including documentation, visit: www.extremenetworks.com/support/
1.2 Getting Context Sensitive Help ................................................................................................................................................................................1-7
1.3 Using the No Command ............................................................................................................................................................................................. 1-9
1.4 Using CLI Editing Features and Shortcuts ......................................................................................................................................................... 1-9
1.4.1 Moving the Cursor on the Command Line .............................................................................................................................................1-10
1.4.2 Completing a Partial Command Name ...................................................................................................................................................1-10
1.5 Using CLI to Create Profiles and Enable Remote Administration ............................................................................................................. 1-11
2.1 User Exec Commands .................................................................................................................................................................................................2-2
2.1.20 mint ................................................................................................................................................................................................................. 2-60
2.1.21 no ........................................................................................................................................................................................................................2-62
2.1.22 on .......................................................................................................................................................................................................................2-64
3.1.4 cd ..........................................................................................................................................................................................................................3-13
3.1.22 dir ........................................................................................................................................................................................................................3-61
3.1.30 halt ....................................................................................................................................................................................................................3-82
3.1.34 mint ...................................................................................................................................................................................................................3-89
3.1.36 more .................................................................................................................................................................................................................3-92
3.1.37 no .......................................................................................................................................................................................................................3-93
3.1.38 on .......................................................................................................................................................................................................................3-95
4.1 Global Configuration Commands .........................................................................................................................................................................4-4
4.1.2 alias .......................................................................................................................................................................................................................4-11
4.1.45 end .................................................................................................................................................................................................................4-208
4.1.58 ip .....................................................................................................................................................................................................................4-299
4.1.62 mac ................................................................................................................................................................................................................ 4-322
4.1.68 no ................................................................................................................................................................................................................... 4-335
5.1 Common Commands ................................................................................................................................................................................................. 5-2
5.1.4 help ........................................................................................................................................................................................................................ 5-6
5.1.5 no ........................................................................................................................................................................................................................... 5-9
5.1.7 service ................................................................................................................................................................................................................. 5-13
5.1.8 show ....................................................................................................................................................................................................................5-58
6.1 show commands .......................................................................................................................................................................................................... 6-2
6.1.1 show ....................................................................................................................................................................................................................... 6-5
6.1.3 bluetooth ...........................................................................................................................................................................................................6-14
6.1.29 global .............................................................................................................................................................................................................. 6-60
6.1.30 gre .....................................................................................................................................................................................................................6-62
6.1.33 ip ........................................................................................................................................................................................................................6-75
6.1.47 mint ................................................................................................................................................................................................................ 6-107
6.1.56 role ................................................................................................................................................................................................................... 6-121
6.1.72 version ........................................................................................................................................................................................................... 6-156
6.1.75 what ................................................................................................................................................................................................................. 6-161
7.1.3 alias ....................................................................................................................................................................................................................... 7-15
7.1.5 area ......................................................................................................................................................................................................................7-24
7.1.34 gre ................................................................................................................................................................................................................... 7-165
7.1.37 ip ..................................................................................................................................................................................................................... 7-348
7.1.41 led .................................................................................................................................................................................................................... 7-365
7.1.55 mint ................................................................................................................................................................................................................7-390
7.1.59 no ................................................................................................................................................................................................................... 7-400
7.1.76 use .................................................................................................................................................................................................................. 7-437
7.1.81 service ............................................................................................................................................................................................................. 7-451
7.1.82 zone ............................................................................................................................................................................................................... 7-456
7.2.2 area .................................................................................................................................................................................................................. 7-465
7.2.14 no .................................................................................................................................................................................................................... 7-479
7.3.3 ip .......................................................................................................................................................................................................................7-499
7.3.4 no .....................................................................................................................................................................................................................7-500
7.3.9 use ...................................................................................................................................................................................................................7-505
7.4.2 ip ........................................................................................................................................................................................................................7-527
7.4.3 power ............................................................................................................................................................................................................. 7-528
7.4.5 use ................................................................................................................................................................................................................... 7-530
7.4.6 no .......................................................................................................................................................................................................................7-531
8.1.6 no ..........................................................................................................................................................................................................................8-19
8.1.9 use .......................................................................................................................................................................................................................8-23
9.1.8 no .........................................................................................................................................................................................................................9-24
10.1.2 no .........................................................................................................................................................................................................................10-5
11.1.4 no .........................................................................................................................................................................................................................11-22
11.2.5 no ....................................................................................................................................................................................................................... 11-45
11.3.2 no ....................................................................................................................................................................................................................... 11-56
11.4.3 no ....................................................................................................................................................................................................................... 11-66
11.5.3 no ....................................................................................................................................................................................................................... 11-74
11.6.3 no ........................................................................................................................................................................................................................11-78
12.1.5 no ...................................................................................................................................................................................................................... 12-58
12.2.5 no ......................................................................................................................................................................................................................12-77
Access Point, Wireless Controller and Service Platform CLI Reference Guide
x
Contents
13.1.8 ip .........................................................................................................................................................................................................................13-13
13.1.13 no ..................................................................................................................................................................................................................... 13-30
14.1.3 mtu ......................................................................................................................................................................................................................14-5
14.1.6 no .........................................................................................................................................................................................................................14-8
15.1.9 no ....................................................................................................................................................................................................................... 15-18
15.1.18 user ..................................................................................................................................................................................................................15-37
15.1.19 service ............................................................................................................................................................................................................ 15-41
16.1.4 no .......................................................................................................................................................................................................................16-10
16.2.8 local ................................................................................................................................................................................................................ 16-25
16.2.9 nas ................................................................................................................................................................................................................... 16-26
16.2.10 no ................................................................................................................................................................................................................... 16-28
16.2.14 use ................................................................................................................................................................................................................. 16-34
16.3.2 user ................................................................................................................................................................................................................. 16-37
16.3.3 no .....................................................................................................................................................................................................................16-40
17.1.3 no ....................................................................................................................................................................................................................... 17-10
17.1.5 service .............................................................................................................................................................................................................. 17-14
18.1.6 no .......................................................................................................................................................................................................................18-10
19.1.1 area ......................................................................................................................................................................................................................19-4
19.1.11 no ...................................................................................................................................................................................................................... 19-19
20.1.6 no ....................................................................................................................................................................................................................20-14
20.1.8 use ................................................................................................................................................................................................................. 20-33
21.1.4 no .........................................................................................................................................................................................................................21-8
22.1.5 no .......................................................................................................................................................................................................................22-9
22.2.5 mtu .................................................................................................................................................................................................................22-22
22.2.6 no ....................................................................................................................................................................................................................22-23
22.2.10 use .................................................................................................................................................................................................................22-31
22.3.4 mtu .................................................................................................................................................................................................................22-37
22.3.5 no ................................................................................................................................................................................................................... 22-38
23.1.1 area ....................................................................................................................................................................................................................23-3
23.1.4 ip ...................................................................................................................................................................................................................... 23-14
23.1.11 no .....................................................................................................................................................................................................................23-22
24.1.5 use ................................................................................................................................................................................................................... 24-18
24.1.6 no .................................................................................................................................................................................................................... 24-19
25.1.4 no ......................................................................................................................................................................................................................25-12
26.1.6 force ............................................................................................................................................................................................................... 26-12
26.1.9 no ..................................................................................................................................................................................................................... 26-15
26.1.12 service .........................................................................................................................................................................................................26-20
26.1.14 use ................................................................................................................................................................................................................ 26-22
26.2.2 no ................................................................................................................................................................................................................... 26-29
27.1.6 internet ............................................................................................................................................................................................................27-9
27.1.10 no ................................................................................................................................................................................................................... 27-19
27.1.12 osu ...................................................................................................................................................................................................................27-21
28.1.3 no .......................................................................................................................................................................................................................28-6
28.2.3 no ....................................................................................................................................................................................................................28-10
28.3.3 no .................................................................................................................................................................................................................... 28-14
28.4.3 no ................................................................................................................................................................................................................... 28-21
28.5.3 no ................................................................................................................................................................................................................... 28-27
Access Point, Wireless Controller and Service Platform CLI Reference Guide
28.6.2 match ............................................................................................................................................................................................................ 28-31
28.6.3 no ................................................................................................................................................................................................................... 28-34
28.6.4 set ................................................................................................................................................................................................................. 28-35
28.7.6 ip ....................................................................................................................................................................................................................28-50
28.7.8 no ................................................................................................................................................................................................................... 28-52
28.8.15 no ................................................................................................................................................................................................................. 28-73
28.8.20 port ............................................................................................................................................................................................................ 28-78
28.8.31 use ...............................................................................................................................................................................................................28-90
29.1.7 use .................................................................................................................................................................................................................... 29-11
29.1.8 no ..................................................................................................................................................................................................................... 29-12
29.2.1 use ................................................................................................................................................................................................................... 29-14
29.2.2 show .............................................................................................................................................................................................................. 29-15
30.1.9 no ..................................................................................................................................................................................................................... 30-11
Appendix A, CONTROLLER MANAGED WLAN USE CASE
A.1 Creating a First Controller Managed WLAN .....................................................................................................................................................A-1
A.1.3 Using the Command Line Interface to Configure the WLAN .......................................................................................................A-2
Appendix B, PUBLICLY AVAILABLE SOFTWARE
B.1 General Information .................................................................................................................................................................................................... B-1
B.2 Open Source Software Used ................................................................................................................................................................................. B-2
B.3.1 Apache License, Version 2.0 .....................................................................................................................................................................B-15
B.3.2 The BSD License ............................................................................................................................................................................................B-17
B.3.3 Creative Commons Attribution-ShareAlike License, version 3.0 ............................................................................................. B-18
B.3.5 GNU General Public License, version 2 ...............................................................................................................................................B-25
B.3.6 GNU GENERAL PUBLIC LICENSE ........................................................................................................................................................ B-26
B.3.7 GNU Lesser General Public License 2.1 ............................................................................................................................................... B-30
B.3.9 GNU General Public License, version 3 .............................................................................................................................................. B-39
B.3.11 GNU Lesser General Public License, version 3.0 ............................................................................................................................ B-48
B.3.12 GNU General Public License 2.0 ...........................................................................................................................................................B-51
B.3.13 GNU Lesser General Public License, version 2.0 ............................................................................................................................B-57
B.3.14 GNU Lesser General Public License, version 2.1 ............................................................................................................................ B-63
B.3.15 GNU LESSER GENERAL PUBLIC LICENSE ...................................................................................................................................... B-65
B.3.16 MIT License .................................................................................................................................................................................................. B-69
B.3.17 Mozilla Public License, version 2 .......................................................................................................................................................... B-70
B.3.18 The Open LDAP Public License ........................................................................................................................................................... B-74
Access Point, Wireless Controller and Service Platform CLI Reference Guide
B.3.25 CWI LICENSE AGREEMENT FOR PYTHON 0.9.0 THROUGH 1.2 ........................................................................................... B-80
B.3.26 Zope Public License (ZPL) Version 2.0 ............................................................................................................................................ B-81
B.3.27 Zope Public License (ZPL) Version 2.1 ............................................................................................................................................. B-82
Access Point, Wireless Controller and Service Platform CLI Reference Guide
xviii
ABOUT THIS GUIDE
This manual supports the following wireless controllers, service platformss, and access points:
NOTE: In this document AP8122, AP8132, AP8163 are collectively referred to as
AP81XX.
CAUTION: To configure a WE access point, exclusively use the WE UI. Do not
use the command line interface (CLI) along with it. Similarly, when using the
CLI to configure the WE access point, do not use the WE UI along with it.
A simplified version of the WiNG operating system user interface (UI) is available on the following access
point and service platforms models:
This new WiNG Express (WE) UI, simplifies configuration and monitoring of small access point
deployments by limiting monitoring, analytics, and configuration capabilities. The WE UI is designed for
single-site access point deployments not exceeding more than 24 access points of the same model.
This section is organized into the following topics:
•Document Conventions
•Notational Conventions
•End-User Software License Agreement
Access Point, Wireless Controller and Service Platform CLI Reference Guide
i
ABOUT THIS GUIDE
!
Document Conventions
The following conventions are used in this document to draw your attention to important information:
NOTE: Indicates tips or special requirements.
CAUTION: Indicates conditions that can cause equipment damage or data
loss.
WARN IN G! Indicates a condition or procedure that could result in personal
injury or equipment damage.
Switch Note: Indicates caveats unique to a RFS4000, RFS6000, NX5500,
NX7500, NX7510, NX7520, NX7530, NX9500, NX9510, or NX9600 model
controller.
Notational Conventions
The following notational conventions are used in this document:
•Italics are used to highlight specific items in the general text, and to identify chapters and sections
in this and related documents
•Bullets (•) indicate:
-lists of alternatives
-lists of required steps that are not necessarily sequential
-action items
•Sequential lists (those describing step-by-step procedures) appear as numbered lists
Understanding Command Syntax
<variable>Variables are described with a short description enclosed within a
‘<‘ and a ‘>’ pair.
For example, the command,
nx9500-6C8809>show interface ge 1
is documented as:
show interface ge <1-2>
where:
• show – is the command – displays information
• interface – is the keyword – represents the interface type
• <1-2> – is the variable – represents the ge interface index value
Access Point, Wireless Controller and Service Platform CLI Reference Guide
ii
ABOUT THIS GUIDE
|The pipe symbol. This is used to separate the variables/keywords
in a list.
For example, the command,
nx9500-6C8809> show .....
is documented as:
show [adoption|bluetooth|bonjour|boot|
......
where:
• show – is the command – displays information
• [adoption|bluetooth|bonjour|boot|.......] – indicates the different
keywords that can be combined with the show command.
However, only one of the above option can be used at a time.
show adoption ...
show bluetooth ...
show bonjour ...
[]Of the different keywords and variables listed inside a ‘[‘ & ‘]’ pair,
only one can be used. Each choice in the list is separated with a ‘|’
(pipe) symbol.
• [arp-cache|cdp|bonjour|counters|crypto|event-history|firewall|
gre|ip|ipv6|l2tpv3-stats|lacp|license|lldp|logging|mac-addresstable|mint|role|rtls|spanning-tree|traffic-shape|vrrp] – indicates
that these keywords are available for this command. However,
only one can be used at a time.
Access Point, Wireless Controller and Service Platform CLI Reference Guide
iii
ABOUT THIS GUIDE
{ }Any command/keyword/variable or a combination of them inside
a ‘{‘ &‘}’ pair is optional. All optional commands follow the same
conventions as listed above. However, they are displayed italicized.
For example, the command,
nx9500-6C8809> show adoption ....
is documented as:
show adoption info {on <DEVICE-NAME>}
here:
• show adoption info – is the command. This command can also
be used as:
show adoption info
The command can also be extended as:
show adoption info {on <DEVICE-NAME>}
here:
• {on <DEVICE-NAME>} – is the keyword, which is optional.
command / keywordThe first word is always a command. Keywords are words that must
be entered as is. Commands and keywords are mandatory.
For example, the command,
nx9500-6C8809>show wireless
is documented as:
show wireless
where:
• show – is the command
• wireless – is the keyword
()Any command/keyword/variable or a combination of them inside
a ‘(‘ & ‘)’ pair are recursive. All recursive commands can be listed in
any order and can be used once along with the rest of the
commands.
For example, the command,
crypto pki export request generate-rsa-key
test autogen-subject-name ...
• crypto pki export request generate-rsa-key <RSA-KEYPAIRNAME> auto-gen-subject-name – is the command
• <RSA-KEYPAIR-NAME> – is the RSA keypair name (in this
example, the keypair name is ‘test’), and is a variable
• (<URL>,email <EMAIL>,fqdn <FQDN>,ip-address <IP>) – is
the set of recursive parameters (separated by commas) that can
be used in any order.
Access Point, Wireless Controller and Service Platform CLI Reference Guide
iv
ABOUT THIS GUIDE
End-User Software License Agreement
This document is an agreement (“Agreement”) between You, the end user, and Extreme Networks, Inc., on
behalf of itself and its Affiliates (“Extreme”) that sets forth your rights and obligations with respect to the
“Licensed Materials”. BY INSTALLING SOFTWARE AND/OR THE LICENSE KEY FOR THE SOFTWARE
(“License Key”) (collectively, “Licensed Software”), IF APPLICABLE, COPYING, OR OTHERWISE USING THE
LICENSED SOFTWARE AND/OR ANY OF THE LICENSED MATERIALS UNDER THIS AGREEMENT, YOU ARE
AGREEING TO BE BOUND BY THE TERMS OF THIS AGREEMENT, WHICH INCLUDES THE LICENSE(S) AND
THE LIMITATION(S) OF WARRANTY AND DISCLAIMER(S)/LIMITATION(S) OF LIABILITY. IF YOU DO NOT
AGREE TO THE TERMS OF THIS AGREEMENT, RETURN THE LICENSE KEY (IF APPLICABLE) TO EXTREME
OR YOUR DEALER, IF ANY, OR DO NOT USE THE LICENSED SOFTWARE AND/OR LICENSED MATERIALS
AND CONTACT EXTREME OR YOUR DEALER WITHIN TEN (10) DAYS FOLLOWING THE DATE OF RECEIPT
TO ARRANGE FOR A REFUND. IF YOU HAVE ANY QUESTIONS ABOUT THIS AGREEMENT, CONTACT
EXTREME, Attn: LegalTeam@extremenetworks.com.
1DEFINITIONS
form of enterprise that directly or indirectly through one or more intermediaries, controls, or is
controlled by, or is under common control with the party specified. “Server Application” means the
software application associated to software authorized for installation (per License Key, if applicable) on
one or more of Your servers as further defined in the Ordering Documentation. “Client Application” shall
refer to the application to access the Server Application. “Network Device” for purposes of this
Agreement shall mean a physical computer device, appliance, appliance component, controller, wireless
access point, or virtual appliance as further described within the applicable product documentation,
which includes the Order Documentation. “Licensed Materials” means the Licensed Software (including
the Server Application and Client Application), Network Device (if applicable), Firmware, media
embodying software, and the accompanying documentation. “Concurrent User” shall refer to any of
Your individual employees who You provide access to the Server Application at any one time.
“Firmware” refers to any software program or code embedded in chips or other media. “Standalone”
software is software licensed for use independent of any hardware purchase as identified in the
Ordering Documentation. “Licensed Software” collectively refers to the software, including Standalone
software, Firmware, Server Application, Client Application or other application licensed with conditional
use parameters as defined in the Ordering Documentation. “Ordering Documentation” shall mean the
applicable price quotation, corresponding purchase order, relevant invoice, order acknowledgement, and
accompanying documentation or specifications for the products and services purchased, acquired or
licensed hereunder from Extreme either directly or indirectly.
2TERM
. This Agreement is effective from the date on which You accept the terms and conditions of this
Agreement via click-through, commence using the products and services or upon delivery of the
License Key if applicable, and shall be effective until terminated. In the case of Licensed Materials
offered on a subscription basis, the term of “licensed use” shall be as defined within Your Ordering
Documentation.
. “Affiliates” means any person, partnership, corporation, limited liability company, or other
3 GRANT OF LICENSE
to use the Licensed Materials and the accompanying documentation for Your own business purposes
subject to the terms and conditions of this Agreement, applicable licensing restrictions, and any term,
user server networking device, field of use, or other restrictions as set forth in Your Ordering
Documentation. If the Licensed Materials are being licensed on a subscription and/or capacity basis, the
applicable term and/or capacity limit of the license shall be specified in Your Ordering Documentation.
You may install and use the Licensed Materials as permitted by the license type purchased as described
below in License Types. The license type purchased is specified on the invoice issued to You by Extreme
Access Point, Wireless Controller and Service Platform CLI Reference Guide
. Extreme will grant You a non-transferable, non-sublicensable, non-exclusive license
v
ABOUT THIS GUIDE
or Your dealer, if any. YOU MAY NOT USE, COPY, OR MODIFY THE LICENSED MATERIALS, IN WHOLE
OR IN PART, EXCEPT AS EXPRESSLY PROVIDED IN THIS AGREEMENT.
4LICENSE TYPES
.
• Single User, Single Network Device. Under the terms of this license type, the license granted to You
by Extreme authorizes You to use the Licensed Materials as bundled with a single Network Device as
identified by a unique serial number for the applicable Term, if and as specified in Your Ordering
Documentation, or any replacement for that network device for that same Term, for internal use only.
A separate license, under a separate License Agreement, is required for any other network device on
which You or another individual, employee or other third party intend to use the Licensed Materials.
A separate license under a separate License Agreement is also required if You wish to use a Client
license (as described below).
• Single User, Multiple Network Device. Under the terms of this license type, the license granted to You
by Extreme authorizes You to use the Licensed Materials with a defined amount of Network Devices
as defined in the Ordering Documentation.
• Client. Under the terms of the Client license, the license granted to You by Extreme will authorize You
to install the License Key for the Licensed Materials on your server and allow the specific number of
Concurrent Users as ordered by you and is set forth in Your Ordering Documentation. A separate
license is required for each additional Concurrent User.
• Standalone. Software or other Licensed Materials licensed to You for use independent of any
Network Device.
• Subscription. Licensed Materials, and inclusive Software, Network Device or related appliance
updates and maintenance services, licensed to You for use during a subscription period as defined in
Your applicable Ordering Documentation.
• Capacity. Under the terms of this license, the license granted to You by Extreme authorizes You to
use the Licensed Materials up to the amount of capacity or usage as defined in the Ordering
Documentation.
5AUDIT RIGHTS
. You agree that Extreme may audit Your use of the Licensed Materials for compliance
with these terms and Your License Type at any time, upon reasonable notice. In the event that such
audit reveals any use of the Licensed Materials by You other than in full compliance with the license
granted and the terms of this Agreement, Extreme reserves the right to charge You for all reasonable
expenses related to such audit in addition to any other liabilities and overages applicable as a result of
such non-compliance, including but not limited to additional fees for Concurrent Users, excess capacity
or usage over and above those specifically granted to You. From time to time, the Licensed Materials
may upload information about the Licensed Materials and the associated usage to Extreme. This is to
verify the Licensed Materials are being used in accordance with a valid license and/or entitlement. By
using the Licensed Materials, you consent to the transmission of this information.
6 RESTRICTION AGAINST COPYING OR MODIFYING LICENSED MATERIALS
permitted in this Agreement, You may not copy or otherwise reproduce the Licensed Materials. In no
event does the limited copying or reproduction permitted under this Agreement include the right to
decompile, disassemble, electronically transfer, or reverse engineer the Licensed Materials, including the
Licensed Software, or to translate the Licensed Materials into another computer language. The media
embodying the Licensed Materials may be copied by You, in whole or in part, into printed or machine
readable form, in sufficient numbers only for backup or archival purposes, or to replace a worn or
defective copy. However, You agree not to have more than two (2) copies of the Licensed Software in
whole or in part, including the original media, in your possession for said purposes without Extreme’
prior written consent, and in no event shall You operate more copies of the Licensed Software than the
specific licenses granted to You. You may not copy or reproduce the documentation. You agree to
maintain appropriate records of the location of the original media and all copies of the Licensed
Software, in whole or in part, made by You. Any portion of the Licensed Software included in any such
modular work shall be used only on a single computer for internal purposes and shall remain subject to
Access Point, Wireless Controller and Service Platform CLI Reference Guide
. Except as expressly
vi
ABOUT THIS GUIDE
all the terms and conditions of this Agreement. You agree to include any copyright or other proprietary
notice set forth on the label of the media embodying the Licensed Software on any copy of the
Licensed Software in any form, in whole or in part, or on any modification of the Licensed Software or
any such modular work containing the Licensed Software or any part thereof.
7 TITLE AND PROPRIETARY RIGHTS
a The Licensed Materials are copyrighted works and are the sole and exclusive property of Extreme,
any company or a division thereof which Extreme controls or is controlled by, or which may result
from the merger or consolidation with Extreme (its “Affiliates”), and/or their suppliers. This
Agreement conveys a limited right to operate the Licensed Materials and shall not be construed to
convey title to the Licensed Materials to You. There are no implied rights. You shall not sell, lease,
transfer, sublicense, dispose of, or otherwise make available the Licensed Materials or any portion
thereof, to any other party.
b You further acknowledge that in the event of a breach of this Agreement, Extreme shall suffer severe
and irreparable damages for which monetary compensation alone will be inadequate. You therefore
agree that in the event of a breach of this Agreement, Extreme shall be entitled to monetary
damages and its reasonable attorney’s fees and costs in enforcing this Agreement, as well as
injunctive relief to restrain such breach, in addition to any other remedies available to Extreme.
8 PROTECTION AND SECURITY
. In the performance of this Agreement or in contemplation thereof, You
and your employees and agents may have access to private or confidential information owned or
controlled by Extreme relating to the Licensed Materials supplied hereunder including, but not limited
to, product specifications and schematics, and such information may contain proprietary details and
disclosures. All information and data so acquired by You or your employees or agents under this
Agreement or in contemplation hereof shall be and shall remain Extreme’ exclusive property, and You
shall use all commercially reasonable efforts to keep, and have your employees and agents keep, any
and all such information and data confidential, and shall not copy, publish, or disclose it to others,
without Extreme’ prior written approval, and shall return such information and data to Extreme at its
request. Nothing herein shall limit your use or dissemination of information not actually derived from
Extreme or of information which has been or subsequently is made public by Extreme, or a third party
having authority to do so.
You agree not to deliver or otherwise make available the Licensed Materials or any part thereof,
including without limitation the object or source code (if provided) of the Licensed Software, to any
party other than Extreme or its employees, except for purposes specifically related to your use of the
Licensed Materials on a single computer as expressly provided in this Agreement, without the prior
written consent of Extreme. You acknowledge that the Licensed Materials contain valuable confidential
information and trade secrets, and that unauthorized use, copying and/or disclosure thereof are
harmful to Extreme or its Affiliates and/or its/their software suppliers.
9 MAINTENANCE AND UPDATES
. Except as otherwise defined below, updates and certain maintenance
and support services, if any, shall be provided to You pursuant to the terms of an Extreme Service and
Maintenance Agreement, if Extreme and You enter into such an agreement. Except as specifically set
forth in such agreement, Extreme shall not be under any obligation to provide updates, modifications,
or enhancements, or maintenance and support services for the Licensed Materials to You. If you have
purchased Licensed Materials on a subscription basis then the applicable service terms for Your
Licensed Materials are as provided in Your Ordering Documentation. Extreme will perform the
maintenance and updates in a timely and professional manner, during the Term of Your subscription,
using qualified and experienced personnel. You will cooperate in good faith with Extreme in the
performance of the support services including, but not limited to, providing Extreme with: (a) access to
the Extreme Licensed Materials (and related systems); and (b) reasonably requested assistance and
Access Point, Wireless Controller and Service Platform CLI Reference Guide
vii
ABOUT THIS GUIDE
information. Further information about the applicable maintenance and updates terms can be found on
Extreme’s website at http://www.extremenetworks.com/company/legal/terms-of-support
10 DEFAULT AND TERMINATION
. In the event that You shall fail to keep, observe, or perform any
obligation under this Agreement, including a failure to pay any sums due to Extreme, or in the event
that you become insolvent or seek protection, voluntarily or involuntarily, under any bankruptcy law,
Extreme may, in addition to any other remedies it may have under law, terminate the License and any
other agreements between Extreme and You.
a Immediately after any termination of the Agreement, Your licensed subscription term, or if You have
for any reason discontinued use of Licensed Materials, You shall return to Extreme the original and
any copies of the Licensed Materials and remove the Licensed Materials, including an Licensed
Software, from any modular works made pursuant to Section 3, and certify in writing that through
your best efforts and to the best of your knowledge the original and all copies of the terminated or
discontinued Licensed Materials have been returned to Extreme.
b Sections 1, 7, 8, 10, 11, 12, 13, 14 and 15 shall survive termination of this Agreement for any reason.
11 EXPORT REQUIREMENTS
. You are advised that the Licensed Materials, including the Licensed Software
is of United States origin and subject to United States Export Administration Regulations; diversion
contrary to United States law and regulation is prohibited. You agree not to directly or indirectly export,
import or transmit the Licensed Materials, including the Licensed Software to any country, end user or
for any Use that is prohibited by applicable United States regulation or statute (including but not limited
to those countries embargoed from time to time by the United States government); or contrary to the
laws or regulations of any other governmental entity that has jurisdiction over such export, import,
transmission or Use.
12 UNITED STATES GOVERNMENT RESTRICTED RIGHTS
. The Licensed Materials (i) were developed solely
at private expense; (ii) contain “restricted computer software” submitted with restricted rights in
accordance with section 52.227-19 (a) through (d) of the Commercial Computer Software-Restricted
Rights Clause and its successors, and (iii) in all respects is proprietary data belonging to Extreme and/or
its suppliers. For Department of Defense units, the Licensed Materials are considered commercial
computer software in accordance with DFARS section 227.7202-3 and its successors, and use,
duplication, or disclosure by the U.S. Government is subject to restrictions set forth herein.
13 LIMITED WARRANTY AND LIMITATION OF LIABILITY
. Extreme warrants to You that (a) the initiallyshipped version of the Licensed Materials will materially conform to the Documentation; and (b) the
media on which the Licensed Software is recorded will be free from material defects for a period of
ninety (90) days from the date of delivery to You or such other minimum period required under
applicable law. Extreme does not warrant that Your use of the Licensed Materials will be error-free or
uninterrupted.
NEITHER EXTREME NOR ITS AFFILIATES MAKE ANY OTHER WARRANTY OR REPRESENTATION,
EXPRESS OR IMPLIED, WITH RESPECT TO THE LICENSED MATERIALS, WHICH ARE LICENSED "AS IS".
THE LIMITED WARRANTY AND REMEDY PROVIDED ABOVE ARE EXCLUSIVE AND IN LIEU OF ALL
OTHER WARRANTIES, INCLUDING IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A
PARTICULAR PURPOSE, WHICH ARE EXPRESSLY DISCLAIMED, AND STATEMENTS OR
REPRESENTATIONS MADE BY ANY OTHER PERSON OR FIRM ARE VOID. IN NO EVENT WILL
EXTREME OR ANY OTHER PARTY WHO HAS BEEN INVOLVED IN THE CREATION, PRODUCTION OR
DELIVERY OF THE LICENSED MATERIALS BE LIABLE FOR SPECIAL, DIRECT, INDIRECT, RELIANCE,
INCIDENTAL OR CONSEQUENTIAL DAMAGES, INCLUDING LOSS OF DATA OR PROFITS OR FOR
INABILITY TO USE THE LICENSED MATERIALS, TO ANY PARTY EVEN IF EXTREME OR SUCH OTHER
PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. IN NO EVENT SHALL
Access Point, Wireless Controller and Service Platform CLI Reference Guide
viii
ABOUT THIS GUIDE
EXTREME OR SUCH OTHER PARTY'S LIABILITY FOR ANY DAMAGES OR LOSS TO YOU OR ANY
OTHER PARTY EXCEED THE LICENSE FEE YOU PAID FOR THE LICENSED MATERIALS.
Some states do not allow limitations on how long an implied warranty lasts and some states do not
allow the exclusion or limitation of incidental or consequential damages, so the above limitation and
exclusion may not apply to You. This limited warranty gives You specific legal rights, and You may also
have other rights which vary from state to state.
14 JURISDICTION
. The rights and obligations of the parties to this Agreement shall be governed and
construed in accordance with the laws and in the State and Federal courts of the State of California,
without regard to its rules with respect to choice of law. You waive any objections to the personal
jurisdiction and venue of such courts. None of the 1980 United Nations Convention on the Limitation
Period in the International Sale of Goods, and the Uniform Computer Information Transactions Act shall
apply to this Agreement.
15 FREE AND OPEN SOURCE SOFTWARE
. Portions of the Software (Open Source Software) provided to
you may be subject to a license that permits you to modify these portions and redistribute the
modifications (an Open Source License). Your use, modification and redistribution of the Open Source
Software are governed by the terms and conditions of the applicable Open Source License. More details
regarding the Open Source Software and the applicable Open Source Licenses are available at
www.extremenetworks.com/services/SoftwareLicensing.aspx. Some of the Open Source software may
be subject to the GNU General Public License v.x (GPL) or the Lesser General Public Library (LGPL),
copies of which are provided with the Licensed Materials and are further available for review at
www.extremenetworks.com/services/SoftwareLicensing.aspx, or upon request as directed herein. In
accordance with the terms of the GPL and LGPL, you may request a copy of the relevant source code.
See the Software Licensing web site for additional details. This offer is valid for up to three years from
the date of original download of the software.
16 GENERAL.
a This Agreement is the entire agreement between Extreme and You regarding the Licensed Materials,
and all prior agreements, representations, statements, and undertakings, oral or written, are hereby
expressly superseded and canceled.
b This Agreement may not be changed or amended except in writing signed by both parties hereto.
c You represent that You have full right and/or authorization to enter into this Agreement.
d This Agreement shall not be assignable by You without the express written consent of Extreme. The
rights of Extreme and Your obligations under this Agreement shall inure to the benefit of Extreme’
assignees, licensors, and licensees.
e Section headings are for convenience only and shall not be considered in the interpretation of this
Agreement
fThe provisions of the Agreement are severable and if any one or more of the provisions hereof are
judicially determined to be illegal or otherwise unenforceable, in whole or in part, the remaining
provisions of this Agreement shall nevertheless be binding on and enforceable by and between the
parties hereto
g Extreme’s waiver of any right shall not constitute waiver of that right in future. This Agreement
constitutes the entire understanding between the parties with respect to the subject matter hereof,
and all prior agreements, representations, statements and undertakings, oral or written, are hereby
expressly superseded and canceled. No purchase order shall supersede this Agreement.
Access Point, Wireless Controller and Service Platform CLI Reference Guide
ix
ABOUT THIS GUIDE
h Should You have any questions regarding this Agreement, You may contact Extreme at the address
set forth below. Any notice or other communication to be sent to Extreme must be mailed by
certified mail to the following address:
Extreme Networks, Inc.
16480 Via Del
San Jose, CA 95119 United States
Tel: +1 408-579-2800
Toll-free: +1 888-257-3000
Access Point, Wireless Controller and Service Platform CLI Reference Guide
x
INTRODUCTION
1
This chapter describes the commands available within a device’s Command Line Interface (CLI) structure.
CLI is available for wireless controllers, access points (APs), and service platforms.
Access the CLI by using:
•A terminal emulation program running on a computer connected to the serial port on the device
(access point, wireless controller, and service platform).
•A Telnet session through Secure Shell (SSH) over a network.
Configuration for connecting to a Controller using a terminal emulator
If connecting through the serial port, use the following settings to configure your terminal emulator:
Bits Per Second19200
For AP8533, AP8432, AP7662, AP7632, AP7622, AP7612,
AP7602, AP7502, AP7522, AP7532, AP7562, AP6521,
AP6522, AP6532, AP6562 model access points set this
value to 115200.
Data Bits8
ParityNone
Stop Bit1
Flow ControlNone
When a CLI session is established, complete the following (user input is in bold):
Use the following credentials when logging into a device for the first time:
User Nameadmin
Passwordadmin123
When logging into the CLI for the first time, you are prompted to change the password.
Examples in this reference guide
Examples used in this reference guide are generic to each supported wireless controller, service platform,
and AP model. Commands that are not common, are identified using the notation “Supported in the
following platforms:” For an example, see below:
Supported in the following platforms:
•Wireless Controller – RFS6000
The above example indicates the command is only available for an RFS6000 model wireless controller.
Access Point, Wireless Controller and Service Platform CLI Reference Guide
1 - 1
INTRODUCTION
This chapter is organized into the following sections:
•CLI Overview
•Getting Context Sensitive Help
•Using the No Command
•Using CLI Editing Features and Shortcuts
•Using CLI to Create Profiles and Enable Remote Administration
1.1 CLI Overview
INTRODUCTION
The CLI is used for configuring, monitoring, and maintaining the network. The user interface allows you to
execute commands on supported wireless controllers, service platforms, and APs, using either a serial
console or a remote access method.
This chapter describes basic CLI features. Topics covered include an introduction to command modes,
navigation and editing features, help features and command history.
The CLI is segregated into different command modes. Each mode has its own set of commands for
configuration, maintenance, and monitoring. The commands available at any given time depend on the
mode you are in, and to a lesser extent, the particular model used. Enter a question mark (?) at the system
prompt to view a list of commands available for each command mode/instance.
Use specific commands to navigate from one command mode to another. The standard order is: USER
EXEC mode, PRIV EXEC mode and GLOBAL CONFIG mode.
Figure 1-1 Hierarchy of User Modes
Command Modes
A session generally begins in the USER EXEC mode (one of the two access levels of the EXEC mode). For
security, only a limited subset of EXEC commands are available in the USER EXEC mode. This level is
Access Point, Wireless Controller and Service Platform CLI Reference Guide
1 - 2
INTRODUCTION
reserved for tasks that do not change the device’s (wireless controller, service platform, or AP)
configuration.
rfs6000-6DB5D4>
The system prompt signifies the device name and the last three bytes of the device MAC address.
To access commands, enter the PRIV EXEC mode (the second access level for the EXEC mode). Once in
the PRIV EXEC mode, enter any EXEC command. The PRIV EXEC mode is a superset of the USER EXEC
mode.
rfs6000-6DB5D4>enable
rfs6000-6DB5D4#
Most of the USER EXEC mode commands are one-time commands and are not saved across device
reboots. Save the command by executing ‘commit’ command. For example, the show command displays
the current configuration and the clear command clears the interface.
Access the GLOBAL CONFIG mode from the PRIV EXEC mode. In the GLOBAL CONFIG mode, enter
commands that set general system characteristics. Configuration modes, allow you to change the running
configuration. If you save the configuration later, these commands are stored across device reboots.
Access a variety of protocol specific (or feature-specific) modes from the global configuration mode. The
CLI hierarchy requires you to access specific configuration modes only through the global configuration
mode.
rfs6000-6DB5D4#configure terminal
Enter configuration commands, one per line. End with CNTL/Z.
rfs6000-6DB5D4(config)#
You can also access sub-modes from the global configuration mode. Configuration sub-modes define
specific features within the context of a configuration mode.
rfs6000-6DB5D4(config)#aaa-policy test
rfs6000-6DB5D4(config-aaa-policy-test)#
The following table summarizes available CLI commands:
Table 1.1 Controller CLI Modes and Commands
User Exec ModePriv Exec ModeGlobal Configuration Mode
telnetip
terminalipv6
time-itipv6-router-advertisement-policy
traceroutel2tpv3
traceroute6mac
upgrademanagement-policy
upgrade-abortmeshpoint
virtual-machine (supported only on
meshpoint-qos-policy
NX9500, NX9600, and VX9000)
watchmint-policy
writenac-list
clrscrno
exitnsight-policy
nx5500 (supported only on
NX9500, NX9600, VX9000)
nx75xx (supported only on
NX9500, NX9600, VX9000)
nx9000 (supported only on
NX9500, NX9600, VX9000)
Access Point, Wireless Controller and Service Platform CLI Reference Guide
1 - 5
INTRODUCTION
Table 1.1
Controller CLI Modes and Commands
User Exec ModePriv Exec ModeGlobal Configuration Mode
nx9600 (supported only on
NX9600)
passpoint-policy
password-encryption
profile
radio-qos-policy
radius-group
radius-server-policy
radius-user-pool-policy
rename
replace
rf-domain
rfs4000
rfs6000
roaming-assist-policy
role-policy
route-map
routing-policy
rtl-server-policy
schedule-policy
self
sensor-policy
smart-rf-policy
t5 (supported only on RFS4000,
RFS6000, NX9500, NX9600,
VX9000)
url-filter (supported only on
NX9500, NX9600, VX9000)
url-list (supported only on
NX9500, NX9600, VX9000)
vx9000 (supported only on
NX9500, and NX9600, VX9000)
web-filter-policy
wips-policy
wlan
wlan-qos-policy
write
clrscr
Access Point, Wireless Controller and Service Platform CLI Reference Guide
1 - 6
INTRODUCTION
Table 1.1
Controller CLI Modes and Commands
User Exec ModePriv Exec ModeGlobal Configuration Mode
commit
do
end
exit
revert
service
show
1.2 Getting Context Sensitive Help
INTRODUCTION
Enter a question mark (?) at the system prompt to display a list of commands available for each mode.
Obtain a list of arguments and keywords for any command using the CLI context-sensitive help.
Use the following commands to obtain help specific to a command mode, command name, keyword or
argument:
CommandDescription
(prompt)#helpDisplays a brief description of the help system
(prompt)#abbreviated-command-entry?Lists commands in the current mode that begin with a
particular character string
(prompt)#abbreviated-command-entry[TAB]Completes a partial command name
(prompt)#?Lists all commands available in the command mode
(prompt)#command ?Lists the available syntax options (arguments and
keywords) for the command
(prompt)#command keyword ?Lists the next available syntax option for the command
NOTE: The system prompt varies depending on the configuration mode.
NOTE: Enter Ctrl + V to use ? as a regular character and not as a character
used for displaying context sensitive help. This is required when the user has
to enter a URL that ends with a ?
NOTE: The escape character used through out the CLI is “\”. To enter a "\"
use "\\" instead.
Access Point, Wireless Controller and Service Platform CLI Reference Guide
1 - 7
INTRODUCTION
When using context-sensitive help, the space (or lack of a space) before the question mark (?) is
significant. To obtain a list of commands that begin with a particular sequence, enter the characters
followed by a question mark (?). Do not include a space. This form of help is called word help, because it
completes a word.
rfs6000-6DB5D4#service?
service Service Commands
rfs6000-6DB5D4#service
Enter a question mark (?) (in place of a keyword or argument) to list keywords or arguments. Include a
space before the “?”. This form of help is called command syntax help. It shows the keywords or arguments
available based on the command/keyword and argument already entered.
rfs6000-6DB5D4#service ?
block-adopter-config-update Block configuration updates from the
bluetooth Bluetooth service commands
clear Clear adoption history
cli-tables-skin Choose a formatting layout/skin for CLI
tabular outputs (EXPERIMENTAL-Applies only
to certain commands)
cluster Cluster Protocol
copy Copy files or directories
delete Delete sessions
delete-offline-aps Delete Access Points that are configured
but offline
force-send-config Resend configuration to the device
force-update-vm-stats Force VM statistics to be pushed up to the
NOC
load-balancing Wireless load-balancing service commands
load-ssh-authorized-keys Load Ssh authorized keys
locator Enable leds flashing on the device
mint MiNT protocol
pktcap Start packet capture
pm Process Monitor
radio Radio parameters
radius Radius test
request-full-config-from-adopter Request full configuration from the
adopter
set Set global options
show Show running system information
signal Send a signal to a process
smart-rf Smart-RF Management Commands
snmp Snmp
ssm Command related to ssm
start-shell Provide shell access
syslog Syslog service
trace Trace a process for system calls and
signals
troubleshoot Troubleshooting
wireless Wireless commands
rfs6000-6DB5D4#
It is possible to abbreviate commands and keywords to allow a unique abbreviation. For example,
“configure terminal” can be abbreviated as config t. Since the abbreviated command is unique, the
controller accepts the abbreviation and executes the command.
Enter the help command (available in any command mode) to provide the following description:
rfs6000-6DB5D4>help
When using the CLI, help is provided at the command line when typing '?'. If no
help is available, the help content will be empty. Backup until entering a '?'
shows the help content.
There are two styles of help provided:
1. Full help. Available when entering a command argument (e.g. 'show ?'). This will
Access Point, Wireless Controller and Service Platform CLI Reference Guide
1 - 8
INTRODUCTION
describe each possible argument.
2. Partial help. Available when an abbreviated argument is entered. This will
display which arguments match the input (e.g. 'show ve?').
rfs6000-6DB5D4>
1.3 Using the No Command
INTRODUCTION
Almost every command has a no form. Use no to disable a feature or function or return it to its default.
Use the command without the no keyword to re-enable a disabled feature.
1.3.1 Basic Conventions
Keep the following conventions in mind while working within the CLI structure:
•Use “?” at the end of a command to display the sub-modes (keywords) associated with the
command. Type the first few characters of the required sub-mode and press the tab key to auto-fill.
Continue using “?” until you reach the last sub-mode.
•Pre-defined CLI commands and keywords are case-insensitive: cfg = Cfg = CFG. However (for
clarity), CLI commands and keywords are displayed (in this guide) using mixed case. For example,
apPolicy, trapHosts, channelInfo.
•Enter commands in uppercase, lowercase, or mixed case. Only passwords are case sensitive.
1.4 Using CLI Editing Features and Shortcuts
INTRODUCTION
A variety of shortcuts and edit features are available. The following sections describe these features:
•Moving the Cursor on the Command Line
•Completing a Partial Command Name
•Command Output Pagination
Access Point, Wireless Controller and Service Platform CLI Reference Guide
1 - 9
INTRODUCTION
1.4.1 Moving the Cursor on the Command Line
Using CLI Editing Features and Shortcuts
The following table shows the key combinations or sequences to move the command line cursor. Ctrl
defines the control key, which must be pressed simultaneously with its associated letter key. Esc means the
escape key (which must be pressed first), followed by its associated letter key. Keys are not case sensitive.
Specific letters are used to provide an easy way of remembering their functions.
Table 1.2 Keystrokes Details
KeystrokesFunction SummaryFunction Details
Left Arrow
or
Ctrl-B
Right Arrow or Ctrl-FForward characterMoves the cursor one character to the right
Esc- BBack wordMoves the cursor back one word
Esc- FForward wordMoves the cursor forward one word
Ctrl-ABeginning of lineMoves the cursor to the beginning of the command
Ctrl-EEnd of lineMoves the cursor to the end of the command line
Ctrl-DDeletes the current character
Ctrl-UDeletes text up to cursor
Ctrl-KDeletes from the cursor to end of the line
Ctrl-PObtains the prior command from memory
Ctrl-NObtains the next command from memory
Esc-CConverts the letter at the cursor to uppercase
Esc-LConverts the letter at the cursor to lowercase
Esc-DDeletes the remainder of a word
Ctrl-WDeletes the word up to the cursor
Ctrl-ZReturns to the root prompt
Ctrl-TTransposes the character to the left of the cursor
Ctrl-LClears the screen
Back characterMoves the cursor one character to the left
When entering a command that extends beyond a
single line, press the Left Arrow or Ctrl-B keys
repeatedly to move back to the system prompt.
line
with the character located at the cursor
1.4.2 Completing a Partial Command Name
Using CLI Editing Features and Shortcuts
If you cannot remember a command name (or if you want to reduce the amount of typing you have to
perform), enter the first few letters of a command, then press the Tab key. The command line parser
completes the command if the string entered is unique to the command mode. If your keyboard does not
have a Tab key, press Ctrl-L.
Access Point, Wireless Controller and Service Platform CLI Reference Guide
1 - 10
INTRODUCTION
The CLI recognizes a command once you have entered enough characters to make the command unique. If
you enter “conf” within the privileged EXEC mode, the CLI associates the entry with the configure
command, since only the configure command begins with conf.
In the following example, the CLI recognizes a unique string in the privileged EXEC mode when the Tab key
is pressed:
rfs6000-6DB5D4#conf[TAB]
rfs6000-6DB5D4#configure
When using the command completion feature, the CLI displays the full command name. The command is
not executed until the [Return] or [Enter] key is pressed. Modify the command if the full command was not
what you intended in the abbreviation. If entering a set of characters (indicating more than one command),
the system lists all commands beginning with that set of characters.
Enter a question mark (?) to obtain a list of commands beginning with a particular set of characters. Do
not leave a space between the last letter and the question mark (?).
In the following example, all commands, available in the current context, starting with the characters ‘co’
are listed:
rfs6000-6DB5D4#co?
commit Commit all changes made in this session
configure Enter configuration mode
connect Open a console connection to a remote device
copy Copy from one file to another
rfs6000-6DB5D4#
NOTE: The characters entered before the question mark are reprinted to the
screen to complete the command entry.
1.4.3 Command Output Pagination
Using CLI Editing Features and Shortcuts
Output often extends beyond the visible screen length. For cases where output continues beyond the
screen, the output is paused and a
--More--
prompt displays at the bottom of the screen. To resume the output, press the [Enter] key to scroll down
one line or press the Spacebar to display the next full screen of output.
1.5 Using CLI to Create Profiles and Enable Remote
Administration
INTRODUCTION
The following sections describe the following essential procedures:
•Creating Profiles
•Changing the default profile by creating vlan 150 and mapping to ge3 Physical interface
•Enabling Remote Administration
Access Point, Wireless Controller and Service Platform CLI Reference Guide
1 - 11
INTRODUCTION
1.5.1 Creating Profiles
Using CLI to Create Profiles and Enable Remote Administration
Profiles are sort of a ‘template’ representation of configuration. The system has:
•a default profile for each of the following devices:
-RFS4000, RFS6000
•a default profile for each of the following service platforms:
Access Point, Wireless Controller and Service Platform CLI Reference Guide
1 - 13
INTRODUCTION
1.5.3 Enabling Remote Administration
Using CLI to Create Profiles and Enable Remote Administration
A terminal server may function in remote administration mode if either the terminal services role is not
installed on the machine or the client used to invoke the session has enabled the admin controller.
•A terminal emulation program running on a computer connected to the serial port on the
controller. The serial port is located on the front of the controller.
•A Telnet session through a Secure Shell (SSH) over a network. The Telnet session may or may not
use SSH depending on how the controller is configured. It is recommended you use SSH for remote
administration tasks.
This section is organized into the following sub sections:
•Configuring Telnet for Management Access
•Configuring SSH for Management Access
1.5.3.1 Configuring Telnet for Management Access
Enabling Remote Administration
To enable Telnet for management access, use the serial console to login to the device and perform the
following:
1The session, by default, opens in the USER EXEC mode (one of the two access levels of the EXEC
mode). Access the PRIV EXEC mode from the USER EXEC mode.
rfs6000-6DB5D4>en
rfs6000-6DB5D4#
2 Access the GLOBAL CONFIG mode from the PRIV EXEC mode.
rfs6000-6DB5D4>en
rfs6000-6DB5D4#configure terminal
Enter configuration commands, one per line. End with CNTL/Z.
rfs6000-6DB5D4(config)#
3 Go to ‘default-management-policy’ mode.
rfs6000-6DB5D4(config)#management-policy ?
MANAGEMENT Name of the management policy to be configured (will be created
if it does not exist)
5 Connect to the controller through Telnet using its configured IP address. If logging in for the first time,
use the following credentials:
User Nameadmin
Passwordadmin123
At the first-time login instance, you will be prompted to change the password. Set a new password.
Access Point, Wireless Controller and Service Platform CLI Reference Guide
1 - 14
INTRODUCTION
6 On subsequent logins, to change the password, access the default management-policy configuration
mode and enter the username, new password, role, and access details.
rfs6000-6DB5D4(config-management-policy-default)#user testuser password test@123
role helpdesk access all
rfs6000-6DB5D4(config-management-policy-default)#commit
rfs6000-6DB5D4(config-management-policy-default)#show context
management-policy default
telnet
http server
https server
no ftp
ssh
user admin password 1
fd07f19c6caf46e5b7963a802d422a708ad39a24906e04667c8642299c8462f1 role superuser
access all
user testuser password 1
32472f01757293a181738674bdf068ffe0b777ce145524fc669278820ab582c0 role helpdesk
access all
snmp-server community 2 uktRccdr9eLoByF5PCSuFAAAAAeB78WhgTbSKDi96msyUiW+ rw
snmp-server community 2 Ne+R15zlwEdhybKxfbd6JwAAAAZzvrLGzU/xWXgwFtwF5JdD ro
snmp-server user snmptrap v3 encrypted des auth md5 2 WUTBNiUi7tL4ZbU2I7Eh/
QAAAAiDhBZTln0UIu+y/W6E/0tR
snmp-server user snmpmanager v3 encrypted des auth md5 2 9Fva4fYV1WL4ZbU2I7Eh/
QAAAAjdvbWANBNw+We/xHkH9kLi
no https use-secure-ciphers-only
rfs6000-6DB5D4(config-management-policy-default)#
7 Logon to the Telnet console and provide the user details configured in the previous step to access the
5 Connect to the controller through SSH using its configured IP address. If logging in for the first time, use
the following credentials:
User Nameadmin
Passwordadmin123
At the first-time login instance, you will be prompted to change the password. Set a new password.
6 On subsequent logins, to change the password, access the default management-policy configuration
mode and enter the username, new password, role, and access details.
rfs6000-6DB5D4(config-management-policy-default)#user testuser password test@123
role helpdesk access all
rfs6000-6DB5D4(config-management-policy-default)#commit
rfs6000-6DB5D4(config-management-policy-default)#show context
management-policy default
telnet
http server
https server
no ftp
ssh
user admin password 1
fd07f19c6caf46e5b7963a802d422a708ad39a24906e04667c8642299c8462f1 role superuser
access all
user testuser password 1
32472f01757293a181738674bdf068ffe0b777ce145524fc669278820ab582c0 role helpdesk
access all
snmp-server community 2 uktRccdr9eLoByF5PCSuFAAAAAeB78WhgTbSKDi96msyUiW+ rw
snmp-server community 2 Ne+R15zlwEdhybKxfbd6JwAAAAZzvrLGzU/xWXgwFtwF5JdD ro
snmp-server user snmptrap v3 encrypted des auth md5 2 WUTBNiUi7tL4ZbU2I7Eh/
QAAAAiDhBZTln0UIu+y/W6E/0tR
snmp-server user snmpmanager v3 encrypted des auth md5 2 9Fva4fYV1WL4ZbU2I7Eh/
QAAAAjdvbWANBNw+We/xHkH9kLi
no https use-secure-ciphers-only
rfs6000-6DB5D4(config-management-policy-default)#
7 Logon to the SSH console and provide the user details configured in the previous step to access the
Access Point, Wireless Controller and Service Platform CLI Reference Guide
1 - 16
USER EXEC MODE COMMANDS
2
Logging in to the wireless controller places you within the USER EXEC command mode. Typically, a login
requires a user name and password. You have three login attempts before the connection attempt is
refused. USER EXEC commands (available at the user level) are a subset of the commands available at the
privileged level. In general, USER EXEC commands allow you to connect to remote devices, perform basic
tests, and list system information.
To list available USER EXEC commands, use ? at the command prompt. The USER EXEC prompt consists of
the device host name followed by an angle bracket (>).
<DEVICE>>?
Command commands:
captive-portal-page-upload Captive portal internal and advanced page upload
change-passwd Change password
clear Clear
clock Configure software system clock
cluster Cluster commands
commit Commit all changes made in this session
connect Open a console connection to a remote device
create-cluster Create a cluster
crypto Encryption related commands
crypto-cmp-cert-update Update the cmp certs
database Database
database-backup Backup database
database-restore Restore database
debug Debugging functions
device-upgrade Device firmware upgrade
disable Turn off privileged mode command
enable Turn on privileged mode command
file-sync File sync between controller and adoptees
help Description of the interactive help system
join-cluster Join the cluster
l2tpv3 L2tpv3 protocol
logging Modify message logging facilities
mint MiNT protocol
no Negate a command or set its defaults
on On RF-Domain
opendns OpenDNS configuration
page Toggle paging
ping Send ICMP echo messages
ping6 Send ICMPv6 echo messages
revert Revert changes
service Service Commands
show Show running system information
ssh Open an ssh connection
telnet Open a telnet connection
terminal Set terminal line parameters
time-it Check how long a particular command took between
request and completion of response
traceroute Trace route to destination
traceroute6 Trace route to destination(IPv6)
virtual-machine Virtual Machine
watch Repeat the specific CLI command at a periodic
interval
write Write running configuration to memory or
terminal
clrscr Clears the display screen
exit Exit from the CLI
<DEVICE>>
Access Point, Wireless Controller and Service Platform CLI Reference Guide
2 - 1
USER EXEC MODE COMMANDS
2.1 User Exec Commands
USER EXEC MODE COMMANDS
The following table summarizes the User Exec Mode commands:
Uploads captive portal advanced pages to adopted access pointspage 2-4
Changes the password of a logged userpage 2-8
Resets the last saved commandpage 2-9
Configures the system clockpage 2-20
Accesses the cluster contextpage 2-21
Establishes a console connection to a remote devicepage 2-22
Creates a new cluster on a specified devicepage 2-23
Enables encryption and configures encryption related parameterspage 2-24
Triggers a CMP certificate update on a specified device or devicespage 2-33
Enables automatic repairing (vacuuming) and dropping of databases
(Captive-portal and NSight)
Backs up captive-portal and/or NSight database to a specified location
and file on an FTP or SFTP server
Restores a previously exported database [captive-portal and/or
NSight]. Previously exported databases (backed up to a specified FTP
or SFTP server) are restored to the original database.
Configures device firmware upgrade settingspage 2-41
Turns off (disables) the privileged mode command setpage 2-49
Turns on (enables) the privileged mode command setpage 2-50
Configures parameters enabling syncing of PKCS#12 and wirelessbridge certificate between the staging-controller and adopted access
points
Adds a device (access point, wireless controller, or service platform) to
an existing cluster of devices
Establishes or brings down Layer 2 Tunneling Protocol Version 3
(L2TPV3) tunnels
Modifies message logging facilitiespage 2-58
Configures MiNT protocolpage 2-60
Negates a command or sets its defaultpage 2-62
Executes the following commands in the RF Domain context: clrscr, do,
end, exit, help, service, and show
page 2-34
page 2-38
page 2-40
page 2-51
page 2-54
page 2-56
page 2-64
Access Point, Wireless Controller and Service Platform CLI Reference Guide
2 - 2
USER EXEC MODE COMMANDS
Table 2.1 User Exec Mode Commands
CommandDescriptionReference
opendns
page
ping
ping6
ssh
telnet
terminal
time-it
traceroute
traceroute6
Connects to the OpenDNS site using OpenDNS registered credentials
(username, password) OR OpenDNS API token to fetch the OpenDNS
device_id. This command is a part of the process that integrates access
points, controllers, and service platforms with OpenDNS.
Toggles a device’s (access point, wireless controller, or service
platform) paging function
Sends ICMP echo messages to a user-specified locationpage 2-68
Sends ICMPv6 echo messages to a user-specified IPv6 addresspage 2-70
Opens an SSH connection between two network devicespage 2-71
Opens a Telnet sessionpage 2-72
Sets the length and width of the terminal windowpage 2-73
Verifies the time taken by a particular command between request and
response
Traces the route to its defined destinationpage 2-75
Traces the route to a specified IPv6 destinationpage 2-76
virtual-machineInstalls, configures, and monitors the status of virtual machines
page 2-65
page 2-67
page 2-74
page 2-77
(VMs) installed on a WiNG controller
watch
Repeats a specific CLI command at a periodic intervalpage 2-83
NOTE: For more information on common commands (clrscr, commit, help,
revert, service, show, write, and exit), see COMMON COMMANDS.
NOTE: The input parameter <HOSTNAME>, if used in syntaxes across this
chapter, cannot include an underscore (_) character.
Access Point, Wireless Controller and Service Platform CLI Reference Guide
2 - 3
USER EXEC MODE COMMANDS
2.1.1 captive-portal-page-upload
User Exec Commands
Uploads captive portal advanced pages to adopted access points. Use this command to provide access
points with specific captive portal configurations, so that they can successfully provision login, welcome,
and condition pages to clients attempting to access the wireless network using the captive portal.
NOTE: Ensure that the captive portal pages uploaded are *.tar files.
Uploads advanced pages of the captive-portal identified by the <CAPTIVE-PORTALNAME> parameter
• <CAPTIVE-PORTAL-NAME> – Specify the captive portal’s name (should be existing
and configured).
<MAC/HOSTNAME>Uploads to a specified AP
• <MAC/HOSTNAME> – Specify AP’s MAC address or hostname.
allUploads to all APs
Access Point, Wireless Controller and Service Platform CLI Reference Guide
2 - 4
upload-time <TIME>Optional. Schedules an AP upload time
• <TIME> – Specify upload time in the MM/DD/YYYY-HH:MM or HH:MM format.
The scheduled upload time is your local system’s time. It is not the access point,
controller, service platform, or virtual controller time and it is not synched with the
device.
To view a list of uploaded captive portal files, execute the show > captive-portal-page-upload > list-files <CAPTIVE-PORTAL-NAME> command.
Uploads advanced pages of the captive portal identified by the <CAPTIVE-PORTALNAME> parameter
• <CAPTIVE-PORTAL-NAME> – Specify captive portal name (should be existing and
configured).
rf-domain
[<DOMAINNAME>|all]
Uploads to all APs within a specified RF Domain or all RF Domains
• <DOMAIN-NAME> – Uploads to APs within a specified RF Domain. Specify the RF
Domain name.
• all – Uploads to APs across all RF Domains
from-controllerOptional. Uploads captive-portal pages to APs via the controller to which the APs are
adopted
upload-time <TIME>Optional. Schedules an AP upload time
• <TIME> – Specify upload time in the MM/DD/YYYY-HH:MM or HH:MM format.
The scheduled upload time is your local system’s time. It is not the access point,
controller, service platform, or virtual controller time and it is not synched with the
device.
Note: The captive portal pages are downloaded to the controller from the location
specified here. After downloading use the captive-portal-page-upload > <CAPTIVE-PORTAL-NAME> > <DEVICE-OR-DOMAIN-NAME> command to upload these pages to
APs.
<OLD-PASSWORD>Optional. Specify the existing password.
<NEW-PASSWORD>Specify the new password.
Note: The password can also be changed interactively. To do so, press [Enter] after
the command.
Usage Guidelines
A password must be from 1 - 64 characters in length.
Example
rfs6000-81742D>change-passwd
Enter old password:
Enter new password:
Password for user 'admin' changed successfully
Please write this password change to memory(write memory) to be persistent.
rfs6000-81742D#write memory
OK
rfs6000-81742D>
Access Point, Wireless Controller and Service Platform CLI Reference Guide
2 - 8
USER EXEC MODE COMMANDS
2.1.3 clear
User Exec Commands
Clears parameters, cache entries, table entries, and other similar entries. The clear command is available for
specific commands only. The information cleared, using this command, depends on the mode where the
clear command is executed.
clear traffic-shape statistics class <1-4> {(on <DEVICE-NAME>)}
clear vrrp [error-stats|stats] {on <DEVICE-NAME>}
Parameters
• clear arp-cache {on <DEVICE-NAME>}
arp-cacheClears Address Resolution Protocol (ARP) cache entries on a device. This protocol
matches layer 3 IP addresses to layer 2 MAC addresses.
on <DEVICE-NAME>Optional. Clears ARP cache entries on a specified device
• <DEVICE-NAME> – Specify the name of the AP, wireless controller, or service
platform.
• clear bonjour cache {on <DEVICE-NAME>}
bonjour cacheClears all Bonjour cached statistics. Once cleared the system has to re-discover
available Bonjour services.
on <DEVICE-NAME>Optional. Clears all Bonjour cached statistics on a specified device
• <DEVICE-NAME> – Specify the name of the AP, wireless controller, or service
platform.
• clear [cdp|lldp] neighbors {on <DEVICE-NAME>}
cdpClears Cisco Discovery Protocol (CDP) table entries
lldpClears Link Layer Discovery Protocol (LLDP) table entries
neighborsClears CDP or LLDP neighbor table entries based on the option selected in the
preceding step
on <DEVICE-NAME>Optional. Clears CDP or LLDP neighbor table entries on a specified device
• <DEVICE-NAME> – Specify the name of the AP, wireless controller, or service
platform.
Access Point, Wireless Controller and Service Platform CLI Reference Guide
countersClears counters based on the parameters passed. The options are: AP, radio, and
wireless clients.
ap <MAC>Clears counters for all APs or a specified AP
• <MAC> – Optional. Specify the AP’s MAC address.
Note: If no MAC address is specified, all AP counters are cleared.
radio <MAC/DEVICENAME> <1-X>
Clears radio interface counters on a specified device or on all devices
• <MAC/DEVICE-NAME> – Optional. Specify the device’s hostname or MAC address.
Optionally, append the radio interface number (to the radio ID) using one of the
following formats: AA-BB-CC-DD-EE-FF:RX or HOSTNAME:RX (where RX is the
interface number).
• <1-X> – Optional. Identifies the radio interface by its index. Specify the radio interface index, if not specified as part of the radio ID. Note, the number of radio interfaces
available varies with the access point type.
If no device name or MAC address is specified, all radio interface counters are
cleared.
wireless-client <MAC> Clears counters for all wireless clients or a specified wireless client
• <MAC> – Optional. Specify the wireless client’s MAC address.
If no MAC address is specified, all wireless client counters are cleared.
on <DEVICE-ORDOMAIN-NAME>
The following option is common to all of the above keywords:
• on <DEVICE-OR-DOMAIN-NAME> – Optional. Clears AP, radio, or wireless client
counters on a specified device or RF Domain
• <DEVICE-OR-DOMAIN-NAME> – Specify the name of the AP, wireless controller,
service platform, or RF Domain.
• clear crypto ike sa [<IP>|all] {on <DEVICE-NAME>}
cryptoClears encryption module’s cached statistics
ike sa [<IP>|all]Clears Internet Key Exchange (IKE) security associations (SAs)
• <IP> – Clears IKE SA entries for the peer identified by the <IP> keyword
• all – Clears IKE SA entries for all peers
on <DEVICE-NAME>Optional. Clears IKE SA entries, for a specified peer or all peers, on a specified device
• <DEVICE-NAME> – Specify the name of the AP, wireless controller, or service
platform.
• clear crypto ipsec sa {on <DEVICE-NAME>}
crypto
ipsec sa
on <DEVICE-NAME>
Clears encryption module’s cached statistics
Clears Internet Protocol Security (IPSec) database SAs
• on <DEVICE-NAME> – Optional. Clears IPSec SA entries on a specified device
• <DEVICE-NAME> – Specify the name of the AP, wireless controller, or service platform.
Access Point, Wireless Controller and Service Platform CLI Reference Guide
2 - 11
• clear eguest registration statistics
USER EXEC MODE COMMANDS
eguest registration
statistics
Clears EGuest registration server counters. When cleared EGuest registration details
are deleted, and the show > eguest > registration > statistics command output is null.
This command is applicable only on the NX9500, NX9600, and VX9000 model
service platforms.
• clear gre stats {on <DEVICE-NAME>}
gre statsClears GRE tunnel statistics
on <DEVICE-NAME>Optional. Clears GRE tunnel statistics on a specified device
• <DEVICE-NAME> – Specify the name of the AP, wireless controller, or service
platform.
• clear event-history
event-historyClears event history cache entries
• clear ip bgp [<IP>|all|external] {in prefix-filter} {on <DEVICE-NAME>}
ip bgp
[<IP>|all|external]
Clears on-going BGP sessions based on the option selected
• <IP> – Clears BGP session with the peer identified by the <IP> keyword. Specify the
BGP peer’s IP address.
This command is applicable only to the RFS4000, RFS6000, NX9500, NX9600, and
VX9000 platforms.
Modifications made to BGP settings (BGP access lists, weight, distance, route-maps,
versions, routing policy, etc.) take effect only after on-going BGP sessions are
cleared. The clear > ip > bgp command clears BGP sessions. To reduce lose of route
updates during the process, use the ‘soft’ option. Soft reconfiguration stores
inbound/outbound route updates to be processed later and updated to the routing
table. This requires high memory usage.
in prefix-filterOptional. Clears inbound route updates
on <DEVICE-NAME>Optional. Clears route updates on a specified device
• <DEVICE-NAME> – Specify the name of the AP or service platform.
• clear ip bgp [<IP>|all|external] {out} {(on <DEVICE-NAME>)}
ip bgp
[<IP>|all|external]
Clears on-going BGP sessions based on the option selected
• <IP> – Clears BGP session with the peer identified by the <IP> keyword. Specify the
BGP peer’s IP address.
• all – Clears all BGP peer sessions
• external – Clears eBGP peer sessions
This command is applicable only to the RFS4000, RFS6000, NX9500, NX9600, and
VX9000 platforms.
Contd..
Access Point, Wireless Controller and Service Platform CLI Reference Guide
2 - 12
USER EXEC MODE COMMANDS
Modifications made to BGP settings (BGP access lists, weight, distance, route-maps,
versions, routing policy, etc.) take effect only after on-going BGP sessions are
cleared. The clear > ip > bgp command clears BGP sessions. To reduce lose of route
updates during the process, use the ‘soft’ option. Soft reconfiguration stores
inbound/outbound route updates to be processed later and updated to the routing
table. This requires high memory usage.
outOptional. Clears outbound route updates. Optionally specify the device on which to
execute this command.
on <DEVICE-NAME>The following keyword is recursive and optional.
• on <DEVICE-NAME> – Optional. Clears BGP sessions on a specified device
• <DEVICE-NAME> – Specify the name of the AP or service platform.
• clear ip bgp [<IP>|all|external] {soft{in|out}}{on <DEVICE-NAME>}
ip bgp
[<IP>|all|external]
Clears on-going BGP sessions based on the option selected
• <IP> – Clears the BGP peer session with the peer identified by the <IP> keyword.
Specify the BGP peer’s IP address.
• all – Clears all BGP peer sessions
• external – Clears eBGP peer sessions
This command is applicable only to the RFS4000, RFS6000, NX9500, NX9600, and
VX9000 platforms.
soft {in|out}
Optional. Initiates soft-reconfiguration of route updates for the specified IP address
• in – Optional. Enables soft reconfiguration of inbound route updates
• out – Optional. Enables soft reconfiguration of outbound route updates
Modifications made to BGP settings (BGP access lists, weight, distance, route-maps,
versions, routing policy, etc.) take effect only after on-going BGP sessions are
cleared. The clear > ip > bgp command clears BGP sessions. To reduce loss of route
updates during the process, use the ‘soft’ option. Soft reconfiguration stores
inbound/outbound route updates to be processed later and updated to the routing
table. This requires high memory usage.
on <DEVICE-NAME>Optional. Initiates soft reconfiguration inbound/outbound route updates on a
specified device
• <DEVICE-NAME> – Specify the name of the AP or service platform.
• clear ip bgp process {on <DEVICE-NAME>}
ip bgp processClears all BGP processes running
This command is applicable only to the RFS4000, RFS6000, NX9500, NX9600, and
VX9000 platforms.
on <DEVICE-NAME>Optional. Clears all BGP processes on a specified device
• <DEVICE-NAME> – Specify the name of the AP or service platform.
• clear ip dhcp bindings [<IP>|all] {on <DEVICE-NAME>}
ipClears a Dynamic Host Configuration Protocol (DHCP) server’s IP address binding
entries
dhcp bindingsClears DHCP connections and server bindings
<IP>Clears specific address binding entries. Specify the IP address to clear binding
entries.
Access Point, Wireless Controller and Service Platform CLI Reference Guide
2 - 13
USER EXEC MODE COMMANDS
allClears all address binding entries
on <DEVICE-NAME>Optional. Clears a specified address binding or all address bindings on a specified
device
• <DEVICE-NAME> – Specify the name of the AP, wireless controller, or service
platform.
• clear ip ospf process {on <DEVICE-NAME>}
ip ospf processClears already enabled Open Shortest Path First (OSPF) process and restarts the
process
on <DEVICE-NAME>Optional. Clears OSPF process on a specified device
OSPF is a link-state interior gateway protocol (IGP). OSPF routes IP packets within a
single routing domain (autonomous system), like an enterprise LAN. OSPF gathers
link state information from neighboring routers and constructs a network topology.
The topology determines the routing table presented to the Internet Layer, which
makes routing decisions based solely on the destination IP address found in IP
packets.
• <DEVICE-NAME> – Specify the name of the AP, wireless controller, or service
platform.
• clear ipv6 neighbor-cache {on <DEVICE-NAME>}
clear ipv6
Clears IPv6 neighbor cache entries
neighbor-cache
on <DEVICE-NAME>Optional. Clears IPv6 neighbor cache entries on a specified device
• <DEVICE-NAME> – Specify the name of the AP, wireless controller, or service
platform.
• clear lacp [<1-4> counters|counters]
clear lacp
[<1-4> counters|
counters]
Clears Link Aggregation Control Protocol (LACP) counters for a specified port-
channel group or all port-channel groups configured
• <1-4> counters – Clears LACP counters for a specified port-channel. Specify the
port-channel index number from 1 - 4. Note, LACP is supported only on the NX5500,
NX7500, and NX9500 model service platforms. However, the NX9500 series service
platforms support only two (2) port-channels, and the other model service
platforms support four (4) port-channels.
• counters – Clears LACP counters for all configured port-channels on the device
mac-address-tableClears MAC address forwarding table data based on the parameters passed
Use this command to clear the following: all or specified MAC addresses from the
system, all MAC addresses on a specified interface, all MAC addresses on a specified
VLAN, or the authentication state of a MAC address.
address <MAC>Optional. Clears a specified MAC address from the MAC address table.
• <MAC> – Specify the MAC address in one of the following formats: AA-BB-CC-DDEE-FF or AA:BB:CC;DD:EE:FF or AABB.CCDD.EEFF
If executed without specifying any MAC address(es), all MAC addresses from the
MAC address table will be removed.
Access Point, Wireless Controller and Service Platform CLI Reference Guide
2 - 14
USER EXEC MODE COMMANDS
vlan <1-4094>Optional. Clears all MAC addresses for a specified VLAN
• <1-4094> – Specify the VLAN ID from 1 - 4094.
on <DEVICE-NAME>Optional. Clears a single MAC entry or all MAC entries, for the specified VLAN on a
specified device
• <DEVICE-NAME> – Specify the name of the AP, wireless controller, or service
platform.
mac-address-tableClears MAC address forwarding table data based on the parameters passed
Use this command to clear the following: all or specified MAC addresses from the
system, all MAC addresses on a specified interface, all MAC addresses on a specified
VLAN, or the authentication state of a MAC address.
interfaceClears all MAC addresses for the selected interface. Use the options available to
specify the interface.
<IF-NAME>Clears MAC address forwarding table for the specified layer 2 interface (Ethernet
port)
• <IF-NAME> – Specify the layer 2 interface name.
ge <1-X>Clears MAC address forwarding table for the specified GigabitEthernet interface
• <1-X> – Specify the GigabitEthernet interface index from 1 - X.
The number of GE interfaces supported varies for different device types.
port-channel <1-X>Clears MAC address forwarding table for the specified port-channel interface
• <1-X> – Specify the port-channel interface index from 1 - X.
The number of port-channel interfaces supported varies for different device types.
on <DEVICE-NAME>Optional. Clears the MAC address forwarding table, for the selected interface, on a
specified device
• <DEVICE-NAME> – Specify the name of the AP, wireless controller, or service
platform.
Clears MAC addresses learned from a particular VLAN when WLAN MAC
authentication and captive-portal fall back is enabled
Access points/controllers provide WLAN access to clients whose MAC address has
been learned and stored in their MAC address tables. Use this command to clear a
specified MAC address on the MAC address table. Once cleared the client has to reauthenticate, and is provided access only on successful authentication.
• <MAC> – Specify the MAC address to clear.
• vlan <1-4904> – Specify the VLAN interface from 1 - 4094. In the AP/controller’s
MAC address table, the specified MAC address is cleared on the specified VLAN interface.
on <DEVICE-NAME>Optional. Clears the specified MAC address on a specified device
• <DEVICE-NAME> – Specify the name of the AP, wireless controller, or service
platform.
If a device is not specified, the system clears the MAC address on all devices.
Access Point, Wireless Controller and Service Platform CLI Reference Guide
2 - 15
USER EXEC MODE COMMANDS
• clear mint mlcp history {on <DEVICE-NAME>}
mintClears MiNT related information
mlcp historyClears MiNT Link Creation Protocol (MLCP) client history
on <DEVICE-NAME>Optional. Clears MLCP client history on a specified device
• <DEVICE-NAME> – Specify the name of the AP, wireless controller, or service
platform.
• clear role ldap-stats {on <DEVICE-NAME>}
role ldap-statsClears Lightweight Directory Access Protocol (LDAP) server statistics
on <DEVICE-NAME>Optional. Clears LDAP server statistics on a specified device
• <DEVICE-NAME> – Specify the name of the AP, wireless controller, or service
platform.
• clear rtls [aeroscout|ekahau] {<MAC/DEVICE-NAME> {on <DEVICE-OR-DOMAIN-NAME>}|
on <DEVICE-OR-DOMAIN-NAME>}
rtlsClears Real Time Location Service (RTLS) statistics
aeroscoutClears RTLS Aeroscout statistics
ekahauClears RTLS Ekahau statistics
<MAC/DEVICE-NAME>This keyword is common to the ‘aeroscout’ and ‘ekahau’ parameters.
• <MAC/DEVICE-NAME> – Optional. Clears Aeroscout or Ekahau RTLS statistics on a
specified AP, wireless controller, or service platform. Specify the AP’s MAC
address or hostname.
on <DEVICE-ORDOMAIN-NAME>
This keyword is common to the ‘aeroscout’, ‘ekahau’, and <MAC/DEVICE-NAME>
parameters.
• on <DEVICE-OR-DOMAIN-NAME> – Optional. Clears Aeroscout or Ekahau RTLS
statistics on a specified device
• <DEVICE-OR-DOMAIN-NAME> – Specify the name of the AP, wireless controller,
service platform, or RF Domain.
spanning-treeClears spanning tree entries on an interface, and restarts protocol migration
detected-protocolsRestarts protocol migration
on <DEVICE-NAME>Optional. Clears spanning tree entries on a specified device
• <DEVICE-NAME> – Specify the name of the AP, wireless controller, or service
platform.
vrrpClears a device’s Virtual Router Redundancy Protocol (VRRP) statistics
VRRP allows a pool of routers to be advertized as a single virtual router. This virtual
router is configured by hosts as their default gateway. VRRP elects a master router,
from this pool, and assigns it a virtual IP address. The master router routes and
forwards packets to hosts on the same subnet. When the master router fails, one of
the backup routers is elected as the master and its IP address is mapped to the
virtual IP address.
error-stats
Clears global error statistics
statsClears VRRP related statistics
on <DEVICE-NAME>The following keywords are common to the ‘error-stats’ and ‘stats’ parameters:
• on <DEVICE-NAME> – Optional. Clears VRRP statistics on a specified device
• <DEVICE-NAME> – Specify the name of the AP, wireless controller, or service
platform.
Access Point, Wireless Controller and Service Platform CLI Reference Guide
-------------------------------------------------------Total number of MACs displayed: 7
rfs4000-229D58>
Access Point, Wireless Controller and Service Platform CLI Reference Guide
2 - 19
USER EXEC MODE COMMANDS
2.1.4 clock
User Exec Commands
Sets a device’s system clock. By default all WiNG devices are shipped with the time zone and time format
set to UTC and 24-hour clock respectively. If a device’s clock is set without resetting the time zone, the
time is displayed relative to the Universal Time Coordinated (UTC) – Greenwich Time. To display time in the
local time zone format, in the device’s configuration mode, use the timezone command. You can also reset
the time zone at the RF Domain level. When configured as RF Domain setting, it applies to all devices
within the domain. Configuring the local time zone prior to setting the clock is recommended. For more
information on configuring RF Domain time zone, see timezone.
clock set <HH:MM:SS> <1-31> <MONTH> <1993-2035> {on <DEVICE-NAME>}
Parameters
• clock set <HH:MM:SS> <1-31> <MONTH> <1993-2035> {on <DEVICE-NAME>}
clock setSets a device’s software system clock
<HH:MM:SS>Sets the current time (in military format hours, minutes, and seconds)
Note: By default, the WiNG software displays time in the 24-hour clock format. This setting
cannot be changed.
<1-31>Sets the numerical day of the month
<MONTH>Sets the month of the year (Jan to Dec)
<1993-2035>Sets a valid four digit year from 1993 - 2035
on
<DEVICE-NAME>
Example
Optional. Sets the clock on a specified device
• <DEVICE-NAME> – Specify the name of the AP, wireless controller, or service platform.
The following commands set the time zone and clock for the logged device:
create-clusterCreates a new cluster on the specified device
join-clusterAdds a wireless controller or service platform, as a member, to an existing cluster of
controllers
Access Point, Wireless Controller and Service Platform CLI Reference Guide
2 - 21
USER EXEC MODE COMMANDS
2.1.6 connect
User Exec Commands
Begins a console connection to a remote device using the remote device’s MiNT ID or name
mint-id <MINT-ID>Connects to the remote system using its MiNT ID
• <MINT-ID> – Specify the remote device’s MiNT ID.
<REMOTE-DEVICENAME>
Connects to the remote system using its name
• <REMOTE-DEVICE-NAME> – Specify the remote device’s name.
Example
rfs6000-81742D>show mint lsp-db
9 LSPs in LSP-db of 19.6D.B5.D4:
LSP 19.6C.88.09 at level 1, hostname nx9500-6C8809", 8 adjacencies, seqnum 1294555
LSP 19.6D.B5.D4 at level 1, hostname "rfs6000-81742D", 8 adjacencies, seqnum
1915724
LSP 19.74.B4.5C at level 1, hostname "ap8132-74B45C", 8 adjacencies, seqnum 1468229
LSP 4D.80.C2.AC at level 1, hostname "ap7532-80C2AC", 8 adjacencies, seqnum 649244
LSP 4D.83.30.A4 at level 1, hostname "ap7522-8330A4", 8 adjacencies, seqnum 202821
LSP 4D.84.A2.24 at level 1, hostname "ap7562-84A224", 8 adjacencies, seqnum 380340
LSP 68.88.0D.A7 at level 1, hostname "rfs4000-880DA7", 8 adjacencies, seqnum
1494523
LSP 68.99.BB.7C at level 1, hostname "ap7131-99BB7C", 8 adjacencies, seqnum 831532
rfs6000-81742D>
rfs6000-81742D>connect mint-id 19.6C.88.09
Entering character mode
Escape character is '^]'.
NX9500 release 5.9.1.0-012D
nx9500-6C8809 login:
Access Point, Wireless Controller and Service Platform CLI Reference Guide
2 - 22
USER EXEC MODE COMMANDS
2.1.7 create-cluster
User Exec Commands
Creates a new device cluster with the specified name and assigns it an IP address and routing level
A cluster (or redundancy group) is a set of controllers or service platforms (nodes) uniquely defined by a
profile configuration. Within the cluster, members discover and establish connections to other members
and provide wireless network self-healing support in the event of member's failure.
A cluster's load is typically distributed evenly amongst its members. An administrator needs to define how
often the profile is load balanced for radio distribution, as radios can come and go and members join and
exit the cluster.
create-cluster name <CLUSTER-NAME> ip <IP> {level [1|2]}
Parameters
• create-cluster name <CLUSTER-NAME> ip <IP> {level [1|2]}
create-clusterCreates a cluster
name
<CLUSTER-NAME>
Configures the cluster name
• <CLUSTER-NAME> – Specify a cluster name. Define a name for the cluster name unique
to its configuration or profile support requirements. The name cannot exceed 64
characters.
ip <IP>Specifies the device’s IP address used for cluster creation
• <IP> – Specify the device’s IP address in the A.B.C.D format.
level [1|2]Optional. Configures the cluster’s routing level
• 1 – Configures level 1 (local) routing
• 2 – Configures level 2 (inter-site) routing
Example
rfs6000-81742D>create-cluster name TechPubs ip 192.168.13.23 level 1
... creating cluster
... committing the changes
... saving the changes
Please Wait .
[OK]
rfs6000-81742D>
rfs6000-81742D>show context session-config include-factory | include cluster name
TechPubs
cluster name TechPubs
rfs6000-81742D>
Related Commands
clusterInitiates cluster context. The cluster context provides centralized management to
configure all cluster members from any one member.
join-clusterAdds a device, as a member, to an existing cluster of devices
Access Point, Wireless Controller and Service Platform CLI Reference Guide
2 - 23
USER EXEC MODE COMMANDS
2.1.8 crypto
User Exec Commands
Enables digital certificate configuration and RSA Keypair management. Digital certificates are issued by
CAs and contain user or device specific information, such as name, public key, IP address, serial number,
company name, etc. Use this command to generate, delete, export, or import encrypted RSA Keypairs and
generate Certificate Signing Request (CSR).
This command also enables trustpoint configuration. Trustpoints contain the CA’s identity and configuration
parameters.
keyEnables RSA Keypair management. Use this command to export, import, generate,
or delete a RSA key.
export rsa
<RSA-KEYPAIRNAME>
Exports an existing RSA Keypair to a specified destination
• <RSA-KEYPAIR-NAME> – Specify the RSA Keypair name.
<EXPORT-TO-URL>Specify the RSA Keypair destination address. Both IPv4 and IPv6 address formats
are supported.
After specifying the destination address (where the RSA Keypair is exported),
configure one of the following parameters: background or passphrase.
backgroundOptional. Performs export operation in the background. If selecting this option, you
can optionally specify the device (access point or controller) to perform the export
on.
passphrase
<KEY-PASSPHRASE>
background
Optional. Encrypts RSA Keypair before exporting
• <KEY-PASSPHRASE> – Specify a passphrase to encrypt the RSA Keypair.
• background – Optional. Performs export operation in the background. After specifying the passphrase, optionally specify the device (access point or controller) to
perform the export on.
on <DEVICE-NAME>The following parameter is recursive and common to all of the above parameters:
• on <DEVICE-NAME> – Optional. Performs export operation on a specified device
• <DEVICE-NAME> – Specify the name of the AP, wireless controller, or service
platform.
keyEnables RSA Keypair management. Use this command to export, import, generate,
or delete a RSA key.
import rsa
<RSA-KEYPAIRNAME>
Imports a RSA Keypair from a specified source
• <RSA-KEYPAIR-NAME> – Specify the RSA Keypair name.
<IMPORT-FROM-URL> Specify the RSA Keypair source address. Both IPv4 and IPv6 address formats are
supported.
After specifying the source address (where the RSA Keypair is imported from),
configure one of the following parameters: background or passphrase.
backgroundOptional. Performs import operation in the background. If selecting this option, you
can optionally specify the device (access point or controller) to perform the import
on.
passphrase
<KEY-PASSPHRASE>
background
Optional. Decrypts the RSA Keypair after importing
• <KEY-PASSPHRASE> – Specify the passphrase to decrypt the RSA Keypair.
• background – Optional. Performs import operation in the background. After specifying the passphrase, optionally specify the device (access point, controller, or service platform) to perform the import on.
on <DEVICE-NAME>The following parameter is recursive and common to the ‘background’ and
‘passphrase’ keywords:
• on <DEVICE-NAME> – Optional. Performs import operation on a specific device
• <DEVICE-NAME> – Specify the name of the AP, wireless controller, or service platform.
pkiEnables PKI management. Use this command to authenticate, export, generate, or
delete a trustpoint and its associated CA certificates.
export requestExports CSR to the CA for a digital identity certificate. The CSR contains applicant’s
details and RSA Keypair’s public key.
[generate-rsa-key|
short [generate-rsakey|use-rsa-key]|
use-rsa-key]
<RSA-KEYPAIRNAME>
Generates a new RSA Keypair or uses an existing RSA Keypair
• generate-rsa-key – Generates a new RSA Keypair for digital authentication
• short [generate-rsa-key|use-rsa-key] – Generates and exports a shorter version of
the CSR
• generate-rsa-key – Generates a new RSA Keypair for digital authentication. If generating a new RSA Keypair, specify a name for it.
• use-rsa-key – Uses an existing RSA Keypair for digital authentication. If using an
existing RSA Keypair, specify its name.
• use-rsa-key – Uses an existing RSA Keypair for digital authentication
• <RSA-KEYPAIR-NAME> – If generating a new RSA Keypair, specify a name for it.
If using an existing RSA Keypair, specify its name.
subject-name
<COMMON-NAME>
Configures a subject name, defined by the <COMMON-NAME> keyword, to identify
the certificate
• <COMMON-NAME> – Specify the common name used with the CA certificate. The
name should enable you to identify the certificate easily (2 to 64 characters in
length).
<COUNTRY>Sets the deployment country code (2 character ISO code)
<STATE>Sets the state name (2 to 64 characters in length)
<CITY>Sets the city name (2 to 64 characters in length)
<ORGANIZATION>Sets the organization name (2 to 64 characters in length)
<ORGANIZATION-
Sets the organization unit (2 to 64 characters in length)
UNIT>
<EXPORT-TO-URL>Specify the CA’s location. Both IPv4 and IPv6 address formats are supported.
The CSR is exported to the specified location.
email
<SEND-TO-EMAIL>
Exports CSR to a specified e-mail address
• <SEND-TO-EMAIL> – Specify the CA’s e-mail address.
fqdn <FQDN>Exports CSR to a specified FQDN
• <FQDN> – Specify the CA’s FQDN.
ip-address <IP>Exports CSR to a specified device or system
pkiEnables PKI management. Use this command to authenticate, export, generate, or
delete a trustpoint and its associated CA certificates.
Access Point, Wireless Controller and Service Platform CLI Reference Guide
2 - 28
USER EXEC MODE COMMANDS
export trustpoint
<TRUSTPOINT-NAME>
Exports a trustpoint along with CA certificate, Certificate Revocation List (CRL),
server certificate, and private key
• <TRUSTPOINT-NAME> – Specify the trustpoint name (should be authenticated).
<EXPORT-TO-URL>Specify the destination address. Both IPv4 and IPv6 address formats are supported.
The trustpoint is exported to the address specified here.
backgroundOptional. Performs export operation in the background. If selecting this option, you
can optionally specify the device (access point or controller) to perform the export
on
passphrase
<KEY-PASSPHRASE>
background
Optional. Encrypts the key with a passphrase before exporting
• <KEY-PASSPHRASE> – Specify the passphrase to encrypt the trustpoint.
• background – Optional. Performs export operation in the background. After specifying the passphrase, optionally specify the device (access point or controller) to
perform the export on.
on <DEVICE-NAME>The following parameter is recursive and common to the ‘background’ and
‘passphrase’ keywords:
• on <DEVICE-NAME> – Optional. Performs export operation on a specified device
• <DEVICE-NAME> – Specify the name of the AP, wireless controller, or service platform.
Generates a self-signed certificate and a trustpoint
• <TRUSTPOINT-NAME> – Specify a name for the certificate and its trustpoint.
Generates a new RSA Keypair, or uses an existing RSA Keypair
• generate-rsa-key – Generates a new RSA Keypair for digital authentication
• use-rsa-key – Uses an existing RSA Keypair for digital authentication
• <RSA-KEYPAIR-NAME> – If generating a new RSA Keypair, specify a name for it.
If using an existing RSA Keypair, specify its name.
subject-name
<COMMON-NAME>
Configures a subject name, defined by the <COMMON-NAME> keyword, to identify
the certificate
• <COMMON-NAME> – Specify the common name used with this certificate. The name
should enable you to identify the certificate easily and should not exceed 2 to 64
characters in length.
<COUNTRY>Sets the deployment country code (2 character ISO code)
<STATE>Sets the state name (2 to 64 characters in length)
<CITY>Sets the city name (2 to 64 characters in length)
<ORGANIZATION>Sets the organization name (2 to 64 characters in length)
<ORGANIZATION-
Sets the organization unit (2 to 64 characters in length)
UNIT>
email
<SEND-TO-EMAIL>
Optional. Exports the self-signed certificate to a specified e-mail address
• <SEND-TO-EMAIL> – Specify the e-mail address.
fqdn <FQDN>Optional. Exports the self-signed certificate to a specified FQDN
• <FQDN> – Specify the FQDN.
ip-address <IP>Optional. Exports the self-signed certificate to a specified device or system
pkiEnables PKI management. Use this command to authenticate, export, generate, or
delete a trustpoint and its associated CA certificates.
importImports certificates, CRL, or a trustpoint to the selected device
trustpoint
<TRUSTPOINT-NAME>
Imports a trustpoint and its associated CA certificate, server certificate, and private
key
• <TRUSTPOINT-NAME> – Specify the trustpoint name (should be authenticated).
<IMPORT-FROM-URL> Specify the trustpoint source address. Both IPv4 and IPv6 address formats are
supported.
backgroundOptional. Performs import operation in the background. If selecting this option, you
can optionally specify the device (access point or controller) to perform the import
on.
passphrase
<KEY-PASSPHRASE>
background
Optional. Decrypts trustpoint with a passphrase after importing
• <KEY-PASSPHRASE> – Specify the passphrase. After specifying the passphrase,
optionally specify the device to perform import on.
• background – Optional. Performs import operation in the background. After specifying the passphrase, optionally specify the device (access point or controller) to
perform the import on.
on <DEVICE-NAME>The following parameter is recursive and optional:
• on <DEVICE-NAME> – Optional. Performs import operation on a specified device
• <DEVICE-NAME> – Specify the name of the AP, wireless controller, or service platform.
rfs6000-81742D>crypto key import rsa test123 url passphrase word background
RSA key import operation is started in background
rfs6000-81742D>
rfs6000-81742DE>crypto pki generate self-signed word generate-rsa-key word
autogen-subject-name fqdn word
Successfully generated self-signed certificate
rfs6000-81742D>
rfs6000-81742D>crypto pki zeroize trustpoint word del-key
Successfully removed the trustpoint and associated certificates
%Warning: Applications associated with the trustpoint will start using defaulttrustpoint
rfs6000-81742D>
rfs6000-81742D>crypto pki authenticate word url background
Import of CA certificate started in background
rfs6000-81742D>
rfs6000-81742D>crypto pki import trustpoint word url passphrase word
Import operation started in background
rfs6000-81742D>
Related Commands
noRemoves server certificates, trustpoints and their associated certificates
Access Point, Wireless Controller and Service Platform CLI Reference Guide
2 - 32
USER EXEC MODE COMMANDS
2.1.9 crypto-cmp-cert-update
User Exec Commands
Triggers a Certificate Management Protocol (CMP) certificate update on a specified device or devices
crypto-cmp-certupdate
<TRUSTPOINTNAME> on
<DEVICE-NAME>
Example
rfs4000-229D58>crypto-cmp-cert-update test on B4-C7-99-71-17-28
CMP Cert update success
rfs4000-229D58>
Triggers a CMP certificate update on a specified device or devices
• <TRUSTPOINT-NAME> – Specify the target trustpoint name. A trustpoint represents a
CA/identity pair containing the identity of the CA, CA specific configuration
parameters, and an association with an enrolled identity certificate. Use the cryptocmp-policy context mode to configure the trustpoint.
• on <DEVICE-NAME> – Optional. Initiates a CMP certificate update and response on a
specified device or devices. Specify the name of the AP, wireless controller, or service
platform. Multiple devices can be provided as a comma separated list.
• <DEVICE-NAME> – Specify the name of the AP, wireless controller, or service platform.
Access Point, Wireless Controller and Service Platform CLI Reference Guide
2 - 33
USER EXEC MODE COMMANDS
2.1.10 database
User Exec Commands
Enables automatic repairing (vacuuming) and dropping of captive-portal and NSight databases
If enforcing authenticated access to the database, use this command to generate the keyfile. Every keyfile
has a set of associated users having a username and password. Access to the database is allowed only if
the user credentials entered during database login are valid. For more information on enabling database
authentication, see Enabling Database Authentication.
Drops (deletes) all or a specified database. Execute the command on the database.
• all – Drops all databases, captive portal and NSight
• captive-portal – Drops the captive-portal database
• nsight – Drops the NSight database
Enables automatic repairing of all databases. Repairing (vacuuming a database refers
to the process of finding and reclaiming space left over from previous DELETE
statements. Execute the command on the database host.
• on <DEVICE-NAME> – Optional. Specifies the name of the database host. When
specified, databases on the specified host are periodically checked to identify and
remove obsolete data documents.
• <DEVICE-NAME> – Specify the name of the
access point, wireless controller, or ser-
vice platform.
Note: If no device is specified, the system repairs all databases.
Access Point, Wireless Controller and Service Platform CLI Reference Guide
2 - 34
• database keyfile generate
USER EXEC MODE COMMANDS
database keyfile
[generate|zerzoise]
• database keyfile [export|import] <URL>
database keyfile
[export|import]
<URL>
Enables database keyfile management. This command is part of a set of
configurations required to enforce database authentication. Use this command to
generate database keyfiles. After generating the keyfile, create the username and
password combination required to access the database. For information on creating
database users see,
service. For information on enabling database authentication, see
Enabling Database Authentication.
• generate – Generates the keyfile. In case of a replica-set deployment, execute the
command on the primary database host. Once generated, export the keyfile to a
specified location from where it is imported on to the replica-set hosts.
Enables database keyfile management. This command is part of a set of
configurations required to enforce database authentication. Use this command to
exchange keyfiles between replica set members.
• export – Exports the keyfile to a specified location on an FTP/SFTP/TFTP server.
Execute the command on the database host on which the keyfile has been generated.
• import – Imports the keyfile from a specified location. Execute the command on the
replica set members.
The following parameter is common to both of the above keywords:
• <URL> – Specify the location to/from where the keyfile is to be exported/imported.
Use one of the following options to specify the keyfile location:
Follow the steps below to enable database authentication.
1On the primary database host,
a Generate the database keyfile.
Primary-DB-HOST>database keyfile generate
Database keyfile successfully generated
Primary-DB-HOST
>
bUse the show > database > keyfile command to view the generated keyfile.
c Export the keyfile to an external location. This is required only in case of database replica-set
database-backupBacks up captive-portal and/or NSight database to a specified location and file on an
FTP or SFTP server
database-restoreRestores a previously exported database [captive-portal and/or NSight]
database-policyDocuments database-policy configuration commands. Use this option to enable the
database.
database-clientpolicy
Documents database-client-policy configuration commands. Use this option to
configure the database host details (IP address or hostname). If enforcing database
authentication, use it to configure the users having database access. Once configured,
use the policy in the NSight/EGuest server’s device config context.
serviceDocuments the database user account configuration details
Access Point, Wireless Controller and Service Platform CLI Reference Guide
2 - 37
USER EXEC MODE COMMANDS
2.1.11 database-backup
User Exec Commands
Backs up captive-portal and/or NSight database to a specified location and file on an FTP, SFTP, or TFTP
server. Execute this command on the database host.
Backs up captive portal and/or NSight database to a specified location. Select the
database to backup:
• captive-portal – Backs up captive portal database
• nsight – Backs up NSight database
After specifying the database type, configure the destination location.
<URL>Configures the destination location. The database is backed up at the specified
location. Specify the location URL in one of the following formats:
ftp://<user>:<passwd>@<hostname|IP>[:port]/path/file.tar.gz
sftp://<user>:<passwd>@<hostname|IP>[:port]/path/file.tar.gz
Backs up the NSight access point placement related details to a specified location
• <URL> – Specify the URL in one of the following formats:
ftp://<user>:<passwd>@<hostname|IP>[:port]/path/file.tar.gz
sftp://<user>:<passwd>@<hostname|IP>[:port]/path/file.tar.gz
tftp://<hostname|IP>[:port]/path/file.tar.gz
Example
NS-DB-nx9510-6C87EF>database-backup database nsight tftp://192.168.9.50/testbckup
NS-DB-nx9510-6C87EF>show database backup-status
Last Database Backup Status : In_Progress(Starting tftp transfer.)
Last Database Backup Time : 2017-04-17 12:48:05
NS-DB-nx9510-6C87EF>show database backup-status
Last Database Backup Status : Successful
Last Database Backup Time : Mon Apr 17 12:48:08 IST 2017
NS-DB-nx9510-6C87EF>Apr 17 12:48:17 2017: NS-DB-nx9510-6C87EF : %DATABASE-6OPERATION_COMPLETE: backup for database nsight successful
NS-DB-nx9510-6C87EF#
Access Point, Wireless Controller and Service Platform CLI Reference Guide
8.9.50/plmentinfo
NS-DB-nx9510-6C87EF>show database backup-status
Last Database Backup Status : Successful
Last Database Backup Time : Mon Apr 17 12:48:48 IST 2017
NS-DB-nx9510-6C87EF>Apr 17 12:49:03 2017: NS-DB-nx9510-6C87EF : %DATABASE-6-
OPERATION_COMPLETE: backup for database nsight-placement-info successful
NS-DB-nx9510-6C87EF>
Related Commands
databaseEnables automatic repairing (vacuuming) and dropping of databases (captive-portal
and/or NSight)
database-restoreRestores a previously exported (backed up) database (captive-portal and/or NSight)]
Access Point, Wireless Controller and Service Platform CLI Reference Guide
2 - 39
USER EXEC MODE COMMANDS
2.1.12 database-restore
User Exec Commands
Restores a previously exported database [captive-portal and/or NSight]. Previously exported databases
(backed up to a specified FTP or SFTP server) are restored from the backed-up location to the original
database.
After specifying the database type, configure the destination location and file name
from where the files are restored.
location. Specify the location URL in one of the following formats:
ftp://<user>:<passwd>@<hostname|IP>[:port]/path/file.tar.gz
sftp://<user>:<passwd>@<hostname|IP>[:port]/path/file.tar.gz
tftp://<hostname|IP>[:port]/path/file.tar.gz
databaseEnables automatic repairing (vacuuming) and dropping of databases (captive-portal
and NSight)
database-backupBacks up captive-portal and/or NSight database to a specified location and file on an
FTP or SFTP server
Access Point, Wireless Controller and Service Platform CLI Reference Guide
2 - 40
USER EXEC MODE COMMANDS
2.1.13 device-upgrade
User Exec Commands
Enables firmware upgrade on an adopted device or a set of adopted devices (access points, wireless
controllers, and service platforms).
In an hierarchically managed (HM) network, this command enables centralized device upgradation across
the network. The WiNG HM network defines a three-tier structure, consisting of multiple wireless sites
managed by a single Network Operations Center (NOC) controller. The NOC controller constitutes the first
and the site controllers constitute the second tier of the hierarchy. The site controllers in turn adopt and
manage access points that form the third tier of the hierarchy.
NOTE: Hierarchical management allows the NOC controller to upgrade
controllers and access points that are directly or indirectly adopted to it.
However, ensure that the NOC controller is loaded with the correct firmware
version.
Use the device-upgrade command to schedule firmware upgrades across adopted devices within the
network. Devices are upgraded based on their device names, MAC addresses, or RF Domain.
NOTE: If the persist-images option is selected, the RF Domain manager
retains the old firmware image, or else deletes it. For more information on
enabling device upgrade on profiles and devices (including the ‘persistimages’ option), see device-upgrade.
NOTE: A NOC controller’s capacity is equal to, or higher than that of a site
controller. The following devices can be deployed at NOC and sites:
• NOC controller – NX95XX (NX9500 and NX9510), NX9600, VX9000
• Site controller – RFS4000, RFS6000, NX5500, or NX95XX
Optional. Schedules an automatic device firmware upgrade on a specified day and
time
• <TIME> – Specify the upgrade time in the MM/DD/YYYY-HH:MM or HH:MM format.
The following actions can be performed after a scheduled upgrade:
• no-reboot – Optional. Disables automatic reboot after a successful upgrade (the
device must be manually restarted)
• reboot-time <TIME> – Optional. Schedules an automatic reboot after a successful
upgrade. Specify the reboot time in the MM/DD/YYYY-HH:MM or HH:MM format.
• device-upgrade all {force|no-reboot|reboot-time <TIME>|upgrade-time <TIME>
{no-reboot|reboot-time <TIME>}} {(staggered-reboot)}
allUpgrades firmware on all devices
forceOptional. Select this option to force upgrade on the selected device(s). When
selected, the devices are upgraded even if they have the same firmware as the
upgrading access point, wireless controller, or service platform. If forcing a device
upgrade, optionally specify any one of the following options: no-reboot, reboot-time,
upgrade-time, or staggered-reboot.
no-rebootOptional. Disables automatic reboot after a successful upgrade (the device must be
manually restarted)
reboot-time <TIME>Optional. Schedules an automatic reboot after a successful upgrade
• <TIME> – Specify the reboot time in the MM/DD/YYYY-HH:MM or HH:MM format.
Access Point, Wireless Controller and Service Platform CLI Reference Guide
Optional. Schedules an automatic device firmware upgrade on all devices on a
specified day and time
• <TIME> – Specify the upgrade time in the MM/DD/YYYY-HH:MM or HH:MM format.
The following actions can be performed after a scheduled upgrade:
• no-reboot – Optional. Disables automatic reboot after a successful upgrade (the
device must be manually restarted).
• reboot-time <TIME> – Optional. Schedules an automatic reboot after a successful
upgrade. Specify the reboot time in the MM/DD/YYYY-HH:MM or HH:MM format.
staggered-rebootThis keyword is recursive and common to all of the above.
• Optional. Enables staggered device reboot (one at a time) without network impact
• device-upgrade [ap6521|ap6522|ap6532|ap6562|ap71xx|ap7502|ap7522|ap7532|
ap7562|ap7602|ap7612|ap7622|ap7632|ap7662|ap81xx|ap82xx|ap8432|ap8533|rfs4000|
rfs6000|nx5500|nx75xx|nx9000|nx9600|vx9000] all {force|no-reboot|reboot-time
Upgrades firmware on all devices of a specific type. Select the device type. The
options are: AP6521, AP6522, AP6532, AP6562, AP7161, AP7502, AP7522, AP7532,
AP7562, AP7602, AP7612, AP7622, AP7632, AP7662, AP81XX, AP8232, AP8432,
AP8533, RFS4000, RFS6000, NX5500, NX75XX, NX9500, NX9600, and VX9000.
After selecting the device type, schedule an automatic upgrade and/or an automatic
reboot.
forceOptional. Select this option to force upgrade on the selected device(s). When
selected, the devices are upgraded even if they have the same firmware as the
upgrading access point, wireless controller, or service platform. If forcing a device
upgrade, optionally specify any one of the following options: no-reboot, reboot-time,
upgrade-time, or staggered-reboot.
no-rebootOptional. Disables automatic reboot after a successful upgrade (the device must be
manually restarted)
reboot-time <TIME>Optional. Schedules an automatic reboot after a successful upgrade
• <TIME> – Optional. Specify the reboot time in the MM/DD/YYYY-HH:MM or HH:MM
format.
Optional. Schedules an automatic firmware upgrade on all devices, of the specified
type, on a specified day and time
• <TIME> – Specify the upgrade time in the MM/DD/YYYY-HH:MM or HH:MM format.
The following actions can be performed after a scheduled upgrade:
• no-reboot – Optional. Disables automatic reboot after a successful upgrade (the
device must be manually restarted)
• reboot-time <TIME> – Optional. Schedules an automatic reboot after a successful
upgrade. Specify the reboot time in the MM/DD/YYYY-HH:MM or HH:MM format.
staggered-rebootThis keyword is recursive and common to all of the above.
• Optional. Enables staggered device reboot (one at a time) without network impact
Access Point, Wireless Controller and Service Platform CLI Reference Guide
2 - 43
USER EXEC MODE COMMANDS
• device-upgrade cancel-upgrade [<MAC/HOSTNAME>|all|ap6521|ap6522|ap6532|
ap6562|ap71xx|ap7502|ap7522|ap7532|ap7562|ap7602|ap7612|ap7622|ap7632|ap7662|
ap81xx|ap82xx|ap8432|ap8533|rfs4000|rfs6000|nx5500|nx75xx|nx9000|nx9600|vx9000|
on rf-domain [<RF-DOMAIN-NAME>|all]]
cancel-upgradeCancels a scheduled firmware upgrade based on the parameters passed. This
command provides the following options to cancel scheduled firmware upgrades:
• Cancels upgrade on specific device(s). The devices are identified by their MAC
addresses or hostnames.
• Cancels upgrade on all devices within the network
• Cancels upgrade on all devices of a specific type. Specify the device type.
• Cancels upgrade on specific device(s) or all device(s) within a specific RF Domain or
all RF Domains. Specify the RF Domain name.
cancel-upgrade
[<MAC/HOSTNAME>|
all]
Cancels a scheduled firmware upgrade on a specified device or on all devices
• <MAC/HOSTNAME> – Cancels a scheduled upgrade on the device identified by the
<MAC/HOSTNAME> keyword. Specify the device’s MAC address or hostname.
• all – Cancels scheduled upgrade on all devices
cancel-upgrade
<DEVICE-TYPE> all
Cancels scheduled firmware upgrade on all devices of a specific type. Select the
device type. The options are: AP6521, AP6522, AP6532, AP6562, AP7161, AP7502,
AP7522, AP7532, AP7562, AP7602, AP7612, AP7622, AP7632, AP7662, AP81XX,
AP8232, AP8432, AP8533, RFS4000, RFS6000, NX5500, NX75XX, NX9500,
NX9600, and VX9000.
cancel-upgrade on
rf-domain
[<RF-DOMAINNAME>|all]
Cancels scheduled firmware upgrade on all devices in a specified RF Domain or all
RF Domains
• <RF-DOMAIN-NAME> – Cancels scheduled device upgrade on all devices in a
specified RF Domain. Specify the RF Domain name.
• all – Cancels scheduled device upgrade on all devices across all RF Domains
Specify the name of the device or RF Domain. The image, of the specified device
type is loaded from the device specified here. In case of an RF Domain, the image
available on the RF Domain manager is loaded.
• <DEVICE-OR-DOMAIN-NAME> – Specify the name of the AP, wireless controller,
service platform, or RF Domain.
Upgrades firmware on devices in a specified RF Domain or all RF Domains. Devices
within a RF Domain are upgraded through the RF Domain manager.
• <RF-DOMAIN-NAME> – Upgrades devices in the RF Domain identified by the <RFDOMAIN-NAME> keyword.
• <RF-DOMAIN-NAME> – Specify the RF Domain name.
• all – Upgrades devices across all RF Domains
• containing <WORD> – Filters RF Domains by their names. RF Domains with names
containing the sub-string identified by the <WORD> keyword are filtered. Devices on
the filtered RF Domains are upgraded.
• filter location <WORD> – Filters devices by their location. All devices with location
matching the <WORD> keyword are upgraded.
<DEVICE-TYPE>After specifying the RF Domain, select the device type. The options are: AP6521,
After specifying the RF Domain and the device type, configure any one of the
following actions: force devices to upgrade, or initiate an upgrade through the
adopting controller.
<MAC/HOSTNAME>Optional. Use this option to identify specific devices for upgradation. Specify the
device’s MAC address or hostname. The device should be within the specified RF
Domain and of the specified device type. After identifying the devices to upgrade,
configure any one of the following actions: force devices to upgrade, or initiate an
upgrade through the adopting controller.
Note: If no MAC address or hostname is specified, all devices of the type selected are
upgraded.
forceOptional. Select this option to force upgrade for the selected device(s). When
selected, the devices are upgraded even if they have the same firmware as the
upgrading access point, wireless controller, or service platform. If forcing a device
upgrade, optionally specify any one of the following options: no-reboot, reboot-time,
upgrade-time, or reboot-time.
from-controllerOptional. Upgrades a device through the adopted device. If initiating an upgrade
through the adopting controller, optionally specify any one of the following options:
no-reboot, reboot-time, upgrade-time, or reboot-time.
Access Point, Wireless Controller and Service Platform CLI Reference Guide
2 - 45
USER EXEC MODE COMMANDS
no-reboot
{staggered-reboot}
reboot-time <TIME>
{staggered-reboot}
Optional. Disables automatic reboot after a successful upgrade (the device must be
manually restarted)
Optional. Schedules an automatic reboot after a successful upgrade. Specify the
reboot time in the MM/DD/YYYY-HH:MM or HH:MM format.
staggered-rebootThis keyword is common to all of the above.
Optional. Enables staggered reboot (one at a time) without network impact
• <TIME> – Specify the upgrade time in the MM/DD/YYYY-HH:MM or HH:MM format.
After a scheduled upgrade, the following actions can be performed.
• no-reboot – Optional. Disables automatic reboot after a successful upgrade the
device must be manually restarted)
• reboot-time <TIME> – Optional. Schedules an automatic reboot after a successful
upgrade. Specify the reboot time in the MM/DD/YYYY-HH:MM or HH:MM format.
nx9500-6C8809>show device-upgrade status
Number of devices currently being upgraded : 1
Number of devices waiting in queue to be upgraded : 0
Number of devices currently being rebooted : 0
Number of devices waiting in queue to be rebooted : 0
Number of devices failed upgrade : 0
-------------------------------Total number of devices displayed: 2
nx9500-6C8809>
Access Point, Wireless Controller and Service Platform CLI Reference Guide
2 - 48
USER EXEC MODE COMMANDS
2.1.14 disable
User Exec Commands
This command can be executed in the Priv Exec Mode only. When executed, the command turns off
(disables) the privileged mode command set and returns to the User Executable Mode. The prompt
changes from rfs6000-81742D#
Access Point, Wireless Controller and Service Platform CLI Reference Guide
2 - 49
USER EXEC MODE COMMANDS
2.1.15 enable
User Exec Commands
Turns on (enables) the privileged mode command set. The prompt changes from rfs6000-81742D> to
rfs6000-81742D#. This command does not do anything in the Privilege Executable mode.
Access Point, Wireless Controller and Service Platform CLI Reference Guide
2 - 50
USER EXEC MODE COMMANDS
2.1.16 file-sync
User Exec Commands
Syncs trustpoint and/or EAP-TLS X.509 (PKCS#12) certificate between the staging-controller and adopted
access points.
When enabling file syncing, consider the following points:
•The X.509 certificate needs synchronization only if the access point is configured to use EAP-TLS
authentication.
•Execute the command on the controller adopting the access points.
•Ensure that the X.509 certificate file is installed on the controller.
Syncing of trustpoint/wireless-bridge certificate can be automated. To automate file syncing, in the
controller’s device/profile configuration mode, execute the following command: file-sync [auto|count <1-20>]. For more information, see file-sync.
Note: Both IPv4 and IPv6 address types are supported.
Configures file-syncing parameters
• trustpoint <TRUSTPOINT-NAME> – Syncs a specified trustpoint between controller and
its adopted APs
• <TRUSTPOINT-NAME> – Specify the trustpoint name.
• wireless-bridge – Syncs wireless-bridge certificate between controller and its adopted
APs
After specifying the file that is to be synced, configure following file-sync parameters:
• <DEVICE-NAME> – Syncs trustpoint/certificate with a specified AP. Specify the AP’s
hostname or MAC address.
• all – Syncs trustpoint/certificate with all APs
• rf-domain [<DOMAIN-NAME>|all] – Syncs trustpoint/certificate with all APs in a
specified RF Domain or in all RF Domains
• <DOMAIN-NAME> – Select to sync with APs within a specified RF Domain. Specify
the RF Domain’s name.
• all – Select to sync with APs across all RF Domains
• from-controller – Optional. Loads certificate to the APs from the adopting
controller and not the RF Domain manager
After specifying the access points, specify the following options: reset-radio and
upload-time.
Access Point, Wireless Controller and Service Platform CLI Reference Guide
2 - 52
USER EXEC MODE COMMANDS
reset-radioThis keyword is recursive and applicable to all of the above parameters.
Optional. Resets the radio after file synchronization. Reset the radio in case the
certificate is renewed along with no changes made to the ‘bridge EAP username’ and
‘bridge EAP password’.
upload-time <TIME> This keyword is recursive and applicable to all of the above parameters.
• upload-time – Optional. Schedules certificate upload at a specified time
• <TIME> – Specify the time in the MM/DD/YYYY-HH:MM or HH:MM format. If no time
is configured, the process is initiated as soon as the command is executed.
The following command uploads certificate to all access points:
rfs6000-81742D>file-sync wireless-bridge all upload-time 06/01/2017-23:42
Access Point, Wireless Controller and Service Platform CLI Reference Guide
2 - 53
USER EXEC MODE COMMANDS
2.1.17 join-cluster
User Exec Commands
Adds a device (access point, wireless controller, or service platform), as a member, to an existing cluster of
devices. Assign a static IP address to the device before adding to a cluster. Note, a cluster can be only
formed of devices of the same model type.
join-cluster <IP> user <USERNAME> password <WORD> {level|mode}
join-cluster <IP> user <USERNAME> password <WORD> {level [1|2]|mode
[active|standby]}
Parameters
• join-cluster <IP> user <USERNAME> password <WORD> {level [1|2]|mode
[active|standby]}
join-clusterAdds an access point, wireless controller, or service platform to an existing cluster
<IP>Specify the cluster member’s IP address.
user <USERNAME>Specify a user account with super user privileges on the new cluster member
password <WORD>Specify password for the account specified in the user parameter
level [1|2]Optional. Configures the routing level
• 1 – Configures level 1 routing
• 2 – Configures level 2 routing
mode
[active|standby]
Optional. Configures the cluster mode
• active – Configures this cluster as active
• standby – Configures this cluster to be on standby mode
Usage Guidelines
To add a device to an existing cluster:
•Configure a static IP address on the device (access point, wireless controller, or service platform).
•Provide username and password for superuser, network admin, system admin, or operator
accounts.
After adding the device to a cluster, execute the “write memory” command to ensure the configuration
persists across reboots.
Example
rfs4000-880DA7>join-cluster 192.168.13.15 user admin password superuser level 1
mode standby
... connecting to 192.168.13.15
... applying cluster configuration
... committing the changes
... saving the changes
[OK]
rfs4000-880DA7>
Access Point, Wireless Controller and Service Platform CLI Reference Guide
2 - 54
Loading...
+ hidden pages
You need points to download manuals.
1 point = 1 manual.
You can buy points or you can get point for every manual you upload.