wlan ssid-profile

wlan ssid-profile <ssid_profile>

a-basic-rates <rate>

a-beacon-rate <rate>

a-max-tx-rate <rate>

a-min-tx-rate <rate>

a-tx-rates <rate>

accounting-server <name>

advertise-ap-name

advertise-location

air-time-limit <limit>

allowed-5ghz-radio <first-dot11a-radio-only | second-dot11a-radio-only | all>

auth-pkt-mac-format {delimiter|upper-case}

auth-req-thresh <threshold>

auth-server <name>

auth-survivability

bandwidth-limit <limit>

blacklist / denylist

broadcast-filter {All|ARP|Unicast-ARP-Only|Disabled}

called-station-id {type{ap-group|ap-name|ipaddr|macaddr|clan-id} |include-ssid [delimiter]}

captive-portal {<type> [exclude-uplink <types>] | external [Profile <name>] [exclude-uplink <types>]}

captive-portal-proxy-server <ip> <port>

cdc-enable

content-filtering

delete-pmkcache

deny-inter-user-bridging

deny-intra-vlan-traffic

deny-local-routing

disable

dmo-channel-utilization-threshold <threshold>

dot11k

dot11k-profile <profile name>

dot11r

dot11v

download-role

dot1x-timer-idrequest-period

dot1x-wpa-key-period

dot1x-wpa-key-retries

dtim-period <value>

dynamic-multicast-optimization

enable

enforce-dhcp

essid <essid>

explicit-ageout-client

external-server

facebook-xwf-role <role-name>

ftm-responder-enable

g-basic-rates <rate>

g-beacon-rate <rate>

g-min-tx-rate <rate>

g-max-tx-rate <rate>

g-tx-rates

hide-ssid

high-efficiency-enable

high-efficiency-disable

high-throughput-enable

high-throughput-disable

no high-throughput-enable

hotspot-profile <name>

inactivity-timeout <interval>

index <idx>

key-duration <duration>

l2-auth-failthrough

leap-use-session-key

local-probe-req-thresh <threshold>

mbssid-group-profile <profile name>

no mbssid-group-profile <profile name>

mac-authentication

mac-authentication-delimiter <delim>

mac-authentication-upper-case

max-authentication-failures <limit>

max-clients-threshold <Max_clients>

max-retries

max-ipv4-users <threshold>

mbo-enable

mdid <Mobility domain ID>

mfp-capable

mfp-required

multicast-rate <rate>

multicast-rate-optimization

mpdu-agg-disable

no

okc

openflow-enable

opmode <opmode>

opmode-transition

opmode-transition-disable

out-of-service <def> <name>

per-user-bandwidth-limit <limit>

priority-use-local-cache-auth

qbss-load-enable

radius-accounting

radius-accounting-mode {user-association|user-authentication}

radius-interim-accounting-interval <minutes> {<seconds>}

radius-reauth-interval <minutes>

rf-band <band>

rrm-quiet-ie

rts-threshold

rx-ampdu-agg-disable

server-load-balancing

set-role <attribute> {{contains|ends-with|equals|matches-regular-expression|not-equals|starts-with} <operand> <role>|value-of}

set-role-by-ssid

set-role-mac-auth <mac_only>

set-role-machine-auth {<machine_only>|<user_only>}

set-role-pre-auth <role>

set-role-unrestricted

set-vlan <attribute> {{contains|ends-with|equals|matches-regular-expression|not-equals|starts-with} <operand> <vlan>|value-of}

short-preamble-disable

strict-svp

supported-mcs-set

temporal-diversity

termination

time-range <name> {enable| disable}

tspec

tspec-bandwidth

type {employee|voice|guest}

use-ip-for-calling-station

utf8

vlan

very-high-throughput-disable

vht-supported-mcs-map

vht-mu-txbf-disable

vht-txbf-explicit-enable

vlan <vlan>

wep-key <wep-key>

wispr

wmm-background-dscp <dscp>

wmm-background-share <share>

wmm-best-effort-dscp <dscp>

wmm-best-effort-share <share>

wmm-uapsd-disable

wmm-video-dscp <dscp>

wmm-video-share <share>

wmm-voice-dscp <dscp>

wmm-voice-share <share>

work-without-uplink

wpa-passphrase <wpa-passphrase>

zone <zone>

no wlan ssid-profile <ssid_profile>

Description

This command configures a WLAN SSID profile. Use this command to configure a WLAN SSID profile to set up an employee, voice, or guest network.

The bandwidth share percentage configuration is not supported on 200 Series, 203H Series, 203R Series, IAP-207, 210 Series, 220 Series, IAP-228, 340 Series, 500 Series, 510 Series, AP-518, and 570 Series access points. Therefore the following parameters do not take effect in these AP platforms: wmm-background-share <share>, wmm-best-effort-share <share>, wmm-video-share <share>, and wmm-voice-share <share>.

Parameter

Description

wlan ssid-profile <ssid_profile>

Creates a WLAN SSID profile.

a-basic-rates

Allows you to define a set of modulation rates to use for the clients on the 5 GHz radio band.

Range: wmm-voice-share <share>

Default: 6, 12, 24

a-beacon-rate <rate>

Configures the beacon rate for 802.11a (use for DAS only). Using this parameter in normal operation may cause connectivity problems.

Range: default, 6, 9, 12, 18,24,36,48,54 Mbps

Default: minimum valid rate

a-max-tx-rate <rate>

Configures the specify the maximum transmission rate for the 5 GHz band.

Range: 6,9,12,18,24,36,48,54 in Mbps

Default: 54

a-min-tx-rate <rate>

Configures the specify the minimum transmission rate for the 5 GHz band.

Range: 6,9,12,18,24,36,48,54 in Mbps

Default: 6

a-tx-rate <rate>

Allows you to configure specific transmission rate at which Instant AP can transmit data to the clients connected on 5 GHz band.

Range: 6,9,12,18,24,36,48,54 in Mbps

Default: All

accounting-server <name>

This command configures a server for accounting purpose.

allowed-5ghz-radio <first-dot11a-radio-only | second-dot11a-radio-only | all >

This command configures the 5GHz radio to which the SSID should be assigned.

The no allowed-5ghz-radio command removes the configuration.

Default: all

advertise-ap-name

When enabled, the Instant AP broadcasts the AP Name information in the beacons frames and probe responses.

advertise-location

When enabled, the Instant AP broadcasts the AP Location Co-ordinate Information by unicast messages in FTM responder frames and by broadcast messages in beacons frames and probe responses.

FTM responder parameter, ftm-responder-enable, must be enabled before configuring advertise-location.

NOTE: Currently, APs do not have the capability to generate location information. However, the static location information can be configured for the AP statically using the CLI. Please contact Aruba Technical Support to configure the location information on your AP for LCI broadcast.

air-time-limit <limit>

Configures an aggregate amount of airtime that all clients using this SSID can use for sending and receiving data.

auth-pkt-mac-format {delimiter|upper-case}

Configures a delimiter and upper-case characters in a MAC Address string of authentication packet or the username and password of the client.

The delimiter and upper-case parameters in this command are available for all authentication methods. And without the mac-authentication-delimiter and mac-authentication-upper-case configuration, it works on the username and password for MAC Authentication.

auth-req-thresh

Allows you to set a threshold for authentication requests for the SSID profile.

auth-server <name>

Configures an authentication server for the SSID users.

auth-survivability

Enables the authentication survivability feature. The default value of the cache timeout period is 24 hours.

NOTE: The authentication survivability feature requires ClearPass Policy Manager 6.0.2 or later, and is applicable only when external servers such as RADIUS are configured for the SSID. When enabled, Instant authenticates the previously connected clients using EAP-PEAP authentication even when connectivity to ClearPass Policy Manager is temporarily lost. The Authentication survivability feature is not applicable when a RADIUS server is configured as an internal server.

Default: Disabled

bandwidth-limit

<limit>

Configures an aggregate amount of bandwidth that each radio is allowed to provide for the connected clients.

Range: 1–65535

blacklist / denylist

Enables dynamic blacklisting / denylisting of clients.

broadcast-filter {All|ARP|Unicast-ARP-Only|Disabled}

Configures broadcast filtering parameters:

You can configure any of the following filtering parameters:

  • All — When set to All, the Instant AP drops all broadcast and multicast frames except DHCP, ARP, igmp-group queries, and IPv6 neighbor discovery protocol.
  • ARP — When set to ARP, the Instant AP drops all broadcast and multicast frames except ARP, DHCP, igmp-group queries, IPv6 neighbor discovery protocol, and additionally converts ARP frames to unicast.
  • Unicast-ARP-Only — When set to Unicast-ARP-Only, the Instant AP allows all broadcast and multicast frames as it is, however the ARP requests are converted to unicast frames and sends them to the associated clients.
  • Disabled — When set to Disabled, the Instant AP routes all the broadcast and multicast frames to the wireless interfaces.

Range: All, ARP, Unicast-ARP-Only, Disabled

Default: ARP

called-station-id

{type

{ap-group|ap-name|ipaddr|macaddr|vlan-id}

|include-ssid [delimiter]}

Configures the following called-station-id types:

  • ap-group — The Virtual Controller name is used as the called-station-id.
  • ap-name — The Instant AP hostname isused as the called-station-id.
  • vlan-id — The VLAN ID of the client is used as the called-station-id.
  • ipaddr — The IP address of the Instant AP is used as the called-station-id.
  • macaddr — The MAC address of the Instant AP is used as the calling-station-id.
  • include-ssid {delimiter <delimiter>} — The SSID is appeneded to the original called-station-id. You can optionally set a delimiter at the end.

Default: called-station-id {type <macaddr>}

captive-portal

{<type>[exclude-uplink <types>]

|external[exclude-uplink <types>|

profile <name>[exclude-uplink <types>]]}

Configures captive portal authentication for the SSID.

If the external captive profiles are created, you can specify the profile name by using the external and profile keywords and associated parameters.

You can also exclude an uplink type for the captive portal based SSID profiles. When an uplink type is selected for the exclude-uplink option, redirection to the captive portal based on the type of specified uplink is disabled.

Range: 3G, 4G, wifi, ethernet

captive-portal-proxy-server

<ip> <port>

Allows you to specify an IP address and port number that match the proxy configuration of your browser.

cdc-enable

Advertizes the Cellular Data Capability (CDC) attribute of an MBO.

NOTE: CDC can only be enabled when MBO is enabled.

content-filtering

Routes all DNS requests for the non-corporate domains to the configured DNS on this network.

Default: Disabled

delete-pmkcache

Deletes client entries from the PMK cache when the client is removed from the client list of an AP. Enabling this parameter deletes client entries in the PMK cache immediately after disconnection as opposed to 8 hours, the default ageout period of PMK cache entries.

Default: Disabled

deny-inter-user-bridging

Disables the bridging traffic between two clients connected to the same SSID on the same VLAN. When inter-user bridging is disabled, the clients can connect to the Internet, but cannot communicate with each other, and the bridging traffic between the clients is sent to the upstream device to make the forwarding decision.

deny-intra-vlan-traffic

Disables client-to-client communication in a network. When intra vlan traffic is disabled, the IAP only fowards client traffic to gateway and configured wired servers. All other traffic from the client is dropped.

Range: Disabled

deny-local-routing

Disables the local-routing optimization on the Instant AP. This setting is only applicable to clients who are not using the AP itself as their respective default gateway. When local routing is disabled, the AP will not attempt to directly forward traffic between two clients on the same AP but on different VLANs. Instead, the traffic between such clients will have to follow the normal routing path and will be first sent to their respective default gateways, which will make the final forwarding decision.

disable-on-6ghz-mesh

Disables the broadcast of the SSID in the 6 GHz band when mesh is configured on the 6 GHz band.

Instant APs support up to four 6 GHz networks at any time. When mesh is enabled on the 6 GHz band, one 6 GHz network is allocated for mesh functions and only three 6 GHz networks can be configured. Enable this parameter on the SSID in which you want to disable the 6 GHz band when mesh is configured on the 6 GHz band.

disable

Disables the SSID. By default all SSIDs are enabled.

dmo-channel-utilization-threshold

<threshold>

Sets a threshold for DMO channel utilization. Instant AP sends multicast traffic over the wireless link.

Range: 1–100 percentage value

Default: 90

dot11k

Enables 802.11k roaming on the SSID profile.

The 802.11k protocol enables Instant APs and clients to dynamically measure the available radio resources.

When 802.11k is enabled, Instant APs and clients send neighbor reports, beacon reports, and link measurement reports to each other.

dot11k-profile <profile name>

Configures a dot11k-profile to the WLAN SSID 

dot11r

Enables 802.11r on the SSID profile.

802.11r or fast BSS FT is an IEEE standard that permits continuous connectivity across wireless devices during client mobility. Fast BSS Transition mechanism minimizes the delay in roaming when a client transitions from one BSS to another within the same cluster.

Fast BSS Transition is operational only if the wireless client supports 802.11r standard. If the client does support 802.11r standard, it falls back to normal WPA-2 authentication method.

dot11v

Enables 802.11v based BSS transition.

download-role

Enables user role download from Policy Manager to the Instant AP

dot1x-timer-idrequest-period

Sets timer options for 802.1X authentication at intervals, in seconds, between identity request retries.

dot1x-wpa-key-period

Interval, in milliseconds, between each WPA key exchange.

dot1x-wpa-key-retries

Set the number of times WPA key messages are retried.

dtim-period <value>

Configures the DTIM interval for the SSID profile.

The DTIM interval determines how often the Instant AP should deliver the buffered broadcast and multicast frames to associated clients in the powersaving mode.

When configured, the client checks for buffered data on the Instant AP at the specified number of beacons. You can also configure a higher value for DTIM interval for power saving.

Range: 1–10 beacons

Default: 1

dynamic-multicast-optimization

Allows the Instant AP to convert multicast streams into unicast streams over the wireless link. Enabling DMO enhances the quality and reliability of streaming video, while preserving the bandwidth available to the non-video clients.

NOTE: When you enable DMO on multicast SSID profiles, ensure that the DMO feature is enabled on all SSIDs configured in the same VLAN.

Default: Disabled

enable

Re-enables the deactivated SSIDs.

Default: Enabled

enforce-dhcp

Blocks Instant AP traffic to the clients that do obtain IP address from DHCP.

Default: Disabled

essid <essid>

Defines a variable for each Instant AP that identifies a WLAN network. The Instant AP takes this parameter from its per-AP-ssid specific configuration.

external-server

Configures an external RADIUS server for authentication.

explicit-ageout-client

Allows the Instant AP to send a deauthentication frame to the client and clear client entry.

Default: Disabled

facebook-xwf-role <role-name>

Configures the base role assigned to Facebook Express Wi-Fi user connecting to the SSID. Configuring this parameter also enables Facebook Express Wi-Fi feature on the SSID.

NOTE: The Facebook Express Wi-Fi feature will no longer be supported after Instant Mode 8.10.0.0. For more information, read the official statement by Meta (formerly Facebook).

ftm-responder-enable

Enables the AP to send responses to Fine Time Measurement (FTM) queries sent from clients. This feature is supported on 500 Series and 600 Series access points.

g-basic-rates

Allows you to define a set of modulation rates to use for the clients on the 2.4 GHz radio band.

Range: 1,2,5,6,9,11,12,18,24,36,48,54 in Mbps

Default: 1, 2

g-beacon-rate <rate>

Configures the beacon rate for 802.11g (use for DAS only). Using this parameter in normal operation may cause connectivity problems.

Range: default, 1,2,5, 6 9, 11, 12, 18, 24, 36, 48, 54 Mbps

Default: minimum valid rate.

g-min-tx-rate <rate>

Configures the specify the minimum transmission rate for the 2.4 GHz band.

Range: 1,2,5,6,9,11,12,18,24,36,48,54 in Mbps

Default: 1

g-max-tx-rate <rate>

Configures the specify the maximum transmission rate for the 2.4 GHz band.

Range: 1,2,5,6,9,11,12,18,24,36,48,54 in Mbps

Default: 54

g-tx-rates

Allows you to configure specific transmission rate at which the Instant AP can transmit data to the clients connected on 2.4 GHz band.

Range: 1,2,5,6,9,11,12,18,24,36,48,54 in Mbps

Default: All

hide-ssid

Hides the SSID. When enabled, the SSID will not be visible for the users.

Default: Disabled

high-efficiecny-enable

Enables the high effiency feature on 802.11ax devices

Default: Enabled

high-efficiency-disable

Disables the high effiency feature on 802.11ax devices

high-throughput-enable

Enables the 802.11n high throughput functionality.

Default: Enabled

high-throughput-disable

Disables the 802.11n high throughput functionality.

no high-throughput-disable

Enables the 802.11n high throughput functionality. This is an AirWave specific command.

hotspot-profile <name>

Associates a hotspot profile with the WLAN SSID profile.

inactivity-timeout <interval>

Configures a timeout value for the inactive client sessions.

When a client session is inactive for the specified duration, the session expires and the clients are required to log in again.

Range: 60–86400 seconds

Default: 1000

index <idx>

Assigns an index value for the SSID.

key-duration <duration>

The r1 key timeout value in seconds for decrypt-tunnel or bridge mode.

l2-auth-failthrough

Allows the clients to use 802.1X authentication when MAC authentication fails.

Default: Disabled

leap-use-session-key

Allows the users to derive session keys for LEAP authentication.

Configure this command for old printers that use dynamic WEP and if you do not want use a session key from the RADIUS Server to derive pair wise unicast keys.

Default: Disabled

local-probe-req-thresh

<threshold>

Configures a RSSI threshold value to limit the number of incoming probe requests.

When enabled, this command controls the system response to the broadcast probe requests sent by clients to search for the available SSIDs and ignores the probe request if required.

Range: 0–100 dB

mbssid-group-profile <profile name>

Binds the MBSSID group profile to the SSID profile which name is specified by <profile name>.

no mbssid-group-profile <profile name>

Unbinds the MBSSID group profile to the SSID profile which name is specified by <profile name>.

mac-authentication

Enables MAC authentication for clients that use this SSID profile.

Default: Disabled

mac-authentication-delimiter <delim>

Allows you to set a delimiter that can be used in the MAC address string for MAC authentication.

You can specify colon or dash for delimiter. If the delimiter is not specified, the MAC address in the xxxxxxxxxxxx format is used. If you specify colon for the delimiter, the MAC addresses in the xx:xx:xx:xx:xx:x

Range: colon or dash format are used.

mac-authentication-upper-case

Enables the Instant AP to use uppercase letters in MAC address string for MAC authentication.

max-authentication-failures <limit>

Configures the maximum number of authentication failures to dynamically blacklist / denylist the users.

The users who exceed the number of authentication failures configured through this command are dynamically blacklisted.

max-clients-threshold <Max_clients>

Specifies the maximum number of clients that can be configured for each BSSID on a WLAN.

Range: 0-1023

Default: 1023

NOTE: Specify 1023 to set the threshold to maximum number of clients. When this parameter is configured the value is applicable to every Instant AP in a cluster.

max-retries

Denotes the maximum number of retries the Instant AP attempts when the client is not responding to the 802.11 frames.

Range: 1–128

Default: 8

max-ipv4-users <threshold>

Configures the maximum number of wired IPv4 users that can connect to the wireless client bridge.

Range: 1-32

Default: 1

mbo-enable

Enables the Agile Multiband Operations (MBO). Enables the mfp-capable, 802.11k and 802.11u-interworking implicitly on the AP.

mdid

Denotes the mobility domain identifier. An Instant AP uses this parameter to announce that it is a part of the Instant AP group that constitutes a mobility domain.

Range: 1–65535

Default: Disabled

mfp-capable

When enabled, the SSID supports Management Frame Protection capable clients and non-MFP clients.

Default: Disabled

mfp-required

When enabled, the SSID supports only the clients that exhibt the MFP functionality.

Default: Disabled

multicast-rate <rate>

Increases the video transmission rate of the Instant AP. The Instant APs can select the rate for video multicast frames. Ensure that you tag the multicast traffic with video priority. You can configure MCS rates as well. MCS is an important setting because it provides a greater throughput. The following information displays the MCS rate of the Instant AP:

MCS Streams 20 MHz 20 MHz SGI--- ------- ------ ----------

0 1 6.5 7.21 1 13.0 14.42 1 19.5 21.73 1 26.0 28.94 1 39.0 43.35 1 52.0 57.86 1 58.5 65.07 1 65.0 72.28 2 13.0 14.49 2 26.0 28.9

10 2 39.0 43.311 2 52.0 57.812 2 78.0 86.713 2 104.0 115.614 2 117.0 130.015 2 130.0 144.4

The MCS rates for video multicast are supported in all the 802.11n-capable Instant APs, and in the 200 Series access points which are 802.11ac-capable.

NOTE: This parameter is not supported on 300 Series access points.

Range: default, 6, 9, 12, 18, 24, 36, 48, 54 Mbps, mcs0-mcs15

Default: default

multicast-rate-optimization

Allows the Instant AP to select the optimal rate for sending broadcast and multicast frames based on the lowest of unicast rates across all associated clients.

When enabled, the multicast traffic can be sent at the rate of 1-24 Mbps. The default rate for sending frames for 2.4 GHz is 1 Mbps and 5 GHz is 6 Mbps.

Default: Disabled

mpdu-agg-disable

Disables MPDU aggregation.

no...

Removes the parameters configured under the wlan ssid-profile command.

okc

Enables OKC.

In the OKC based roaming, the Instant AP stores one PMK per client, which is derived from last 802.1X authentication completed by the client in the network. The cached PMK is used when a client roams to a new Instant AP to allow faster roaming of clients.

NOTE: If the wireless client (the 802.1X supplicant) does not support this feature, a complete 802.1X authentication is required whenever it roams to a new Instant AP. OKC is supported on WPA-2-AES Enterprise network only. Starting from Instant Mode 8.11.0.0, OKC is supported on WPA3-Enterprise networks.

Default: Disabled

openflow-enable

Configures OpenFlow to an Instant AP.

opmode <opmode>

Configures the layer-2 authentication encryption for the SSID. Define the encryption method to secure access and ensure the privacy of the data transmitted to and from the network.

You can configure any of the following types of encryption:

  • opensystem—No authentication and encryption.
  • wpa2-aes—WPA-2 with AES encryption and dynamic keys using 802.1X.
  • wpa2-psk-aes—WPA-2 with AES encryption using a preshared key.
  • wpa-tkip—WPA with TKIP encryption and dynamic keys using 802.1X.
  • wpa-psk-tkip—WPA with TKIP encryption using a PSK.
  • wpa-tkip, wpa2-aes—WPA with TKIP and WPA-2 with AES encryption.
  • wpa-psk-tkip,wpa2-psk-aes - WPS with TKIP and WPA-2 with AES encryption using a PSK.
  • static-wep—WEP with static keys.
  • dynamic-wep—WEP with dynamic keys.
  • mpsk-aes—Multiple PSK for SSID with AES encryption.
  • enhanced-open—Improved data encryption in open Wi-Fi networks and protects data from sniffing. Enhanced open replaces open system as the default opmode.
  • wpa3-sae-aes—WPA3 with AES encryption using Simultaneous Authentication of Equals.
  • wpa3-aes-ccm-128—WPA3 with AES CCM-128 encryption and dynamic keys using 802.1X.
  • wpa3-cnsa—WPA3 with AES GCM-256 encryption using CNSA (192 bit).
  • wpa3-aes-gcm-256—WPA3 with AES GCM-256 encryption.

NOTE: Wi-Fi 6E networks only support enhanced-open, wpa3-sae-aes, wpa3-aes-ccm-128, wpa3-cnsa, and wpa3-aes-gcm-256 encryption types.

Range: opensystem|wpa2-aes|wpa2-psk-aes|wpa-tkip|wpa-psk-tkip|wpa-tkip,wpa2-aes|wpa-psk-tkip,wpa2-psk-aes|static-wep|dynamic-wep|mpsk-aes|enhanced-open|wpa3-sae-aes|wpa3-aes-ccm-128|wpa3-cnsa|wpa3-aes-gcm-256

Default: opensystem

opmode-transition

Enables backward compatibility for enhanced-open and wpa3-sae-aes opmodes

Default: Enabled

opmode-transition-disable

Disables opmode transition for enhanced-open or wpa3-sae-aes opmodes

out-of-service <def> <name>

Enables or disables the SSID based on any of the out of service states of the Instant AP:

  • VPN down
  • Uplink down
  • Internet down
  • Primary uplink down

The network will be out of service when selected event occurs and the SSID is enabled or disabled as per the configuration settings applied. For example, if you select the VPN down option from the dropdown and set the status to enabled, the SSID is enabled when the VPN connection is down and is disabled when the VPN connection is restored.

Range: For out-of-service states,any of the following values are allowed: vpn-down, uplink-down, internet-down, primary-uplink-down

For SSID status, select enable or disable.

per-user-bandwidth-limit <limit>

Configures a bandwidth limit in Kbps for the SSID users.

NOTE: The bandwidth contracts can also be applied per SSID user.

Range: 1–65535 Kbps

priority-use-local-cache-auth

Authenticates clients using the local cache maintained for authentication survivability before sending out an authentication request to the RADIUS server. This feature is only supported for clients authenticated using MAC and 802.1X authentication.

NOTE: This feature is available only when authentication survivability feature is enabled.

Range: Disabled

qbss-load-enable

Enables QBSS load IE.

radius-accounting

Enables accounting for the RADIUS server authentication.

When enabled, the Instant APs post accounting information to the Radius server at the specified accounting interval.

radius-accounting-mode

{user-association|user-authentication}

Configures an accounting mode for the captive portal users.

You can configure any of the following modes for accounting:

  • user-authentication—when configured, the accounting starts only after client authentication is successful and stops when the client logs out of the network.
  • user-association—When configured, the accounting starts when the client associates to the network successfully and stops when the client is disconnected.

Default: user-authentication

radius-interim-accounting-interval

<minutes> {<seconds>}

Configures an interval for posting accounting information as RADIUS INTERIM accounting records to the RADIUS server. The <seconds> definition is optional.

When configured, the Instant AP sends interim-update messages with current user statistics to the RADIUS server at regular intervals.

Range: 0–60

radius-reauth-interval

<minutes>

Allows you to configure an interval after which the Instant APs can redo the RADIUS transaction to reauthenticate clients.

If the reauthentication interval is configured:

  • On an SSID performing L2 authentication (MAC or 802.1X authentication): When reauthentication fails, the clients are disconnected. If the SSID is performing only MAC authentication and has a pre-authentication role assigned to the client, the client will get a post-authentication role only after a successful reauthentication. If reauthentication fails, the client retains the pre-authentication role.
  • On an SSID performing both L2 and L3 authentication (MAC with captive portal authentication): When reauthentication succeeds, the client retains the role that is already assigned. If reauthentication fails, a pre-authentication role is assigned to the client.
  • On an SSID performing only L3 authentication (captive portal authentication): When reauthentication succeeds, a pre-authentication role is assigned to the client that is in a post-authentication role. Due to this, the clients are required to go through captive portal to regain access.

Range: Any integer value in minutes

rf-band <band>

Configures the radio frequency band on which this SSID will be broadcast. You can select one of the following options:

  • none — disables the SSID in both 2.4 GHz and 5 GHz bands.
  • 2.4 GHz — the SSID is broadcast in the 2.4 GHz band.
  • 5 GHz — the SSID is broadcast in the 5 GHz band.
  • all — the SSID is broadcast in both the 5 GHz and 2.4 GHz bands.

Range: 2.4 GHz, 5 GHz, all, none

rf-band-6ghz

Broadcasts the SSID in the 6 GHz radio band. This option is disabled by default. You must enable this to start broadcasting the network in the 6 GHz radio band. The corresponding no command stops the broadcast of the network in the 6 GHz band. This option is only available in Wi-Fi 6E capable APs.

To configure an SSID to operate only in the 6 GHz band, enable rf-band-6ghz and set the rf-band parameter to none.

rrm-quiet-ie

Configures a radio resource management IE profile to define the information elements advertised by an Instant AP.

rts-threshold <threshold>

Configures a threshold to trigger the RTS or CTS handshake.

The RTS or CTS mechanism allows devices to reserve the RF medium and minimizes frame collisions introduced by the hidden stations. When RTS is enabled, a higher number of retransmissions occurring on the WLAN trigger the RTS or CTS handshake and the transmitter station sends an RTS frame to the receiver station. The receiver station responds with a CTS frame. Typically, the RTS or CTS frames are not sent, unless the packet size exceeds the RTS threshold. By default, the RTS threshold is set to 2333 octets. When the size of the packets sent by the transmitter exceeds the configured threshold, RTS frames are sent.

Range: 0–2347

Default: 2333

rx-ampdu-agg-disable

When this parameter is disabled, Instant APs reject A-MPDU based aggregations in the Add Block Acknowledgement response frames.

This parameter can be configured on 300 Series Instant APs.

Default: Enabled

server-load-balancing

Enables load balancing across two RADIUS servers if two authentication servers are configured for the SSID.

Range: Enabled

set-role{{contains|ends-with|

equals|matches-regular-expression|

not-equals|starts-with}

<operand> <role>|value-of}

Assigns a user role to the clients. The first rule that matches the configured condition is applied.

You can set any of the following conditions:

  • contains—The rule is applied only if the attribute value contains the specified string.
  • ends-with—The rule is applied only if the attribute value ends with the specified string.
  • equals—The rule is applied only if the attribute value is equal to the specified string.
  • not-equals—The rule is applied only if the attribute value is not equal to the specified string.
  • starts-with—The rule is applied only if the attribute value begins with the specified string.
  • value-of - This rule sets the user role to the value of the attribute returned. To set a user role, the value of the attribute must already be configured on the Instant AP.
  • matches-regular-expression—The rule is applied only if the attribute value matches the regular expression pattern specified in Operand. This operator is available only if the mac-address-and-dhcp-options attribute is selected in the Attribute drop-down.

set-role-by-ssid

Configures a user role based on the type of SSID configured.

set-role-mac-auth <mac-only>

Configures a MAC authentication based user role.

set-role-machine-auth

<machine_only>

<user_only>

Configures a machine authentication rule.

You can assign different rights to clients based on whether their hardware device supports machine authentication.

Machine authentication is only supported on Windows devices, so this can be used to distinguish between Windows devices and other devices such as iPads.

set-role-pre-auth <role>

Configures a pre-authentication role to allow some access to the guest users before the client authentication.

set-role-unrestricted

Configures unrestricted access control.

set-vlan <attribute>{{contains|ends-with|

equals|matches-regular-expression|

not-equals|starts-with}

<operand> <vlan>|value-of}

Assigns a VLAN to the clients. The first rule that matches the configured condition is applied.

You can specify any of the following conditions:

  • contains—The rule is applied only if the attribute value contains the specified string.
  • ends-with—The rule is applied only if the attribute value ends with the specified string.
  • equals—The rule is applied only if the attribute value is equal to the specified string.
  • not-equals—The rule is applied only if the attribute value is not equal to the specified string.
  • starts-with—The rule is applied only if the attribute value begins with the specified string.
  • value-of - This rule sets the VLAN to the value of the attribute returned. To set a user role, the value of the attribute must already be configured on the Instant AP.
  • matches-regular-expression—The rule is applied only if the attribute value matches the regular expression pattern specified in Operand. This operator is available only if the mac-address-and-dhcp-options attribute is selected in the Attribute drop-down.

short-preamble-disable

Disables the transmission and reception of short preamble frames for the clients connected to an SSID.

By default, short preamble is enabled.

strict-svp

Enables Strict SVP and prioritizes voice traffic for SVP handsets.

supported-mcs-set

Allows you to define a set of MCS rates for HT channels.

Range: 0–23

temporal-diversity

Shows if the temporal diversity feature has been enabled or disabled. When this feature is enabled and the client is not responding to 802.11 packets, the Instant AP attempts two hardware retries. If the hardware retries are not successful, it attempts software retries. When this feature is disabled, the Instant AP attempts only hardware retries.

Range: enable, disable

Default: disable

tspec

Allows the Instant APs to prioritize time-sensitive traffic such as voice traffic initiated by the client.

tspec-bandwidth

Reserves the configured bandwidth for prioritizing voice traffic when TSPEC is enabled.

Range: 200–600000 Kbps

Default: 2000 Kbps

termination

Configures the EAP portion of 802.1X authentication on the Instant AP, instead of the RADIUS server.

When enabled, this command reduces network traffic to the external RADIUS server by terminating the authorization protocol on the Instant AP. By default, for 802.1X authorization, the client conducts an EAP exchange with the RADIUS server, and the Instant AP acts as a relay for this exchange. The Instant AP by itself acts as an authentication server and terminates the outer layers of the EAP protocol, only relaying the innermost layer to the external RADIUS server.

Range: Disabled

time-range <name> {enable | disable}

Specify the time range profile name to apply.

  • When a time range profile is enabled on SSID, the SSID is made available to the users for the configured time range. For example, if the specified time range is 12:00 to 13:00, the SSID becomes available only between 12 PM to 1 PM on a given day.
  • If a time range is disabled, the SSID becomes unavailable for the configured time range. For example, if configured time-range is 14:00 to 17:00, the SSID is made unavailable from 2 PM to 5 PM on a given day.

type {employee|voice|guest}

Configures the type of network such as employee, voice, guest network.

use-ip-for-calling-station

The IP address of the client will be used as the calling-station-id.

utf8

Encodes the SSID. When enabled, the SSID name is displayed in the UTF-8 format.

SSIDs are not encoded by default.

vlan

Configures a VLAN name or VLAN ID in the SSID profile.

very-high-throughput-disable

Disables VHT for clients connecting the WLAN SSID profile.

vht-mu-txbf-disable

Disables MU-MIMO. The MU-MIMO feature allows the 802.11ac Wave 2 Instant APs to send multiple frames to multiple clients simultaneously over the same frequency spectrum. With MU-MIMO, APs can support simultaneous directional RF links and up to four simultaneous full-rate Wi-Fi connections (For example, smart phone, tablet, laptop, multimedia player or other client device). The MU-MIMO feature is enabled by default on WLAN SSIDs.

vht-supported-mcs-map

Allows you to define a combination of VHT MCS and spatial streams as a VHT MCS rate set.

Range: -, 7, 8, 9

Default: 9 for each spatial stream

vht-txbf-explicit-disable

Disables VHT TX beamforming on the 200 Series Series access points.

This feature is available only on the 200 Series access points.

vlan <vlan>

Allows you to assign a unique VLAN ID or a VLAN name to a specified SSID user. The Instant AP takes this parameter from its per AP vlan specific configuration.

Default: 1–4095

wep-key <wep-key>

Static WEP key associated with the key index. The WEP key values can be 10 or 26 hexadecimal characters in length.

wispr

Enables WISPr authentication for the SSID profile.

wmm-background-dscp <dscp>

Allows you to specify the DSCP mapping value for the background traffic.

Range: 0–63

wmm-background-share <share>

Allocates bandwidth for background traffic such as file downloads or print jobs.

wmm-best-effort-dscp <dscp>

Allows you to specify the DSCP mapping value for the best effort traffic.

Range: 0–63

wmm-best-effort-share <share>

Allocates bandwidth or best effort traffic such as traffic from legacy devices or traffic from applications or devices that do not support QoS.

wmm-uapsd-disable

Disables UAPSD on all WMM ACs.

By default, UAPSD or WMM power save is enabled.

wmm-video-dscp <dscp>

Allows you to specify the DSCP mapping value for the video traffic.

Range: 0–63

wmm-video-share <share>

Allocates bandwidth for video traffic generated from video streaming.

wmm-voice-dscp <dscp>

Allows you to specify the DSCP mapping value for the voice traffic.

Range: 0–63

wmm-voice-share <share>

Allocates bandwidth for voice traffic generated from the incoming and outgoing voice communication.

work-without-uplink

Allows the SSID to be used without an uplink connection.

NOTE: In Instant 6.4.4.4-4.2.3.0 release, the work-without-uplink is not operational. To configure SSID availability based on the uplink connection status, use the out-of-service parameter.

wpa-passphrase <passphrase>

Defines a WPA passphrase with which you can generate a PSK.

zone <zone>

Specify the zone names for the SSID profile. When the zone is defined in SSID profile and if the same zone is defined on anInstant AP, the SSID is created on that Instant AP. Enter multiple zone name as comma-separated values.

no wlan ssid-profile <ssid_profile>

Removes the WLAN SSID profile configuration.

Example

The following example configures an employee WLAN SSID profile:

(Instant AP)(config)# wlan ssid-profile employee1

(Instant AP)(SSID Profile "employee1")# type employee

(Instant AP)(SSID Profile "employee1")# essid employee1

(Instant AP)(SSID Profile "employee1")# enable

(Instant AP)(SSID Profile "employee1")# vlan 1

(Instant AP)(SSID Profile "employee1")# wpa-passphrase user@123

(Instant AP)(SSID Profile "employee1")# opmode wpa2-psk-aes

(Instant AP)(SSID Profile "employee1")# max-authentication-failures 0

(Instant AP)(SSID Profile "employee1")# mac-authentication

(Instant AP)(SSID Profile "employee1")# l2-auth-failthrough

(Instant AP)(SSID Profile "employee1")# termination

(Instant AP)(SSID Profile "employee1")# blacklist

(Instant AP)(SSID Profile "employee1")# cdc-enable

(Instant AP)(SSID Profile "employee1")# mbo-enable

(Instant AP)(SSID Profile "employee1")# mac-authentication

(Instant AP)(SSID Profile "employee1")# auth-server InternalServer

(Instant AP)(SSID Profile "employee1")# rf-band all

(Instant AP)(SSID Profile "employee1")# dtim-period 1

(Instant AP)(SSID Profile "employee1")# inactivity-timeout 1000

(Instant AP)(SSID Profile "employee1")# delete-pmkcache

(Instant AP)(SSID Profile "employee1")# broadcast-filter none

(Instant AP)(SSID Profile "employee1")# use-ip-for-calling-station

(Instant AP)(SSID Profile "employee1")# dmo-channel-utilization-threshold 90

(Instant AP)(SSID Profile "employee1")# local-probe-req-thresh 0

(Instant AP)(SSID Profile "employee1")# max-clients-threshold 64

(Instant AP)(SSID Profile "employee1")# set-role Group-Name contains wireless employee

(Instant AP)(SSID Profile "employee1")# set-vlan mac-address-and-dhcp-options matches-regular-expression ..link 200

(Instant AP)(SSID Profile "employee1")# no wmm-background-dscp

(Instant AP)(SSID Profile "employee1")# wmm-best-effort-dscp 21

(Instant AP)(SSID Profile "employee1")# no wmm-video-dscp

(Instant AP)(SSID Profile "employee1")# wmm-voice-dscp 46,44,42,41

(Instant AP)(SSID Profile "employee1")# zone Zone1

(Instant AP)(SSID Profile "employee1")# end

(Instant AP)# commit apply

The following example configures a guest WLAN SSID profile:

(Instant AP)(config)# wlan ssid-profile guestNetwork

(Instant AP)(SSID Profile "guestNetwork")# type guest

(Instant AP)(SSID Profile "guestNetwork")# essid guestNetwork

(Instant AP)(SSID Profile "guestNetwork")# enable

(Instant AP)(SSID Profile "guestNetwork")# opmode opensystem

(Instant AP)(SSID Profile "guestNetwork")# rf-band all

(Instant AP)(SSID Profile "guestNetwork")# dtim-period 1

(Instant AP)(SSID Profile "guestNetwork")# g-min-tx-rate 1

(Instant AP)(SSID Profile "guestNetwork")# g-max-tx-rate 54

(Instant AP)(SSID Profile "guestNetwork")# a-min-tx-rate 6

(Instant AP)(SSID Profile "guestNetwork")# a-max-tx-rate 54

(Instant AP)(SSID Profile "guestNetwork")# inactivity-timeout 1000

(Instant AP)(SSID Profile "guestNetwork")# vlan 1

(Instant AP)(SSID Profile "guestNetwork")# dmo-channel-utilization-threshold 90

(Instant AP)(SSID Profile "guestNetwork")# max-clients-threshold 64

(Instant AP)(SSID Profile "guestNetwork")# local-probe-req-thresh 0

(Instant AP)(SSID Profile "guestNetwork")# blacklist

(Instant AP)(SSID Profile "guestNetwork")# max-authentication-failures 3

(Instant AP)(SSID Profile "guestNetwork")# radius-interim-accounting-interval 10

(Instant AP)(SSID Profile "guestNetwork")# radius-reauth-interval 30

(Instant AP)(SSID Profile "guestNetwork")# captive-portal external

(Instant AP)(SSID Profile "guestNetwork")# mac-authentication

(Instant AP)(SSID Profile "guestNetwork")# auth-server server1

(Instant AP)(SSID Profile "guestNetwork")# set-role-by-ssid

(Instant AP)(SSID Profile "guestNetwork")# set-role-pre-auth test1

(Instant AP)(SSID Profile "guestNetwork")# end

(Instant AP)# commit apply

 

The following example configures multiple zones in a WLAN SSID profile:

(Instant AP)(config)# wlan ssid-profile default

(Instant AP)(SSID Profile "default") # zone zone1,zone2,zone3

(Instant AP)# commit apply

Command History

Release

Modification

Instant Mode 8.12.0.0

Introduced qbss-load-enable parameter.

Instant Mode 8.12.0.0

Introduced mbssid-group-profile <profile name> and no mbssid-group-profile <profile name> parameters.

Instant Mode 8.11.0.0

  • The okc parameter was modified to be supported on WPA3-CNSA instead of WPA2.

  • The advertise-location parameter was added.

Instant Mode 8.9.0.0

  • A new option, none, was added to the rf-band parameter.
  • Encryption types supported by Wi-Fi 6E networks was added as a note to the opmode parameter.
  • The a-beacon-rate and g-beacon-rate parameters were added.
  • The disable-on-6ghz-mesh parameter was added.
  • The rf-band-6ghz parameter was added.
  • All instances of Blacklist were replaced with denylist.

HPE Aruba Networking Instant 8.8.0.0

  • The delete-pmkcache parameter was added.
  • The ftm-responder-enable parameter was added.

HPE Aruba Networking Instant 8.7.0.0

  • The facebook-xwf-role <role-name> parameter was added.
  • The functionality of advertise-ap-name parameter was modified to advertise the ap-name in probe responses.
  • The radius-interim-accounting-interval <minutes> parameters was modified to include an additional {<seconds>} definition.

HPE Aruba Networking Instant 8.6.0.0

The following parameters were added:

  • allowed-5ghz-radio
  • cdc-enable
  • max-ipv4-users <threshold>
  • mbo-enable
  • opmode <wpa3-aes-gcm-256>
  • priority-use-local-cache-auth

HPE Aruba Networking Instant 8.5.0.0

The following parameters were added:

  • deny-intra-vlan-traffic
  • high-throughput-enable
  • high-throughput-disable
  • no high-throughput-disable

HPE Aruba Networking Instant 8.4.0.0

The following parameters were added:

  • download-role
  • advertise-ap-name
  • opmode <mpsk-aes>
  • opmode <wpa3-aes-ccm-128>
  • opmode <wpa-sae-aes>
  • opmode <wpa3-cnsa>
  • opmode-transition
  • opmode-transition-disable
  • enhanced-open
  • high-efficiency-enable
  • high-efficiency-disable

HPE Aruba Networking Instant 8.3.0.0

Command introduced.

Command Information

Platforms

Command Mode

All platforms

Configuration mode and WLAN SSID profile configuration sub-mode.