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

Update an existing gateway cluster profile configuration

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

List of Gateway Cluster Profiles.

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

Gateway Cluster Profile name. Manual cluster profile name should not start with auto_ prefix and it should not contain space.

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 true

With this knob enabled, gateways will be added to the auto-cluster/removed from the auto-cluster automatically by the System. This knob should be set to false while creating the manual cluster profiles.

coa-vrrp
object

CoA-VRRP configuration

string
length between 1 and 256

User comment.

int32
500 to 65535

Gateway will wait for heartbeat threshold time (ms) before declaring a peer cluster node as dead.

ipv4-gateways
array of objects
length ≤ 2147483647

Upto 12 gateways can be configured in a profile. Based on the combination of Gateway platforms, system will restrict Gateway addition to the profile.
Ex: Presence of 70xx model gateway in the profile will reduce the Gateway count to 4.

ipv4-gateways
boolean
Defaults to false

Enable or disable the ipv6 mode in cluster profiles. ipv6-enable knob can not be toggled once the cluster profile is created.

ipv6-gateways
array of objects
length ≤ 2147483647

Upto 12 gateways can be configured in a profile. Based on the combination of Gateway platforms, system will restrict Gateway addition to the profile.
Ex: Presence of 70xx model gateway in the profile will reduce the Gateway count to 4.

ipv6-gateways
int32
1 to 4094

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

string
length between 1 and 31

Gateway Cluster Profile name. Manual cluster profile name should not start with auto_ prefix and it should not contain space.

boolean
Defaults to false

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

boolean
Defaults to false

Enable/disable uplink tracking for the cluster profile.
With this knob enabled, Cluster leader will be selected based on number of active uplinks.
Applicable only when one-to-one-redundancy knob is enabled.

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