Appendix C. Command Line Interface (CLI) for AP Configuration
In addition to the Web based user interface, the Devicescape Enterprise-Managed 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 Enterprise-Managed 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. For information on how to set an access point to stand-alone or cluster mode from the CLI, see Set Configuration Policy for New Access Points.)
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 Enterprise-Managed 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.g
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 for 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
You can configure all Ethernet (Wired) settings from the CLI except "Connection Type".
To change the Connection Type from DHCP to Static IP addressing (or vice versa), you must use the Web UI.
|
yes
|
|
|
yes
|
yes
|
|
|
yes
|
yes
|
|
|
yes
|
yes
|
|
|
yes
|
|
|
|
yes
|
yes
|
|
|
yes
You can configure all Radio settings from the CLI except for turning on/off Super AG.
|
yes
|
|
|
yes
|
yes
|
|
|
yes
|
yes
|
|
|
yes
|
yes
|
|
|
yes
|
yes
|
|
|
yes
|
yes
|
|
|
yes
|
|
|
|
yes
|
yes
|
|
Upgrade the Firmware
|
You cannot upgrade the firmware from the CLI. Please use the Web UI to configure this feature as described in Upgrading the Firmware.
|
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 asTeraTerm, 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.
- 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:
apconfd: Initialization complete.
apconfd: dhcpc: Interface br0 obtained lease on 10.10.100.123.
- When you see that the access point has obtained an IP address on
br0, 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.
Instant802-AP login:
Password:
Enter the default Administrator username and password for the Devicescape Enterprise-Managed 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 Enterprise-Managed AP help command prompt.
Instant802-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. (LEDs on the AP should indicate when the AP has booted. Specifics will vary depending on the AP manufacturer.) 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 choose Start > Run to bring up the Run dialog, and type cmd in the Open field, 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.
Instant802-AP login:
Password:
Enter the default Administrator username and password for the Devicescape Enterprise-Managed 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 Enterprise-Managed AP help command prompt.
Instant802-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 Enterprise-Managed 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 Enterprise-Managed AP help command prompt.
Instant802-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 Enterprise-Managed 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.instance is a name of an instance of class.- field values cannot contain spaces unless the value is in quotes
For a detailed class and field reference, see CLI Classes and Fields Reference.
|
|
get
|
The "get" command allows you to get the field values of existing instances of a class.
Classes can be "named" or "unnamed". The command syntax is:
get unnamed-class [ field ... | detail ]
get named-class [ instance | all [ field ... | name | detail ] ]
The rest of the command line is optional. If provided, it is either a list of one or more fields, 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 field values of existing instances of a class.
set unnamed-class [ with qualifier-field qualifier-value ... to ] field 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-field qualifier-value pairs, and ends with the keyword to. If these are included, then only instances whose present value of qualifier-field is qualifier-value will be set. The qualfier-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 field-value pairs.
set named-class instance | all [ with qualifier-field qualifier-value ... to ] field value . . .
The first argument is either a named class in the configuration.
The next argument is 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 qualfier-value arguments cannot contain spaces.
Here are some examples. (Bold text indicates class names, field names or keywords; the unbold text are values to which the fields 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 of a class.
add named-class instance [ field value ... ]
add anonymous-class [ field value ... ]
For example:
add radius-user wally
|
|
remove
|
The "remove" command allows you to remove an existing instance of a class.
remove unnamed-class [ field value . . . ]
remove named-class instance | all [ field 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.
Instant802-AP#
add Add an instance to the running configuration
factory-reset Reset the system to factory defaults
get Get field values of the running configuration
reboot Reboot the system
remove Remove instances in the running configuration
save-running Save the running configuration
set Set field values of the running configuration
Example 2: Type "get " TAB TAB (including a space after get) to see a list of all field options for the get command.
Instant802-AP# get
association Associated station
basic-rate Basic rates of radios
bridge-port Bridge ports of bridge interfaces
bss Basic Service Set of radios
cluster Clustering-based configuration settings
cluster-member Member of a cluster of like-configured access points
config Configuration settings
detected-ap Detected access point
dhcp-client DHCP client settings
dot11 IEEE 802.11 (all radios)
host Internet host settings
interface Network interface
ip-route IP route entry
klog-entry Kernel log entry
log Log settings
log-entry Log entry
mac-acl MAC address access list item
ntp Network Time Protocol client
portal Guest captive portal
radio Radio
radius-user RADIUS user
serial Serial access to the command line interface
ssh SSH access to the command line interface
supported-rate Supported rates of radios
system System settings
telnet Telnet access to the command line interface
tx-queue Transmission queue parameters
wme-queue Transmission queue parameters for stations
Example 3: Type "get system v" TAB. This will result in completion with the only matching field, "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 following summary of interface names 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.
|
Interface
|
Description
|
|
lo
|
Local loopback for data meant for the access point itself.
|
|
eth0
|
The wired (Ethernet) interface for the Internal network.
|
|
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 inteface for the access point. To telnet or ssh into the access point, use the IP address for this inteface.
br0 consists:
- eth0 (or vlan
SomeNumber if you have VLANs configured)
- wlan0
- wlan1 (if the AP is a dual-radio AP)
The IP address of the access point is provided in the output detail for br0. So, a useful command is get interface. This gives you common information on all interfaces. From the output results, you can find the IP address for br0. Use this IP address to connect to the AP.
|
|
brguest
|
The Guest bridge, which consists of eth1 and wlan0guest.
|
|
brvwn1
|
The bridge interface for Virtual Wireless Network (VWN) 1.
On a single-radio AP, the bridge interface for VWN1 consists of:
wlan0vwn1vlanVLANID where VLANID is a four-digit VLAN ID that you provided. (For example, if you provided a VLAN ID of 1234, the VLAN interface would be "vlan1234"
On a dual-radio AP, the bridge interface for VWN1 consists of:
wlan0vwn1wlan1vwn1vlanVLANID where VLANID is a four-digit VLAN ID that you provided. (For example, if you provided a VLAN ID of 1234, the VLAN interface would be "vlan1234" |
|
brvwn2
|
This is for the second Virtual Wireless Network (VWN) 2.
On a single-radio AP, the bridge interface for VWN2 consists of:
wlan0vwn1vlanVLANID where VLANID is a four-digit VLAN ID that you provided. (For example, if you provided a VLAN ID of 1234, the VLAN interface would be vlan1234.)
On a dual-radio AP, the bridge interface for VWN2 consists of:
wlan0vwn1wlan1vwn1vlanVLANID where VLANID is a four-digit VLAN ID that you provided. (For example, if you provided a VLAN ID of 5678, the VLAN interface would be vlan5678.) |
|
wlan0
|
The wireless (radio) interface for the Internal network.
|
|
wlan0guest
|
The wireless (radio) interface for the Guest network.
|
|
wlan0vwn1
|
The wireless interface for Virtual Wireless Network (VWN) 1.
|
|
wlan0vwn2
|
The wireless interface for Virtual Wireless Network (VWN) 2.
|
|
wlan0wdsx
|
A wireless distribution system (WDS) inteface 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.
|
|
wlan1vwn1
|
On a dual radio AP, the wireless interface for Virtual Wireless Network (VWN) 1 on the second radio.
|
|
wlan1vwn2
|
On a dual radio AP, the wireless interface for Virtual Wireless Network (VWN) 2 on the second radio.
|
|
vlanxxxx
|
A VLAN interface for VLAN ID xxxx. To find out what this VLAN interface is (Internal, Guest, VWN1 or VWN2), use the following command to look at the "role" field:
get interface vlanVLANID role
For example:
get interface vlan1234 role
|
Saving Configuration Changes
The Devicescape Enterprise-Managed 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 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 interface br0 ip
or
get interface
get interface is a catch-all command that shows common information on all interfaces for the AP such as IP addresses, MAC addresses, and so on. The IP address for the Internal inteferface (and the one used to access the AP) is that shown for br0. (See Understanding Interfaces as Presented in the CLI.)
|
|
|
get interface br0 mac
|
|
|
get interface br0 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"
|
|
|
get system encrypted-password
|
|
|
set system password NewPassword
For example:
set system password admin
|
|
|
get interface wlan0 ssid
|
|
|
set inteface wlan0 ssid NewSSiD
For example:
set interface wlan0 ssid Vicky
set interface wlan0 ssid "Vicky's AP"
|
Get the IP Address for the Internal Interface on 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 Internal network.
Instant802-AP# get interface br0 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.
Instant802-AP# get interface br0 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:
Instant802-AP# get interface br0 mac ip
Field 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.
Instant802-AP# get interface
name type status mac ip mask
---------------------------------------------------------------------------
-----
lo up 00:00:00:00:00:00 127.0.0.1 255.0.0.0
eth0 up 00:02:B3:01:01:01
eth1 down 00:02:B3:02:02:02
br0 bridge up 00:02:B3:01:01:01 10.10.100.110
255.255.255.0
brguest bridge down 00:00:00:00:00:00
wlan0 service-set up 00:0C:41:16:DF:A6
wlan0guest service-set up
wlan0wds0 wds down
wlan0wds1 wds down
wlan0wds2 wds down
wlan0wds3 wds down
Instant802-AP#
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 the Firmware Version.
Instant802-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.
Instant802-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:
Instant802-AP# set system location hallway
Instant802-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
Instant802-AP# get system location
Vicky's Office
Get the Current Password
Instant802-AP# get system encrypted-password
2yn.4fvaTgedM
Set the Password
Instant802-AP# set system password admin
Instant802-AP# get system encrypted-password
/rYSvxS4Okptc
Get the Wireless Network Name (SSID)
Instant802-AP# get interface wlan0 ssid
Internal Instant802 Network
Set the Wireless Network Name (SSID)
Instant802-AP# set interface wlan0 ssid "Vicky's AP"
Instant802-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 detail
|
|
|
get clustered-ap all name
|
Determine if the AP is a Cluster Member or in Stand-alone Mode
This command shows whether the AP is clustered or not. If the command returns 0, the AP is in stand-alone mode (not clustered). If the command returns 1, the AP is a member of a cluster. In the following example, the AP is in stand-alone mode.
Instant802-AP# get cluster detail
Field Value
--------------------
clustered 0
clusterable 0
kickstarted 0
location not set
formation
Get MAC Addresses for all Access Points in the Cluster
Instant802-AP# get cluster-member all
name mac ip location removed
---------------------------------------------------------------------
00:e0:b8:76:23:b4 00:e0:b8:76:23:b4 10.10.10.248 not set 0
00:e0:b8:76:16:88 00:e0:b8:76:16:88 10.10.10.230 not set 0
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.
rThis 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 accounts:
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 "Elizabeth Montgomery"
(or set radius-user samantha Elizabeth)
|
|
To set user's password:
|
set radius-user UserName password Password
For example:
set radius-user samantha password bewitched
|
|
|
remove radius-user UserName
|
Get All User Accounts
To view all user names:
Instant802-AP# get radius-user all name
name
--------
larry
To view all user accounts:
Instant802-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":
Instant802-AP# add radius-user samantha
- Provide a real name (Elizabeth Montgomery) for this user:
Instant802-AP# set radius-user samantha realname "Elizabeth Montgomery"
- Set the user password for samantha to "bewitched":
Instant802-AP# set radius-user samantha password bewitched
- Repeat this process to add some other users (endora, darren, and wally):
Instant802-AP# add radius-user endora
Instant802-AP# set radius-user endora realname "Agnes Moorhead"
Instant802-AP# set radius-user endora password scotch
Instant802-AP# add radius-user darren
Instant802-AP# set radius-user darren realname "Dick York"
Instant802-AP# set radius-user darren password martini
Instant802-AP# add radius-user wally
Instant802-AP# set radius-user wally realname "Tony Dow"
Instant802-AP# set radius-user wally password sodapop
- After configuring these new accounts, use the "get" command to view all users. (Passwords are always hidden.)
Instant802-AP# get radius-user all
name username disabled password realname
------------------------------------------------------------
larry David White
samantha Elizabeth Montgomery
endora Agnes Moorhead
darren Dick York
wally Tony Dow
Remove a User Account
To remove a user account, type the following
Instant802-AP# remove radius-user wally
Use the "get" command to view all user names. (You can see "wally" has been removed.)
Instant802-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 command to get all detail on a Basic Service Set (BSS).
This is a useful command to use to get a comprehensive picture of how the AP is currently configured.
|
get bss all detail
|
|
|
get interface br0
|
|
|
get interface br0
|
|
|
get interface brguest
get interface brguest mac
get interface brguest ssid
|
|
|
get interface wlan0 mac
|
|
|
get interface wlan0 ssid
|
|
|
get radio wlan0 mode
|
|
|
get radio wlan0 channel
|
|
|
get radio wlan0
get radio wlan0 detail
|
|
|
get log-entry all
|
|
|
As a prerquisite to remote logging, the Log Relay Host must be configured first as described in Setting Up the Log Relay Host.
set log relay-enabled 1 enables remote logging
set log relay-enabled 1 disables remote logging
get log
set log TAB TAB shows values you can set on the log
|
|
|
get interface all ip mac ssid tx-packets tx-bytes tx-errors rx-packets rx-bytes rx-errors
|
|
|
get association
|
|
|
get clustered-ap
|
Get Common Information on the Internal Interface for the AP
The following command obtains all information on the internal interface for an access point:
Instant802-AP# get interface br0
Field Value
--------------------
type bridge
status up
hello 10
mac 00:a0:c9:8c:c4:7e
ip 192.168.1.1
mask 255.255.255.0
Get Current Settings for the Ethernet (Wired) Internal Interface
The following example shows how to use the CLI to get the Ethernet (Wired) settings for the Internal interface for an access point. You can see by the output results of the command that the MAC address is 00:a0:c9:8c:c4:7e, the IP address is 192.168.1.1, and the subnet mask is 255.255.255.0.
Get All Wired Settings for the Wired Internal Interface
Instant802-AP# get interface br0
Field Value
--------------------
mac 00:a0:c9:8c:c4:7e
ip 192.168.1.1
mask 255.255.255.0
Get the MAC Address for the Wired Internal Interface
Instant802-AP#
