Product Documentation for Enterprise-Managed AP

Documentation Home for Self-Managed and Enterprise-Managed APs | Administrators Guide

Appendix C- continued. CLI Class and Field Documentation

Class Index

Class	Description
association	An associated station.
basic-rate	A radio rate.
bridge-port	A port that is a member of a bridge.
bss	A BSS of a radio.
cluster	Stores arbitrary data.
cluster-member	Stores arbitrary data.
config	Config settings.
detected-ap	A detected access point.
dhcp-client	The DHCP client.
dot11	802.11 settings (all radios).
host	IP host settings.
interface	A network interface.
interface (bridge)	A bridge interface.
interface (ppp)	A PPP (PPTP or PPPoE) interface.
interface (service-set)	A service set interface.
interface (vlan)	A VLAN interface.
interface (wds)	A WDS interface.
ip-route	An IP route.
log	Access point log settings.
log-entry	An entry in the log.
mac-acl	A MAC access list entry.
ntp	Network Time Protocol client settings.
portal	Guest captive portal settings.
radio	A physical radio.
radius-user	A local authentication server user.
serial	Serial access to the CLI.
snmp	SNMP server.
ssh	SSH access to the CLI.
supported-rate	A radio rate.
system	System-wide settings.
telnet	Telnet access to the CLI.
tx-queue	A transmission queue.
wme-queue	A WME station queue.

association

Persistent: No.
Purpose:

An associated station.

Field Index

Field	Description
interface	The interface with which the station is associated.
station	The MAC address of the station.
authenticated	Whether the station is authenticated.
associated	Whether the station is associated.
rx-packets	The number of packets received from the station.
tx-packets	The number of packets transmitted by the station.
rx-bytes	The number of bytes received from the station.
tx-bytes	The number of bytes transmitted by the station.
tx-rate	The transmission rate.
listen-interval	The listen interval.

interface

Purpose		The interface with which the station is associated.
Valid values		Linux network interface name.

station

Purpose		The MAC address of the station.
Valid values		Six colon-separated octets in hexadecimal.

authenticated

Purpose		Whether the station is authenticated.
Valid values		"Yes" or "-".

associated

Purpose		Whether the station is associated.
Valid values		"Yes" or "-".

rx-packets

Purpose		The number of packets received from the station.
Valid values		Positive integer.

tx-packets

Purpose		The number of packets transmitted by the station.
Valid values		Positive integer.

rx-bytes

Purpose		The number of bytes received from the station.
Valid values		Positive integer.

tx-bytes

Purpose		The number of bytes transmitted by the station.
Valid values		Positive integer.

tx-rate

Purpose		The transmission rate.
Valid values		A rate, in 100 kbps.

listen-interval

Purpose		The listen interval.
Valid values		A time, in ms.

basic-rate

Persistent: Yes.
Purpose:

A radio rate.

Description:

Used to set the rate sets of radios.

Field Index

Field	Description
rate	A radio rate in MBps.

rate

Purpose		A radio rate in MBps. Note that you cannot change an existing rate field; you can only insert or delete the entire instance.
Valid values		Positive integer, or 5.5.

bridge-port

Persistent: Yes.
Purpose:

A port that is a member of a bridge.

Field Index

Field	Description
path-cost	The path cost.
priority	The port priority.

path-cost

Purpose		The path cost. Used only when STP is on.
Valid values		1-65535.

priority

Purpose		The port priority. Used only when STP is on.
Valid values		0-255.

bss

Persistent: Yes.
Purpose:

A BSS of a radio.

Description:

Represents a basic service set.

Field Index

Field	Description
status	Controls whether this is on or off.
description	A human-readable description of the interface.
radio	The radio this is part of.
beacon-interface	The service-set interface to send beacons for.
mac	The MAC address of the interface.
dtim-period	Delivery Traffic Information Map period.
max-stations	Maximum number of stations.
ignore-broadcast-ssid	Do not send SSID in beacons and ignore probe requests.
mac-acl-mode	MAC address Access Control List mode.
mac-acl-name	The name of the mac access control list to use.
radius-accounting	Whether RADIUS accounting is enabled.
radius-ip	The RADIUS server IP address.
radius-key	The RADIUS server shared secret.
open-system-authentication	Whether Open System authentication is permitted.
shared-key-authentication	Whether Shared Key authentication is permitted.
wpa-allow-non-wpa-stations	Whether non-WPA stations can associate during WPA.
wpa-cipher-tkip	Whether TKIP is permitted as a WPA cipher.
wpa-cipher-ccmp	Whether CCMP is permitted as a WPA cipher.

status

Purpose		Controls whether this is on or off.
Valid values		"up" or "down".

description

Purpose		A human-readable description of the interface.
Valid values		an ASCII string.

radio

Purpose		The radio this is part of.
Valid values		The name of an existing radio instance.

beacon-interface

Purpose		The service-set interface to send beacons for.
Valid values		The name of an existing interface instance with type of service-set.

mac

Purpose		The MAC address of the interface. Read-only; value is determined by the starting MAC of the radio.
Valid values		6 colon-separated hexadecimal digit pairs.

dtim-period

Purpose		Delivery Traffic Information Map period.
Valid values		1-225.

max-stations

Purpose		Maximum number of stations.
Valid values		0-2007.

ignore-broadcast-ssid

Purpose		Do not send SSID in beacons and ignore probe requests.
Valid values		"on" or "off".

mac-acl-mode

Purpose		MAC address Access Control List mode.
Valid values		"deny-list": deny only stations in list. "accept-list": accept only stations in list. */

mac-acl-name

Purpose		The name of the mac access control list to use.
Valid values		the name of existing mac-acl instances.

radius-accounting

Purpose		Whether RADIUS accounting is enabled. If unset defaults to "off".
Valid values		"on" or "off".

radius-ip

Purpose		The RADIUS server IP address.
Valid values		An IP address.

radius-key

Purpose		The RADIUS server shared secret.
Valid values		A string.

open-system-authentication

Purpose		Whether Open System authentication is permitted.
Valid values		"on" or "off".

shared-key-authentication

Purpose		Whether Shared Key authentication is permitted.
Valid values		"on" or "off".

wpa-allow-non-wpa-stations

Purpose		Whether non-WPA stations can associate during WPA. If unset defaults to "off".
Valid values		"on" or "off".

wpa-cipher-tkip

Purpose		Whether TKIP is permitted as a WPA cipher.
Valid values		"on" or "off".

wpa-cipher-ccmp

Purpose		Whether CCMP is permitted as a WPA cipher.
Valid values		"on" or "off".

cluster

Persistent: Yes.
Purpose:

Stores arbitrary data.

Field Index

This class has the same fields as class cluster-member.

cluster-member

Persistent: Yes.
Purpose:

Stores arbitrary data.

Description:

No services are restarted.

config

Persistent: Yes.
Purpose:

Config settings.

Description:

Used for config fields.

Field Index

Field	Description
startup	Configuration at boot time.
default	Configuration after factory reset.
no-external-updates	Prevent external configuration updates.

startup

Purpose		Configuration at boot time. Write-only.
Valid values		"default": Reset to factory defaults. "rescue": Reset to rescue. "running": Save running config.

default

Purpose		Configuration after factory reset. Write-only.
Valid values		"rescue": Reset to rescue. "running": Save running config.

no-external-updates

Purpose		Prevent external configuration updates.
Valid values		"up" or "down".

detected-ap

Persistent: No.
Purpose:

A detected access point.

Description:

Represents an access point that has been detected by passive scanning.

Field Index

Field	Description
mac	The MAC address of the AP.
radio	The radio that detected the AP.
beacon-interval	The beacon interval of the AP in kus (1.
capability	The capabilities of the AP.
type	The type of device detected.
privacy	Whether privacy (WEP or WPA) is enabled.
ssid	The SSID of the AP.
wpa	Whether WPA security is enabled.
phy-type	The mode our radio was in when the AP was detected.
band	The RF band the AP was detected in.
channel	The channel of the AP.
rate	The rate of the AP.
signal	The signal of the AP.
erp	The ERP of the AP.
beacons	The number of beacons received from this AP.
last-beacon	The time of the last beacon received from this AP.
supported-rates	The supported rates of the AP.

mac

Purpose		The MAC address of the AP.
Valid values		Six colon-separated octets in hexadecimal.

radio

Purpose		The radio that detected the AP.
Valid values		Linux network interface name.

beacon-interval

Purpose		The beacon interval of the AP in kus (1.024 ms).
Valid values		Positive integer.

capability

Purpose		The capabilities of the AP.
Valid values		C-formatted hexadecmial bitflag.

type

Purpose		The type of device detected.
Valid values		"AP", "Ad hoc", or "Other".

privacy

Purpose		Whether privacy (WEP or WPA) is enabled.
Valid values		"On" or "Off".

ssid

Purpose		The SSID of the AP.
Valid values		String of up to 32 octets.

wpa

Purpose		Whether WPA security is enabled.
Valid values		"On" or "Off".

phy-type

Purpose		The mode our radio was in when the AP was detected. Note that in B or G mode, it is possible to detect both B and G APs, therefore the distinction between B and G is not useful information.
Valid values		4: IEEE 802.11b. 7: IEEE 802.11g. 8: IEEE 802.11a. 256: Atheros Turbo.*/

band

Purpose		The RF band the AP was detected in.
Valid values		"2.4", "5", or "5 Turbo".

channel

Purpose		The channel of the AP.
Valid values		Positive integer.

rate

Purpose		The rate of the AP.
Valid values		Positive integer.

signal

Purpose		The signal of the AP.
Valid values		Positive integer.

erp

Purpose		The ERP of the AP.
Valid values		C-formatted hexadecimal number.

beacons

Purpose		The number of beacons received from this AP.
Valid values		Positive integer.

last-beacon

Purpose		The time of the last beacon received from this AP.
Valid values		Date and time, in Unix time format.

supported-rates

Purpose		The supported rates of the AP.
Valid values		Bracketed list of hexadecimal rate codes.

dhcp-client

Persistent: Yes.
Purpose:

The DHCP client.

Description:

Represents a DHCP client.

Field Index

Field	Description
status	Controls whether this is on or off.
interface	The interface to perform DHCP on.

status

Purpose		Controls whether this is on or off.
Valid values		"up" or "down".

interface

Purpose		The interface to perform DHCP on.
Valid values		The name of an existing interface instance. */

dot11

Persistent: Yes.
Purpose:

802.11 settings (all radios).

Description:

Represents the wireless functions of the access point.

Field Index

Field	Description
status	Controls whether 802.
debug	The debugging level for 802.
dot11d	Whether AP should enable 802.

status

Purpose		Controls whether 802.11 is in use.
Valid values		"up" or "down".

debug

Purpose		The debugging level for 802.11.
Valid values		0-3.

dot11d

Purpose		Whether AP should enable 802.11d
Valid values		"up" or "down".

host

Persistent: Yes.
Purpose:

IP host settings.

Description:

Used for IP host fields.

Field Index

Field	Description
dns-[12]	Domain name servers in use.
domain	Domain name in use.
id	The host name.
static-dns-[12]	Domain name servers to use when not obtained through DHCP.
static-domain	Domain name to use when not obtained through DHCP.
dns-via-dhcp	Whether DNS parameters are obtained through DHCP.

dns-[12]

Purpose		Domain name servers in use.
Valid values		IP address.

domain

Purpose		Domain name in use.
Valid values		DNS domain name.

id

Purpose		The host name.
Valid values		DNS domain name.

static-dns-[12]

Purpose		Domain name servers to use when not obtained through DHCP.
Valid values		IP address.

static-domain

Purpose		Domain name to use when not obtained through DHCP.
Valid values		DNS domain name.

dns-via-dhcp

Purpose		Whether DNS parameters are obtained through DHCP.
Valid values		"up" or "down".

interface

Persistent: Yes.
Purpose:

A network interface.

Description:

Used for per-interface fields.

Field Index

Field	Description
ip	The actual IP address of this interface.
mask	The actual netmask of this interface.
status	Controls whether this is on or off.
type	The type of the interface.
description	A human-readable description of the interface.
mac	The MAC address of the interface.
static-ip	The static IP address of this interface.
static-mask	The static netamsk of this interface.
rx-bytes	Received bytes.
rx-packets	Received packets.
rx-errors	Received packets with errors.
rx-drop	Received packets that were dropped.
rx-fifo	Received packets with FIFO overflows.
rx-frame	Received packets with frame errors.
rx-compressed	Received packets with compression.
rx-multicast	Received packets that were multicast.
tx-bytes	Transmitted bytes.
tx-packets	Transmitted packets.
tx-errors	Transmitted packets with errors.
tx-drop	Transmitted packets that were dropped.
tx-fifo	Transmitted packets with FIFO overflows.
tx-colls	Transmitted packets will collisions.
tx-carrier	Transmitted packets with carrier errors.
tx-compressed	Transmitted packets with compression.

ip

Purpose		The actual IP address of this interface. Read-only.
Valid values		IP address.

mask

Purpose		The actual netmask of this interface. Read-only.
Valid values		Netmask in dotted-decimal notation.

status

Purpose		Controls whether this is on or off.
Valid values		"up" or "down".

type

Purpose		The type of the interface. Used to determine what additional fields are available. Read-only.
Valid values		"ethernet", "loopback", "service-set", "bridge", "vlan", "wds", "pptp", "pppoe".

description

Purpose		A human-readable description of the interface.
Valid values		an ASCII string.

mac

Purpose		The MAC address of the interface.
Valid values		6 colon-separated hexadecimal digit pairs.

static-ip

Purpose		The static IP address of this interface. Used when DHCP is not in use.
Valid values		IP address.

static-mask

Purpose		The static netamsk of this interface. Used when DHCP is not in use.
Valid values		Netmask in dotted-decimal notation.

rx-bytes

Purpose		Received bytes.
Valid values		Integer.

rx-packets

Purpose		Received packets.
Valid values		Integer.

rx-errors

Purpose		Received packets with errors.
Valid values		Integer.

rx-drop

Purpose		Received packets that were dropped.
Valid values		Integer.

rx-fifo

Purpose		Received packets with FIFO overflows.
Valid values		Integer.

rx-frame

Purpose		Received packets with frame errors.
Valid values		Integer.

rx-compressed

Purpose		Received packets with compression.
Valid values		Integer.

rx-multicast

Purpose		Received packets that were multicast.
Valid values		Integer.

tx-bytes

Purpose		Transmitted bytes.
Valid values		Integer.

tx-packets

Purpose		Transmitted packets.
Valid values		Integer.

tx-errors

Purpose		Transmitted packets with errors.
Valid values		Integer.

tx-drop

Purpose		Transmitted packets that were dropped.
Valid values		Integer.

tx-fifo

Purpose		Transmitted packets with FIFO overflows.
Valid values		Integer.

tx-colls

Purpose		Transmitted packets will collisions.
Valid values		Integer.

tx-carrier

Purpose		Transmitted packets with carrier errors.
Valid values		Integer.

tx-compressed

Purpose		Transmitted packets with compression.
Valid values		Integer.

interface (bridge)

Extends: interface
Persistent: Yes.
Purpose:

A bridge interface.

Field Index

Field	Description
stp	Whether the Spanning Tree Protocol is in use.
hello	The hello time.
fd	The forward delay.
priority	The bridge priority.
port-isolation	Whether ports are isolated.

stp

Purpose		Whether the Spanning Tree Protocol is in use.
Valid values		"on" or "off".

hello

Purpose		The hello time. Only used when stp is on.
Valid values		1.0-10.0.

fd

Purpose		The forward delay. Only used when stp is on.
Valid values		4.0-30.0.

priority

Purpose		The bridge priority. Only used when stp is on.
Valid values		0-65535.

port-isolation

Purpose		Whether ports are isolated. If on, then isolated ports on this bridge can only exchange data with non-isolated ports.
Valid values		"on" or "off".

interface (ppp)

Extends: interface
Persistent: Yes.
Purpose:

A PPP (PPTP or PPPoE) interface.

Field Index

Field	Description
status	Controls whether this is on or off.
type	The type of the interface.
username	The username to login with.
password	The password to login with.
interface	The interface to run PPPoE over.
server	The PPTP server to connect to.

status

Purpose		Controls whether this is on or off.
Valid values		"up" or "down".

type

Purpose		The type of the interface. Read-only.
Valid values		Always "pptp" or "pppoe".

username

Purpose		The username to login with.
Valid values		String.

password

Purpose		The password to login with.
Valid values		String.

interface

Purpose		The interface to run PPPoE over. Only used with type of pppoe.
Valid values		The name of an existing interface instance.

server

Purpose		The PPTP server to connect to. Only used with type of pptp.
Valid values		An IP address.

interface (service-set)

Extends: interface
Persistent: Yes.
Purpose:

A service set interface.

Description:

Represents a service set interface.

Field Index

Field	Description
status	Controls whether the service set is on or off.
type	The type of the interface.
ssid	The SSID.
bss	The BSS this is part of.
security	The security to use.
wep-default-key	The WEP key index to use when transmitting.
wpa-personal-key	The pre-shared key for WPA personal.
wep-key-ascii	Whether wep-key-[1-4] are ASCII characters or hexadecimal digits.
wep-key-length	The length of wep-key-[1-4], in bits, not including the IV.
wep-key-[1-4]	The WEP keys.
mac	The MAC address of the interface.

status

Purpose		Controls whether the service set is on or off.
Valid values		"up" or "down".

type

Purpose		The type of the interface. Read-only.
Valid values		Always "service-set".

ssid

Purpose		The SSID.
Valid values		Any string between 1 and 32 characters.

bss

Purpose		The BSS this is part of.
Valid values		The name of an existing bss instance.

security

Purpose		The security to use.
Valid values		plain-text static-wep dot1x wpa-personal wpa-enterprise */

wep-default-key

Purpose		The WEP key index to use when transmitting. Only used when security is static-wep.
Valid values		a number between 1 and 4.

wpa-personal-key

Purpose		The pre-shared key for WPA personal. Only used when security is wpa-personal.
Valid values		an ASCII string between 8 and 63 characters.

wep-key-ascii

Purpose		Whether wep-key-[1-4] are ASCII characters or hexadecimal digits. Only used when security is static-wep.
Valid values		"yes" or "no"