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

Update profile by name

patch
https://de1.api.central.arubanetworks.com/network-config/v1alpha1/mesh/

Mesh profile.

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

Mesh 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

string
enum
Defaults to BAND_TYPE_5GHZ

Configures the radio band used for mesh link. When configured, the mesh link is established in the defined radio band.

Show Details
BAND_TYPE_24GHZConfigures mesh links to operate in the 2.4 GHz radio band.
BAND_TYPE_5GHZConfigures mesh links to operate in the 5 GHz radio band.
BAND_TYPE_6GHZConfigures mesh links to operate in the 6 GHz radio band.
BAND_TYPE_ALLConfigures mesh links to operate in either the 6 GHz radio band or 5 GHz radio band.
Allowed:
cluster
array of objects
length ≤ 2147483647

List of Mesh clusters.

cluster
string
length between 1 and 256

Mesh profile description.

boolean
Defaults to true

Enable extremely-high-throughput (802.11be) features on Mesh

boolean
Defaults to true

Allow Mesh on AP.

string
length ≤ 9999

The API is only supported on AOS8 with the per-AP setting. It works together with the per-AP mesh cluster. For scenarios, refer to the mesh cluster description.

string
length between 8 and 32

The API is only supported on AOS8 with the per-AP setting. It works in conjunction with the per-AP mesh-cluster-key and supports the following scenarios:
1.Set up mesh network among standalone APs
2.Set up Point-to-Point mesh network between two APs, no matter standalone or swarm mode
3.Set up 16 avaliable mesh clusters (with mesh-cluster list) and as the top priority cluster
For regular scenarios, it is still recommended to use the mesh-cluster list.

int32
1 to 255
Defaults to 10

Heartbeat threshold for mesh neighbor APs. The AP will drop connection with the neighboring AP when the missed heartbeat count exceeds the defined threshold.
Range: 1-255 Default: 10

int32
1 to 32
Defaults to 2

Maximum number of hop counts allowed between the AP and the mesh portal. The parent mesh AP will be dynamically selected on the number of number of hop counts allowed.
Range: 1-32 Default: 2

int32
10 to 90
Defaults to 12

Threshold RSSI value below which mesh links incur a metric penalty. Range: 10-90 Default: 12

int32
1 to 64
Defaults to 8

Maximum number of mesh children APs that can be connected to the AP.Range: 1-64 Default: 8

int32
1 to 15
Defaults to 4

Maximum number of scans the Instant AP performs on a particular channel to identify neighboring mesh APs before moving on to the next channel.
Range: 1-15 Default: 4

string
enum
Defaults to DISTRIBUTED_TREE_RSSI

Metric algorithm used for path selection to the mesh portal AP. Range: distributed-tree-rssi, best-link-rssi Default: distributed-tree-rssi

Show Details
BEST_LINK_RSSICombine link-RSSI with a node cost based on hop-count alone.
DISTRIBUTED_TREE_RSSICombine link-RSSI with a node cost based on number of children.
Allowed:
10 to 50

Configures enabled fast roaming on a mesh point

int32
10 to 25
Defaults to 16

Number of consecutive missed Beacon frames after which mesh roaming it triggered on the AP. Applies to mesh points with mobility enabled.
Range: 10-25 Default: 16

string
length between 1 and 256

Mesh profile name.

int32
1 to 100
Defaults to 24

Time interval between scans to identify better mesh neighbor APs for topology optimization. The value is defined in hours. Range: 1-100 hours Default: 24

string
enum
Defaults to NONE

The preferred 5 GHz radio for mesh links. Mesh link neighbors identified in this radio band will be prioritized over other neighbors identified in the other radio band. This parameter will only take effect when dual 5 GHz or split 5 GHz radio is enabled on the AP and mesh-split5g-radio-band is set to full. Range: none, 5g-lower, 5g-upper Default: none

Show Details
NONEDefault value
UPLINK_5G_LOWER5GHz Lower band
UPLINK_5G_UPPER5GHz Upper band
Allowed:
int64
0 to 4094
Defaults to 0

Mesh private VLAN ID for control traffic between a remote mesh portal and mesh node. Range: 0-4094 Default: 0

string
length between 8 and 64

A function to allow mesh point connection using a backup general configs when configured profile can not establish mesh link

string
enum
Defaults to STARTUP_SUBTHRESHOLD

Reselection mode of operation. Range: never, subthreshold, startup-subthreshold, anytime Default: startup-subthreshold

Show Details
ANYTIMEAnytime
NEVER Never
STARTUP_SUBTHRESHOLDStartup_subthreshold
SUBTHRESHOLDSubthreshold
Allowed:
string
enum

Mesh role

Show Details
AUTOMesh Auto
POINTMesh Point
PORTALMesh Portal
Allowed:
string
enum

Configures the 5 GHz radio used for the mesh link. Use this command to configure the 5 GHz radio that should be used as the mesh link. This setting only takes effect when split 5 GHz or dual 5 GHz radio is enabled on the AP.

Show Details
FIRSTConfigures radio 0 as the mesh link.
FULLConfigures both the sub bands of the 5 GHz radio as the mesh link. The radio assignment however depends on factors such as hop count to the mesh portal, availability of neighboring mesh APs, and preferred uplink radio setting of the mesh profile. This is the default setting.
LOWERConfigures the lower 5 GHz radio as the mesh link.
UPPERConfigures the upper 5 GHz radio as the mesh link
Allowed:
string
enum
Defaults to LOCAL

Mesh topology algorithm

Show Details
CENTRALMesh central topology algorithm
LOCALMesh local topology algorithm
Allowed:
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