API ReferenceNew CentralGuidesMRT APIConfiguration API
GithubAirheads Developer Community
API Reference
GithubAirheads Developer Community

Create Beacon Report Request profile.

post
https://de1.api.central.arubanetworks.com/network-config/v1alpha1/bcn-rpt-req-profiles/

Configures list of Beacon Report Request Profile to provide the parameters for the Beacon Report Request frames.
The Beacon Report Request profile is attached to 802.11K profile.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
length ≤ 9999

Beacon report request profile name

Query Params
string

LOCAL - To create local objects. SHARED - To create shared objects. Default - Defaults to SHARED if not provided

string

Scope at which local object needs to be created. Mandatory if object-type = LOCAL. Should not be provided for object-type = SHARED.

string

Device function for which the local object needs to be created. Mandatory if object_type = LOCAL. Should not be provided for object_type = SHARED.

Body Params

profilebody object

string
length ≤ 9999

BSSID included in the beacon request. Default: wildcard

enum

This option is used to set the Channel field in the Beacon Report Request frame. The Channel value can be set to one of the following:
The channel of the AP (when Measurement Mode is set to either 'Passive' or 'Active-All channels') 0 (when Measurement Mode is set to 'Beacon Table')
255 (when Measurement Mode is set to 'Active-Channel Report')

boolean
Defaults to true

Enable including SSID IE in Beacon Report Request

boolean
Defaults to false

Enable Last Beacon Request Indication sub-element in Beacon Report Request.

int64
0 to 65535
Defaults to 0

Measurement Duration field in the Beacon Report Request frame.
The Measurement Duration is set to the duration of the requested measurement. It is expressed in units of TUs.

string
enum
Defaults to BEACON_TABLE

Measurement Mode for Beacon Reports. The mode should be one of active-all-ch|active-ch-rpt|beacon-table|passive. Default: beacon-table

Show Details
ACTIVE_ALL_CHactive-all-ch
ACTIVE_CH_RPTactive-ch-rpt
BEACON_TABLEbeacon-table
PASSIVEpassive
Allowed:
string
length between 1 and 63

Beacon report request profile name

int64
0 to 65535
Defaults to 0

Randomization Interval field in the Beacon Report Request frame.
The Randomization Interval is used to specify the desired maximum random delay in the measurement start time.
It is expressed in units of TUs (Time Units). A Randomization Interval of 0 in a measurement request indicates that
no random delay is to be used.

string
enum
Defaults to AUTO

Regulatory Class for Beacon Report Request. Value: auto, 1, 12, 81, 115, or 131. Default auto to use value based on country code

Show Details
AUTOAuto uses value based on country code.
CLASS_1value 1
CLASS_115value 115
CLASS_12value 12
CLASS_131value 131
CLASS_81value 81
Allowed:
boolean
Defaults to false

Value for the Detail field in the Reporting Detail sub-element present in the Beacon Report Request frame.

string
length ≤ 9999

Contents of the Request Information IE that could be present in the Beacon Report Request frame.
The Request Information IE is present for all Measurement Modes except the Beacon Table mode. It consists of a list of Element IDs that
should be included by the client in the response frame.
Any valid element ID in the x/y/z format. For example, 0/21/22.

string
length between 1 and 32

SSID (network name).

Responses

Updated 11 days ago

Language
Credentials
OAuth2
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 11 days ago