 |
 |
 |
 |
 |
 |
 |
 |
Class | Description |
|---|---|
An access-point. |
An associated station. |
A radio rate. |
|
A port that is a member of a bridge. |
|
A BSS of a radio. |
|
Stores arbitrary data. |
|
Controls channel planner parameters.
|
|
Config settings. |
|
A detected access point. |
|
The DHCP client. |
|
802.11 settings (all radios). |
|
Upgrade the firmware of the AP through HTTP. |
|
IP host settings. |
|
A network interface. |
|
A bridge interface. |
|
An Ethernet interface. |
|
A loopback interface. |
|
A service set interface. |
|
A VLAN interface. |
|
A WDS interface. |
|
An IP route. |
|
Access point log settings. |
|
An entry in the log. |
|
A MAC access list entry. |
|
Network Time Protocol client settings. |
|
Guest captive portal settings. |
|
A physical radio. |
|
A local authentication server user. |
|
Serial access to the CLI. |
|
SNMP server. |
|
SSH access to the CLI. |
|
A radio rate. |
|
System-wide settings. |
|
Telnet access to the CLI. |
|
A transmission queue. |
|
A Virtual Wireless Network. |
|
A web server. |
|
A WME station queue. |
Persistent: Yes.
Purpose:
Access Point
Description:
Enables access point configuration for Guest and VWN.
Property | Description |
|---|---|
Determines whether guest access is enabled or not. |
|
Determines whether guest access uses the second Ethernet port, or a VLAN on the first Ethernet port. |
|
Determines whether Virtual Wireless Networks are enabled. |
|
Purpose
|
Determines whether guest access is enabled or not. |
|
|
Valid values
|
"up" or "down". |
|
Purpose
|
Determines whether guest access uses the second Ethernet port, or a VLAN on the first Ethernet port. |
|
|
Valid values
|
"ethernet" or "vlan". |
|
Purpose
|
Determines whether the Virtual Wireless Networks are enabled. |
|
|
Valid values
|
"up" or "down" |
Persistent: No.
Purpose:
An associated station.
Property | Description |
|---|---|
The interface with which the station is associated. |
|
The MAC address of the station. |
|
Whether the station is authenticated. |
|
Whether the station is associated. |
|
The number of packets received from the station. |
|
The number of packets transmitted by the station. |
|
The number of bytes received from the station. |
|
The number of bytes transmitted by the station. |
|
The transmission rate. |
|
The listen interval. |
|
Purpose
|
The interface with which the station is associated. |
|
|
Valid values
|
Linux network interface name. |
|
Purpose
|
The MAC address of the station. |
|
|
Valid values
|
Six colon-separated octets in hexadecimal. |
|
Purpose
|
Whether the station is authenticated. |
|
|
Valid values
|
"Yes" or "-". |
|
Purpose
|
Whether the station is associated. |
|
|
Valid values
|
"Yes" or "-". |
|
Purpose
|
The number of packets received from the station. |
|
|
Valid values
|
Positive integer. |
|
Purpose
|
The number of packets transmitted by the station. |
|
|
Valid values
|
Positive integer. |
|
Purpose
|
The number of bytes received from the station. |
|
|
Valid values
|
Positive integer. |
|
Purpose
|
The number of bytes transmitted by the station. |
|
|
Valid values
|
Positive integer. |
|
Purpose
|
The transmission rate. |
|
|
Valid values
|
A rate, in 100 kbps. |
|
Purpose
|
The listen interval. |
|
|
Valid values
|
A time, in ms. |
Persistent: Yes.
Purpose:
A radio rate.
Description:
Used to set the rate sets of radios.
Property | Description |
|---|---|
A radio rate in MBps. |
|
Purpose
|
A radio rate in MBps. Note that you cannot change an existing rate property; you can only insert or delete the entire instance. |
|
|
Valid values
|
Positive integer, or 5.5. |
Persistent: Yes.
Purpose:
A port that is a member of a bridge.
Property | Description |
|---|---|
The path cost. |
|
The port priority. |
|
Purpose
|
The path cost. Used only when STP is on. |
|
|
Valid values
|
1-65535. |
|
Purpose
|
The port priority. Used only when STP is on. |
|
|
Valid values
|
0-255. |
Persistent: Yes.
Purpose:
A BSS of a radio.
Description:
Represents a basic service set.
Property | Description |
|---|---|
Controls whether this is on or off. |
|
A human-readable description of the interface. |
|
The radio this is part of. |
|
The service-set interface to send beacons for. |
|
The MAC address of the interface. |
|
Delivery Traffic Information Map period. |
|
Maximum number of stations. |
|
Do not send SSID in beacons and ignore probe requests. |
|
MAC address Access Control List mode. |
|
The name of the mac access control list to use. |
|
Whether RADIUS accounting is enabled. |
|
The port to use for RADIUS accounting. |
|
The port to use for RADIUS authentication. |
|
The RADIUS server shared secret. |
|
Whether Open System authentication is permitted. |
|
Whether Shared Key authentication is permitted. |
|
Whether non-WPA stations can associate during WPA. |
|
Whether TKIP is permitted as a WPA cipher. |
|
Whether CCMP is permitted as a WPA cipher. |
|
Purpose
|
Controls whether this is on or off. |
|
|
Valid values
|
"up" or "down". |
|
Purpose
|
A human-readable description of the interface. |
|
|
Valid values
|
An ASCII string. |
|
Purpose
|
The radio this is part of. |
|
|
Valid values
|
The name of an existing radio instance. |
|
Purpose
|
The service-set interface to send beacons for. |
|
|
Valid values
|
The name of an existing interface instance with type of service-set. |
|
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. |
|
Purpose
|
Delivery Traffic Information Map period. |
|
|
Valid values
|
1-225. |
|
Purpose
|
Maximum number of stations. |
|
|
Valid values
|
0-2007. |
|
Purpose
|
Do not send SSID in beacons and ignore probe requests. |
|
|
Valid values
|
"on" or "off". |
|
Purpose
|
MAC address Access Control List mode. |
|
|
Valid values
|
"deny-list": deny only stations in list. |
|
Purpose
|
The name of the mac access control list to use. |
|
|
Valid values
|
The name of existing mac-acl instances. |
|
Purpose
|
Whether RADIUS accounting is enabled. If unset defaults to "off". |
|
|
Valid values
|
"on" or "off". |
|
Purpose
|
The port to use for RADIUS accounting. |
|
|
Valid values
|
0-65535. |
|
Purpose
|
The port to use for RADIUS authentication. |
|
|
Valid values
|
0-65535. |
|
Purpose
|
The RADIUS server IP address. |
|
|
Valid values
|
An IP address. |
|
Purpose
|
The RADIUS server shared secret. |
|
|
Valid values
|
A string. |
|
Purpose
|
Whether Open System authentication is permitted. |
|
|
Valid values
|
"on" or "off". |
|
Purpose
|
Whether Shared Key authentication is permitted. |
|
|
Valid values
|
"on" or "off". |
|
Purpose
|
Whether non-WPA stations can associate during WPA. If unset defaults to "off". |
|
|
Valid values
|
"on" or "off". |
|
Purpose
|
Whether TKIP is permitted as a WPA cipher. |
|
|
Valid values
|
"on" or "off". |
|
Purpose
|
Whether CCMP is permitted as a WPA cipher. |
|
|
Valid values
|
"on" or "off". |
Persistent: Yes.
Purpose:
The set of APs, identified by IP addresses, that share configuration information.
Description:
Stores data relating to clustering.
Property |
Description |
|---|---|
Determines whether clustering is enabled on this node. |
|
The location of the cluster member. |
|
The name of the cluster to join. |
|
Purpose
|
Determines whether clustering is enabled on this node.. |
|
|
Valid values
|
"0": Disable clustering (clustering is OFF). |
|
Purpose
|
The location of the cluster member. |
|
|
Valid values
|
Any string. If the string includes spaces or special characters, enclose it in double quotes. |
|
Purpose
|
The name of the cluster to join. |
|
|
Valid values
|
Any string. If the string includes spaces or special characters, enclose it in double quotes. |
Persistent: Yes.
Purpose:
Description:
Controls channel planner parameters.
Property | Description |
|---|---|
Determines whether channel planning is enabled. |
|
The percentage change in error required to propagate new channel assignments. |
|
Minutes between each attempt to optimize channel assignments.. |
|
Comma delimited list of APs whose channels' channel planner will not change. |
|
Purpose
|
Determines whether channel planning is enabled or not. |
|
|
Valid values
|
"0": Disable channel planning (channel planning is OFF). |
|
Purpose
|
The percentage change in error required to propagate new channel assignments. |
|
|
Valid values
|
0-100 |
|
Purpose
|
Minutes between each attempt to optimize channel assignments. |
|
|
Valid values
|
1 + minutes. A reasonable maximum of 2880 minutes. |
|
Purpose
|
Comma-delimited list of APs whose channels' channel planner will not change. |
|
|
Valid values
|
A valid IP address. |
Persistent: Yes.
Purpose:
Config settings.
Description:
Used for config properties.
Property | Description |
|---|---|
Configuration at boot time. |
|
Configuration after factory reset. |
|
Prevent external configuration updates. |
|
Version of configuration. |
|
Format of backup configuration file. |
|
Purpose
|
Configuration at boot time. Write-only. |
|
|
Valid values
|
"default": Reset to factory defaults. |
|
Purpose
|
Configuration after factory reset. Write-only. |
|
|
Valid values
|
"rescue": Reset to rescue. |
|
Purpose
|
Prevent external configuration updates. |
|
|
Valid values
|
"up" or "down". |
Purpose |
Shows version of AP configuration. |
|
Valid values |
Numeric string such as 1.03. |
Purpose |
Shows file format of backup configuration file. |
|
Valid values |
"plain" or "encrypted" |
Persistent: No.
Purpose:
A detected access point.
Description:
Represents an access point that has been detected by passive scanning.
Property | Description |
|---|---|
The MAC address of the AP. |
|
The radio that detected the AP. |
|
The beacon interval for this radio in kus (1.024 ms). |
|
The capabilities of the AP. |
|
The type of device detected. |
|
Whether privacy (WEP or WPA) is enabled. |
|
The SSID of the AP. |
|
Whether WPA security is enabled. |
|
The mode our radio was in when the AP was detected. |
|
The RF band the AP was detected in. |
|
The channel of the AP. |
|
The rate of the AP. |
|
The signal of the AP. |
|
The ERP of the AP. |
|
The number of beacons received from this AP. |
|
The time of the last beacon received from this AP. |
|
The supported rates of the AP. |
|
Purpose
|
The MAC address of the AP. |
|
|
Valid values
|
Six colon-separated octets in hexadecimal. |
|
Purpose
|
The radio that detected the AP. |
|
|
Valid values
|
Linux network interface name. |
|
Purpose
|
The beacon interval of the AP in kus (1.024 ms). |
|
|
Valid values
|
Positive integer. |
|
Purpose
|
The capabilities of the AP. |
|
|
Valid values
|
C-formatted hexadecmial bitflag. |
|
Purpose
|
The type of device detected. |
|
|
Valid values
|
"AP", "Ad hoc", or "Other". |
|
Purpose
|
Whether privacy (WEP or WPA) is enabled. |
|
|
Valid values
|
"On" or "Off". |
|
Purpose
|
The SSID of the AP. |
|
|
Valid values
|
String of up to 32 octets. |
|
Purpose
|
Whether WPA security is enabled. |
|
|
Valid values
|
"On" or "Off". |
|
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. |
|
Purpose
|
The RF band the AP was detected in. |
|
|
Valid values
|
"2.4", "5", or "5 Turbo". |
|
Purpose
|
The channel of the AP. |
|
|
Valid values
|
Positive integer. |
|
Purpose
|
The rate of the AP. |
|
|
Valid values
|
Positive integer. |
|
Purpose
|
The signal of the AP. |
|
|
Valid values
|
Positive integer. |
|
Purpose
|
The ERP of the AP. |
|
|
Valid values
|
C-formatted hexadecimal number. |
|
Purpose
|
The number of beacons received from this AP. |
|
|
Valid values
|
Positive integer. |
|
Purpose
|
The time of the last beacon received from this AP. |
|
|
Valid values
|
Date and time, in Unix time format. |
|
Purpose
|
The supported rates of the AP. |
|
|
Valid values
|
Bracketed list of hexadecimal rate codes. |
Persistent: Yes.
Purpose:
The DHCP client.
Description:
Represents a DHCP client.
Property | Description |
|---|---|
Controls whether this is on or off. |
|
The interface to perform DHCP on. |
|
Purpose
|
Controls whether this is on or off. |
|
|
Valid values
|
"up" or "down". |
|
Purpose
|
The interface to perform DHCP on. |
|
|
Valid values
|
The name of an existing interface instance. |
Persistent: Yes.
Purpose:
802.11 settings (all radios).
Description:
Represents the wireless functions of the access point.
Property | Description |
|---|---|
Controls whether 802.11 is in use. |
|
The debugging level for 802.11. |
|
Whether AP should enable 802.11d. |
|
Purpose
|
Controls whether 802.11 is in use. |
|
|
Valid values
|
"up" or "down". |
|
Purpose
|
The debugging level for 802.11. |
|
|
Valid values
|
0-3. |
|
Purpose
|
Whether AP should enable 802.11d |
|
|
Valid values
|
"up" or "down". |
Persistent: Yes.
Purpose:
Upgrade the firmware of the AP through HTTP.
Description:
Enables the upgrade to the latest version of firmware.
Property | Description |
|---|---|
Indicates the progress of the firmware upgrade. |
|
Starts the firmware upgrade through HTTP. |
|
The url to the location of the firmware upgrade file. |
|
Checks the validity of the upgrade file. |
|
Purpose
|
Indicates the progress of the firmware upgrade . |
|
|
Valid values
|
Progress time in seconds. |
|
Purpose
|
Starts the firmware upgrade. |
|
|
Valid values
|
"yes" or "no". |
|
Purpose
|
The url to the location of the upgrade file. |
|
|
Valid values
|
http://<server IP>[<server port>]/filename |
|
Purpose
|
Checks the validity of the upgrade file |
|
|
Valid values
|
"yes" or "no". |
Persistent: Yes.
Purpose:
IP host settings.
Description:
Used for IP host properties.
Property | Description |
|---|---|
Domain name servers in use. |
|
Domain name in use. |
|
The host name. |
|
Domain name servers to use when not obtained through DHCP. |
|
Domain name to use when not obtained through DHCP. |
|
Whether DNS parameters are obtained through DHCP. |
|
Purpose
|
Domain name servers in use. |
|
|
Valid values
|
IP address. |
|
Purpose
|
Domain name in use. |
|
|
Valid values
|
DNS domain name. |
|
Purpose
|
The host name. |
|
|
Valid values
|
DNS domain name. |
|
Purpose
|
Domain name servers to use when not obtained through DHCP. |
|
|
Valid values
|
IP address. |
|
Purpose
|
Domain name to use when not obtained through DHCP. |
|
|
Valid values
|
DNS domain name. |
|
Purpose
|
Whether DNS parameters are obtained through DHCP. |
|
|
Valid values
|
"up" or "down". |
Persistent: Yes.
Purpose:
A network interface.
Description:
Used for per-interface properties.
Property | Description |
|---|---|
The actual IP address of this interface. |
|
The actual netmask of this interface. |
|
Controls whether this is on or off. |
|
The type of the interface. |
|
A human-readable description of the interface. |
|
The MAC address of the interface. |
|
The static IP address of this interface. |
|
The static netmask of this interface. |
|
Received bytes. |
|
Received packets. |
|
Received packets with errors. |
|
Received packets that were dropped. |
|
Received packets with FIFO overflows. |
|
Received packets with frame errors. |
|
Received packets with compression. |
|
Received packets that were multicast. |
|
Transmitted bytes. |
|
Transmitted packets. |
|
Transmitted packets with errors. |
|
Transmitted packets that were dropped. |
|
Transmitted packets with FIFO overflows. |
|
Transmitted packets will collisions. |
|
Transmitted packets with carrier errors. |
|
Transmitted packets with compression. |
|
Purpose
|
The actual IP address of this interface. Read-only. |
|
|
Valid values
|
IP address. |
|
Purpose
|
The actual netmask of this interface. Read-only. |
|
|
Valid values
|
Netmask in dotted-decimal notation. |
|
Purpose
|
Controls whether this is on or off. |
|
|
Valid values
|
"up" or "down". |
|
Purpose
|
The type of the interface. Used to determine what additional properties are available. Read-only. |
|
|
Valid values
|
"ethernet", "loopback", "service-set", "bridge", "vlan", "wds". |
|
Purpose
|
A human-readable description of the interface. |
|
|
Valid values
|
An ASCII string. |
|
Purpose
|
The MAC address of the interface. |
|
|
Valid values
|
6 colon-separated hexadecimal digit pairs. |
|
Purpose
|
The static IP address of this interface. Used when DHCP is not in use. |
|
|
Valid values
|
IP address. |
|
Purpose
|
The static netmask of this interface. Used when DHCP is not in use. |
|
|
Valid values
|
Netmask in dotted-decimal notation. |
|
Purpose
|
Received bytes. |
|
|
Valid values
|
Integer. |
|
Purpose
|
Received packets. |
|
|
Valid values
|
Integer. |
|
Purpose
|
Received packets with errors. |
|
|
Valid values
|
Integer. |
|
Purpose
|
Received packets that were dropped. |
|
|
Valid values
|
Integer. |
|
Purpose
|
Received packets with FIFO overflows. |
|
|
Valid values
|
Integer. |
|
Purpose
|
Received packets with frame errors. |
|
|
Valid values
|
Integer. |
|
Purpose
|
Received packets with compression. |
|
|
Valid values
|
Integer. |
|
Purpose
|
Received packets that were multicast. |
|
|
Valid values
|
Integer. |
|
Purpose
|
Transmitted bytes. |
|
|
Valid values
|
Integer. |
|
Purpose
|
Transmitted packets. |
|
|
Valid values
|
Integer. |
|
Purpose
|
Transmitted packets with errors. |
|
|
Valid values
|
Integer. |
|
Purpose
|
Transmitted packets that were dropped. |
|
|
Valid values
|
Integer. |
|
Purpose
|
Transmitted packets with FIFO overflows. |
|
|
Valid values
|
Integer. |
|
Purpose
|
Transmitted packets will collisions. |
|
|
Valid values
|
Integer. |
|
Purpose
|
Transmitted packets with carrier errors. |
|
|
Valid values
|
Integer. |
|
Purpose
|
Transmitted packets with compression. |
|
|
Valid values
|
Integer. |
Extends: interface
Persistent: Yes.
Purpose:
A bridge interface.
Property | Description |
|---|---|
Whether the Spanning Tree Protocol is in use. |
|
The hello time. |
|
The forward delay. |
|
The bridge priority. |
|
Whether ports are isolated. |
|
Purpose
|
Whether the Spanning Tree Protocol is in use. |
|
|
Valid values
|
"on" or "off". |
|
Purpose
|
The hello time. Only used when stp is on. |
|
|
Valid values
|
1.0-10.0. |
|
Purpose
|
The forward delay. Only used when stp is on. |
|
|
Valid values
|
4.0-30.0. |
|
Purpose
|
The bridge priority. Only used when stp is on. |
|
|
Valid values
|
0-65535. |
|
Purpose
|
Whether ports are isolated. If on, then isolated ports on this bridge can only exchange data with |