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

Update an existing Gateway Cluster Intent profile configuration

patch
https://de1.api.central.arubanetworks.com/network-config/v1alpha1/gw-cluster-intent-config/

List of GW Cluster Intent Profiles.

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

GW Cluster intent 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 CM_MANUAL

Cluster-Mode decides how the cluster profiles are formed automatically. Setting cluster-mode type to CM_MANUAL will disable the auto-formation of the cluster profiles.

Show Details
CM_MANUALAuto-clustering is disabled.
CM_SITEAuto-clustering is formed at Site level.
Allowed:
boolean
Defaults to false

Enable or disable the CoA.

coa-vrrp
object

CoA-VRRP configuration

boolean
Defaults to false

Enable/disable one-to-one-redundancy mode for auto cluster profiles.
With this knob enabled, only 2 gateways are allowed in the cluster profile.
Leader is active and non-leader is standby. Required for BRANCH_GW.

string
length between 1 and 256

User comment.

string
enum
Defaults to MOBILITY_GW

Persona of the GW cluster profile. Device-type of the GW cluster profile
should be one of the BRANCH_GW, MOBILITY_GW, VPNC.

Show Details
ACCESS_SWITCHAccess Switch. This persona provides Access Switch functionality.
AGG_SWITCHAggregation Switch. This persona provides Aggregation Switch functionality.
ALLALL. This persona provides ALL devices functionality.
AOSS_ACCESS_SWITCHAOS-S Access Switch. This persona provides Access Switch functionality.
AOSS_AGG_SWITCHAOS-S Aggregation Switch. This persona provides Aggregation Switch functionality.
AOSS_CORE_SWITCHAOS-S Core Switch. This persona provides Core Switch functionality.
BRANCH_GWBranch gateway. This gateway persona provides Aruba InstantOS and SD-Branch (LAN + WAN) functionality
BRIDGEBridge . This persona provides bridge functionality.
CAMPUS_APCampus/Branch AP. This AP persona provides WLAN functionality.
CORE_SWITCHCore Switch. This persona provides Core Switch functionality.
EC_BRANCH_GWEdgeConnect Branch Gateway
EC_VPNCEdgeConnect VPNC
HYBRID_NACHybrid NAC Edge VM. This persona provides Hybrid NAC Edge VM functionality.
IOTIoT Edge VM. This persona provides IoT Edge VM functionality.
MICROBRANCH_APMicrobranch AP. This AP persona provides SD-WAN-lite functionality in addition to the functions of WLAN AP.
MOBILITY_GWMobility Gateway. This gateway persona provides Overlay WLAN and (or) wired LAN functionalities.
SERVICE_PERSONAService Persona. This persona provides service functionality.
VPNCVPN Concentrator.
int32
500 to 65535

Minimum Heartbeat Threshold in milliseconds.

boolean
Defaults to false

Enable or disable the ipv6 mode in auto cluster profiles

int32
1 to 4094

VLAN to be used for forwarding multicast traffic to upstream router.

string
length between 1 and 63

GW Cluster intent Profile name.

boolean
Defaults to false

Enable/disable uplink sharing for auto cluster profiles.
Applicable only for BRANCH_GW device-type with default-gateway-mode enabled.

boolean
Defaults to false

Enable/disable uplink tracking for auto cluster profiles.
With this knob enabled, Cluster leader will be selected based on number of active uplinks.
Applicable only for BRANCH_GW device-type with default-gateway-mode enabled.

Responses

Updated 6 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 6 days ago