- Table of Contents
-
- 26-WLAN Command References(AC)
- 00-Preface
- 01-Compatibility of hardware and AC functionality.htm
- 03-Radio management commands
- 05-WLAN security commands
- 07-WIPS commands
- 09-WLAN roaming commands
- 11-WLAN radio resource measurement commands
- 13-Band navigation commands
- 15-WLAN RRM commands
- 17-WLAN probe commands
- Related Documents
-
Title | Size | Download |
---|---|---|
09-WLAN roaming commands |
Contents
display wlan mobility roam-track mac-address
bss transition-management disassociation
bss transition-management enable
display wlan sacp move-history
display wlan client rm-capabilities
mac-authentication fast-connect enable
sacp roam-optimize traffic-hold enable advanced
sacp roam-optimize bss-candidate-list
display wlan mobility roam-count
snmp-agent trap enable wlan mobility
WLAN roaming commands
client cache aging-time
Use client cache aging-time to set the aging time for client roaming entries.
Use undo client cache aging-time to restore the default.
Syntax
client cache aging-time aging-time
undo client cache aging-time
Default
The aging time for client roaming entries is 180 seconds.
Views
Service template view
Predefined user roles
network-admin
Parameters
aging-time: Specifies the aging time in the range of 0 to 86400 seconds.
Usage guidelines
Setting the roaming entry aging time to 0 allows the system to delete the roaming entry of a client once the client goes offline. Fast roaming cannot be performed.
Make sure the service template is disabled before you executing this command.
The aging time is applicable only to intra-AC roaming entries. It does not take effect on inter-AC roaming entries.
Examples
# Set the aging time for client roaming entries to 100 seconds.
<Sysname> system-view
[Sysname] wlan service-template service1
[Sysname-wlan-st-service1] client cache aging-time 100
display wlan mobility roam-track mac-address
Use display wlan mobility roam-track mac-address to display roaming information for a client.
Syntax
display wlan mobility roam-track mac-address mac-address
Views
Any view
Predefined user roles
Parameters
mac-address mac-address: Specifies a client by its MAC address, in the form of H-H-H.
Usage guidelines
Roaming information is displayed in sequence. The most recent roam-track information is displayed the first.
The system can save a maximum of 128 roaming entries. To record a new entry if the maximum number has been reached, the system deletes the third oldest entry and then records the new entry.
In a network enabled with roaming relay, the AC IP address displayed in the output from this command is the IP address of the relay device.
Examples
# Display roaming information for the specified client.
<Sysname> display wlan mobility roam-track mac-address 5250-0012-0411
Total entries: 2
Current entries: 2
BSSID Created at Online time AC IP address RID AP name
000f-e203-7777 2016-06-14 11:12:28 00hr 01min 02sec 127.0.0.1 1 ap2
000f-e200-4444 2016-06-14 11:12:04 00hr 03min 51sec 127.0.0.1 1 ap1
Table 1 Command output
Field |
Description |
BSSID |
BSSID of the AP with which the client is associated. |
Created at |
Time when a roam-track entry was created for the client. |
Online time |
Online time of the client. |
AC IP address |
IP address of the device with which the client is associated. This field displays 127.0.0.1. |
RID |
ID of the radio with which the client is associated. |
AP name |
Name of the AP with which the client is associated. |
Enhanced roaming commands
bss transition-management disassociation
Use bss transition-management disassociation to enable BTM disassociation.
Use undo bss transition-management disassociation to disable BTM disassociation.
Syntax
bss transition-management disassociation { forced | recommended } [ timer time ]
undo bss transition-management disassociation
Default
Recommended BTM disassociation is enabled and the disassociation timeout is 90 seconds.
Views
Service template view
Predefined user roles
network-admin
Parameters
forced: Enables forced disassociation. An AP forcibly logs off a client if that client has not disassociated with that AP when the disassociation timer expires.
recommended: Enables recommended disassociation. An AP does not forcibly log off a client if that client has not disassociated with that AP when the disassociation timer expires.
timer time: Specifies the disassociation timer in the range of 0 to 180 seconds. By default, the timer is 90 seconds. With this timer set to 0, an AP forcibly logs off a client immediately after sending a BTM request to that client if forced disassociation is enabled. If recommended disassociation is enabled, the AP does not log off a client after sending a BTM request to that client.
Usage guidelines
With BTM disassociation configured, an AP sends a BTM request to a client upon receiving a BTM query from the client and guides the client for BSS transition. With forced BTM disassociation configured, the AP forcibly logs off the client if the client fails to leave the current BSS before the disassociation timer expires.
Forced BTM disassociation will forcibly log off a client. Use this feature with caution.
For BTM disassociation to take effect, enable BTM first.
Examples
# Enable BTM disassociation and set the forced disassociation timer to 60 seconds.
<Sysname> system-view
[Sysname] wlan service-template service1
[Sysname-wlan-st-service1] bss transition-management disassociation force timer 60
Related commands
bss transition-management enable
bss transition-management enable
Use bss transition-management enable to enable BTM.
Use undo bss transition-management enable to disable BTM.
Syntax
bss transition-management enable
undo bss transition-management enable
Default
BTM is disabled.
Views
Service template view
Predefined user roles
network-admin
Usage guidelines
With BTM enabled, an AP responds to a BTM query from a client with a BTM request. If client anti-sticky is disabled, the AP sends an unsolicited BTM request to the client when it detects that the RSSI of the client is lower than the specified threshold to trigger BTM. After receiving the BTM request, the client determines whether to roam to another BSS.
Make sure the service template is disabled before you perform this task.
For BTM to take effect on all clients, use the bss transition-management disassociation command to enable BTM disassociation.
Examples
# Enable BTM.
<Sysname> system-view
[Sysname] wlan service-template service1
[Sysname-wlan-st-service1] bss transition-management enable
Related commands
bss transition-management disassociation
sacp anti-sticky
display wlan sacp move-history
Use display wlan sacp move-history to display the client roaming history.
Syntax
display wlan sacp move-history [ mac-address mac-address ]
Views
Any view
Predefined user roles
network-admin
network-operator
Parameters
mac-address mac-address: Specifies the MAC address of a client. If you do not specify this option, the command displays the roaming history of all clients.
Usage guidelines
This command displays client association and disassociation history during BSS transition.
If you do not specify a client, the command displays information about all clients with the latest information coming first in the output.
This command is available only in AC+fit AP networks.
Examples
# Display the roaming history of all clients.
<Sysname> display wlan sacp move-history mac-address 78AC-C0AF-944F
Total entries: 2
Current entries:2
Time MAC address AP name Chl RSSI Result
1/11 15:57:09 78AC-C0AF-944F S:AP2 6 20
T:AP3 11
1/11 15:57:10 A:AP3 11 40 BTM-1
--------------------------------------------------------------------------------
1/11 15:56:39 78AC-C0AF-944F S:AP1 1 19
T:AP3 1
1/11 15:56:45 A:AP2 1 42 BTM-2
# Display the roaming history of a specific client that does not support BTM.
<Sysname> display wlan sacp move-history mac-address 58AC-C0AF-EEFF
Total entries: 2
Current entries: 2
Time MAC address AP name Chl RSSI Result
1/11 10:51:09 58AC-C0AF-EEFF S:AP2 6 20
- -
1/11 10:51:16 A:AP3 11 40 DE-SA
--------------------------------------------------------------------------------
1/11 10:50:44 58AC-C0AF-EEFF S:AP1 1 19
- -
1/11 10:50:45 A:AP2 6 42 DE
Table 2 Command output
Field |
Description |
Total entries |
Total number of entries for all clients. |
Current entries |
Number of most recent entries for all clients. The system displays a maximum of 30 entries for each client. |
Time |
Time at which the entry was generated. · For BTM-capable clients: ¡ For the currently associated AP (named S:ap_name), this field displays the time at which the AP sent the first BTM request to the client. ¡ For the first associated AP (named A:ap_name), this field displays the time at which the client came online. · For BTM-incapable clients: ¡ For the currently associated AP (named S:ap_name), this field displays the time at which the AP sent the last Deauth packet to the client. ¡ For the first associated AP (named A:ap_name), this field displays the time at which the client came online. |
MAC address |
MAC address of the client. |
AP name |
AP role and AP name. · S—Source, the currently associated AP. · T—Target. ¡ For a BTM-capable client, T represents that the AP is the first one in the BSS candidate list the last time a BTM request takes effect. If no APs exist in the candidate list, this field displays -. ¡ For a BTM-incapable client, this field displays - because no target AP exists. · A—Actual, the AP from which the client came online. If the name of an AP exceeds 30 characters, the system displays only the last 27 characters with an ellipsis prefixed to the string. For example, if the AP name is cabcxyzxyzxyzabcabcabcxyzabcxyz, the system displays the name as …xyzxyzxyzabcabcabcxyzabcxyz. |
Chl |
Channel. · S—Current working channel. · T—Target channel. ¡ For a BTM-capable client, T represents that the channel is the first one in the recommended channel list the last time a BTM request takes effect. If no channels exist in the list, this field displays -. ¡ For a BTM-incapable client, this field displays - because no target channel exists. · A—Channel from which the client came online. |
RSSI |
Client RSSI. · S—Client RSSI detected by the associated AP the last time a BTM request or Deauth packet takes effect. · A—Client RSSI when the client came online. This field might display 0 if the collected client RSSI is too low. |
Result |
Reason why the client changed the associated BSS and the result. · For a BTM-capable client, options include: ¡ BTM-n—BTM transition succeeded. n represents that the target AP is the nth in the BSS candidate list. n is in the range of 1 to 5. ¡ BTM-NT—BTM transition succeeded. Not Target (NT) represents that the target is not in the BSS candidate list. ¡ BTM-NU—BTM transition succeeded. NULL (NU) represents that the candidate list is not provided. ¡ BTM-QU—BTM transition succeeded. QU represents that the transition was triggered by a BTM Query sent by the client. If the system has not received the RSSI reported by anti-sticky detection, the RSSI field displays -. · For a BTM-incapable client, options include: ¡ DE—DEAUTH transition succeeded. The client came online within 5 seconds after receiving the Deauth packet. ¡ DE-SA—DEAUTH transition succeeded. SlowAccess (SA) represents that it took 5 to 10 seconds for the client to come online again after receiving the Deauth packet. ¡ DE-FO—DEAUTH transition failed. ForcedOffline (FO) represents that the client came online 10 to 30 seconds after being logged off for other reasons. ¡ DE-OB—DEAUTH transition succeeded. OldBSSID (OB) represents that the client came online from the old AP within 5 seconds after receiving the Deauth packet. ¡ DE-NS—DEAUTH transition succeeded. NewSSID (NS) represents that the client came online from a new SSID within 30 seconds after receiving the Deauth packet. |
Related commands
bss transition-management enable
sacp roam-optimize bss-candidate-list enable
display wlan client rm-capabilities
Use display wlan client rm-capabilities to display radio resource measurement capabilities reported by clients.
Syntax
display wlan client rm-capabilities [ mac-address mac-address ]
Views
Any view
Predefined user roles
network-admin
network-operator
Parameters
mac-address mac-address: Specifies a client by its MAC address. If you do not specify this option, the command displays information about all clients.
Examples
# Display radio resource measurement capabilities of the client with a MAC address of a89c-55bc-7819.
<Sysname> display wlan client rm-capabilities mac-address a89c-55bc-7819
Neighbor report capability : Enabled
Beacon passive measurement : Enabled
Beacon active measurement : Enabled
Beacon table measurement : Enabled
Table 3 Command output
Field |
Description |
Neighbor report capability |
Neighbor report capability: · Disabled. · Enabled. |
Beacon passive measurement |
Beacon passive measurement capability: · Disabled. · Enabled. |
Beacon active measurement |
Beacon active measurement capability: · Disabled. · Enabled. |
Beacon table measurement |
Beacon table measurement capability: · Disabled. · Enabled. |
ft enable
Use ft enable to enable fast BSS transition (FT).
Use undo ft enable to disable FT.
Syntax
ft enable
undo ft enable
Default
FT is disabled.
Views
Service template view
Predefined user roles
network-admin
Usage guidelines
FT minimizes the delay when a client roams from a BSS to another BSS within the same ESS. During 802.11r FT, a client needs to exchange messages with the target AP. FT provides two message exchanging methods.
802.11r takes effect only on clients associated with the AC.
Enable FT only when the service template is disabled.
To use FT, enable RSN IE in the beacon and probe responses, configure the CCMP cipher suite, and and do not use local authentication. For more information about the security IE, see the security-ie command in "WLAN security commands."
Do not enable 802.11r FT and set the WPA3 security mode or enable enhanced open system authentication at the same time. If you do so, the service template cannot be enabled. For more information about 802.11r, see configuring WLAN security in WLAN Configuration Guide.
Examples
# Enable FT.
<Sysname> system-view
[Sysname] wlan service-template st
[Sysname-wlan-st-st] ft enable
Related commands
security-ie
ft method
Use ft method to set the FT method.
Use undo ft method to restore the default.
Syntax
ft method { over-the-air | over-the-ds }
undo ft method
Default
The FT method is over-the-air.
Views
Service template view
Predefined user roles
network-admin
Parameters
over-the-air: Specifies over-the-air FT. This method enables clients to communicate directly with the target AP for pre-roaming authentication.
over-the-ds: Specifies over-the-DS FT. This method enables clients to communicate with the target AP through the current AP for pre-roaming authentication.
Usage guidelines
Set the FT method only when the service template is disabled.
This command takes effect only when FT is enabled.
Examples
# Set the FT method to over-the-DS.
<Sysname> system-view
[Sysname] wlan service-template st
[Sysname-wlan-st-st] ft method over-the-ds
Related commands
ft enable
ft reassociation-timeout
Use ft reassociation-timeout to set the reassociation timeout timer.
Use undo ft reassociation-timeout to restore the default.
Syntax
ft reassociation-timeout timeout
undo ft reassociation-timeout
Default
The reassociation timeout timer is 20 seconds.
Views
Service template view
Predefined user roles
network-admin
Parameters
timeout: Specifies the reassociation timeout timer in the range of 1 to 100 seconds.
Usage guidelines
The roaming process is terminated if a client does not send any reassociation requests before the timeout timer expires.
Set the reassociation timeout timer only when the service template is disabled.
This command takes effect only when FT is enabled.
Examples
# Set the reassociation timeout timer to 30 seconds.
<Sysname> system-view
[Sysname] wlan service-template st
[Sysname-wlan-st-st] ft reassociation-timeout 30
Related commands
ft enable
mac-authentication fast-connect enable
Use mac-authentication fast-connect enable to enable fast-connect for MAC authenticated intra-AC roaming clients.
Use undo mac-authentication fast-connect enable to disable fast-connect for MAC authenticated intra-AC roaming clients.
Syntax
mac-authentication fast-connect enable
undo mac-authentication fast-connect enable
Default
Fast-connect is enabled for MAC authenticated intra-AC roaming clients.
Views
Service template view
Predefined user roles
network-admin
Usage guidelines
This command allows a MAC authentication roaming client that has been authenticated once on the AC to come online from any APs attached to the AC without re-authentication.
This feature applies only to MAC authentication wireless clients whose authentication location and association location are both on the AC.
This feature affects the displayed roaming state of inter-AC roaming clients that use MAC authentication and requires special configuration for them.
· If a client has roamed between ACs, its roaming state is N/A in the output from the display wlan client verbose command.
· If the inter-AC roaming clients belong to different VLANs, you must make sure the upstream ports of all the ACs in the same roaming group permit traffic from these VLANs to pass through.
Examples
# Enable fast-connect for MAC authenticated intra-AC roaming clients in service template service1.
<Sysname> system-view
[Sysname] wlan service-template service1
[Sysname-wlan-st-service1] mac-authentication fast-connect enable
Related commands
client-security authentication-mode
sacp anti-sticky
Use sacp anti-sticky enable to enable client anti-sticky.
Use sacp anti-sticky disable to disable client anti-sticky.
Use undo sacp anti-sticky to restore the default.
Syntax
sacp anti-sticky { disable | enable [ rssi rssi-value ] [ interval interval ] [ forced-logoff ] }
undo sacp anti-sticky
Default
In radio view, a radio uses the configuration in an AP group's radio view.
In an AP group's radio view, client anti-sticky is enabled.
Views
Radio view
AP group's radio view
Predefined user roles
network-admin
Parameters
rssi rssi-value: Specifies the RSSI threshold in the range of 5 to 100 dBm. By default, the threshold is 20 dBm.
interval interval: Specifies the detection interval in the range of 1 to 10 seconds. By default, the interval is 3 seconds.
forced-logoff: Logs off non-802.11v clients whose signal strength is lower than the RSSI threshold.
Usage guidelines
This feature enables APs to examine the signal strength of clients at the specified intervals. For an 802.11v client, its associated AP triggers a BSS transition to guide the client to a better BSS if the signal strength of the client is lower than the threshold. For a non-802.11v client, no action is performed.
Examples
# Enable client anti-sticky, set the RSSI threshold to 30, set the detection interval to 5 seconds, and enable forced logoff for radio 1 of AP ap1.
<Sysname> system-view
[Sysname] wlan ap ap1 model WA6320
[Sysname-wlan-ap-ap1] radio 1
[Sysname-wlan-ap-ap1-radio-1] sacp anti-sticky enable rssi 30 interval 5 forced-logoff
# Enable client anti-sticky, set the RSSI threshold to 30, and set the detection interval to 5 seconds for radio 1 of APs in AP group 1.
<Sysname> system-view
[Sysname] wlan ap-group 1
[Sysname-wlan-ap-group-1] ap-model WA6320
[Sysname-wlan-ap-group-1-ap-model-WA6320] radio 1
[Sysname-wlan-ap-group-1-ap-model-WA6320-radio-1] sacp anti-sticky enable rssi 30 interval 5
Related commands
bss transition-management
sacp anti-sticky acl
Use sacp anti-sticky acl to configure ACL-based client anti-sticky.
Use sacp anti-sticky acl remove to remove the ACL-based client anti-sticky configuration.
Use undo sacp anti-sticky acl to restore the default.
Syntax
In radio view:
sacp anti-sticky acl { acl-number rssi rssi-value | remove }
undo sacp anti-sticky acl
In an AP group's radio view:
sacp anti-sticky acl acl-number [ rssi rssi-value ]
undo sacp anti-sticky acl
Default
In radio view, a radio uses the configuration in AP group view.
In an AP group's radio view, ACL-based client anti-sticky is not configured.
Views
Radio view
AP group's radio view
Predefined user roles
network-admin
Parameters
acl-number: Specifies the number of a Layer 2 ACL, in the range of 4000 to 4999.
rssi rssi-value: Specifies the RSSI threshold in the range of 5 to 100 dBm.
Usage guidelines
With client anti-sticky enabled, the system logs off a client if the signal strength of the client cannot reach the RSSI threshold. This practice might cause frequent BSS transitions and affect user experience.
To solve this issue, configure ACL-based client anti-sticky to set different RSSI thresholds for clients matching different ACL rules.
For clients that do not match any configured ACL rules, the RSSI threshold for client anti-sticky is used.
This feature takes effect only on clients associated with the AC.
Examples
# Specify ACL 4000 for ACL-based client anti-sticky and set the RSSI threshold to 35 for radio 1 of AP ap1.
<Sysname> system-view
[Sysname] wlan ap ap1 model WA6320
[Sysname-wlan-ap-ap1] radio 1
[Sysname-wlan-ap-ap1-radio-1] sacp anti-sticky acl 4000 rssi 35
# Specify ACL 4000 for ACL-based client anti-sticky and set the RSSI threshold to 35 for radio 1 of APs in AP group apgroup2.
<Sysname> system-view
[Sysname] wlan ap-group apgroup1
[Sysname-wlan-ap-group-apgroup1] ap-model WA6320
[Sysname-wlan-ap-group-apgroup1-ap-model-WA6320] radio 1
[Sysname-wlan-ap-group-apgroup1-ap-model-WA6320-radio-1] sacp anti-sticky acl 4000 rssi 35
Related commands
sacp anti-sticky
sacp roam-optimize traffic-hold enable advanced
Use sacp roam-optimize traffic-hold enable advanced to enable advanced data transmission holding during roaming.
Use undo sacp roam-optimize traffic-hold enable to disable advanced data transmission holding during roaming.
Syntax
sacp roam-optimize traffic-hold enable advanced
undo sacp roam-optimize traffic-hold enable
Default
Advanced data transmission holding during roaming is disabled.
Views
Service template view
Predefined user roles
network-admin
Usage guidelines
With advanced data transmission holding during roaming enabled, the device caches the data packets and sends the cached packets to the client to reduce the packet loss when the client signal strength is lower than the RSSI threshold specified by client anti-sticky. With advanced data transmission holding during roaming disabled, the device ages out the cached packets after a period of time and will not send the packets to the client. As a best practice, enable advanced data transmission holding during roaming in the BSS roaming scenario enabled with client anti-sticky.
To make this feature take effect, enable client association at the AC and enable the AC to forward client data traffic.
This feature is not supported in an AC hierarchy network.
Examples
# Enable advanced data transmission holding during roaming.
<Sysname> system-view
[Sysname] wlan service-template 1
[Sysname-wlan-st-1] sacp roam-optimize traffic-hold enable advanced
sacp roam-optimize bss-candidate-list
Use sacp roam-optimize bss-candidate-list enable to enable an AP to obtain BSS candidate information.
Use sacp roam-optimize bss-candidate-list disable to disable an AP from obtaining BSS candidate information.
Use undo sacp roam-optimize bss-candidate-list to restore the default.
Syntax
sacp roam-optimize bss-candidate-list { disable | enable [ interval interval ] }
undo sacp roam-optimize bss-candidate-list
Default
In radio view, an AP uses the configuration in an AP group's radio view.
In an AP group's radio view, the BSS candidate obtaining feature is disabled.
Views
Radio view
AP group's radio view
Predefined user roles
network-admin
Parameters
interval interval: Specifies the interval for obtaining BSS candidate information in the range of 1 to 500 seconds. By default, the interval is 10 seconds.
Usage guidelines
This feature takes effect only on clients that come online after the feature is configured.
This feature enables an AP to send Beacon requests at specific intervals to clients that support Beacon measurement and obtain information about BSSs detected by the clients. Upon receiving such a request, a client responds with a Beacon Report frame to report BSS information.
With this feature disabled, the AP stops updating BSS candidate information and deletes all the candidates after the aging time expires.
If both this feature and BSS transition management are enabled, the system can guide clients to roam to better services based on the BSS candidate information.
To examine if a client supports beacon measurement, use the display wlan client rm-capabilities command.
Examples
# Enable the BSS candidate obtaining feature for radio 1 of AP ap1.
<Sysname> system-view
[Sysname] wlan ap ap1 model WA6320
[Sysname-wlan-ap-ap1] radio 1
[Sysname-wlan-ap-ap1-radio-1] sacp roam-optimize bss-candidate-list enable
# Enable the BSS candidate obtaining feature for radio 1 of APs in AP group apgroup1.
<Sysname> system-view
[Sysname] wlan ap-group apgroup1
[Sysname-wlan-ap-group-apgroup1] ap-model WA6320
[Sysname-wlan-ap-group-apgroup1-ap-model-WA6320] radio 1
[Sysname-wlan-ap-group-apgroup1-ap-model-WA6320-radio-1] sacp roam-optimize bss-candidate-list enable
Related commands
bss transition-management
Mobility group commands
For information about MSR routers that can function as ACs, see "Compatibility of hardware and AC functionality."
display wlan mobility roam-count
Use display wlan mobility roam-count to display the number of roamings for each client.
Syntax
display wlan mobility roam-count
Views
Any view
Predefined user roles
network-admin
network-operator
Examples
# Display the number of roamings for each client.
<Sysname> display wlan mobility roam-count
MAC address Count
5250-0012-0411 0
9cd3-6d9d-ea3c 3
8007-3fed-aa6c 8
Table 4 Command output
Field |
Description |
MAC address |
Client MAC address. |
Count |
Number of roamings. |
snmp-agent trap enable wlan mobility
Use snmp-agent trap enable wlan mobility to enable SNMP notifications for WLAN roaming.
Use undo snmp-agent trap enable wlan mobility to disable SNMP notifications for WLAN roaming.
Syntax
snmp-agent trap enable wlan mobility
undo snmp-agent trap enable wlan mobility
Default
SNMP notifications are disabled for WLAN roaming.
Views
System view
Predefined user roles
network-admin
Usage guidelines
To report critical WLAN roaming events to an NMS, enable SNMP notifications for WLAN roaming. For WLAN roaming event notifications to be sent correctly, you must also configure SNMP on the device. For more information about SNMP configuration, see Network Management and Monitoring Configuration Guide.
Examples
# Enable SNMP notifications for WLAN roaming.
<Sysname> system-view
[Sysname] snmp-agent trap enable wlan mobility