WLAN Functions¶
emulation wlan client config¶
Execute Tester Command ${rt_handle} command=test_control <additional key=value arguments>
- Purpose:
Spirent Extension (for Spirent HLTAPI only).
Configures or deletes IEEE802.11 Client emulation on the specified device.
IEEE 802.11 is a set of media access control (MAC) and physical layer (PHY) specifications for implementing wireless local area network (WLAN) computer communication in the 900 MHz and 2.4, 3.6, 5, and 60 GHz frequency bands.
Synopsis:
Note: M indicates the argument is `Mandatory`.
emulation wlan client config
mode= {enable|modify} M
handle= <device_handle>
client_handle= <client_handle>
client_profile= <client_profile_handle>
active= {true|false}
Arguments:
handle
Specifies the device handle on which to enable the WLAN (IEEE802.11)
client. It is required for mode create.
client_handle
Specifies the WLAN client handle returned by the function. It is
required for mode modify.
mode
Specifies the action to perform. This argument is `Mandatory`.
Possible values are::
enable Enables the WLAN client on the specified device
modify Modifies the WLAN client specified by client_handle
client_profile
Specifies the WLAN client profile association with the client enabled device.
You must specify client_handle.
Before specifying the profile handle, you must create the profile using
emulation wlan client profile config, and use the returned
profile handle in the call of emulation wlan client config.
active
Enables the WLAN client specified by the handle argument.
You must specify a valid device handle.
The default value is true.
- Return Values:
Depending on the specific language that HLTAPI uses, the function returns a keyed list/dictionary/hash (See Introduction for more information on return value formats) using the following keys (with corresponding data):
status $SUCCESS (1) or $FAILURE (0) log Error message if command returns {status 0} client_handle The WLAN client handle returned by the function- Description:
The
emulation wlan client configfunction enables or deletes a WLAN client on a specified device.Before you enable WLAN on the device, you must create the device, and use the returned device handle in the call to the emulation wlan client config.
- Examples:
The following example enables WLAN on the specified device:
emulation wlan client config mode= enable handle= [keylget device_ret0 handle_list] active= true client_profile= $client_profile_handleSample Output:
{client_handle ieee80211clientconfig1} {status 1}
End of Procedure Header
emulation wlan accesspoint config¶
Execute Tester Command ${rt_handle} command=test_control <additional key=value arguments>
- Purpose:
Spirent Extension (for Spirent HLTAPI only).
Configures or deletes IEEE802.11 Access Point emulation on the specified device.
Synopsis:
Note: M indicates the argument is `Mandatory`.
emulation wlan accesspoint config
mode= {enable|modify} M
handle= <device_handle>
accesspoint_handle= <accesspoint_handle>
accesspoint_profile= <accesspoint_profile_handle>
active= {true|false}
Arguments:
handle
Specifies the device handle on which to enable the WLAN (IEEE802.11)
access point. It is required for mode enable.
accesspoint_handle
Specifies the WLAN access point handle returned by the function. It is
required for mode modify.
mode
Specifies the action to perform. This argument is `Mandatory`.
Possible values are::
enable Enables the WLAN access point on the specified device
modify Modifies the WLAN access point specified by client_handle
accesspoint_profile
Specifies the WLAN access point profile association with the access point
enabled device. You must specify accesspoint_handle.
Before specifying the profile handle, you must create the profile using
emulation wlan accesspoint profile config, and use the returned
profile handle in the call of emulation wlan accesspoint config.
active
Enables the WLAN access point specified by the handle argument.
You must specify a valid device handle.
The default value is true.
- Return Values:
Depending on the specific language that HLTAPI uses, the function returns a keyed list/dictionary/hash (See Introduction for more information on return value formats) using the following keys (with corresponding data):
status $SUCCESS (1) or $FAILURE (0) log Error message if command returns {status 0} client_handle The WLAN access point handle returned by the function- Description:
The
emulation wlan accesspoint configfunction enables or deletes a WLAN access point on a specified device.Before you enable WLAN on the device, you must create the device, and use the returned device handle in the call to the emulation wlan accesspoint config.
- Examples:
The following example enables WLAN on the specified device:
emulation wlan accesspoint config mode= enable handle= [keylget device_ret0 handle_list] active= true accesspoint_profile= $accesspoint_profile_handleSample Output:
{accesspoint_handle ieee80211accesspointconfig1} {status 1}
End of Procedure Header
emulation wlan client profile config¶
Execute Tester Command ${rt_handle} command=test_control <additional key=value arguments>
- Purpose:
Spirent Extension (for Spirent HLTAPI only).
Creates or modifies the WLAN client profile on the specified WLAN client enabled device.
Synopsis:
Note: M indicates the argument is `Mandatory`.
emulation wlan client profile config
mode= {create|modify|delete} M
profile_handle= <handle>
profile_name= <ALPHANUM>
protocol_rate= {auto | 802.11a | 802.11b | 802.11g | 802.11n | 802.11ac | 802.11ax}
ssid= <ANY>
encryption_type= {open | wep | wpa_wpa2_enterprise | wpa_wpa2_personal}
fast_transition_roaming= {true | false}
fast_transition_bssid_list= <MAC>
fast_transition_mode= {random | sequential}
fast_transition_over_ds= {true | false}
bssid= <MAC>
passphrase= <ANY>
guard_interval= {long | short}
max_ht_a_mpdu_size= {16k | 32k | 64k | 8k}
min_a_mpdu_density= {0.25 | 0.5 | 1 | 2 | 4 | 8 | none}
max_vht_a_mpdu_size= {1024k | 128k | 16k | 256k | 32k | 512k | 64k | 8k}
max_a_msdu= {4k | 8k}
ht_40_mhz_support= {true | false}
ldpc_support= {true | false}
active_key= {1 | 2 | 3 | 4}
key_format= {ascii | hex}
key1= <ANY>
key1_type= {128bit | 64bit | disabled}
key2= <ANY>
key2_type= {128bit | 64bit | disabled}
key3= <ANY>
key3_type= {128bit | 64bit | disabled}
key4= <ANY>
key4_type= {128bit | 64bit | disabled}
eap_authentication_type= {aka | peap | tls | ttls}
ttls_phase_two_authentication= {chap | gtc | md5 | mschap | mschapv2 | pap | tls}
ttls_peer_identity= <ANY>
ttls_anonymous_identity= <ANY>
ttls_password= <ANY>
ttls_client_certification_authority_file_path= <ANY>
tls_password= <ANY>
peer_identity= <ANY>
client_certificate_file_path= <ANY>
client_private_key_file_path= <ANY>
client_certification_authority_file_path= <ANY>
peap_phase_two_authentication= {chap | gtc | md5 | mschap | mschapv2 | pap | tls}
peap_version= {v0 | v1}
peap_password= <ANY>
peap_client_certification_authority_file_path= <ANY>
peap_peer_identity= <ANY>
peap_anonymous_identity= <ANY>
aka_realm_name= <ANY>
aka_sequence_number= <ANY>
aka_authentication_key= <ANY>
aka_operator_variant_code= <ANY>
aka_mobile_subscriber_identity= <ANY>
Arguments:
mode
Specifies the action to perform. This argument is `Mandatory`.
Possible values are::
create Creates the WLAN client profile.
modify Modifies the configuration of the WLAN client profile
specified by profile_handle
delete Deletes the WLAN client profile.
profile_handle
Specifies the WLAN profile handle returned by the function. It is
required for mode modify.
profile_name
Specifies the name of the profile.
protocol_rate
Specifies the 802.11 rate supported.
The default value is auto.
ssid
Specifies the Service Set Identifier (SSID).
The default value is APDUT.
encryption_type
Specifies the type of the encryption.
The default type is open.
fast_transition_roaming
Enables or disables Fast Transition Roaming.
Possible values are true(enables) and false(disables).
The default value is false.
fast_transition_bssid_list
Specifies the Basic Service Set Identifier (MAC address) list.
This argument is available when fast_transition_roaming argument is set to true.
The default value is 00:10:94:00:00:01.
fast_transition_mode
Specifies the fast transition mode.
This argument is available when fast_transition_roaming is set to true.
Possible values are::
sequential Starts from the first access point (AP) target and moves
to the next AP target in the list, until the end of the list.
random Selects from the AP target list in a random pattern.
The default value is sequential.
fast_transition_over_ds
Enables or disables the Fast Transition Over Distribution System.
Possible values are true(enables) and false(disables).
The default value is false.
bssid
Specifies the Basic Service Set Identifier value.
The default value is 00:00:00:00:00:00.
passphrase
Specifies the password phrase to use in encryption. This argument is
available when encryption_type is set to wpa_wpa2_personal.
guard_interval
Specifies the period of time elapsed between symbols (characters)
being transmitted. The guard interval eliminates intersymbol interference (ISI).
Possible values are short and long.
The default value is short.
max_ht_a_mpdu_size
Specifies the maximum size of HT AMPDU frame.
The default value is 64k. This is the maximum allowed.
min_a_mpdu_density
Specifies the minimum AMPDU Density Size. This parameter controls the
interpacket gap for AMPDU frames.
The default value is 8.
max_vht_a_mpdu_size
Specifies the maximum size of VHT AMPDU frame.
Default value is 1024k.
max_a_msdu
Specifies the maximum AMSDU size.
The default value is 8k.
ht_40_mhz_support
This option is used to disable 40MHz bandwidth when testing 802.11n.
802.11ac requires 80MHz. If this option is enabled, and 802.11ac is configured,
the client configuration downgrades to 802.11n automatically.
The default value is true.
ldpc_support
LDPC is a linear error correcting code, a method of transmitting a
message over noisy transmission channels.
The default value is true.
active_key
Selects key type. This argument is
available when encryption_type is set to wep.
The default value is 1.
key_format
Specifies a format to apply to all keys in the list.
Possible values are ascii and hex.
The default format is hex.
key1
Specifies the wep key1 value.
key1_type
Specifies the type of wep key1 value.
Possible values are 128bit,64bit, and disabled.
The default type is disabled.
key2
Specifies the wep key2 value.
key2_type
Specifies the type of wep key1 value.
Possible values are 128bit,64bit, and disabled.
The default type is disabled.
key3
Specifies the wep key3 value.
key3_type
Specifies the type of wep key3 value.
Possible values are 128bit,64bit, and disabled.
The default type is disabled.
key4
Specifies the wep key4 value.
key4_type
Specifies the type of wep key4 value.
Possible values are 128bit,64bit, and disabled.
The default type is disabled.
eap_authentication_type
Specifies the eap authentication type.
Possible values are tls,ttls, peap and aka.
The default type is tls.
ttls_phase_two_authentication
Specifies the method of TTLS PhaseTwo Authentication.
The default type is md5.
ttls_peer_identity
EAPTTLS peer name (Peer-Id) represents the identity
to be used for access control and accounting purposes.
The default value is anonymous@example.com.
ttls_anonymous_identity
Specifies the unencrypted identity to be sent in response to an
EAP identity request.
ttls_password
Specifies the password to be used for clientside
certificate encryption.
ttls_client_certification_authority_file_path
Specifies a digital certification of ownership of a public key file.
Example: public.key
tls_password
Specifies the password to be used for clientside
certificate encryption.
peer_identity
Peer Identity (PeerId) represents the identity to be used for
access control and accounting purposes.
The default value is anonymous@example.com.
client_certificate_file_path
Specifies a digital certification of ownership of a public key file.
Example: public.key
client_private_key_file_path
Specifies an electronic document used to prove ownership of a public key.
Example: file.key
client_certification_authority_file_path
Specifies an ITU-T standard for a public key infrastructure (PKI).
Example: file.key
peap_phase_two_authentication
Specifies the method of peap PhaseTwo Authentication.
The default type is md5.
peap_version
Specifies the version for the Phase-2 Authentication selection.
The default type is v0.
peap_password
Specifies the Password to be used for clientside certificate encryption.
peap_client_certification_authority_file_path
Specifies a digital certification of ownership of a public key.
peap_peer_identity
Peer Identity (PeerId) represents the identity to be used
for access control and accounting purposes.
peap_anonymous_identity
Specifies the unencrypted identity to be sent in response
to an EAP identity request.
aka_realm_name
Specifies the name of the Realm to use in the authentication process.
aka_sequence_number
Specifies the sequence number used in the authentication process.
aka_authentication_key
Specifies the authentication key (in 32 hexdigits) that is shared by user
equipment (UE) and the test set and is used in the authentication procedure.
aka_operator_variant_code
Specifies whether the Operator Variant Parameter Value (Hex) is
used as OP or OPc value for authentication.
aka_mobile_subscriber_identity
International Mobile Subscriber Identifier, used to identify subscribers.
- Return Values:
Depending on the specific language that HLTAPI uses, the function returns a keyed list/dictionary/hash (See Introduction for more information on return value formats) using the following keys (with corresponding data):
status $SUCCESS (1) or $FAILURE (0) log Error message if command returns {status 0} client_profile_handle The WLAN client profile handle returned by the function- Description:
- The
emulation wlan client profile configfunction creates, modifies or deletes the wlan access point profile. Use mode to specify the action to perform. - Examples:
The following example creates a WLAN client profile:
emulation wlan client profile config mode= create profile_name= profile_1 protocol_rate= 802.11a encryption_type= wep fast_transition_roaming= true fast_transition_bssid_list= "00:11:94:00:00:01 00:12:94:00:00:01" fast_transition_mode= random fast_transition_over_ds= true passphrase= abckdfkd ssid= New bssid= 00:10:94:00:00:02 guard_interval= long max_ht_a_mpdu_size= 16k min_a_mpdu_density= 0.25 max_a_msdu= 4k max_vht_a_mpdu_size= 128k ht_40_mhz_support= true ldpc_support= true active_key= 2 key_format= hex key1= 1111111 key1_type= 128bit key2= 222222 key2_type= 64bit key3= 3333333 key3_type= 128bit key4= 4444444 key4_type= 128bit eap_authentication_type= ttls ttls_phase_two_authentication= tls ttls_peer_identity= 1 ttls_anonymous_identity= 2 ttls_password= spirent1 ttls_client_certification_authority_file_path= "D:/abc.key" tls_password= spirent2 peer_identity= abc client_certificate_file_path= "D:/abc.key" client_private_key_file_path= "D:/abc.key" client_certification_authority_file_path= "D:/abc.key" peap_phase_two_authentication= tls peap_peer_identity= 1 peap_anonymous_identity= 2 peap_version= v1 peap_password= spirent3 peap_client_certification_authority_file_path= "D:/abc.key" aka_realm_name= wlan aka_sequence_number= 1111111 aka_authentication_key= 22222 aka_operator_variant_code= 333333 aka_mobile_subscriber_identity= 44444
Sample Output:
{client_profile_handle ieee80211clientprofile1} {status 1}
End of Procedure Header
emulation wlan accesspoint profile config¶
Execute Tester Command ${rt_handle} command=test_control <additional key=value arguments>
- Purpose:
Spirent Extension (for Spirent HLTAPI only).
Creates, modifies or deletes the WLAN access point profile on the specified WLAN access point enabled device.
Synopsis:
Note: M indicates the argument is `Mandatory`.
emulation wlan accesspoint profile config
mode= {create|modify|delete} M
profile_handle= <handle>
profile_name= <ALPHANUM>
ssid= <ANY>
beacon_interval= <NUMERIC>
disable_max_a_msdu= {true | false}
max_vht_a_mpdu_size= {1024k | 128k | 16k | 256k | 32k | 512k | 64k | 8k}
enable_wmm= {true | false}
encryption_type= {open | wep | wpa_psk}
guard_interval_mode= {long | short}
ldpc_support= {true | false}
rts_threshold= <NUMERIC>
station_inactivity_timeout= <NUMERIC>
wpa_type= {wpa_personal | wpa2_personal | wpa_wpa2_personal}
passphrase= <ANY>
active_key= {1 | 2 | 3 | 4}
key_format= {ascii | hex}
key1= <ANY>
key1_type= {128bit | 64bit | disabled}
key2= <ANY>
key2_type= {128bit | 64bit | disabled}
key3= <ANY>
key3_type= {128bit | 64bit | disabled}
key4= <ANY>
key4_type= {128bit | 64bit | disabled}
Arguments:
mode
Specifies the action to perform. This argument is `Mandatory`.
Possible values are::
create Creates the WLAN access point profile.
modify Modifies the configuration of the WLAN access point profile
specified by profile_handle
delete Deletes the WLAN access point profile.
profile_handle
Specifies the WLAN profile handle returned by the function. It is
required for mode modify.
profile_name
Specifies the name of the profile.
ssid
Specifies the Service Set Identifier (SSID).
The default value is apdut.
beacon_interval
Specifies the time interval between sending beacon frames in milliseconds.
The default value is 100.
disable_max_a_msdu
Enables or disables Maximum AMSDU Support.
The default value is false.
max_vht_a_mpdu_size
Specifies the maximum size of VHT AMPDU frame.
Default value is 1024k.
enable_wmm
Readonly Wi-Fi Multimedia selection.
Default is true.
encryption_type
Specifies the encryption of WLAN.
The default type open.
passphrase
Specifies the password phrase to use in encryption. This argument is
available when encryption_type is set to wpa_wpa2_personal.
guard_interval_mode
Specifies the period of time elapsed between symbols (characters)
being transmitted. The guard interval eliminates intersymbol interference (ISI).
Possible values are short and long.
The default value is short.
ldpc_support
LDPC is a linear error correcting code, a method of transmitting a
message over noisy transmission channels.
The default value is true.
rts_threshold
Specifies the RTS Threshold length (bytes).
Possible values are 1-2347.
The default value is 2347.
station_inactivity_timeout
Specifies the time to remove inactivated clients in seconds.
The default value is 300.
wpa_type
Specifies WPA mode if encryption type is WPA/WPA2.
The default type is wpa_personal.
active_key
Selects the key type. This argument is
available when encryption_type is set to wep.
The default value is 1.
key_format
Specifies a format to apply to all keys in the list.
Possible values are ascii and hex.
The default format is hex.
key1
Specifies the wep key1 value.
key1_type
Specifies the type of wep key1 value.
Possible values are 128bit,64bit, and disabled.
The default type is disabled.
key2
Specifies the wep key2 value.
key2_type
Specifies the type of wep key1 value.
Possible values are 128bit,64bit, and disabled.
The default type is disabled.
key3
Specifies the wep key3 value.
key3_type
Specifies the type of wep key3 value.
Possible values are 128bit,64bit, and disabled.
The default type is disabled.
key4
Specifies the wep key4 value.
key4_type
Specifies the type of wep key4 value.
Possible values are 128bit,64bit, and disabled.
The default type is disabled.
- Return Values:
Depending on the specific language that HLTAPI uses, the function returns a keyed list/dictionary/hash (See Introduction for more information on return value formats) using the following keys (with corresponding data):
status $SUCCESS (1) or $FAILURE (0) log Error message if command returns {status 0} accesspoint_profile_handle The WLAN client profile handle returned by the function- Description:
- The
emulation wlan accesspoint profile configfunction creates, modifies or deletes the WLAN access point profile. Use mode to specify the action to perform. - Examples:
The following example creates a WLAN client profile:
emulation wlan accesspoint profile config mode= create profile_name= profile_2 encryption_type= wep passphrase= abckdfkd guard_interval_mode= long max_vht_a_mpdu_size= 1024k disable_max_a_msdu= true enable_wmm= true beacon_interval= 10 ssid= New ldpc_support= true rts_threshold= 10 station_inactivity_timeout= 30 active_key= 2 key_format= hex key1= 31 key1_type= 128bit key2= 3131 key2_type= 64bit key3= 3131 key3_type= 128bit key4= 3131 key4_type= 128bit wpa_type= wpa_personal
Sample Output:
{accesspoint_profile_handle ieee80211accesspointprofile1} {status 1}
End of Procedure Header
emulation wlan port config¶
Execute Tester Command ${rt_handle} command=test_control <additional key=value arguments>
- Purpose:
Spirent Extension (for Spirent HLTAPI only).
Configures or modifies the 802.11 parameters of the WLAN port
Synopsis:
Note: M indicates the argument is `Mandatory`.
emulation wlan port config
mode= {create | modify} M
port_handle= <ANY> M
handle= <ANY>
line_speed= {speed_1g | speed_2_5g | speed_5g | speed_unknown}
frequency_band= {2.4ghz | 5ghz | auto}
mimo_type= {1 | 2 | 3 | 4}
mimo_mode= {mu_mimo su_mimo}
association_load_type= {fixed | random}
association_load_mode= {random | sequential}
association_delay_in_seconds= <NUMERIC>
association_timeout= <NUMERIC>
enable_radio_power= {true | false}
enable_access_point_mode= {true | false}
power_level= <NUMERIC>
access_point_operational_mode= {a | a_n | a_n_ac | b | g | g_n}
access_point_bandwidth= {160m | 20m | 40m | 80m | 80p80m}
access_point_channel= <NUMERIC>
access_point_ht40_mode= {auto | minus | plus}
dfs_test_mode= {true | false}
data_rate_1mbps= {true | false}
data_rate_2mbps= {true | false}
data_rate_5_5mbps= {true | false}
data_rate_6mbps= {true | false}
data_rate_9mbps= {true | false}
data_rate_11mbps= {true | false}
data_rate_12mbps= {true | false}
data_rate_18mbps= {true | false}
data_rate_24mbps= {true | false}
data_rate_36mbps= {true | false}
data_rate_48mbps= {true | false}
data_rate_54mbps= {true | false}
data_rate_mcs7= {true | false}
data_rate_mcs6= {true | false}
data_rate_mcs5= {true | false}
data_rate_mcs4= {true | false}
data_rate_mcs3= {true | false}
data_rate_mcs2= {true | false}
data_rate_mcs1= {true | false}
data_rate_mcs0= {true | false}
max_numberof_amsdu= {1-31}
max_numberof_ampdu= {1-255}
vht_mcs_type {07 | 08 | 09= | none}
use_highest_mcs_index= {true | false}
vht_tx_mcs_type= {VHT_TX_TYPE_NONE | VHT_TX_TYPE_0_7 | VHT_TX_TYPE_0_8 | VHT_TX_TYPE_0_9 |
VHT_TX_TYPE_0_11 | VHT_TX_TYPE_0 | VHT_TX_TYPE_1 | VHT_TX_TYPE_2 | VHT_TX_TYPE_3 |
VHT_TX_TYPE_4 | VHT_TX_TYPE_5 | VHT_TX_TYPE_6 | VHT_TX_TYPE_7 | VHT_TX_TYPE_8 |
VHT_TX_TYPE_9 | VHT_TX_TYPE_10 | VHT_TX_TYPE_11}]
vht_rx_mcs_type= {VHT_TYPE_NONE | VHT_TYPE_0_7 | VHT_TYPE_0_8 |
VHT_TYPE_0_9 | VHT_TYPE_0_11}]
he_tx_mcs_type= {HE_TX_TYPE_NONE | HE_TX_TYPE_0_7 | HE_TX_TYPE_0_8 | HE_TX_TYPE_0_9 |
HE_TX_TYPE_0_11 | HE_TX_TYPE_0 | HE_TX_TYPE_1 | HE_TX_TYPE_2 | HE_TX_TYPE_3 |
HE_TX_TYPE_4 | HE_TX_TYPE_5 | HE_TX_TYPE_6 | HE_TX_TYPE_7 | HE_TX_TYPE_8 |
HE_TX_TYPE_9 | HE_TX_TYPE_10 | HE_TX_TYPE_11 | HE_TX_TYPE_12 | HE_TX_TYPE_13}]
he_rx_mcs_type= {HE_RX_TYPE_NONE | HE_RX_TYPE_0_7 | HE_RX_TYPE_0_8 | HE_RX_TYPE_0_9}
high_efficiency_mcs0= {true | false}
high_efficiency_mcs1= {true | false}
high_efficiency_mcs2= {true | false}
high_efficiency_mcs3= {true | false}
high_efficiency_mcs4= {true | false}
high_efficiency_mcs5= {true | false}
high_efficiency_mcs6= {true | false}
high_efficiency_mcs8= {true | false}
high_efficiency_mcs9= {true | false}
high_efficiency_mcs10= {true | false}
high_efficiency_mcs11= {true | false}
enable_sma1= {true | false}
enable_sma2= {true | false}
enable_sma3= {true | false}
enable_sma4= {true | false}
enable_sma5= {true | false}
enable_sma6= {true | false}
enable_sma7= {true | false}
enable_sma8= {true | false}
enable_sma9= {true | false}
enable_sma10= {true | false}
enable_sma11= {true | false}
enable_sma12= {true | false}
sma_attenuator_1= <0-254>
sma_attenuator_2= <0-254>
sma_attenuator_3= <0-254>
sma_attenuator_4= <0-254>
sma_attenuator_5= <0-254>
sma_attenuator_6= <0-254>
sma_attenuator_7= <0-254>
sma_attenuator_8= <0-254>
sma_attenuator_9= <0-254>
sma_attenuator_10= <0-254>
sma_attenuator_11= <0-254>
sma_attenuator_12= <0-254>
antenna_list= <ANY>
sma_start_index= <0-8>
power_level_channel= <0-127>
traffic_pass_through= {true | false}
apply_all_attenuators= {true | false}
ignore_link_status= {true | false}
channel_bw_160mhz= {true | false}
channel_bw_20mhz= {true | false}
channel_bw_40mhz= {true | false}
channel_bw_80mhz= {true | false}
disable_back_pressure= {true | false}
disable_twt= {true | false}
dual_carrier_modulation= {true | false}
duration_based_rts= {true | false}
enable_80211k_roaming= {true | false}
enable_80211v_roaming= {true | false}
enable_rts_cts= {true | false}
enable_vht_2g= {true | false}
extended_range= {true | false}
enable_noise_generator= {true | false}
enable_bss_color_detection= {true | false}
firmware_switch_for_alp_testing= {true | false}
forward_error_correction= {true | false}
mtu= <0-16383>
fragmentation_level= <0-3>
bss_color= <0-63>
noise_generator_channel= <1-165>
fast_transition_roaming_threshold= <ANY>
scanning_threshold_80211k= <ANY>
country_region= <ANY>
data_path_mode= {normal | local_loopback | line_monitor}
custom_fec_mode= {none | kr_fec | rs_fec | kp4_fec}
long_training_field= {auto | ltfx_1 | ltfx_2 | ltfx_4}
port_setup_mode= {port_config_only | registers_only}
power_level_type= {off | auto | fixed}
access_point_guard_interval_mode= {short | long}
layer2_mode= {802.11}
media_type= { 802.11 | unknown}
support_channel_attenuation= {true | false}
support_channel_attenuation_sma= {true | false}
support_channel_bandwidth_160mhz= {true | false}
support_channel_bandwidth_20mhz= {true | false}
support_channel_bandwidth_40mhz= {true | false}
support_channel_bandwidth_80mhz= {true | false}
support_frequency_2g= {true | false}
support_frequency_5g= {true | false}
support_frequency_6g= {true | false}
support_frequency_auto= {true | false}
support_frequency_tri_band= {true | false}
support_high_efficiency= {true | false}
support_ht_config_edit= {true | false}
support_vht_config_edit= {true | false}
support_vht_mcs_types= {true | false}
support_rate_change= {true | false}
downlink_mu_mimo= {true | false}
downlink_ofdma= {true | false}
uplink_mu_mimo= {true | false}
uplink_ofdma= {true | false}
Arguments:
mode
Specifies the action to perform. This argument is `Mandatory`.
Possible values are::
create Configures the WLAN port specified by port_handle
modify Modifies the WLAN port configurations specified by handle
port_handle
Specifies the port handle on which the WLAN port will be
configured. It is required for mode create.
handle
Specifies the WLAN port configuration handle returned by this
function. It is required for mode modify.
line_speed
Sets the line speed for the port.
The default speed is speed_1g.
frequency_band
Selects an operational band frequency.
The default value is 5ghz.
mimo_mode
Specifies a MIMO mode.
su_mimo Singleuser MIMO.
mu_mimo Multiuser MIMO. Enabled by default.
mimo_type
Selects Multipleinput, multiple-output antenna configuration.
The default value is 3.
association_load_type
Specifies the association load types.
fixed Delay between associations, in seconds
random Delay is random value in range (0, value)
The default value is fixed.
association_load_mode
Specifies the association load modes. Applicable if there are multiple
device blocks.
sequential Pick up multiple device blocks sequentially to do association
random Pick up multiple device blocks randomly to do association
The default value is fixed.
association_delay_in_seconds
Specifies the association delay time value.
The default value is 0.
association_timeout
Specifies the timeout value.
If the client is not associated after timeout, its association fails.
The default value is 10.
enable_radio_power
On or Off radio power.
Possible values are true(on) and false(off).
The default value is true.
enable_access_point_mode
Enables or disables AP emulation. When AP emulation is enabled,
the Access Point configuration tab appears.
The default value is false.
power_level
Transmit power attenuation.
Possible values are 0dB - 30 dB
The default value is 0.
access_point_operational_mode
Specifies the access point Operational Mode based on the selection of
frequency_band.
Frequency Protocols Default
2.4 GHz 802.11b 802.11b
802.11b/g
802.11b/g/n
5 GHz 802.11a 802.11a
802.11a/n
802.11a/n/ac
access_point_bandwidth
Specifies the access point bandwidth based on the access_point_operational_mode
and frequency_band values.
The default value is 20m.
List of supported bandwidths::
Protocol Frequency Default
802.11a
802.11b
802.11g 20 MHz 20 MHz
802.11n 20/40 MHz
802.11ac 20/40/80 MHz
access_point_channel
Specifies the channel value based on the frequency_band and
access_point_operational_mode values.
The default value is 36.
access_point_ht40_mode
Specifies the HT40 options of HT function for 802.11n.
The default value is auto.
dfs_test_mode
Enables or disables DFC test mode.
Possible values are true(enables) and false(disables).
The default value is false.
data_rate_1mbps
Enables or disables data rate usage as 1 MBPS based on the 802.11 protocol type.
This is applicable for protocol rates b/n. Possible values are true(enables) and false(disables).
The default value is true.
data_rate_2mbps
Enables or disables data rate usage as 2 MBPS based on the 802.11 protocol type.
This is applicable for protocol rates b/n. Possible values are true(enables) and false(disables).
The default value is true.
data_rate_5_5mbps
Enables or disables data rate usage as 5.5 MBPS based on the 802.11 protocol type.
This is applicable for protocol rates b/n. Possible values are true(enables) and false(disables).
The default value is true.
data_rate_11mbps
Enables or disables data rate usage as 11 MBPS based on the 802.11 protocol type.
This is applicable for protocol rates b/n. Possible values are true(enables) and false(disables).
The default value is true.
data_rate_6mbps
Enables or disables data rate usage as 6 MBPS based on the 802.11 protocol type.
This is applicable for protocol rates a/g/n/ac. Possible values are true(enables) and false(disables).
The default value is true.
data_rate_9mbps
Enables or disables data rate usage as 9 MBPS based on the 802.11 protocol type.
This is applicable for protocol rates a/g/n/ac. Possible values are true(enables) and false(disables).
The default value is true.
data_rate_12mbps
Enables or disables data rate usage as 12 MBPS based on the 802.11 protocol type.
This is applicable for protocol rates a/g/n/ac. Possible values are true(enables) and false(disables).
The default value is true.
data_rate_18mbps
Enables or disables data rate usage as 18 MBPS based on the 802.11 protocol type.
This is applicable for protocol rates a/g/n/ac. Possible values are true(enables) and false(disables).
The default value is true.
data_rate_24mbps
Enables or disables data rate usage as 24 MBPS based on the 802.11 protocol type.
This is applicable for protocol rates a/g/n/ac. Possible values are true(enables) and false(disables).
The default value is true.
data_rate_36mbps
Enables or disables data rate usage as 36 MBPS based on the 802.11 protocol type.
This is applicable for protocol rates a/g/n/ac. Possible values are true(enables) and false(disables).
The default value is true.
data_rate_48mbps
Enables or disables data rate usage as 48 MBPS based on the 802.11 protocol type.
This is applicable for protocol rates a/g/n/ac. Possible values are true(enables) and false(disables).
The default value is true.
data_rate_54mbps
Enables or disables data rate usage as 54 MBPS based on the 802.11 protocol type.
This is applicable for protocol rates a/g/n/ac. Possible values are true(enables) and false(disables).
The default value is true.
data_rate_mcs0
Enables or disables MCS type BPSK-(0,8,16,24).
The default value is true.
data_rate_mcs1
Enables or disables MCS type QPSK 1/2-(1,9,17,25).
The default value is true.
data_rate_mcs2
Enables or disables MCS type QPSK 3/4-(2,10,18,26).
The default value is true.
data_rate_mcs3
Enables or disables MCS type 16QAM 1/2-(3,11,19,27).
The default value is true.
data_rate_mcs4
Enables or disables MCS type 16QAM 3/4-(4,12,20,28).
The default value is true.
data_rate_mcs5
Enables or disables MCS type 64QAM 2/3-(5,13,21,29).
The default value is true.
data_rate_mcs6
Enables or disables MCS type 64QAM 3/4-(6,14,22,30).
The default value is true.
data_rate_mcs7
Enables or disables MCS type 64QAM 5/6-(7,15,23,31).
The default value is true.
max_numberof_amsdu
Specifies the maximum number of AMSDUs.
The default value is 7.
Possible value range is 1-31.
max_numberof_ampdu
Specifies the maximum number of AMPDUs.
The default value is 255.
Possible value range is 1-255.
vht_mcs_type
Specifies the vht MCS type values.
Very High Throughput MCS types are available for 5G mode on AC radios.
Applies to all spatial streams.
The default value is 0-9.
use_highest_mcs_index
Enables or disables use highest mcs index when vht_mcs_type is set to 0-7, 0-8 or 0-9.
The default value is false.
vht_tx_mcs_type
Specifies to set the vht Tx MCS Type.
The default value is VHT_TX_TYPE_0_9.
vht_rx_mcs_type
Specifies to set the vht Rx MCS Type.
The default value is VHT_TYPE_0_9.
he_tx_mcs_type
Specifies to set the HE Tx MCS Type.
The default value is HE_TX_TYPE_0_11.
he_rx_mcs_type
Specifies to set the HE Rx MCS Type.
The default value is HE_RX_TYPE_0_11.
high_efficiency_mcs0
Enables or disables HighEfficiency Modulation and Coding Scheme #0.
The default value is true.
high_efficiency_mcs1
Enables or disables HighEfficiency Modulation and Coding Scheme #1.
The default value is true.
high_efficiency_mcs2
Enables or disables HighEfficiency Modulation and Coding Scheme #2.
The default value is true.
high_efficiency_mcs3
Enables or disables HighEfficiency Modulation and Coding Scheme #3.
The default value is true.
high_efficiency_mcs4
Enables or disables HighEfficiency Modulation and Coding Scheme #4.
The default value is true.
high_efficiency_mcs5
Enables or disables HighEfficiency Modulation and Coding Scheme #5.
The default value is true.
high_efficiency_mcs6
Enables or disables HighEfficiency Modulation and Coding Scheme #6.
The default value is true.
high_efficiency_mcs7
Enables or disables HighEfficiency Modulation and Coding Scheme #7.
The default value is true.
high_efficiency_mcs8
Enables or disables HighEfficiency Modulation and Coding Scheme #8.
The default value is true.
high_efficiency_mcs9
Enables or disables HighEfficiency Modulation and Coding Scheme #9.
The default value is true.
high_efficiency_mcs10
Enables or disables HighEfficiency Modulation and Coding Scheme #10.
The default value is true.
high_efficiency_mcs11
Enables or disables HighEfficiency Modulation and Coding Scheme #11.
The default value is true.
enable_sma1
Specifies whether to use SMA (SubMiniature version A) in the configuration.
Possible values are true and false. The default value is true.
enable_sma2
Specifies whether to use SMA (SubMiniature version A) in the configuration.
Possible values are true and false. The default value is true.
enable_sma3
Specifies whether to use SMA (SubMiniature version A) in the configuration.
Possible values are true and false. The default value is true.
enable_sma4
Specifies whether to use SMA (SubMiniature version A) in the configuration.
Possible values are true and false. The default value is true.
enable_sma5
Specifies whether to use SMA (SubMiniature version A) in the configuration.
Possible values are true and false. The default value is true.
enable_sma6
Specifies whether to use SMA (SubMiniature version A) in the configuration.
Possible values are true and false. The default value is true.
enable_sma7
Specifies whether to use SMA (SubMiniature version A) in the configuration.
Possible values are true and false. The default value is true.
enable_sma8
Specifies whether to use SMA (SubMiniature version A) in the configuration.
Possible values are true and false. The default value is true.
enable_sma9
Specifies whether to use SMA (SubMiniature version A) in the configuration.
Possible values are true and false. The default value is true.
enable_sma10
Specifies whether to use SMA (SubMiniature version A) in the configuration.
Possible values are true and false. The default value is true.
enable_sma11
Specifies whether to use SMA (SubMiniature version A) in the configuration.
Possible values are true and false. The default value is true.
enable_sma12
Specifies whether to use SMA (SubMiniature version A) in the configuration.
Possible values are true and false. The default value is true.
sma_attenuator_1
Specifies this property to vary the level of attenuation. Possible values
range from 0 to 254. The default value is 127.
sma_attenuator_2
Specifies this property to vary the level of attenuation. Possible values
range from 0 to 254. The default value is 127.
sma_attenuator_3
Specifies this property to vary the level of attenuation. Possible values
range from 0 to 254. The default value is 127.
sma_attenuator_4
Specifies this property to vary the level of attenuation. Possible values
range from 0 to 254. The default value is 127.
sma_attenuator_5
Specifies this property to vary the level of attenuation. Possible values
range from 0 to 254. The default value is 127.
sma_attenuator_6
Specifies this property to vary the level of attenuation. Possible values
range from 0 to 254. The default value is 127.
sma_attenuator_7
Specifies this property to vary the level of attenuation. Possible values
range from 0 to 254. The default value is 127.
sma_attenuator_8
Specifies this property to vary the level of attenuation. Possible values
range from 0 to 254. The default value is 127.
sma_attenuator_9
Specifies this property to vary the level of attenuation. Possible values
range from 0 to 254. The default value is 127.
sma_attenuator_10
Specifies this property to vary the level of attenuation. Possible values
range from 0 to 254. The default value is 127.
sma_attenuator_11
Specifies this property to vary the level of attenuation. Possible values
range from 0 to 254. The default value is 127.
sma_attenuator_12
Specifies this property to vary the level of attenuation. Possible values
range from 0 to 254. The default value is 127.
antenna_list
Specifies the antenna selection list. The default value is 1.
sma_start_index
Specifies the start index of the SMA. Possible values range
from 0 to 8. The default value is 0.
power_level_channel
Specifies the reduction in the strength of a channel signal. Possible
values range from 0 to 127. The default value is 127.
traffic_pass_through
Specifies whether to enable Wlan traffic passthrough. Possible
values are true and false. The default value is false.
apply_all_attenuators
Specifies whether to apply all attenuators. Possible values are
true and false. The default value is true.
ignore_link_status
Specifies whether to allow the port to continue transmitting
traffic if the link(s) with its peer port(s) goes down. Possible
values are true and false. The default value is false.
channel_bw_160mhz
Specifies whether to enable channel bandwidth 160MHz. Possible
values are true and false. The default value is true.
channel_bw_20mhz
Specifies whether to enable channel bandwidth 20MHz. Possible
values are true and false. The default value is true.
channel_bw_40mhz
Specifies whether to enable channel bandwidth 40MHz. Possible
values are true and false. The default value is true.
channel_bw_80mhz
Specifies whether to enable channel bandwidth 80MHz. Possible
values are true and false. The default value is true.
disable_back_pressure
Specifies whether to disable transmit back pressure. Possible values
are true and false. The default value is false.
disable_twt
Specifies whether to disable TWT. Possible values are true
and false. The default value is false.
dual_carrier_modulation
Specifies whether to enable Dual Carrier Modulation (DCM). Possible
values are true and false. The default value is false.
duration_based_rts
Specifies whether to enable Duration Based RTS (DBRT). Possible
values are true and false. The default value is false.
enable_80211k_roaming
Specifies whether to enable 802.11v. Possible values
are true and false. The default value is false.
enable_80211v_roaming
Specifies whether to enable RTS/CTS. Possible values
are true and false. The default value is true.
enable_rts_cts
Specifies whether to enable VHT on 2.4G radio. Possible values
are true and false. The default value is true.
enable_vht_2g
Specifies whether to enable noise generator. Possible values
are true and false. The default value is false.
extended_range
Specifies the extended range value. Possible values are true
and false. The default value is false.
enable_noise_generator
Specifies whether to enable noise generator. Possible values
are true and false. The default value is false.
enable_bss_color_detection
Specifies whether to enable BSS color detection. Possible values
are true and false. The default value is true.
firmware_switch_for_alp_testing
Specifies whether to enable firmware switch for ALP testing. Possible
values are true and false. The default value is false.
forward_error_correction
Specifies the Forward error correction (FEC) value. Possible values
are true and false. The default value is true.
mtu
specifies the maximum transmission unit value of WLAN port. Possible
values range from 0 to 16383. The default value is 1500.
fragmentation_level
Specifies to set the level of fragmentation. Possible values
range from 0 to 3. The default value is 2.
bss_color
Specifies to set the BSS color. Possible values range from 0 to 63.
The default value is 29.
noise_generator_channel
Specifies to indicate which channel to use for noise generator. Possible values
range from 1 to 165. The default value is 36.
fast_transition_roaming_threshold
Specifies to configure the fast transition roaming threshold. The default value
is 12.
scanning_threshold_80211k
Specifies to configure the 802.11k scanning threshold. The default value is -75.
country_region
Specifies the country region value. The default value is USA.
The default value is false.
data_path_mode
Specifies the path for the port to transmit data. The default value
is normal. Possible values are::
Values Description
normal Port will transmit normally
local_loopback Port will transmit in a loopback mode, so
transmitted data will be received by the transmitting
port without going out on the wire
line_monitor Port will be placed in line monitor mode. All received
packets will be transmitted as is but can also be
captured on the port
custom_fec_mode
Specifies to configure the custom FEC mode on the port. The default
value is kr_fec. Possible values are::
Values Description
none No custom FEC mode
kr_fec KR FEC mode
rs_fec RS FEC mode
kp4_fec KP4 FEC mode
long_training_field
Specifies to set the long training field. The default value is auto.
Possible values are::
Values Description
auto Long Training Field Mode AUTO
ltfx_1 Long Training Field Mode X1
ltfx_2 Long Training Field Mode X2
ltfx_4 Long Training Field Mode X4
port_setup_mode
Specifies the port setup or hardware register parameters. The default
value is port_config_only. Possible values are::
Values Description
port_config_only Port configuration only
registers_only Registers only
power_level_type
Specifies the port level power of WLAN port. The default value is
auto. Possible values are::
Values Description
off Power off
auto Power auto
fixed Power fixed
access_point_guard_interval_mode
Specifies the accesspoint guard interval mode of WLAN port. The default
value is short. Possible values are::
Values Description
short GI_MODE_SHORT (Short Mode)
long GI_MODE_LONG (Long Mode)
layer2_mode
Specifies the Layer 2 mode of WLAN port. The default value is 802.11.
media_type
Specifies the media type of WLAN port. The default value is 802.11.
Possible values are::
Values Description
802.11 IEEE 802.11
unknown UNKNOWN
support_channel_attenuation
Specifies whether to support channel attenuation in the configuration. Possible values
are true and false. The default value is false.
support_channel_attenuation_sma
Specifies whether to support channel attenuation SMA in the configuration. Possible
values are true and false. The default value is false.
support_channel_bandwidth_160mhz
Specifies whether to support the channel bandwidth of 160MHz in the configuration.
Possible values are true and false. The default value is false.
support_channel_bandwidth_20mhz
Specifies whether to support the channel bandwidth of 20MHz in the configuration.
Possible values are true and false. The default value is false.
support_channel_bandwidth_40mhz
Specifies whether to support the channel bandwidth of 40MHz in the configuration.
Possible values are true and false. The default value is false.
support_channel_bandwidth_80mhz
Specifies whether to support the channel bandwidth of 80MHz in the configuration.
Possible values are true and false. The default value is false.
support_frequency_2g
Specifies whether to support frequency 2.4G in the configuration. Possible
values are true and false. The default value is false.
support_frequency_5g
Specifies whether to support frequency 5G in the configuration. Possible
values are true and false. The default value is false.
support_frequency_6g
Specifies whether to support frequency 6G in the configuration. Possible
values are true and false. The default value is false.
support_frequency_auto
Specifies whether to support frequency auto in the configuration. Possible
values are true and false. The default value is false.
support_frequency_tri_band
Specifies whether to support frequency triband in the configuration.
Possible values are true and false. The default value is false.
support_high_efficiency
Specifies whether to support high efficiency in the configuration. Possible
values are true and false. The default value is false.
support_ht_config_edit
Specifies whether to edit ht config in the configuration. Possible
values are true and false. The default value is true.
support_vht_config_edit
Specifies whether to edit vht config in the configuration. Possible
values are true and false. The default value is false.
support_vht_mcs_types
Specifies whether to support vht mcs type in the configuration. Possible
values are true and false. The default value is false.
support_rate_change
Specifies whether to support rate change in the configuration. Possible
values are true and false. The default value is false.
downlink_mu_mimo
Specifies whether to use downlink MUMIMO in the configuration. Possible
values are true and false. The default value is false.
downlink_ofdma
Specifies whether to use downlink OFDMA in the configuration. Possible
values are true and false. The default value is false.
uplink_mu_mimo
Specifies whether to use uplink MUMIMO in the configuration. Possible
values are true and false. The default value is false.
uplink_ofdma
Specifies whether to use uplink OFDMA in the configuration. Possible
values are true and false. The default value is false.
- Return Values:
Depending on the specific language that HLTAPI uses, the function returns a keyed list/dictionary/hash (See Introduction for more information on return value formats) using the following keys (with corresponding data):
status $SUCCESS (1) or $FAILURE (0) log Error message if command returns {status 0} handle The WLAN port configuration handle returned by the function- Description:
- The
emulation wlan port configfunction configures the available 802.11 options for the specified WLAN port. Use mode to specify the action to perform. - Examples:
The following example configures the specified WLAN port:
emulation wlan port config mode= create port_handle= $port1 line_speed= speed_2_5g frequency_band= 2.4ghz mimo_type= 1 mimo_mode= mu_mimo association_load_type= random association_load_mode= random association_delay_in_seconds= 100 association_timeout= 100 enable_radio_power= true enable_access_point_mode= false access_point_operational_mode= a access_point_bandwidth= 20m access_point_channel= 40 access_point_secondary_channel= 40 access_point_ht40_mode= minus dfs_test_mode= true data_rate_1mbps= false data_rate_2mbps= true data_rate_5_5mbps= false data_rate_6mbps= false data_rate_9mbps= false data_rate_11mbps= false data_rate_12mbps= false data_rate_18mbps= true data_rate_24mbps= true data_rate_36mbps= true data_rate_48mbps= true data_rate_54mbps= true data_rate_mcs7= true data_rate_mcs6= false data_rate_mcs5= true data_rate_mcs4= false data_rate_mcs3= true data_rate_mcs2= false data_rate_mcs1= true data_rate_mcs0= false max_numberof_amsdu= 1 max_numberof_ampdu= 2 vht_mcs_type= none use_highest_mcs_index= true power_level= 3Sample Output:
{handle ieee80211phy1} {status 1}
End of Procedure Header
emulation wlan client control¶
Execute Tester Command ${rt_handle} command=test_control <additional key=value arguments>
- Purpose:
Spirent Extension (for Spirent HLTAPI only).
Associates or disassociates the wlan client
Synopsis:
Note: M indicates the argument is `Mandatory`.
emulation wlan client control
handle= <client_handle_list> M
action= {associate_client | disassociate_client}
wait= <ANY>
Arguments:
handle
Specifies a list of WLAN client devices on which to perform the action.
action
Specifies the action to be performed. This argument is `Mandatory`.
Possible values are::
associate_client Associates the WLAN client
disassociate_client Disassociates the WLAN client
wait
Specifies the time for clients to associate or disassociate.
- Return Values:
Depending on the specific language that HLTAPI uses, the function returns a keyed list/dictionary/hash (See Introduction for more information on return value formats) using the following keys (with corresponding data):
status $SUCCESS (1) or $FAILURE (0) log Error message if command returns {status 0}- Description:
- The
emulation wlan client controlfunction associates or disassociates the WLAN clients. You must specify handle. - Examples:
The following example associates the specified client device:
emulation wlan client control handle= "$client_handle" action= associate
Sample Output:
{status 1}
End of Procedure Header
emulation wlan accesspoint control¶
Execute Tester Command ${rt_handle} command=test_control <additional key=value arguments>
- Purpose:
Spirent Extension (for Spirent HLTAPI only).
Starts or stops the wlan client test
Synopsis:
Note: M indicates the argument is `Mandatory`.
emulation wlan accesspoint control
handle= <accesspoint_handle_list> M
action= {start | stop}
Arguments:
handle
Specifies a list of WLAN access point devices on which to perform the action.
action
Specifies the action to be performed. This argument is `Mandatory`.
Possible values are::
start Starts WLAN access point
stop Stops WLAN access point
wait
Specifies the time for access points to start or stop.
- Return Values:
Depending on the specific language that HLTAPI uses, the function returns a keyed list/dictionary/hash (See Introduction for more information on return value formats) using the following keys (with corresponding data):
status $SUCCESS (1) or $FAILURE (0) log Error message if command returns {status 0}- Description:
- The
emulation wlan accesspoint controlfunction starts or stops the WLAN access points. You must specify handle. - Examples:
The following example starts the specified access point device:
emulation wlan accesspoint control handle= "$accesspoint_handle" action= start
Sample Output:
{status 1}
End of Procedure Header
radar signal generator config¶
Execute Tester Command ${rt_handle} command=test_control <additional key=value arguments>
Purpose:
Configures to set the port as a DFS (Dynamic Frequency Selection) port.
Synopsis:
Note: M indicates the argument is `Mandatory`.
radar signal generator config
mode= {create | modify| delete} M
port_handle= <ANY> M
handle= <ANY>
bandwidth_detection_test_handle= <ANY>
probability_detection_test_handle= <ANY>
trial_block_handle= <ANY>
trial_block_mode= {create | modify| delete}
bandwidth_detection_test_mode= {create | modify| delete}
probability_detection_test_mode= {create | modify| delete}
enable_radar_emulation= {true | false}
radar_channel_frequency_mode= {channel_mode | frequency_mode}
dfs_channel= <52-144>
dfs_frequency= <5250-5730>
tx_attenuation= <0-89>
region= {jp5250_2019 | korea | jp5470 | jp5250 | ydt2905_2015 | etsi207 | fcc2016}
dut_bss_id= <aa:bb:cc:dd:ee:ff>
random_frequency= {true | false}
trial_block_radar_type= {radar_type_0|radar_type_1|radar_type_2|radar_type_3|
radar_type_4|radar_type_5|radar_type_6|radar_type_7|
radar_type_8}]
trial_count= <1-255>
transmit_signal_only= {true | false}
pulse_width= <ANY>
pulse_count= <NUMERIC>
pulse_repetition_interval= <NUMERIC>
bw_test_radar_type= {radar_type_0|radar_type_1|radar_type_2|radar_type_3|
radar_type_4|radar_type_5|radar_type_6|radar_type_7|
radar_type_8}]
bw_test_trial_per_iteration= <1-255>
bw_test_freq_shift_step_1= <1-5>
bw_test_freq_shift_step_2= <1-5>
prob_test_radar_type= {radar_type_0|radar_type_1|radar_type_2|radar_type_3|
radar_type_4|radar_type_5|radar_type_6|radar_type_7|
radar_type_8}]
prob_test_trial_count= <1-255>
prob_test_iteration_count= <1-255>
Arguments:
mode
Specifies the action to perform. This argument is `Mandatory`.
Possible values are::
create Configures the WLAN port as a DFS (Dynamic Frequency
Selection) port
modify Modifies the DFS port configurations specified by handle
delete Modifies the DFS port configurations specified by handle
port_handle
Specifies the port handle to set the port as a DFS (Dynamic Frequency
Selection) port configured. It is required for mode create.
handle
Specifies the handle to modify the DFS port configurations.
It is required for mode modify and delete.
bandwidth_detection_test_handle
Specifies the handle to modify the bandwidth detection test
configuration. It is required for mode modify and delete.
probability_detection_test_handle
Specifies the handle to modify the probability detection test
configuration. It is required for mode modify and delete.
trial_block_handle
Specifies the handle to modify the trial block configuration.
It is required for mode modify and delete.
bandwidth_detection_test_mode
Specifies the action to perform. If this option is not configured,
it takes the value of mode. Possible values are::
create Configures bandwidth detection test.
modify Modifies the bandwidth detection test configuration.
delete Deletes the bandwidth detection test configuration.
probability_detection_test_mode
Specifies the action to perform. If this option is not configured,
it takes the value of mode. Possible values are::
create Configures probability detection test
modify Modifies the probability detection test configuration.
delete Deletes the probability detection test configuration.
trial_block_mode
Specifies the action to perform. If this option is not configured,
it takes the value of mode. Possible values are::
create Configures trial block containing one or more
trials for testing.
modify Modifies the trial block pattern configuration.
delete Deletes the trial block configuration.
enable_radar_emulation
Enables a port to become a radar emulator. Possible values are
false and true. If it is set to true, enables radar emulator and
configures on the specified port. The default value is false.
radar_channel_frequency_mode
Specifies the frequency mode value. The default value is
channel_mode. Possible values are::
Value Description
channel_mode RADAR_CHANNEL_MODE
frequency_mode RADAR_FREQUENCY_MODE
dfs_channel
Specifies the channel in which DFS will operate. Possible values
range from 52 to 144. The default value is 52.
dfs_frequency
Specifies the frequency in which DFS will operate. Possible values
range from 5250 to 5730. The default value is 5250.
tx_attenuation
Specifies the transmit power attenuation. Possible values
range from 0 to 89. The default value is 30.
region
Specifies the DFS code that identifies the region in which the
access point operates. The default value is fcc2016.
Possible values are::
Value Description
fcc2016 RADAR_TRIAL_REGION_FCC2016
etsi207 RADAR_TRIAL_REGION_ETSI207
ydt2905_2015 RADAR_TRIAL_REGION_YDT2905_2015
jp5250 RADAR_TRIAL_REGION_JP5250
jp5470 RADAR_TRIAL_REGION_JP5470
korea RADAR_TRIAL_REGION_KOREA
jp5250_2019 RADAR_TRIAL_REGION_JP5250_2019
dut_bss_id
Specifies the Device Under Test (DUT) MAC address to use in the test.
The default value is 00:00:00:00:00:00.
random_frequency
Specifies whether to select random frequency. Possible values are
false and true. The default value is false.
trial_block_radar_type
Specifies the type of FCC or ETSI waveform to use for each trial.
The default value is radar_type_0. Possible values are::
Value Description
radar_type_0 RADAR_TYPE_0
radar_type_1 RADAR_TYPE_1
radar_type_2 RADAR_TYPE_2
radar_type_3 RADAR_TYPE_3
radar_type_4 RADAR_TYPE_4
radar_type_5 RADAR_TYPE_5
radar_type_6 RADAR_TYPE_6
radar_type_7 RADAR_TYPE_7
radar_type_8 RADAR_TYPE_8
trial_count
Specifies the number of trials to generate. Possible values
range from 1 to 255. The default value is 30.
transmit_signal_only
Specifies whether no packet analyzing is required when transmitting
signals. Possible values are false and true. The default value
is true.
pulse_width
Specifies the value to adjust the pulse width. The default
value is 0.0.
pulse_count
Specifies the number of pulses that will be generated. The default
value is 0.
pulse_repetition_interval
Specifies the number of pulses that will be generated. The default
value is 0.
bw_test_radar_type
Specifies the type of FCC or ETSI waveform to use for each bandwidth
detection test. The default value is radar_type_0.
Possible values are::
Value Description
radar_type_0 RADAR_TYPE_0
radar_type_1 RADAR_TYPE_1
radar_type_2 RADAR_TYPE_2
radar_type_3 RADAR_TYPE_3
radar_type_4 RADAR_TYPE_4
radar_type_5 RADAR_TYPE_5
radar_type_6 RADAR_TYPE_6
radar_type_7 RADAR_TYPE_7
radar_type_8 RADAR_TYPE_8
bw_test_trial_per_iteration
Specifies the number of trials per iteration. Possible values
range from 1 to 255. The default value is 30.
bw_test_freq_shift_step_1
Specifies the first frequency shifting in Megahertz (MHz).
Possible values range from 1 to 255. The default value is 30.
bw_test_freq_shift_step_2
Specifies the second frequency shifting in Megahertz (MHz).
Possible values range from 1 to 255. The default value is 30.
prob_test_radar_type
Specifies the type of FCC or ETSI waveform to use for each probability
detection test. The default value is radar_type_0.
Possible values are::
Value Description
radar_type_0 RADAR_TYPE_0
radar_type_1 RADAR_TYPE_1
radar_type_2 RADAR_TYPE_2
radar_type_3 RADAR_TYPE_3
radar_type_4 RADAR_TYPE_4
radar_type_5 RADAR_TYPE_5
radar_type_6 RADAR_TYPE_6
radar_type_7 RADAR_TYPE_7
radar_type_8 RADAR_TYPE_8
prob_test_trial_count
Specifies the number of trials to generate for the probability
test. Possible values range from 1 to 255.
The default value is 30.
prob_test_iteration_count
Specifies the number of iterations to generate for the probability
test. Possible values range from 1 to 255.
The default value is 10.
- Return Values:
Depending on the specific language that HLTAPI uses, the function returns a keyed list/dictionary/hash (See Introduction for more information on return value formats) using the following keys (with corresponding data):
status $SUCCESS (1) or $FAILURE (0) log Error message if command returns {status 0} radar_emulation_handle The radar emulator configuration handle returned by the function radar_trial_block_handle The radar trial block configuration handle returned by the function bandwidth_detection_test_config_handle The bandwidth detection test configuration handle returned by the function probability_detection_test_config_handle The probability detection test configuration handle returned by the function- Description:
- The
radar signal generator configfunction configures the port as a DFS (Dynamic Frequency Selection) port. - Examples:
The following example configures the specified port as a DFS (Dynamic Frequency Selection) port with 3 different trial block configurations, 2 different bandwidth detection test configurations and 2 different probability detection test configurations.
- radar signal generator config
- mode= create port_handle= $port1 enable_radar_emulation= true region= fcc2016 dfs_channel= 52 radar_channel_frequency_mode= channel_mode tx_attenuation= 30 dut_bss_id= 00:00:00:00:00:03 random_frequency= false bw_test_trial_per_iteration= “2 4” bw_test_freq_shift_step_1= “1 2” bw_test_freq_shift_step_2= “2 3” prob_test_trial_count= “4 5” prob_test_iteration_count= “9 7” pulse_width= “{5 3 2} 4” pulse_count= “{16 20} 10” pulse_repetition_interval= “{1200 1000} 1420” transmit_signal_only= “false true” trial_block_radar_type= “radar_type_0 radar_type_1” trial_count= “3 4 5” ]
Sample Output:
{radar_emulation_handle radaremulationconfig1} {radar_trial_block_handle radartrialblock1 radartrialblock2 radartrialblock3} {probability_detection_test_config_handle probabilitydetectiontestconfig1 probabilitydetectiontestconfig2} {bandwidth_detection_test_config_handle bandwidthdetectiontestconfig1 bandwidthdetectiontestconfig2} {status 1}
The following example creates 2 trial block, 1 bandwidth detection test and 2 different probability detection test configurations.
- radar signal generator config
- mode= modify handle= radartrialpatternconfig1 bandwidth_detection_test_mode= create probability_detection_test_mode= create trial_block_mode= create bw_test_trial_per_iteration= “2” bw_test_freq_shift_step_1= “1” bw_test_freq_shift_step_2= “2” prob_test_trial_count= “3 5” prob_test_iteration_count= “8 6” pulse_width= “{2 3} 4” trial_count= “2 4” ]
Sample Output:
{radar_trial_block_handle radartrialblock4 radartrialblock5} {probability_detection_test_config_handle probabilitydetectiontestconfig3 probabilitydetectiontestconfig4} {bandwidth_detection_test_config_handle bandwidthdetectiontestconfig3} {status 1}
The following example modifies the created trial blocks, bandwidth detection tests and probability detection tests configuration.
- radar signal generator config
- mode= modify handle= radartrialpatternconfig1 bandwidth_detection_test_handle= radartrialblock4 probability_detection_test_handle= probabilitydetectiontestconfig4 trial_block_handle= bandwidthdetectiontestconfig3 bw_test_trial_per_iteration= “2” bw_test_freq_shift_step_1= “1” bw_test_freq_shift_step_2= “2” prob_test_trial_count= “3” prob_test_iteration_count= “8” pulse_count= “4” ]
Sample Output:
{status 1}
End of Procedure Header
emulation radar generator control¶
Execute Tester Command ${rt_handle} command=test_control <additional key=value arguments>
Purpose:
Starts or Stops the transmission of radar signals on selected trials, the selected bandwidth detection test and the selected probability detection test.
Synopsis:
Note: M indicates the argument is `Mandatory`.
emulation radar generator control
handle= <radar emulation handle | trial blocks |
bandwidth detection test handles |probability detection
test handles> M]
action= {start | cancel}
Arguments:
handle
Specifies the handles on which to start or
stop the transmission of radar signals on selected trials,
the selected bandwidth detection test and the selected probability
detection test.
action
Specifies the action to be performed. This argument is `Mandatory`.
Possible values are::
start Starts the specified trial blocks, bandwidth
detection tests, probability tests
cancel Stops the specified trial blocks, bandwidth
detection tests, probability tests
- Return Values:
Depending on the specific language that HLTAPI uses, the function returns a keyed list/dictionary/hash (See Introduction for more information on return value formats) using the following keys (with corresponding data):
status $SUCCESS (1) or $FAILURE (0) log Error message if command returns {status 0}- Description:
- The
emulation radar generator controlfunction starts or stops the transmission of radar signals on selected trials, the selected bandwidth detection test and the selected probability detection test. - Examples:
The following example starts the transmission of specified trial blocks, specified bandwidth detection tests and probability detection tests:
emulation radar generator control handle= "radartrialblock1 radartrialblock2 probabilitydetectiontestconfig2 bandwidthdetectiontestconfig1" action= start ]
Sample Output:
{status 1}
The following example stops the transmission of specified trial blocks, specified bandwidth detection tests and probability detection tests:
emulation radar generator control handle= "radartrialblock1 radartrialblock2 probabilitydetectiontestconfig2 bandwidthdetectiontestconfig1" action= cancel
Sample Output:
{status 1}
The following example starts the transmission of all trial blocks, all bandwidth detection tests and all detection tests configured on the specified radar emulator.
- emulation radar generator control
- handle= “radaremulationconfig1” action= start ]
Sample Output:
{status 1}
End of Procedure Header
noise generator config¶
Execute Tester Command ${rt_handle} command=test_control <additional key=value arguments>
Purpose:
Configures noise generator on the specified port.
Synopsis:
Note: M indicates the argument is `Mandatory`.
noise generator config
mode= {create | modify} M
port_handle= <ANY> M
handle= <ANY>
enable_noise_generator= {true | false}
channel= <1-165>
operational_mode= {auto | 802.11_a | 802.11_b |
802.11_g | 802.11_n | 802.11_ac |
802.11_ax ]
duration= <NUMERIC>
traffic_load= <ANY>
fixed_frame_length= <12-16383>
guard_interval= {short | long | extra_long}
src_mac_addr= <aa:bb:cc:dd:ee:ff>
dst_mac_addr= <aa:bb:cc:dd:ee:ff>
bssid= <aa:bb:cc:dd:ee:ff>
Arguments:
mode
Specifies the action to perform. This argument is `Mandatory`.
Possible values are::
create Configures the noise generator on the specified
port
modify Modifies the noise generator configurations specified
by handle
port_handle
Specifies the port handle on which to configure noise generator
Selection) port configured. It is required for mode create.
handle
Specifies the handle to modify the noise generator configurations.
enable_noise_generator
Enables noise generator on the specified port. Possible values are
false and true. The default value is false.
channel
Specifies the channel value of noise generator. Possible values
range from 1 to 165. The default value is 36.
operational_mode
Specifies the operational mode of noise generator. The default value
is 802.11_ax. Possible values are::
Value Description
auto PROTOCOL_RATE_AUTO
802.11_a PROTOCOL_RATE_A (802.11(a))
802.11_b PROTOCOL_RATE_B (802.11(b))
802.11_g PROTOCOL_RATE_G (802.11(g))
802.11_n PROTOCOL_RATE_N (802.11(n))
802.11_ac PROTOCOL_RATE_AC (802.11(ac))
802.11_ax PROTOCOL_RATE_AX (802.11(ax))
guard_interval
Specifies the guard interval of noise generator. The default value
is short. Possible values are::
Value Description
short GI_MODE_LONG
long GI_MODE_SHORT
extra_long GI_MODE_DLONG
src_mac_addr
Specifies the source MAC address value of noise generator.
The default value is 00:00:10:00:00:00.
dst_mac_addr
Specifies the destination MAC address value of noise generator.
The default value is 00:00:10:00:00:01.
bssid
Specifies the BSS ID value of noise generator.
The default value is 00:00:10:00:00:01.
duration
Specifies the traffic duration value of noise generator. The default
value is 60.
traffic_load
Specifies the traffic load percentage value of noise generator.
The default value is 10.
fixed_frame_length
Specifies the fixed frame length value of noise generator. Possible
values range from 12 to 16383. The default value is 128.
- Return Values:
Depending on the specific language that HLTAPI uses, the function returns a keyed list/dictionary/hash (See Introduction for more information on return value formats) using the following keys (with corresponding data):
status $SUCCESS (1) or $FAILURE (0) log Error message if command returns {status 0}- Description:
- The
noise generator configfunction configures noise generator on the specified port. - Examples:
The following example configures the noise generator on a specified port:
noise generator config mode= create port_handle= $port2 enable_noise_generator= true bssid= 00:33:44:55:66:01 channel= 1 operational_mode= 802.11_ax guard_interval= short src_mac_addr= 00:00:10:00:00:10 dst_mac_addr= 00:00:10:00:00:02 duration= 60 traffic_load= 10 fixed_frame_length= "128" ]Sample Output:
{noise_generator_handle noisegenerator1} {status 1}
The following example modifies the noise generator configuration of a specified port:
noise generator config mode= modify handle= noisegenerator1 src_mac_addr= 00:22:12:22:02:02 bssid= 00:0a:0b:66:66:01 ]
Sample Output:
{status 1}
End of Procedure Header
emulation noise generator control¶
Execute Tester Command ${rt_handle} command=test_control <additional key=value arguments>
Purpose:
Starts or stops the noise generator.
Synopsis:
Note: M indicates the argument is `Mandatory`.
emulation noise generator control
handle= <noise generator handle> M
action= {start | cancel}
Arguments:
handle
Specifies the handle on which to start or
stop noise generator.
action
Specifies the action to be performed. This argument is `Mandatory`.
Possible values are::
start Starts the noise generator
cancel Stops the noise generator
- Return Values:
Depending on the specific language that HLTAPI uses, the function returns a keyed list/dictionary/hash (See Introduction for more information on return value formats) using the following keys (with corresponding data):
status $SUCCESS (1) or $FAILURE (0) log Error message if command returns {status 0}- Description:
- The
emulation noise generator controlfunction starts or stops the noise generator. - Examples:
The following example starts the specified noise generator:
emulation noise generator control handle= "noisegenerator1" action= start
Sample Output:
{status 1}
The following example starts the noise generator on the specified port:
emulation noise generator control handle= "port1" action= start
Sample Output:
{status 1}
The following example stops the specified noise generator:
emulation noise generator control handle= "noisegenerator1" action= cancel
Sample Output:
{status 1}
End of Procedure Header