ADX, AnyIO, Brocade, Brocade Assurance, the B-Mobility symbol, DCX, Fabric OS, ICX, MLX, MyBrocade, OpenScript, VCS, VDX,
and Vyatta are registered trademarks, and HyperEdge, The Effortless Network, and The On-Demand Data Center are trademarks
of Brocade Communications Systems, Inc., in the United States and/or in other countries. Other brands, products, or service
names mentioned may be trademarks of their respective owners.
Notice: This document is for informational purposes only and does not set forth any warranty, expressed or implied, concerning
any equipment, equipment feature, or service offered or to be offered by Brocade. Brocade reserves the right to make changes to
this document at any time, without notice, and assumes no responsibility for its use. This informational document describes
features that may not be currently available. Contact a Brocade sales office for information on feature and product availability.
Export of technical data contained in this document may require an export license from the United States government.
The authors and Brocade Communications Systems, Inc. shall have no liability or responsibility to any person or entity with
respect to any loss, cost, liability, or damages arising from the information contained in this book or the computer programs that
accompany it.
The product described by this document may contain “open source” software covered by the GNU General Public License or other
open source license agreements. To find out which open source software is included in Brocade products, view the licensing
terms applicable to the open source software, and obtain a copy of the programming source code, please visit
http://www.brocade.com/support/oscd.
Brocade Communications Systems, Incorporated
Corporate and Latin American Headquarters
Brocade Communications Systems, Inc.
130 Holger Way
San Jose, CA 95134
Tel: 1-408-333-8000
Fax: 1-408-333-8101
E-mail: info@brocade.com
European Headquarters
Brocade Communications Switzerland Sàrl
Centre Swissair
Tour B - 4ème étage
29, Route de l'Aéroport
Case Postale 105
CH-1215 Genève 15
Switzerland
Tel: +41 22 799 5640
Fax: +41 22 799 5641
E-mail: emea-info@brocade.com
Asia-Pacific Headquarters
Brocade Communications Systems China HK, Ltd.
No. 1 Guanghua Road
Chao Yang District
Units 2718 and 2818
Beijing 100020, China
Tel: +8610 6588 8888
Fax: +8610 6588 9999
E-mail: china-info@brocade.com
Asia-Pacific Headquarters
Brocade Communications Systems Co., Ltd. (Shenzhen WFOE)
Citic Plaza
No. 233 Tian He Road North
Unit 1308 – 13th Floor
Guangzhou, China
Tel: +8620 3891 2000
Fax: +8620 3891 2111
E-mail: china-info@brocade.com
• [arp-cache|cdp|crypto|event-history|firewall|ip|spanning-tree] – Indicates that seven keywords are
available for this command and only one can be used at a time
{ }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
RFController> show adoption ....
is documented as
show adoption info {on <DEVICE-OR-DOMAIN-NAME>}
Here:
• show adoption info – The command. This command can also be used as
show adoption info
• {on <DEVICE-OR-DOMAIN-NAME>} – The optional keyword on <device-or-domain-name>. The
command can also be extended as
show adoption info {on <DEVICE-OR-DOMAIN-NAME>}
Here the keyword {on <DEVICE-OR-DOMAIN-NAME>} 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,
RFController>show wireless
is documented as
show wireless
where:
• show – The command
• wireless – The keyword
Related publications
The following Brocade Communications Systems, Inc. documents supplement the information in
this guide and can be located at http://www.brocade.com/ethernetproducts.
• Brocade Mobility RFS Controller System Reference Guide - Describes configuration of the
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
Data Bits8
ParityNone
Stop Bit1
Flow ControlNone
1
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 – Brocade Mobility RFS6000
The above example indicates the command is only available for a Brocade Mobility RFS6000 model
wireless controller.
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 1Hierarchy 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 reserved for tasks that do not change the device’s (wireless controller, service
platform, or AP) configuration.
rfs7000-37FABE>
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.
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.
rfs7000-37FABE# configure terminal
Enter configuration commands, one per line. End with CNTL/Z.
rfs7000-37FABE(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.
rfs7000-37FABE(config)# aaa-policy test
rfs7000-37FABE(config-aaa-policy-test)#
Tab le 1 summarizes available CLI commands.
TABLE 1Controller CLI Modes and Commands
User Exec ModePriv Exec ModeGlobal Configuration Mode
User Exec ModePriv Exec ModeGlobal Configuration Mode
write
clrscr
commit
do
end
exit
revert
service
show
Getting Context Sensitive Help
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.
1
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
The system prompt varies depending on the configuration mode.
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 ?
The escape character used through out the CLI is “\”. To enter a "\" use "\\" instead.
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.
rfs7000-37FABE#service?
service Service Commands
rfs7000-37FABE#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.
rfs7000-37FABE#service ?
advanced-wips Advanced WIPS service commands
block-adopter-config-update Block configuration updates from the
adopter
clear Clear adoption history
cli-tables-skin Choose a formatting layout/skin for CLI
tabular outputs
cluster Cluster Protocol
copy Copy from one file to another
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
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 validation mode
show Show running system information
signal Send a signal to a process
smart-rf Smart-RF Management Commands
ssm Command related to ssm
start-shell Provide shell access
trace Trace a process for system calls and
signals
wireless Command related to wireless
rfs7000-37FABE#
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:
rfs7000-37FABE>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
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?').
rfs7000-37FABE>
Using the No Command
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
1
no keyword to re-enable a disabled feature.
Basic Conventions
Keep the following conventions in mind while working within the CLI structure:
• Use ? at the end of a command to display available sub-modes. Type the first few characters of
the sub-mode and press the tab key to add the sub-mode. 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.
Using CLI Editing Features and Shortcuts
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
Moving the Cursor on the Command Line
Tab le 2 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. In
Tab le 2, bold characters indicate the relation between a letter and its function.
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 line
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 with the
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.
character located at the cursor
Completing a Partial Command Name
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.
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
In the following example, the CLI recognizes a unique string in the privileged EXEC mode when the
Tab key is pressed:
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 that set of characters. Do not
leave a space between the last letter and the question mark (?).
For example, entering U lists all commands available in the current command mode:
rfs7000-37FABE#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
rfs7000-37FABE#
The characters entered before the question mark are reprinted to the screen to complete the
command entry.
Command Output pagination
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.
Creating Profiles
Profiles are sort of a ‘template’ representation of configuration. The system has:
• a default profile for each of the following devices:
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. Brocade recommends using SSH
for remote administration tasks.
Configuring Telnet for Management Access
Login through the serial console. Perform the following:
1. A session generally begins in the USER EXEC mode (one of the two access levels of the EXEC
mode).
2. Access the GLOBAL CONFIG mode from the PRIV EXEC mode.
rfs7000-37FABE> en
rfs7000-37FABE# configure terminal
Enter configuration commands, one per line. End with CNTL/Z.
4. Enter Telnet and the port number at the command prompt. The port number is optional. The
default port is 23. Commit the changes after every command. Telnet is enabled.
5. Connect to the controller through Telnet using its configured IP address. Use the following
credentials when logging on to the device for the first time:
When logging into the controller for the first time, you are prompted to change the password.
To change user credentials:
1. Enter the username, password, role and access details.
rfs7000-37FABE(config-management-policy-default)#user testuser password
admin123
role helpdesk access all
rfs7000-37FABE(config-management-policy-default)# commit
rfs7000-37FABE(config-management-policy-default)#show context
management-policy default
telnet
http server
https server
ssh
user admin password 1
ba7da2bf2f7945af1d3ae1b8b762b541bd5bac1f80a54cd4488f38ed44b91ecd role
superuser access all
user operator password 1
0be97e9e30d29dfc4733e7c5f74a7be54570c2450e855cea1a696b0558a40401 role monitor
access all
user testuser password 1
bca381b5b93cddb0c209e1da8a9d387fa09bfae14cc987438a4d144cb516ffcb role
helpdesk access all
snmp-server community public ro
snmp-server community private rw
snmp-server user snmptrap v3 encrypted des auth md5 0
snmp-server user snmpoperator v3 encrypted des auth md5 0 operator
snmp-server user snmpmanager v3 encrypted des auth md5 0
rfs7000-37FABE(config-management-policy-default)#
2. Logon to the Telnet console and provide the user details configured in the previous step to
access the controller.
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 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
debug Debugging functions
device-upgrade Device firmware upgrade
disable Turn off privileged mode command
enable Turn on privileged mode command
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
page Toggle paging
ping Send ICMP echo messages
revert Revert changes
service Service Commands
show Show running system information
smart-cache Content Cache Operation
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
virtual-machine Virtual Machine
watch Repeat the specific CLI command at a periodic
interval
write Write running configuration to memory or
terminal
2
clrscr Clears the display screen
exit Exit from the CLI
<OLD-PASSWORD>Optional. Specify the password to be changed.
<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.
Example
rfs7000-37FABE>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.
rfs7000-37FABE#write memory
OK
rfs7000-37FABE>
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.
Supported in the following platforms:
• Access Points — Brocade Mobility 650 Access Point, Brocade Mobility 6511 Access Point,
Brocade Mobility 1220 Access Point, Brocade Mobility 71XX Access Point, Brocade
Mobility 1240 Access Point
countersClears counters based on the parameters passed. The options are: AP, radio, and wireless clients.
br <MAC>Clears counters for all APs or a specified AP
• <MAC> – Optional. Specify the AP’s MAC address.
If no MAC address is specified, all AP counters are cleared.
radio
<MAC/DEVICE-NAME>
<1-3>
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-3> – Optional. Identifies the radio interface by its index. Specify the radio interface
index, if not specified as part of the radio ID.
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-OR-DOMAIN-NAME
>
This keyword is common to all of the above keywords.
• on <DEVICE-OR-DOMAIN-NAME> – Optional. Clears AP, radio, or wireless client counters on a specified
AP, wireless controller, service platform, or RF Domain.
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>}
cryptoClears encryption module database
ipsec sa
{on <DEVICE-NAME>}
gre statsClears GRE tunnel statistics
on <DEVICE-NAME>Optional. GRE tunnel statistics on a specified device
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.
clear gre stats {on <DEVICE-NAME>}
• <DEVICE-NAME> – Specify the name of the AP, wireless controller, or service platform.
clear event-history
event-historyClears event history cache entries
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.
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.
mac-address-tableClears the MAC address forwarding table
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 Ethernet interfaces supported varies for different device types. Brocade Mobility RFS4000
supports 5 GE interfaces.
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. Brocade Mobility
RFS4000 supports 3 port-channels.
t1e1 <1-4> <1-1>Clears MAC address forwarding table for the specified T1E1L interface
• <1-4> – Specify the T1E1 interface index from 1 - 4. A maximum of 4 slots are available. Select the
slot to clear the MAC address forwarding table.
up <1-X>Clears MAC address forwarding table for the WAN Ethernet interface
The number of WAN Ethernet interfaces supported varies for different devices. The Brocade Mobility
RFS4000 and Brocade Mobility RFS6000 devices support 1 WAN Ethernet interface.
vmif <1-X>Clears MAC address forwarding table for the VM interface
• <1-X> – Specify the VM interface index from 1 - X.
The VMIF interfaces are supported only on the Brocade Mobility RFS9510 series service platforms. The
number of supported VMIFs varies for different device types.
xge <1-4>Clears MAC address forwarding table for the specified TenGigabitEthernet interface
• <1-4> – Specify the GigabitEthernet interface index from 1 - 4.
This interface is supported only on the NX9000 series service platforms.
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.
2
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 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.
Optional. Clears spanning tree entries on different interfaces
• <INTERFACE-NAME> – Clears detected spanning tree entries on a specified interface. Specify
the interface name.
• ge <1-5> – Clears detected spanning tree entries for the selected GigabitEthernet interface.
Select the GigabitEthernet interface index from 1 - 5.
• me1 – Clears FastEthernet interface status
• port-channel <1-3> – Clears detected spanning tree entries for the selected port channel
interface. Select the port channel index from 1 - 3.
• pppoe1 – Clears detected spanning tree entries for Point-to-Point Protocol over Ethernet
(PPPoE) interface
• up1 – Clears detected spanning tree entries for the WAN Ethernet interface
• vlan <1-4094> – Clears detected spanning tree entries for the selected VLAN interface. Select
a Switch Virtual Interface (SVI) VLAN ID from 1- 4094.
• wwan1 – Clears detected spanning tree entries for wireless WAN interface.
• <DEVICE-NAME> – Specify the name of the AP, wireless controller, or service platform.
clear vrrp [error-stats|stats] {on <DEVICE-NAME>}
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.
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 balance 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.
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
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.
Supported in the following platforms:
• Access Points — Brocade Mobility 650 Access Point, Brocade Mobility 6511 Access Point,
Brocade Mobility 1220 Access Point, Brocade Mobility 71XX Access Point, Brocade
Mobility 1240 Access Point
keyEnables RSA Keypair management. Use this command to export, import, generate, or delete a RSA key.
zeroize rsa
<RSA-KEYPAIR-NAME>
force
{on <DEVICE-NAME>}
on <DEVICE-NAME>Optional. Deletes all certificates associated with the RSA Keypair on a specified device
Deletes a specified RSA Keypair
• <RSA-KEYPAIR-NAME> – Specify the RSA Keypair name.
NOTE: All device certificates associated with this key will also be deleted.
Optional. Forces deletion of all certificates associated with the specified RSA Keypair. Optionally specify a
device on which to force certificate deletion.
• <DEVICE-NAME> – Specify the name of the AP, wireless controller, or service platform.
crypto pki authenticate <TRUSTPOINT-NAME> <URL> {background {on
<DEVICE-NAME>}|
on <DEVICE-NAME>}
pkiEnables Private Key Infrastructure (PKI) management. Use this command to authenticate, export,
generate, or delete a trustpoint and its associated Certificate Authority (CA) certificates.
rfs7000-37FABE>crypto key import rsa moto123 url passphrase word background on
rfs7000-37FABE
RSA key import operation is started in background
rfs7000-37FABE>
rfs7000-37FABE>crypto pki generate self-signed word generate-rsa-key word
autogen-subject-name fqdn word
Successfully generated self-signed certificate
rfs7000-37FABE>
rfs7000-37FABE>crypto pki zeroize trustpoint word del-key on rfs7000-37FABE
Successfully removed the trustpoint and associated certificates
%Warning: Applications associated with the trustpoint will start using
default-trustpoint
rfs7000-37FABE>
rfs7000-37FABE>crypto pki authenticate word url background on rfs7000-37FABE
Import of CA certificate started in background
rfs7000-37FABE#>
rfs7000-37FABE>crypto pki import trustpoint word url passphrase word on
rfs7000-37FABE
Import operation started in background
rfs7000-37FABE>
Related Commands:
noRemoves server certificates, trustpoints and their associated certificates
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 Mobility 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 may
or may not be grouped to form clusters. The site controllers in turn adopt and manage access
points that form the third tier of the hierarchy.
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.
All adopted devices (access points and second-level controllers) are referred to as the ‘adoptee’.
The adopting devices are the ‘adopters’. A controller cannot be configured as an adoptee and an
adopter simultaneously. In other words, a controller can either be an adopter (adopts another
controller) or an adoptee (is adopted by another controller).
Network administrators can 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. The firmware image used for the upgrade can either be
user-defined or built-in.
The user-defined image is pulled from the defined location and applied to the device(s). Use the
device-upgrade > load-image command to provide the image file name and location. User-defined
images always get precedence over built-in images.
NOC and site controllers possess built-in firmware images for the various device types. If the
administrator has not specified an image file name and location, the image on the controller is
used to upgrade the device. The following example describes the various scenarios possible in the
absence of a user-defined image.
A site controller has been scheduled to upgrade all adopted APs. Before executing the upgrade, the
site controller compares the image it possesses with the image on the NOC controller. In case of an
image version mismatch, the site controller does the following:
1. If the site controller is a cluster member, it pulls the image:
• From a cluster peer, provided the AP image version on the peer and the NOC controller
matches.
• From the NOC controller, if the AP image version on the peer and the NOC controller are
mismatched.
• From the NOC controller, if none of the cluster members possess a AP image.
2. If the site controller is not a cluster member, it pulls the image from the NOC controller.
When upgrading devices in a RF Domain, the process is controlled and driven by the NOC
controller. For example, in case of a scheduled upgrading of all APs within an RF Domain, the NOC
controller:
1. Adopts all controllers, in the RF Domain, to the NOC cluster and gets the status of each
controller.
2. Upgrades all controllers, in the cluster, without rebooting them.
Once the upgrade is completed, the following two scenarios are possible:
Scenario 1: If the upgrade/reboot options ARE NOT specified by the network
administrator, the NOC controller:
a. Pushes the AP image on to the RF Domain manager.
b. Reboots the active controller within the RF Domain.
c. Reboots standby controllers after the active controller has successfully rebooted.
If the controllers are auto upgrade enabled, all APs are upgraded after the controllers have
rebooted and the APs have been re-adopted.
Scenario 2: If the upgrade/reboot options ARE specified by the network administrator, the
NOC controller:
a. Reboots the active controller followed by the standby controllers.
b. Pushes the AP image file on to the RF Domain manager.
c. Initiates upgrades on all AP within the RF Domain.
Ensure the RF Domain controllers are auto upgrade enabled.
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 ‘persist-images’ option), see device-upgrade.
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:
- Site controller – Brocade Mobility RFS4000, Brocade Mobility RFS6000, and Brocade Mobility
RFS7000
Within a HM network, the devices deployed as site controllers depends on the NOC controller device
type. For more information on the adoption capabilities of various NOC controller devices, see Usage
Guidelines (NOC controller adoption matrix).
Standalone devices have to be manually upgraded.
Supported in the following platforms:
• Access Points — Brocade Mobility 650 Access Point, Brocade Mobility 6511 Access Point,
Brocade Mobility 1220 Access Point, Brocade Mobility 71XX Access Point, Brocade
Mobility 1240 Access Point
br71xx-0F43D8 failed 2013-01-05 00:21:08 3 00-23-68-22-9D-58
Update error: Unable to get update file, failure in ftp/openssl/tar
ap6532-986C50 failed 2013-01-05 00:26:31 3 00-23-68-22-9D-58
Update error: Bad file, failure in tar. tar: invalid tar magic
Total number of entries displayed: 2
rfs4000-229D58>
This command can be executed in the Priv Exec Mode only. This command turns off (disables) the
privileged mode command set and returns to the User Executable Mode. The prompt changes from
rfs7000-37FABE# to rfs7000-37FABE>.
Supported in the following platforms:
• Access Points — Brocade Mobility 650 Access Point, Brocade Mobility 6511 Access Point,
Brocade Mobility 1220 Access Point, Brocade Mobility 71XX Access Point, Brocade
Mobility 1240 Access Point
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.
join-cluster <IP> user <USERNAME> password <WORD> {level [1|2]|mode
[active|standby]}
join-clusterAdds a 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.
2
After adding the device to a cluster, execute the “write memory” command to ensure the
configuration persists across reboots.
Example
rfs7000-37FABE#join-cluster 172.16.10.10 user admin password admin123
Joining cluster at 172.16.10.10... Done
Please execute “write memory” to save cluster configuration.
rfs7000-37FABE#
nx6500-31FABE#join-cluster 172.16.10.10 user admin password admin123
Joining cluster at 172.16.10.10... Done
Please execute “write memory” to save cluster configuration.
nx6500-31FABE#
Related Commands:
clusterInitiates cluster context. The cluster context enables centralized management and configuration of all cluster
members from any one member.
create-clusterCreates a new cluster on a specified device
l2tpv3
User Exec Commands
Establishes or brings down an Layer 2 Tunnel Protocol Version 3 (L2TPV3) tunnel
mint traceroute <MINT-ID> {(destination-port <1-65535>|max-hops <1-255>|
NOTE
source-port <1-65535>|timseout <1-255>)}
traceroute <MINT-ID>Prints the route packets trace to a device
• <MINT-ID> – Specify the destination device’s MiNT ID.
destination-port
<1-65535>
max-hops <1-255>Optional. Sets the maximum number of hops a traceroute packet traverses in the forward direction
Optional. Sets the Equal-cost Multi-path (ECMP) routing destination port
• <1-65535> – Specify a value from 1 - 65535. The default port is 45.
• <1-255> – Specify a value from 1 - 255. The default is 30.
source-port
<1-65535>
timeout <1-255>Optional. Sets the minimum response time period in seconds
Optional. Sets the ECMP source port
• <1-65535> – Specify a value from 1 - 65535. The default port is 45.
• <1-65535> – Specify a value from 1 sec - 255 sec. The default is 30 seconds.
Example
rfs7000-37FABE>mint ping 70.37.FA.BF count 20 size 128
MiNT ping 70.37.FA.BF with 128 bytes of data.
Response from 70.37.FA.BF: id=1 time=0.292 ms
Response from 70.37.FA.BF: id=2 time=0.206 ms
Response from 70.37.FA.BF: id=3 time=0.184 ms
Response from 70.37.FA.BF: id=4 time=0.160 ms
Response from 70.37.FA.BF: id=5 time=0.138 ms
Response from 70.37.FA.BF: id=6 time=0.161 ms
Response from 70.37.FA.BF: id=7 time=0.174 ms
Response from 70.37.FA.BF: id=8 time=0.207 ms
Response from 70.37.FA.BF: id=9 time=0.157 ms
Response from 70.37.FA.BF: id=10 time=0.153 ms
Response from 70.37.FA.BF: id=11 time=0.159 ms
Response from 70.37.FA.BF: id=12 time=0.173 ms
Response from 70.37.FA.BF: id=13 time=0.156 ms
Response from 70.37.FA.BF: id=14 time=0.209 ms
Response from 70.37.FA.BF: id=15 time=0.147 ms
Response from 70.37.FA.BF: id=16 time=0.203 ms
Response from 70.37.FA.BF: id=17 time=0.148 ms
Response from 70.37.FA.BF: id=18 time=0.169 ms
Response from 70.37.FA.BF: id=19 time=0.164 ms
Response from 70.37.FA.BF: id=20 time=0.177 ms
2
--- 70.37.FA.BF ping statistics --20 packets transmitted, 20 packets received, 0% packet loss
round-trip min/avg/max = 0.138/0.177/0.292 ms
rfs7000-37FABE>
no
User Exec Commands
Use the
turns off an enabled feature or reverts settings to default.
The commands have their own set of parameters that can be reset.
no
[adoption|captive-portal|crypto|debug|logging|mac-user-db|page|service|termin
al|
virtual-machine|wireless]
no adoption {on <DEVICE-OR-DOMAIN-NAME>}
no captive-portal client [captive-portal <CAPTIVE-PORTAL-NAME>|mac <MAC>]
{on <DEVICE-OR-DOMAIN-NAME>}
no crypto pki [server|trustpoint]
no crypto pki [server|trustpoint] <TRUSTPOINT-NAME> {del-key {on
<DEVICE-NAME>}|
on <DEVICE-NAME>}
Parameters
no adoption
{on
<DEVICE-OR-DOMAIN-NAME>}
no logging monitor
no mac-user-db user [<USER-NAME>|all]
no page
no service [enable|locator]
no service enable [l2tpv3|radiusd]
no service locator {on <DEVICE-NAME>}
no terminal [length|width]
no virtual-machine assign-usb-ports {on <DEVICE-NAME>}
no wireless client [all|<MAC>]
no wireless client all {filter|on}
no wireless client all {filter [wlan <WLAN-NAME>]}
no wireless client all {on <DEVICE-OR-DOMAIN-NAME>} {filter [wlan
<WLAN-NAME>]}
no wireless client mac <MAC> {on <DEVICE-OR-DOMAIN-NAME>}
no adoption {on <DEVICE-OR-DOMAIN-NAME>}
Resets the adoption status of a specified device or all devices
• <DEVICE-OR-DOMAIN-NAME> – Optional. Specify the name of the AP, wireless controller, service
platform, or RF Domain. If an RF Domain is specified, the system resets status of all adopted
devices within the specified domain.
no captive-portal client [captive-portal <CAPTIVE-PORTAL-NAME>|mac <MAC>]
{on <DEVICE-OR-DOMAIN-NAME>}
no captive-portal clientDisconnects captive portal clients from the network
captive-portal
<CAPTIVE-PORTAL-NAME>
mac <MAC>Disconnects a client specified by its MAC address
Disconnects clients of the captive portal identified by the <CAPTIVE-PORTAL-NAME> keyword
• <CAPTIVE-PORTAL-NAME> – Specify the captive portal name.
• <MAC> – Specify the client’s MAC address.
on
<DEVICE-OR-DOMAIN-NAME>
no crypto pkiDeletes all PKI authentications
[server|trustpoint]
<TRUSTPOINT-NAME>
Optional. Disconnects clients on a specified device or RF Domain
• <DEVICE-OR-DOMAIN-NAME> – Specify the name of the AP, wireless controller, service platform, or
RF Domain.
no crypto pki [server|trustpoint] <TRUSTPOINT-NAME> {del-key {on
<DEVICE-NAME>}|
on <DEVICE-NAME>}
Deletes PKI authentications, such as server certificates and trustpoints
• server – Deletes server certificates
• trustpoint – Deletes a trustpoint and its associated certificates
The following keyword is common to the ‘server’ and ‘trustpoint’ parameters:
• <TURSTPOINT-NAME> – Deletes a trustpoint or its server certificate. Specify the
trustpoint name.
del-key
{on <DEVICE-NAME>}
Optional. Deletes the private key associated with a server certificate or trustpoint. The operation fails if
the private key is in use by other trustpoints.
• on <DEVICE-NAME> – Optional. Deletes the private key on a specified device
• <DEVICE-NAME> – Specify the name of the AP, wireless controller, or service platform.
2
no logging monitor
no logging monitorResets terminal lines message logging levels
no mac-user-db user [<USER-NAME>|all]
no mac-user-db userDeletes a specified user or all users from the MAC registration user database
This command is available only on the NX9000 series service platforms.
<USER-NAME>Deletes the user, identified by the <USER-NAME> keyword, from the MAC registration user database
• <USER-NAME> – Specify the username.
allDeletes all users from the MAC registration user database
no page
no page Resets paging to its default. Disabling paging displays the CLI command output at once, instead of page
by page.
no service enable [l2tpv3|radiusd]
no serviceDisables specified services or features
enable [l2tpv3|radiusd]Disables the following features:
• l2tpv3 – Disables L2TPV3
• radiusd – Disables loading of the RADIUS server on low memory devices
<IP/HOSTNAME>Specify the destination IP address or hostname. When entered without any parameters, this command
prompts for an IP address or a hostname.
count <1-10000>Optional. Sets the pings to the specified destination
• <1-10000> – Specify a value from 1 - 10000. The default is 5.
dont-fragment
{count|size}
size <1-64000>Optional. Sets the ping payload size in bytes
Optional. Sets the don’t fragment bit in the ping packet. Packets with the dont-fragment bit specified are not
fragmented. When a packet, with the dont-fragment bit specified, exceeds the specified maximum transmission unit (MTU) value, an error message is sent from the device trying to fragment it.
• count <1-10000> – Optional. Sets the pings to the specified destination from 1 - 10000. The default is 5.
• size – <1-64000> – Optional. Sets the size of ping payload size from 1 - 64000 bytes. The default is 100
bytes.
• <1-64000> – Specify the ping payload size from 1 - 64000. The default is 100 bytes.
Example
rfs7000-37FABE>ping 172.16.10.4 count 6
PING 172.16.10.4 (172.16.10.4): 100 data bytes
108 bytes from 172.16.10.4: seq=0 ttl=64 time=0.851 ms
108 bytes from 172.16.10.4: seq=1 ttl=64 time=0.430 ms
108 bytes from 172.16.10.4: seq=2 ttl=64 time=0.509 ms
108 bytes from 172.16.10.4: seq=3 ttl=64 time=0.507 ms
108 bytes from 172.16.10.4: seq=4 ttl=64 time=0.407 ms
108 bytes from 172.16.10.4: seq=5 ttl=64 time=0.402 ms
--- 172.16.10.4 ping statistics --6 packets transmitted, 6 packets received, 0% packet loss
round-trip min/avg/max = 0.402/0.517/0.851 ms
rfs7000-37FABE>
ssh
User Exec Commands
Opens a Secure Shell (SSH) connection between two network devices
Supported in the following platforms:
• Access Points — Brocade Mobility 650 Access Point, Brocade Mobility 6511 Access Point,
Brocade Mobility 1220 Access Point, Brocade Mobility 71XX Access Point, Brocade
Mobility 1240 Access Point
[<IP/HOSTNAME>]Specify the IP address or hostname of the remote system.
<USERNAME>Specify the name of the user requesting SSH connection with the remote system.
Example
rfs7000-37FABE>ssh 172.16.10.4 admin
The authenticity of host '172.16.10.4 (172.16.10.4)' can't be established.
RSA key fingerprint is 82:b7:27:86:de:08:e8:53:9f:d6:a3:88:aa:1f:e8:ff.
Are you sure you want to continue connecting (yes/no)?
2
telnet
User Exec Commands
Opens a Telnet session between two network devices
Supported in the following platforms:
• Access Points — Brocade Mobility 650 Access Point, Brocade Mobility 6511 Access Point,
Brocade Mobility 1220 Access Point, Brocade Mobility 71XX Access Point, Brocade
Mobility 1240 Access Point
108 bytes from 172.16.10.2: seq=2 ttl=64 time=0.458 ms
108 bytes from 172.16.10.2: seq=3 ttl=64 time=0.378 ms
108 bytes from 172.16.10.2: seq=4 ttl=64 time=0.364 ms
--- 172.16.10.2 ping statistics --5 packets transmitted, 5 packets received, 0% packet loss
round-trip min/avg/max = 0.364/0.477/0.725 ms
rfs7000-37FABE>
exit
User Exec Commands
Ends the current CLI session and closes the session window
For more information, see exit.
Supported in the following platforms:
• Access Points — Brocade Mobility 650 Access Point, Brocade Mobility 6511 Access Point,
Brocade Mobility 1220 Access Point, Brocade Mobility 71XX Access Point, Brocade
Mobility 1240 Access Point
Installs, configures, and monitors the status of third-party virtual machines (VMs)
In addition to the Brocade shipped VMs and Brocade Mobility RFS9510 series service platforms
support the installation and administration of third-party VMs. However, the third-party VMs
supported by these devices varies.
The third-party VMs supported on Brocade Mobility RFS9510 are:
• ADSP
• TEAM-CMT
Use the virtual-machine command to install the third-party VMs, and configure parameters, such
as install media type and location, number of Virtual Central Processing Units (VCPUS), VM
memory, VM disk, number of Virtual Network Interfaces (VIFs), and Virtual Networking Computing
(VNC) port.
• on <DEVICE-NAME> – Optional. Executes the command on a specified device or devices
• <DEVICE-NAME> – Specify the service platform name. In case of multiple devices,
list the device names separated by commas.
The VM should be in a stop state during the export process.
If the destination is a device, the image is copied to a predefined location (VM archive)
virtual-machine install <VM-NAME> type [disk|iso disk-size <SIZE>|vm-archive]
install-media [<FILE>|<URL>|<USB>] {autostart|memory|on|vcpus|vif-count|vnc}
virtual-machine installInstalls the VM. The install command internally creates a VM template, consisting of the specified
parameters, and starts the installation process.
• <VM-NAME> – Specify the VM name.
• type – Specify the install-media (image) type. The options are:
• disk – Specifies the install media type as pre-installed OS disk image (located in the flash
memory)
• iso disk-size <SIZE> – Specifies the install media type as ISO file. This is a single file, which
contains the OS bootable install media.
•disk-size <SIZE> – If the install media type is ISO, specify the disk size in GB.
• vm-archive – Specifies the install media type as VM archive. The VM archive file is a tar.gz file
consisting of a pre-installed OS disk image and an associated configuration file. The
configuration is a standard libvirt VM template consisting of VM specific
information.
After specifying the install media type, specify the location of the image. The image can be located in any
of the following supported locations: FLASH, USB, or a remote location, such as http, ftp, sftp, tftp.
install-media
[<FILE>|<URL>|<USB>]
Specifies the install media location
• <FILE> – Specifies the install-media file is located on flash, for example flash:/cache
• <URL> – Specifies the install-media file is located on a remote URL. Provide the URL using one of the
following formats:
tftp://<hostname|IP>[:port]/path/file
ftp://<user>:<passwd>@<hostname|IP>[:port]/path/file
sftp://<user>:<passwd>@<hostname|IP>[:port]>/path/file
http://<hostname|IP>[:port]/path/file
• <USB> – Specifies the install-media file is located on a USB. Provide the USB path and file name
using the following format:
usb<n>:/path/file
After specifying the image location, you may provide the following information:
• autostart – Optional. Specifies whether to autostart the VM on system reboot
• ignore – Enables autostart on each system boot/reboot
• start – Disables autostart (default setting)
• memory – Optional. Defines the VM memory size
• <512-8192> – Specify the VM memory from 512 - 8192 MB. The default is 2048 MB.
• on – Optional. Executes the command on a specified device
• <DEVICE-NAME> – Specify the service platform name.
• vcpus – Optional. Specifies the number of VCPUS for this VM
• <1-4> – Specify the number of VCPUS from 1- 4. The default setting is 4.
Contd...
• vif-count – Optional. Configures or resets the VIF number for this VM
• <0-2> – Specify the VIF number from 0 - 2. the default setting is 1. If assigning a virtual network
interface for the VM, optionally specify the following parameters:
• vif-mac – Sets the MAC index for the virtual interfaces 1 & 2.
• vif-to-vmif – Maps the virtual interface (1 or 2) to the selected VMIF interface. Specify the VMIF
interface index from 1 - 8. VMIFs are layer 2 interfaces on the Mobility bridge. Each custom VM
can have up to a maximum of 2 virtual Ethernet interfaces. By default, these interfaces are
internally
connected to the Dataplane bridge through VMIF1, which is an untagged port with
access VLAN 1.
• vnc – Enables or disables VNC on the virtual interfaces 1 & 2
• vnc – Optional. Disables/enables VNC port. When enabled, provides remote access to VGA through
• autostart – Specifies whether to autostart the VM on system reboot
• ignore – Enables autostart on each system reboot
• start – Disables autostart
• memory – Defines the VM memory size
• <512-8192> – Specify the VM memory from 512 - 8192 MB. The default is 1024 MB.
• vcpus – Specifies the number of VCPUS for this VM
• <1-4> – Specify the number of VCPUS from 1- 4.
• vif-count – Configures or resets the VM’s VIFs
• <0-2> – Specify the VIF number from 0 - 2.
• vif-mac – Configures the MAC address of the selected virtual network interface
• <1-2> – Select the VIF
• <1-8> – Specify the MAC index for the selected VIF
• <MAC> – Specify the customized MAC address for the selected VIF in the
AA-BB-CC-DD-EE-FF format.
Each VM has a maximum of two network interfaces (indexed 1 and 2, referred to as VIF). By default, each
VIF is automatically assigned a MAC from the range allocated for that device. However, you can use the
‘set’ keyword to specify the MAC from within the allocated range. Each of these VIFs are mapped to a layer
2 port in the dataplane (referred to as VMIF). These VMIFs are standard l2 ports on the DP bridge,
supporting all VLAN and ACL commands. Mobility 5.5 supports up to a maximum of 8 VMIFs. By default, a
VM’s interface is always mapped to VMIF1. You can map a VIF to any of the 8 VMIFs. Use the vif-to-vmif
command to map a VIF to a VMIF on the DP bridge.
• vif-to-vmif – Maps the virtual interface (1 or 2) to the selected VMIF interface. Specify the VMIF
interface index from 1 - 8.
Mobility provides a dataplane bridge for external network connectivity for VMs. VM Interfaces define which
IP address is associated with each VLAN ID the service platform is connected to and enables remote
service platform administration. Each custom VM can have up to a maximum of two VM interfaces.
By default, VM interfaces are internally connected to the dataplane bridge via VMIF1. VMIF1, by default, is
an untagged port providing access to VLAN 1 to support the capability to connect the VM interfaces to any
of the VMIF ports. This provides the flexibility to move a VM interface onto different VLANs as well as
configure specific firewall and QOS rules.
• vnc – Disables/enables VNC port option for an existing VM. When enabled, provides remote access
to VGA through the noVNC client.
• disable – Disables VNC port
• enable – Enables VNC port
Contd...
After configuring the VM settings, identify the VM to apply the settings.
• <VM-NAME> – Applies these settings to the VM identified by the <VM-NAME> keyword. Specify the
VM name.
• team-urc – Applies these settings to the VM TEAM-URC
• team-rls – Applies these settings to the VM TEAM-RLS
• team-vowlan – Applies these settings to the VM TEAM-VoWLAN
virtual-machine uninstallUninstalls the specified VM
• <VM-NAME> – Uninstalls the VM identified by the <VM-NAME> keyword. Specify the VM name.
• team-urc – Uninstalls the VM TEAM-URC
• team-rls – Uninstalls the VM TEAM-RLS
• team-vowlan – Uninstalls the VM TEAM-VoWLAN
The following keywords are common to all of the above parameters:
• on <DEVICE-NAME> – Optional. Executes the command on a specified device or devices
• <DEVICE-NAME> – Specify the service platform name. In case of multiple devices,
list the device names separated by commas.
This command releases the VM’s resources, such as memory, VCPUS, VNC port, disk space, and removes
the RF Domain reference from the system.
virtual-machine consoleConnects to the ADSP or TEAM-CMT VM’s console, based on the parameters passed. Select one of the
following console options:
• <VM-NAME> – Connects to the console of the VM identified by the <VM-NAME> keyword. Specify the
VM name.
• adsp – Connects to the Air-Defense Services Platform (ADSP) VM’s management console
• team-cmt – Connects to TEAM-CMT VM’s management console
When ADSP is running on the Brocade Mobility RFS9510 model service platforms, Mobility communicates
with ADSP using a single sign-on (SSO) authentication mechanism. Once the user is logged in, Mobility
gains access to ADSP without being prompted to login again at ADSP. However, the Mobility and ADSP
databases are not synchronized. ADSP has its own user database, stored locally within its VM, which is
accessed whenever a user logs directly into ADSP.
Mobility and ADSP must be consistent in the manner events are reported up through a network hierarchy
to ensure optimal interoperability and event reporting. To provide such consistency, Mobility has added
support for an ADSP-like hierarchal tree. The tree resides within Mobility, and ADSP reads it from Mobility
and displays the network hierarchy in its own ADSP interface. The hierarchal tree can also be used to
launch ADSP modules (like Spectrum Analyzer) directly from Mobility. For more information on configuring
Mobility tree-node structure, see tree-node.
virtual-machine installInstalls the ADSP or TEAM-CMT VM, based on the parameter passed
• on <DEVICE-NAME> – Optional. Executes the command on a specified device or devices
• <DEVICE-NAME> – Specify the service platform name. In case of multiple devices,
list the device names separated by commas.
Before installing the ADSP VM, execute the upgrade command, giving the path and file name of the ADSP
firmware image. This extracts the image on to the device (Brocade Mobility RFS9510) on which the
command has been executed. On successful completion of this process, execute the reload command to
reboot the device. Once the device has been successfully rebooted, execute the virtual-machine > install > adsp command.
For example:
-03-5.5.0.0-072B.img
Aug 20 15:12:51 2013: nx9500-6C874D : %DIAG-6-NEW_LED_STATE: LED state
message FIRMWARE_UPGRADE_STARTED from module led_msg
Running from partition /dev/sda8
Validating image file header
Extracting files (this may take some time).....Aug 20 15:12:53 2013:
virtual-machine set memory <512-8192> [adsp|team-cmt] {on <DEVICE-NAME>}
Modifies the ADSP or TEAM-CMT VM’s memory, in MB, based on the parameter passed. Specify a value
from 512 - 8192 MB.
• on <DEVICE-NAME> – Optional. Executes the command on a specified device or devices
• <DEVICE-NAME> – Specify the service platform name. In case of multiple devices,
list the device names separated by commas.
virtual-machine set Mobility-memory <12288-32739>
Specifies the Mobility memory size in MB
This command is applicable only to the Brocade Mobility RFS9510 service platforms. Use the show >
virtual-machine-configuration command to view the configured memory allocation. Use the show >
virtual-machine-statistics to view the current allocated memory allocation.
• <12288-32739> – Specify a value from 12288 - 32739 MB. The default is 18432 MB.
The new memory setting takes effect only after the next boot.
virtual-machine uninstallUninstalls the ADSP or TEAM-CMT VM based on the parameter passed
• on <DEVICE-NAME> – Optional. Executes the command on a specified device or devices
• <DEVICE-NAME> – Specify the service platform name. In case of multiple devices,
list the device names separated by commas.
Example
The following examples show the VM installation process:
Insatllation media: USB
<DEVICE>#virtual-machine install <VM-NAME> type iso disk-size 8 install-media
usb1://vms/win7.iso autostart start memory 512 vcpus 3 vif-count 2 vnc enable
Installation media: pre-installed disk image
<DEVICE>#virtual-machine install <VM-NAME> type disk install-media
flash:/vms/win7_disk.img autostart start memory 512 vcpus 3 vif-count 2
vnc-enable on <DEVICE-NAME>
In the preceding example, the command is executed on the device identified by
the <DEVICE-NAME> keyword. In such a scenario, the disk-size is ignored if
specified. The VM has the install media as first boot device.
Installation media: VM archive
<DEVICE>#virtual-machine install type vm-archive install-media
flash:/vms/<VM-NAME> vcpus 3
In the preceding example, the default configuration attached with the VM
archive overrides any parameters specified.
Most PRIV EXEC commands set operating parameters. Privileged-level access should be password
protected to prevent unauthorized use. The PRIV EXEC command set includes commands
contained within the USER EXEC mode. The PRIV EXEC mode also provides access to configuration
modes, and includes advanced testing commands.
The PRIV EXEC mode prompt consists of the hostname of the device followed by a pound sign (#).
To access the PRIV EXEC mode, enter the following at the prompt:
<DEVICE>>enable
<DEVICE>#
The PRIV EXEC mode is often referred to as the enable mode, because the enable command is
used to enter the mode.
There is no provision to configure a password to get direct access to PRIV EXEC (enable) mode.
<DEVICE>#?
Privileged command commands:
archive Manage archive files
boot Boot commands
captive-portal-page-upload Captive portal advanced page upload
cd Change current directory
change-passwd Change password
clear Clear
clock Configure software system clock
cluster Cluster commands
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
create-cluster Create a cluster
crypto Encryption related commands
debug Debugging functions
delete Deletes specified file from the system.
device-upgrade Device firmware upgrade
diff Display differences between two files
dir List files on a filesystem
disable Turn off privileged mode command
edit Edit a text file
enable Turn on privileged mode command
erase Erase a filesystem
halt Halt the system
help Description of the interactive help system
join-cluster Join the cluster
l2tpv3 L2tpv3 protocol
logging Modify message logging facilities
mint MiNT protocol
mkdir Create a directory
more Display the contents of a file
no Negate a command or set its defaults
page Toggle paging
ping Send ICMP echo messages
pwd Display current directory
raid RAID operations
re-elect Perform re-election
reload Halt and perform a warm reboot
remote-debug Troubleshoot remote system(s)
rename Rename a file
revert Revert changes
rmdir Delete a directory
self Config context of the device currently logged
into
service Service Commands
show Show running system information
smart-cache Content Cache Operation
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
upgrade Upgrade software image
upgrade-abort Abort an ongoing upgrade
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>#
Privileged Exec Mode Commands
Tab le 1 summarizes the PRIV EXEC Mode commands.
TABLE 1Privileged Exec Commands
CommandDescriptionReference
archiveManages file archive operationspage 78
bootSpecifies the image used after rebootipage 80
captive-portal-pageupload
cdChanges the current directorypage 83
change-passwdChanges the password of a logged userpage 83
clearClears parameters, cache entries, table entries, and other similar entriespage 84
clockConfigures the system clockpage 93
clusterInitiates a cluster contextpage 93
configureEnters the configuration modepage 94
connectBegins a console connection to a remote devicepage 95
tarManipulates (creates, lists or extracts) a tar file
/xtractExtracts content from a tar file
<FILE>Defines tar filename
<URL>Sets the tar file URL
<DIR>Specify a directory name. When used with /create, dir is the source directory for the tar file. When used with
/xtract, dir is the destination file where contents of the tar file are extracted.
Example
Following examples show how to zip the folder flash:/log/?
rfs4000-229D58#dir flash:/
Directory of flash:/
drwx Wed Jan 30 02:45:10 2013 log
drwx Sat Jan 1 00:00:09 2000 configs
drwx Sat Jan 1 00:00:08 2000 cache
drwx Wed Jan 16 22:26:53 2013 crashinfo
drwx Wed Jan 2 22:23:41 2013 testdir
drwx Wed Jan 16 22:57:14 2013 archived_logs
drwx Sat Jan 1 00:00:08 2000 upgrade
drwx Sat Jan 1 00:00:09 2000 hotspot
drwx Sat Jan 1 00:00:09 2000 floorplans
drwx Sat Jan 1 00:00:09 2000 startuplog
drwx Wed Jan 30 02:45:10 2013 log
drwx Sat Jan 1 00:00:09 2000 configs
drwx Sat Jan 1 00:00:08 2000 cache
drwx Wed Jan 16 22:26:53 2013 crashinfo
drwx Wed Jan 2 22:23:41 2013 testdir
drwx Wed Jan 16 22:57:14 2013 archived_logs
drwx Sat Jan 1 00:00:08 2000 upgrade
drwx Sat Jan 1 00:00:09 2000 hotspot
drwx Sat Jan 1 00:00:09 2000 floorplans