API ReferenceNew CentralGuidesMRT APIConfiguration API
GithubAirheads Developer Community
API Reference

Update profile by name

List of radio profiles.

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

Radio profile name.

Query Params
string

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

string

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

string

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

Body Params

profilebody object

boolean
Defaults to false

Additional rf connectors or loss.

string
enum
Defaults to ANT_OMNI

Configures AP antenna direction mode to Omni/Directional. This will take effect immediately after configuration. No need to reload AP.
Only partial AP support to change the antenna direction mode. Antenna used omni mode is by default.

Show Details
ANT_DIRECTIONALUse directional for antenna direction mode
ANT_OMNIUse omni for antenna direction mode
Allowed:
string
length ≤ 9999

Antenna Type.

device
array of objects
length ≤ 2147483647

Configures static channel, static power, antenna gain/polarization for 2.4GHz/5GHz/6GHz.

device
string
enum
Defaults to WIDE

5GHz/6GHz antennas support that dynamically select between two antenna mode, wide(90deg x 30deg) and narrow(30deg x 30deg).

Show Details
NARROWUse narrow mode for antenna
WIDEUse wide mode for antenna
Allowed:
boolean
Defaults to false

Enable external antennas.

string
Defaults to 0

Configures an antenna gain value for APs with external antennas. Range: -63.9 to 63.9.

radio-modes
array of objects
length ≤ 2147483647

For AP models with customizable radio band type, configures band type (None, auto, 24GHz, 5GHz, 5GHz_8x8, 5GHz_4x4, 6GHz) for each radio.

radio-modes
string
enum
Defaults to AUTO

Select either the legacy recovery mode or the auto mode (fast recovery).

Show Details
AUTOauto mode of fast-recovery
LEGACYlegacy mode of fast-recovery
Allowed:
string
length between 1 and 32

Configures the RF zone and maps the RF zone to a radio profile.

boolean
Defaults to true

Control AP to enable/disable SAM (Smart Antenna Module) feature. This feature is enabled by default.
This requires reboot AP when switch enable/disable SAM. For SAM it provides the below main feature:
Auto RF cable loss detection, especially for the RF cables that installed between AP RPSMA(N) and N-type connector for outdoor APs,
We allowed customers to equip different types or lengths RF cables for different user scenarios,
and Aruba AP equipment installers can leverage this feature, (no need to do the RF cables cable lose value by themselves,
then provide one static cable lose value and the antenna gain value to provision AP, this is a fairly crude measurement process).

string
length between 1 and 256

Radio profile description.

string
enum
Defaults to AUTOMATIC

Specify the type of installation (indoor or outdoor).
The default parameter automatically selects an installation mode based upon the AP model type.

Show Details
AUTOMATICProvsion AP to default
INDOORProvsion AP to indoor AP
OUTDOORProvsion AP to outdoor AP
Allowed:
string
length between 1 and 256

Radio profile name.

radio
array of objects
length ≤ 2147483647

The list of profiles in which AP configure its 2.4GHz/5GHz/Secondary 5GHz/6GHz radio settings.
Each radio profile includes:
Extremely High Throughput (EHT) related settings,
Adaptive Radio Management (ARM) related settings,
Very High Throughput (VHT) related settings (5GHz only),
High Efficiency (HE) related settings (6GHz only),
radio enable/disable, radio mode, dot11h, etc.

radio
string
enum
Defaults to UTB_6GHZ

This is used to control the band on which UTB limitation is applied in the regulatory-domain-profile.
The utb filter supports channel band on both 5GHz and 6GHz. The default value is 6GHz.

Show Details
UTB_5GHZ5GHz upper band
UTB_6GHZ6GHz lower band
Allowed:
Responses

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