Appendix C. Command Line Interface (CLI) for AP Configuration
In addition to the Web based user interface, the Devicescape Reference AP includes a command line interface (CLI) for administering the access point. The CLI lets you view and modify status and configuration information.
From the client station perspective, even a single deployed Devicescape Reference AP broadcasting its "network name" to clients constitutes a wireless network. Keep in mind that CLI configuration commands, like Web UI settings, can affect a single access point running in stand-alone mode or automatically propagate to a network of clustered access points that share the same settings. (For more information on clustering, see Managing Access Points and Clusters.
The following topics provide an introduction to the class structure upon which the CLI is based, CLI commands, and examples of using the CLI to get or set configuration information on an access point or cluster of APs:
Comparison of Settings Configurable with the CLI and Web UI
The command line interface (CLI) and the Web user interface (UI) to the Devicescape Reference AP are designed to suit the preferences and requirements for different types of users or scenarios. Most administrators will probably use both UIs in different contexts. Some features (such as Clustering) can only be configured from the Web UI and, conversely, some details and more complex configurations are only available through the CLI.
The CLI is particularly useful in that it provides an interface to which you can write programmatic scripts for AP configurations. Also, the CLI can be made available through a serial port, so it can be used even if the network connection is not functioning. Finally, the CLI may be less resource-intensive than a Web interface.
The following table shows a feature-by-feature comparison of which settings can be configured through the CLI or the Web UI, and which are configurable with either.
|
Feature or Setting
|
Configurable from CLI
|
Configurable
from Web UI
|
- Getting/changing Administrator Password
- Getting/changing AP name and location
- Viewing information like MAC, IP address, and Firmware version
|
yes
|
yes
|
|
|
Get existing settings only.
You cannot set configuration policy or other cluster features from the CLI.
Use the Web UI to change clustering settings.
|
yes
|
|
|
yes
|
yes
|
|
User Database Backup and Restore
|
You cannot backup or restore a user database from the CLI.
Please use the Web UI to do this as described in Backing Up and Restoring a User Database.
|
yes
|
|
Sessions
|
The CLI does not provide session monitoring information.
Use the Web UI to view client sessions.
|
yes
|
|
Channel Management
|
You cannot configure Channel Management from the CLI.
Please use the Web UI for this as described in Channel Management.
|
yes
|
|
Wireless Neighborhood
|
You cannot view the cluster-based "Wireless Neighborhood" from the CLI.
Please use the Web UI for this as described in Wireless Neighborhood.
|
yes
|
|
|
yes
|
yes
|
|
|
yes
|
yes
|
|
|
yes
|
yes
|
|
|
yes
|
yes
|
|
|
yes
|
yes
|
|
|
yes
|
yes
|
|
|
yes
|
yes
|
|
|
yes
|
yes
|
|
|
yes
|
yes
|
|
|
yes
|
yes
|
|
|
yes
|
yes
|
|
|
yes
|
yes
|
|
|
yes
|
yes
|
|
|
yes
|
|
|
|
yes
|
yes
|
|
|
yes
|
yes
|
|
Backup and Restore
|
You cannot backup or restore an AP configuration from the CLI. Please use the Web UI to configure this feature as described in Backing up and Restoring a Configuration.
|
yes
|
How to Access the CLI for an Access Point
You can use any of these methods to access the command line interface (CLI) for the access point or wireless network:
Serial Port Connection to the AP
If your access point has a serial port (not all do), you can create a direct physical connection into the access point by connecting a cable from a laptop or desktop PC to a serial port on the access point. Then, using terminal emulation software on your PC, you can access the AP system console.
To emulate the AP system console on a serial port connection, you will need to have terminal emulation software installed on your PC (such as TeraTerm, which is available at http://www.ayera.com/teraterm).
Follow these steps to set up the serial port connection, configure the terminal emulation software, and access the CLI.
- Connect one end of the serial cable to the PC and the other end of the cable to the serial port on the access point.
|
Note
|
For a complete description of how to set up access point wired connections, see the Administrators Guide.
|
- Install and configure the Terminal Emulation software on your PC.
To access the Serial Port settings on TeraTerm Pro, choose Setup > Serial Port from the Tera Term menu.
|
Serial Port Options
|
Recommended Settings
|
|
Port
|
COM1
|
|
Baud rate
|
115200
Note: If the Baud rate setting is incorrect, the system console messages will be unreadable.
|
|
Data
|
8 bits
|
|
Parity
|
none
|
|
Stop bits
|
1
|
|
Flow control
|
none
|
|
Note
|
If you are connected to the serial port before changing the Baud rate to the correct setting, you may see same garbled messages. If that happens, change Baud rate. For example, on TeraTerm: (1) Go to "Control" menu and click on "Reset terminal", (2) Change Baud rate, (3) To increase Scroll buffer, go to "Setup" menu and click on "Window" and change the "Scroll buffer" value.
|
Save Setup. When you have configured the Serial Port settings as desired. For example, with TeraTerm choose Setup > Save Setup to save the configuration to a an initialization file (TERRATERM.INI) so that these settings will be used the next time you bring up the Tera Term window. (If you do not save setup, you will have to re-set the Serial Port configuration every time you start Tera Term.)
- Power up the access point.
On the serial console, you will see startup messages as the AP boots up.
When the initialization sequence is complete, the system console displays messages similar to the following:
dman: Initialization complete.
- Press the "Enter" or "Return" key on your PC keyboard to get a command prompt in the command window for your terminal emulation software.
- You will be prompted for an Administrator user name and password for the access point.
Devicescape-AP login:
Password:
Enter the default Administrator username and password for the Devicescape Reference AP (admin, admin), and press "Enter" after each. (The password is masked, so it will not be displayed on the screen.)
When the user name and password is accepted, the screen displays the Devicescape Reference AP help command prompt.
Devicescape-AP login: admin
Password:
Enter 'help' for help.
You are now ready to enter CLI commands at the command line prompt.
Telnet Connection to the AP
If you know already have your network deployed and know the IP address of your access point, you can use a remote "Telnet" connection to the access point to view the system console over the network.
Using Telnet tends to be more convenient than a serial port connection because it gives you remote access the AP system console. The only disadvantage of using Telnet (versus the direct serial port connection) is that with Telnet you cannot access the system console until the AP is fully initialized. Therefore, you cannot view AP startup messages. However, once the AP is operational you can use a Telnet connection to view the AP system console and enter CLI commands in exactly the same way as you would with a serial port connection.
- Bring up a command window on your PC.
(For example, from the system tray on the desktop choose Start > Run to bring up the Run dialog, and type cmd in the Open property, and click OK.)
- At the command prompt, type the following:
telnet IPAddressOfAccessPoint
where IPAddressOfAccessPoint is the address of the access point you want to monitor.
(If your Domain Name Server is configured to map domain names to IP addresses via DHCP, you can also telnet to the domain name of the AP.)
- You will be prompted for an Administrator user name and password for the access point.
Devicescape-AP login:
Password:
Enter the default Administrator username and password for the Devicescape Reference AP (admin, admin), and press "Enter" after each. (The password is masked, so it will not be displayed on the screen.)
When the user name and password is accepted, the screen displays the Devicescape Reference AP help command prompt.
Devicescape-AP login: admin
Password:
Enter 'help' for help.
You are now ready to enter CLI commands at the command line prompt.
SSH Connection to the AP
If you know already have your network deployed and know the IP address of your access point, you can use a remote "SSH" connection to the access point to view the system console over the network.
Using an SSH connection to the access point is similar to "Telnet" in that it gives you remote access to the system console and CLI. SSH has the added advantage of being a secure connection traffic encrypted.
To use an SSH connection, you need to have SSH software installed on your PC (such as PuTTY, which is available at http://www.chiark.greenend.org.uk/~sgtatham/putty/).
- Start your SSH application. (We use PuTTY as an example.)
- Enter the IP address of access point and click Open.
(If your Domain Name Server is configured to map domain names to IP addresses via DHCP, you can enter the domain name of the AP instead of an IP address.)
This brings up the SSH command window and establishes a connection to the access point. The login prompt is displayed.
login as:
- Enter the default Administrator username and password for the Devicescape Reference AP (
admin, admin), and press "Enter" after each. (The password is masked, so it will not be displayed on the screen.)
login as: admin
admin@10.10.100.110's password:
Enter 'help' for help.
When the user name and password is accepted, the screen displays the Devicescape Reference AP help command prompt.
Devicescape-AP#
You are now ready to enter CLI commands at the command line prompt.
Quick View of Commands and How to Get Help
- Ready to Get Started?
|
Caution
|
Settings updated from the CLI (with get, set, add, remove commands) will not be saved to the startup configuration unless you explicitly save them via the save-running command. For a description of configurations maintained on the AP and details on how to save your updates, see Saving Configuration Changes.
|
Commands and Syntax
The CLI for the Devicescape Reference AP provides the following commands for manipulating objects.
|
Notes
|
- named_class is a class of an object from the configuration whose instances are individually named. Named classes have two types: unique-named and group-named. All the instances of a unique named class must be assigned unique names. In a group named class, instances that have the same name form a group.
instance is a name of an instance of class.- property values cannot contain spaces unless the value is in quotes
For a detailed class and property reference, see CLI Classes and Properties Reference.
|
|
get
|
The "get" command allows you to get the property values of existing instances of a class.
Classes can be "named" or "unnamed". The command syntax is:
get unnamed-class [ property ... | detail ]
get named-class [ instance | all [ property ... | name | detail ] ]
The rest of the command line is optional. If provided, it is either a list of one or more properties, or the keyword detail.
An example of using the "get" command on an unnamed class with a single instance is: get log
(There is only one log on the AP. This command returns information on the log file.)
An example of using the "get" command on an unnamed class with multiple instances is: get log-entry
(There are multiple log entries but they are not named. This command returns all log entries.)
An example of using the "get" command on a named class with multiple instances is: get bss wlan0bssInternal (There are multiple bss's and they are named. This command returns information on the BSS named "wlan0bssInternal".)
An example of using the "get" command on a named class to get all instances:
get radius-user all name
get radius-user all
Note: " wlan0bssInternal" is the name of the basic service set ( BSS) on the internal network ( wlan0 interface). For information on interfaces, see Understanding Interfaces as Presented in the CLI.
|
|
set
|
The "set" command allows you to set the property values of existing instances of a class.
set unnamed-class [ with qualifier-property qualifier-value ... to ] property value . . .
The first argument is an unnamed class in the configuration.
After this is an optional qualifier that restricts the set to only some instances. For singleton classes (with only one instance) no qualifier is needed. If there is a qualifier, it starts with the keyword with, then has a sequence of one or more qualifier-property qualifier-value pairs, and ends with the keyword to. If these are included, then only instances whose present value of qualifier-property is qualifier-value will be set. The qualifier-value arguments cannot contain spaces. Therefore, you cannot select instances whose desired qualifier-value has a space in it.
The rest of the command line contains property-value pairs.
set named-class instance | all [ with qualifier-property qualifier-value ... to ] property value . . .
The first argument is either a named class in the configuration.
The next argument is either the name of the instance to set, or the keyword all, which indicates that all instances should be set. Classes with multiple instances can be set consecutively in the same command line as shown in Example 4 below. The qualifier-value arguments cannot contain spaces.
Here are some examples. (Bold text indicates class names, property names or keywords; the unbold text are values to which the properties are being set.)
1. set interface wlan0 ssid "Vicky's AP"
2. set radio all beacon-interval 200
3. set tx-queue wlan0 with queue data0 to aifs 3
4. set tx-queue wlan0 with queue data0 to aifs 7 cwmin 15 cwmax 1024 burst 0
5. set bridge-port br0 with interface eth0 to path-cost 200
Note: For information on interfaces used in this example (such as wlan0, br0, or eth0) see Understanding Interfaces as Presented in the CLI.
|
|
add
|
The "add" command allows you to add a new instance or group of instances of a class.
add unique-named-class instance [ property value ... ]
add group-named-class instance [ property value ... ]
add anonymous-class [ property value ... ]
For example:
add radius-user wally
Note: If you're adding an instance to a unique-named class, you must assign the instance a name not already in use by any other instance of that class. If you add instances to group-named classes, you can form groups by creating instances and assigning them identical names. All instances of a group-named class that have the same name form a group of instances.
|
|
remove
|
The "remove" command allows you to remove an existing instance of a class.
remove unnamed-class [ property value . . . ]
remove named-class instance | all [ property value . . .]
For example:
remove radius-user wally
|
The CLI also includes the following commands for maintenance tasks:
|
save-running
|
The save-running command saves the running configuration as the startup configuration.
|
|
reboot
|
The reboot command restarts the access point (a "soft" reboot).
For more information, see Reboot the AP.
|
|
factory-reset
|
The factory-reset command resets the AP to factory defaults and reboots.
|
Getting Help on Commands at the CLI
Help on commands can be requested at the command line interface (CLI) by using the TAB key. This is a quick way to see all valid completions for a class.
Hitting TAB once will attempt to complete the current command.
If multiple completions exist, a beep will sound and no results will be displayed. Enter TAB again to display all available completions.
- Example 1: At a blank command line, hit TAB twice to get a list of all commands.
Devicescape-AP#
add Add an instance to the running configuration
factory-reset Reset the system to factory defaults
get Get property values of the running configuration
reboot Reboot the system
remove Remove instances in the running configuration
save-running Save the running configuration
set Set property values of the running configuration
Example 2: Type "get " TAB TAB (including a space after get) to see a list of all property options for the get command.
Devicescape-AP# get
access-point Guest, VLAN and VWN settings
association Associated station
basic-rate Basic rates of radios
bridge-port Bridge ports of bridge interfaces
bss Basic Service Set of radios
channel-planner Channel planner settings
cluster Clustering-based configuration settings
config Configuration settings
configuration Configuration file info
detected-ap Detected access point
dhcp-client DHCP client settings
dot11 IEEE 802.11 (all radios)
firmware-upgrade Upgrade firmware of the AP through http
host Internet host settings
interface Network interface
ip-route IP route entry
log Log settings
log-entry Log entry
mac-acl MAC address access list item
management Management communication configurations
ntp Network Time Protocol client
portal Guest captive portal
radio Radio
radius-user RADIUS user
serial Serial access to the command line interface
snmp SNMP (Simple Network Management Protocol)
ssh SSH access to the command line interface
static-ip-route Static IP route entry - used when DHCP is off
supported-rate Supported rates of radios
system System settings
telnet Telnet access to the command line interface
traphost Destination host for SNMP traps
tx-queue Transmission queue parameters
untagged-vlan Untagged VLAN configuration
vwn Virtual Wireless Network
web-server Web server
wme-queue Transmission queue parameters for stations
Example 3: Type "get system v" TAB. This will result in completion with the only matching property, "get system version". Hit ENTER to display the output results of the command.
For detailed examples on getting help, see Keyboard Shortcuts and Tab Completion Help.
Ready to Get Started?
If you know the four basic commands shown above (get, set, remove, and add) and how to get help at the CLI using tab completion, you are ready to get started.
The best way to get up-to-speed quickly is to bring up the CLI on your AP and follow along with some or all of the examples in the next topic Command Usage and Configuration Examples.
Command Usage and Configuration Examples
Understanding Interfaces as Presented in the CLI
The table of interface names below, is provided to help clarify the related CLI commands and output results. These names are not exposed on the Web UI, but are used throughout the CLI. You get and set many configuration values on the AP by referring to interfaces. In order to configure the AP through the CLI, you need to understand which interfaces are available on the AP, what role they play (corresponding setting on the Web UI), and how to refer to them.
The Management Interface is the interface used to manage the access point. It is the interface that has an IP address assigned to it, and can be used for access to telnet, ssh, SNMP, the Web UI etc. Depending on the configuration of the access point, the Management Interface can change. To determine which interface is the management interface, use the command get management and look at the interface property. The management class also provides easy access to get and set the properties of the management interface, including its IP address.
|
Interface
|
Description
|
|
lo
|
Local loopback for data meant for the access point itself.
|
|
eth0
|
The primary wired (Ethernet) interface.
This interface may receive untagged or both tagged and untagged packets, depending on the configuration. The packets may be bridged to wireless networks or used for management..
|
|
eth1
|
The wired (Ethernet) interface for a physically separate Guest network.
Note: Whether or not you have this interface will depend on whether your access point device has a second network port. See Hardware Connections for a Physically Separate Guest Network.
|
|
br0
|
The Internal bridge represents the Internal interface for the access point.
br0 consists:
- eth0 (or vlan
SomeNumber if you have VLANs configured)
- wlan0
- wlan1 (if the AP is a dual-radio AP)
|
|
brguest
|
The Guest bridge, which consists of eth1 (or VLAN xxxx if you have VLANs configured) and wlan0guest.
|
|
brtrunk
|
The Trunk bridge. When VLANs are in use, bridges tag packets between the interfaces that use them (eth0, wlan0wdsx).
|
|
brvlanxxxx
|
The bridge interface for the management VLAN using VLAN ID xxxx. This is only used when the management VLAN is not using an already existing bridge, for example, br0, brvwnx, etc.
|
|
brvwnx
|
The bridge interface for Virtual Wireless Network (VWN) where "x" indicates the number of the VWN.
|
|
wlan0
|
The wireless (radio) interface for the Internal network.
|
|
wlan0guest
|
The wireless (radio) interface for the Guest network.
|
|
wlan0vwnx
|
The wireless interface for Virtual Wireless Network (VWN) where "x" indicates the number of the VWN.
|
|
wlan0wdsx
|
A wireless distribution system (WDS) interface where "x" indicates the number of the WDS link. (For example, wlan0wds1.)
|
|
wlan1
|
On a dual radio AP, the wireless (radio) interface for the Internal network on the second radio.
|
|
wlan1guest
|
On a dual radio AP, the wireless (radio) interface for the Guest network on the second radio.
|
|
wlan1vwnx
|
On a dual radio AP, the wireless interface for Virtual Wireless Network (VWN) where "x" indicates the number of the VWN.
|
|
vlanxxxx
|
A VLAN interface for VLAN ID xxxx. To find out what this VLAN interface is (Internal, Guest, Management), use the following command to look at the "role" property:
get interface vlanVLANID role
For example:
get interface vlan1234 role
|
Understanding CLI Validation of Configuration Settings
The CLI performs validation on individual property values in a set or add, but does not check to see if different property values are consistent with each other. For example, it would not provide any error if a radio's mode was set to "a" and its channel was set to "1". (Even though "1" is not a valid channel in "a" mode, it is a valid channel in "g" mode.) In cases where the configuration is left in an inconsistent state, the services associated with the configuration may not be operational. Therefore, it is important to consult the class and property reference to understand the acceptable values for properties given the values of other properties. For more information, see CLI Classes and Properties Reference.
Saving Configuration Changes
The Devicescape Reference AP maintains three different configurations.
You can always return the AP to the factory defaults by using the factory-reset command, as described in Reset the AP to Factory Defaults.
- Startup Configuration - The startup configuration contains the settings with which the AP will use the next time it starts up (for example, upon reboot).
To save configuration updates made from the CLI to the startup configuration, you must execute the save-running or "set config startup running" command from the CLI after making changes.
- Running Configuration - The running configuration contains the settings with which the AP is currently running.
When you view or update configuration settings through the command line interface (CLI) using get, set, add, and remove commands, you are viewing and changing values on the running configuration only. If you do not save the configuration (by executing the save-running or "set config startup running" command at the CLI), you will lose any changes you submitted via the CLI upon reboot.
The save-running command saves the running configuration as the startup configuration. (The save-running command is a shortcut command for "set config startup running", which accomplishes the same thing)
Settings updated from the CLI (with get, set, add, remove commands) will not be saved to the startup configuration unless you explicitly save them via the save-running command. This gives you the option of maintaining the startup configuration and trying out values on the running configuration that you can discard (by not saving).
By contrast, configuration changes updated from the Web UI are automatically saved to both the running and startup configurations. If you make changes from the Web UI that you do not want to keep, your only option is to reset to factory defaults. The previous startup configuration will be lost.
Basic Settings
|
Note
|
Before configuring this feature, make sure you are familiar with the names of the interfaces as described in Understanding Interfaces as Presented in the CLI. The interface name you reference in a command determines whether a setting applies to a wired or wireless interface, the Internal or Guest network, or (on a dual-radio AP) to radio "one" or radio "two".
|
The following CLI command examples correspond to tasks you can accomplish on the Basic Settings tab of the Web UI for access points with clustering capabilities. In some cases, the CLI get command provides additional details not available through the Web UI.
This table shows a quick view of Basic Settings commands and provides links to detailed examples.
|
|
get management ip
or
get management
If management VLANs are not enabled, then the management interface will be br0. Therefore, it is also possible to use get interface br0 ip to get the IP address.
|
|
|
get management mac
|
|
|
get management mac ip
|
|
|
get interface
|
|
|
get system version
|
|
|
get cluster location
|
|
|
set system location NewLocation
For example:
set system location hallway
or
set system location "Vicky's Office"
|
|
|
set system password NewPassword
For example:
set system password admin
|
|
|
get interface wlan0 ssid
|
|
|
set interface wlan0 ssid NewSSiD
For example:
set interface wlan0 ssid Vicky
set interface wlan0 ssid "Vicky's AP"
|
Get the IP Address for an Access Point
In the following example, the IP address for the access point is: 10.10.55.216. Use the get command as shown to obtain the IP address for the management interface.
Devicescape-AP# get management ip
10.10.55.216
Get the MAC Address for an Access Point
In the following example, the MAC address for the access point is: 00:a0:c9:8c:c4:7e. Use the get command as shown to obtain the MAC address for the management interface.
Devicescape-AP# get management mac
00:a0:c9:8c:c4:7e
Get Both the IP Address and MAC Address
The following command returns both the IP address and the MAC address for an access point:
Devicescape-AP# get management ip
Property Value
---------------------
ip 10.10.55.216
mac 00:a0:c9:8c:c4:7e
Get Common Information on All Interfaces for an AP
The following example shows common information (including IP addresses) for all interfaces.
Devicescape-AP# get interface
name type status mac ip mask
---------------------------------------------------------------
wlan0wds0 wds down
wlan0wds3 wds down
wlan0wds2 wds down
wlan0wds1 wds down
wlan0vwn2 service-set up
wlan0vwn4 service-set up
wlan0vwn12 service-set up
wlan0vwn1 service-set up
wlan0vwn3 service-set up
wlan0vwn11 service-set up
wlan0vwn14 service-set up
wlan0 service-set up 0.0.0.0
wlan0vwn9 service-set up
wlan0vwn13 service-set up
wlan0vwn6 service-set up
wlan0guest service-set up 0.0.0.0
wlan0vwn8 service-set up
wlan0vwn5 service-set up
wlan0vwn10 service-set up
wlan0vwn7 service-set up
brvwn7 bridge down
brvwn6 bridge down
brvwn10 bridge down
brvwn13 bridge down
br0 bridge up 172.16.1.112 255.255.0.0
brvwn3 bridge down
brvwn9 bridge down
brvwn8 bridge down
brvwn11 bridge down
brguest bridge down
brvwn5 bridge down
brvwn2 bridge down
brvwn12 bridge down
brvwn1 bridge down
brvwn4 bridge down
brvwn14 bridge down
lo loopback up 127.0.0.1
eth0 ethernet up
eth1 ethernet down
Get the Firmware Version for the Access Point
In the following example, the access point is running Firmware Version:1.0.0.9. Use the get command as shown to obtain the Firmware Version.
Devicescape-AP# get system version
1.0.0.9
Get the Location of the Access Point
In the following example, the location of the access point has not been set. Use the get command as shown to obtain the location of the access point.
Devicescape-AP# get cluster location
not set
Set the Location for an Access Point
To set the location for an access point, use the set command as follows:
Devicescape-AP# set system location hallway
Devicescape-AP# set system location "Vicky's Office"
To check to make sure that the location was set properly, use the get command again to find out the location
Devicescape-AP# get system location
Vicky's Office
Get the Current Password
For security reasons, you cannot directly retrieve the password of a device. If you forget the password of a device, and you have a CLI session, you can change the password to a new value. Alternatively, you can perform a factory reset to return the default password.
Although you cannot directly retrieve a password, you can retrieve an encrypted copy of it. This is useful if you want to set the same password on several different devices. In that case, you can get the encrypted password on one device, copy that value, and set the encrypted password to be the same value on other devices.
Note: If the devices are clustered, this happens in the background when you change the password. All passwords on the clustered devices will be the same.
Devicescape-AP# get system encrypted-password
2yn.4fvaTgedM
Set the Password
Devicescape-AP# set system password admin
Devicescape-AP# get system encrypted-password
/rYSvxS4Okptc
Get the Wireless Network Name (SSID)
Devicescape-AP# get interface wlan0 ssid
Internal Devicescape Network
Set the Wireless Network Name (SSID)
Devicescape-AP# set interface wlan0 ssid "Vicky's AP"
Devicescape-AP# get interface wlan0 ssid
Vicky's AP
Access Point and Cluster Settings
The command examples in this section show how to get the configuration for a cluster of access points. These settings generally correspond to those on the Cluster > Access Points tab in the Web UI.
|
Note
|
You cannot use the CLI to add or remove an access point from a cluster or set the configuration policy. If you want to configure clustering, please use the Web User Interface as described in Managing Access Points and Clusters.
|
This table provides a quick view of Access Point Cluster commands and links to detailed examples.
|
|
get cluster
|
|
|
get cluster clustered
|
|
|
get cluster cluster-name
|
|
|
get cluster location
|
Determine if the AP is a Cluster Member or in Standalone Mode (whilst obtaining all cluster properties)
This get cluster command shows all the cluster properties associated with an AP. If the property clustered has a value of 0, then the AP is in stand-alone mode (i.e. not clustered). If the property clustered returns a value of 1, then the AP is a member of a cluster.
In the following example, the AP is in standalone mode.
Devicescape-AP# get cluster
Property Value
--------------------
clustered 0
location not set
cluster-name not set
In the following example, the AP is a member of a cluster, since a value of 1 has been returned.
Devicescape-AP# get cluster
Property Value
--------------------
clustered 1
location Vicky's Office
cluster-name vicky-cluster
Determine only whether an AP is clustered or not
The get cluster clustered command returns a value of 0 or 1. If the command returns a value of 1, then the AP is a member of a cluster. If the AP returns a value of 0, then the AP is in standalone mode.
Devicescape-AP# get cluster clustered
1
Determine the name of the cluster your AP is part of
The get cluster cluster-name command tells you the name of the cluster your AP is part of. In the following example, the name of the cluster your AP is joined to is "vicky-cluster".
Devicescape-AP# get cluster cluster-name
vicky-cluster
Determine the location of the AP that is part of the cluster
If you have specified a location for the AP, you can determine this using the get cluster location command.
Devicescape-AP# get cluster location
Vicky's Office
User Accounts
The following command examples show configuration tasks related to user accounts. These tasks correspond to the Cluster > User Management tab in the Web UI.
This table shows a quick view of User Management commands and provides links to detailed examples.
|
|
To view all usernames:
get radius-user all name
To view all user account details:
get radius-user all
|
|
|
add radius-user UserName
For example:
add radius-user samantha
|
|
To set the user's real name:
|
set radius-user UserName RealName
For example:
set radius-user samantha realname "Elizabeth Montgomery"
(or set radius-user samantha realname Elizabeth Montgomery)
|
|
To set user's password:
|
set radius-user UserName password Password
For example:
set radius-user samantha password bewitched
|
|
Save the new user account details
|
save-running
|
|
|
remove radius-user UserName
|
Get All User Accounts
To view all user names:
Devicescape-AP# get radius-user all name
name
--------
larry
To view all user accounts:
Devicescape-AP# get radius-user all
name username disabled password realname
------------------------------------------------------------
larry David White
(When we start out, "larry" is the only user configured.)
Add Users
In this example, we will add four new users: (1) samantha, (2) endora, (3) darren, and (4) wally. We'll set up user names, real names, and passwords for each.
- Add username "samantha":
Devicescape-AP# add radius-user samantha
- Provide a real name (Elizabeth Montgomery) for this user:
Devicescape-AP# set radius-user samantha realname "Elizabeth Montgomery"
- Set the user password for samantha to "bewitched":
Devicescape-AP# set radius-user samantha password bewitched
- Repeat this process to add some other users (endora, darren, and wally):
Devicescape-AP# add radius-user endora
Devicescape-AP# set radius-user endora realname "Agnes Moorhead"
Devicescape-AP# set radius-user endora password scotch
Devicescape-AP# add radius-user darren
Devicescape-AP# set radius-user darren realname "Dick York"
Devicescape-AP# set radius-user darren password martini
Devicescape-AP# add radius-user wally
Devicescape-AP# set radius-user wally realname "Tony Dow"
Devicescape-AP# set radius-user wally password sodapop
|
Note
|
After you have added all the necessary users, use the save-running command to save the new radius-user accounts. If you do not run this command, all new radius-user accounts will be lost when you reboot the AP.
|
- After configuring and saving these new accounts, use the "get" command to view all users.
Devicescape-AP# get radius-user all
name username disabled password realname
------------------------------------------------------------
larry David White
samantha bewitched Elizabeth Montgomery
endora scotch Agnes Moorhead
darren martini Dick York
wally sodapop Tony Dow
Remove a User Account
To remove a user account, type the following
Devicescape-AP# remove radius-user wally
Use the "get" command to view all user names. (You can see "wally" has been removed.)
Devicescape-AP# get radius-user all name
name
--------
larry
samantha
endora
darren
Status
The command tasks and examples in this section show status information on access points. These settings correspond to what is shown on the Status tabs in the Web UI. (See Interfaces, Event Logs, Transmit/Receive Statistics, Associated Wireless Clients, and Neighboring Access Points.)
This table provides a quick view of all Status commands and links to detailed examples.
|
Note
|
Make sure you are familiar with the names of the interfaces as described in Understanding Interfaces as Presented in the CLI. The interface name you reference in a get command determines whether the command output shows a wired or wireless interface, the Internal or Guest network, or (on a dual-radio AP) to radio "one" or radio "two".
|
|
|
Reference of interface names and purposes as described in Understanding Interfaces as Presented in the CLI.
|
|
Global commands to get details on all Basic Service Sets (BSSs).
This is a useful command to use to get a comprehensive picture of how the AP is currently configured.
|
get bss all detail |
