You are here: CLI_commands > wlan ssid-profile
Previous TopicNext Topic

wlan ssid-profile

wlan ssid-profile <ssid_profile>

a-max-tx-rate <rate>

a-min-tx-rate <rate>

air-time-limit <limit>

auth-server <name>

auth-survivability

bandwidth-limit <limit>

blacklist

broadcast-filter <type>

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

content-filtering

deny-inter-user-bridging

deny-local-routing

disable

dmo-channel-utilization-threshold <threshold>

dot11k

dot11r

dot11v

dtim-period <value>

dynamic-multicast-optimization

enable

enforce-dhcp

essid <essid>

external-server

g-min-tx-rate <rate>

g-max-tx-rate <rate>

hide-ssid

hotspot-profile <name>

inactivity-timeout <interval>

index <idx>

key-duration <duration>

l2-auth-failthrough

leap-use-session-key

local-probe-req-thresh <threshold>

mac-authentication

mac-authentication-delimiter <delim>

mac-authentication-upper-case

max-authentication-failures <limit>

max-clients-threshold <Max_clients>

multicast-rate-optimization

okc-disable

opmode <opmode>

per-user-bandwidth-limit <limit>

radius-accounting

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

radius-interim-accounting-interval <minutes>

radius-reauth-interval <minutes>

rf-band <band>

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}

termination

type {employee|voice|guest}

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-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…

Description

This command configures a WLAN SSID profile.

Syntax

Command/Parameter

Description

Range

Default

wlan ssid-profile <ssid_profile>

Creates a WLAN SSID profile.

a-max-tx-rate <rate>

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

6-54 Mbps 54 Mbps

a-min-tx-rate <rate>

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

6-54 Mbps 6 Mbps

air-time-limit <limit>

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

auth-server <name>

Configures an authentication server for the SSID users.
auth-survivability

Enables the authentication survivability feature.

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.

bandwidth-limit

<limit>

 

Configures an aggregate amount of bandwidth that each radio is allowed to provide for the connected clients. 1—65535
blacklist Enables dynamic blacklisting of clients.

broadcast-filter <type>

Configures broadcast filtering parameters:

You can configure any of the following filtering parameters:

l All—When set to All, the IAP drops all broadcast and multicast frames except DHCP and ARP.
l ARP—When set to ARP, the IAP converts ARP requests to unicast and send frames directly to the associated client.
l Disabled— When set to Disabled, all broadcast and multicast traffic is forwarded.
All, ARP, Disabled Disabled

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. 3G,4G, wifi,ethernet
content-filtering Routes all DNS requests for the non-corporate domains to OpenDNS on this network. 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-local-routing Disables the routing traffic between two clients connected to the same SSID on different VLANs. When local routing is disabled, the clients can connect to the Internet, but cannot communicate with each other, and the routing traffic between the clients is sent to the upstream device to make the forwarding decision.

disable

Disables the SSID. By default all SSIDs are enabled.

dmo-channel-utilization-threshold

<threshold>

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

1–100 percentage value 90
dot11k

Enables 802.11k roaming on the SSID profile.

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

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

dot11r

Enables 802.11r on the SSID profile.

802.11r or fast BSS transition (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 WPA2 authentication method.

dot11v

Enables 802.11v based BSS transition.

dtim-period <value>

Configures the Delivery Traffic Indication Message (DTIM) interval for the SSID profile.

The DTIM interval determines how often the IAP 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 IAP at the specified number of beacons. You can also configure a higher value for DTIM interval for power saving.

1–10 beacons 1

dynamic-multicast-optimization

Allows the IAP to convert multicast streams into unicast streams over the wireless link. Enabling Dynamic Multicast Optimization (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.

Disabled

enable

Re-enables the deactivated SSIDs. Enabled

enforce-dhcp

Enforces dynamic VLAN assignment for clients from the DHCP server. Disabled
essid <essid> Defines a name that uniquely identifies a wireless network.

external-server

Configures an external RADIUS server for authentication.

g-min-tx-rate <rate>

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

1-54 Mbps 1 Mbps

g-max-tx-rate <rate>

Configures the specify the maximum transmission rate for the 2.4 GHz band. 1-54 Mbps 54 Mbps

hide-ssid

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

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.

60-86400 seconds 1000

index <idx>

Assigns an index value for the SSID.

l2-auth-failthrough

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

Disabled

leap-use-session-key

Allows the users to derive session keys for Lightweight Extensible Authentication Protocol (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.

Disabled

local-probe-req-thresh

<threshold>

Configures a Received signal strength indication (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,

0-100 dB
mac-authentication Enables MAC authentication for clients that use this SSID profile. 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:xx format are used.

colon or dash
mac-authentication-upper-case Enables the IAP 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 the users.

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

max-clients-threshold <threshold>

Configures the maximum number of clients for a BSSID on a WLAN. 0-255 64
multicast-rate-optimization

Allows the IAP 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.0 GHz is 6 Mbps.

Disabled
okc-disable

Disables opportunistic key caching (OKC).

In the OKC based roaming, the AP stores one pairwise master key (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 IAP 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 IAP. OKC is supported on WPA2-AES Enterprise network only.

opmode <opmode>

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

You can configure any of the following types of encryption:

l opensystem — No authentication and encryption.
l wpa2-aes —WPA2 with AES encryption and dynamic keys using 802.1x.
l wpa2-psk-aes — WPA2 with AES encryption using a preshared key.
l wpa-tkip — WPA with TKIP encryption and dynamic keys using 802.1x.
l wpa-psk-tkip — WPA with TKIP encryption using a pre-shared key.
l wpa-tkip, wpa2-aes — WPA with TKIP and WPA2 with AES encryption.
l wpa-psk-tkip,wpa2-psk-aes - WPS with TKIP and WPA2 with AES encryption using a pre-shared key.
l static-wep — WEP with static keys.
l dynamic-wep — WEP with dynamic keys.

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

opensystem

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.

1—65535 Kbps

radius-accounting

Enables accounting for the RADIUS server authentication.

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

Disabled

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:

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

radius-interim-accounting-interval

<minutes>

Configures an interval for posting accounting information as RADIUS INTERIM accounting records to the RADIUS server.

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

Any integer value in minutes

radius-reauth-interval

<minutes>

Configures an interval at which IAPs can periodically reauthenticate all associated and authenticated clients. Any integer value in minutes

rf-band <band>

Configures the radio frequency band on which this SSID will be broadcast. You can select either 2.4GHz, 5 GHz, or all to specify both bands. 2.4 GHz, 5 GHz, all all

server-load-balancing

Enables load balancing across two RADIUS servers if two authentication servers are configured for the SSID. 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:

l contains — The rule is applied only if the attribute value contains the specified string.
l ends-with — The rule is applied only if the attribute value ends with the specified string.
l equals — The rule is applied only if the attribute value is equal to the specified string.
l not-equals — The rule is applied only if the attribute value is not equal to the specified string.
l starts-with — The rule is applied only if the attribute value begins with the specified string.
l 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 IAP.
l 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:

l contains — The rule is applied only if the attribute value contains the specified string.
l ends-with — The rule is applied only if the attribute value ends with the specified string.
l equals — The rule is applied only if the attribute value is equal to the specified string.
l not-equals — The rule is applied only if the attribute value is not equal to the specified string.
l starts-with — The rule is applied only if the attribute value begins with the specified string.
l 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 IAP.
l 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.

termination

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

When enabled, this command reduces network traffic to the external RADIUS server by terminating the authorization protocol on the IAP. By default, for 802.1X authorization, the client conducts an EAP exchange with the RADIUS server, and the IAP acts as a relay for this exchange. The IAP 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.

Disabled
type {employee|voice|guest} Configures the type of network such as employee, voice, guest network.
vlan <vlan> Allows the administrators to assign a VLAN to the SSID users. 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. 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. 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-video-dscp <dscp> Allows you to specify the DSCP mapping value for the video traffic. 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. 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

wpa-passphrase <passphrase>

Defines a WPA passphrase with which you can generate a pre-shared key (PSK).
zone <zone>

Allows you to specify a zone for SSID. If an SSID belongs to a zone, it is not broadcast on any AP which does not belong to the zone.

   

Usage Guidelines

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

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")# 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")# broadcast-filter none

(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

Command History

Version

Description

Aruba Instant 6.4.0.2-4.1This command is modified.
Aruba Instant 6.2.1.0-3.4This command is modified.

Aruba Instant 6.2.1.0-3.3

This command is introduced.

Command Information

IAP Platform

Command Mode

All platforms

Configuration mode and WLAN SSID profile configuration sub-mode.