NSRedundantGatewayGroup

Represents Redundant Group formed by two VNS Gateways.

Overview

consecutiveFailuresCount integer
description string filterable   orderable  
enterpriseID string read only  
entityScope enum (ENTERPRISE | GLOBAL) autogenerated  
externalID string filterable   orderable   locally unique  
gatewayPeer1AutodiscoveredGatewayID string
gatewayPeer1Connected boolean read only  
gatewayPeer1ID string required  
gatewayPeer1Name string
gatewayPeer2AutodiscoveredGatewayID string
gatewayPeer2Connected boolean read only  
gatewayPeer2ID string deprecated   filterable   orderable  
gatewayPeer2Name string
heartbeatInterval integer
heartbeatVLANID integer
lastUpdatedBy string autogenerated  
name string required   filterable   orderable  
permittedAction enum (ALL | DEPLOY | EXTEND | INSTANTIATE | READ | USE)
personality enum (DC7X50 | HARDWARE_VTEP | NSG | NSGBR | NSGDUC | NUAGE_210_WBX_32_Q | NUAGE_210_WBX_48_S | OTHER | VRSB | VRSG | VSA | VSG) filterable   orderable  
redundancyPortIDs list
redundantGatewayStatus enum (FAILED | SUCCESS) read only  

API Resource

/nsgredundancygroups/id
delete get put

Parents

/enterprises/id/nsgredundancygroups
get post
/nsgredundancygroups
get post

Children

/nsgredundancygroups/id/permissions
get post
/nsgredundancygroups/id/metadatas
get post
/nsgredundancygroups/id/shuntlinks
get post put
/nsgredundancygroups/id/alarms
get
/nsgredundancygroups/id/globalmetadatas
get post put
/nsgredundancygroups/id/enterprisepermissions
get post
/nsgredundancygroups/id/nsgateways
get put
/nsgredundancygroups/id/nsredundantports
get post put
/nsgredundancygroups/id/eventlogs
get

Members

This object has no members.

Attributes documentation

consecutiveFailuresCount integer
Discussion

Consecutive failure count. Supported value is 3.

Charateristics

Default value: 3
Min value: 3
Max value: 3
SDK attribute: consecutiveFailuresCount

description string filterable   orderable  
Discussion

Description of the Redundancy Group

Charateristics

Format: free
Max length: 255
SDK attribute: description

enterpriseID string read only  
Discussion

The enterprise associated with this Redundant Group. This is a read only attribute

Charateristics

Format: free
SDK attribute: enterpriseID

entityScope enum autogenerated  
Discussion

Specify if scope of entity is Data center or Enterprise level

Charateristics

Allowed values: ENTERPRISE, GLOBAL
SDK attribute: entityScope

externalID string filterable   orderable   locally unique  
Discussion

External object ID. Used for integration with third party systems

Charateristics

Format: free
SDK attribute: externalID

gatewayPeer1AutodiscoveredGatewayID string
Discussion

The Auto Discovered Gateway configuration owner in this Redundant Group.

Charateristics

Format: free
SDK attribute: gatewayPeer1AutodiscoveredGatewayID

gatewayPeer1Connected boolean read only  
Discussion

Indicates status of the authoritative gateway of this Redundancy Group.

Charateristics

Default value: false
SDK attribute: gatewayPeer1Connected

gatewayPeer1ID string required  
Discussion

The gateway configuration owner in this Redundant Group. when Redundant Group is deleted this gateway will recieve vport associations

Charateristics

Format: free
SDK attribute: gatewayPeer1ID

gatewayPeer1Name string
Discussion

The name of the authoritative gateway owning the configuration for the Redundant Group

Charateristics

Format: free
SDK attribute: gatewayPeer1Name

gatewayPeer2AutodiscoveredGatewayID string
Discussion

The Auto Discovered Gateway configuration for the secondary gateway in this Redundant Group.

Charateristics

Format: free
SDK attribute: gatewayPeer2AutodiscoveredGatewayID

gatewayPeer2Connected boolean read only  
Discussion

Indicates status of the secondary gateway of this Redundancy Group.

Charateristics

Default value: false
SDK attribute: gatewayPeer2Connected

gatewayPeer2ID string deprecated   filterable   orderable  
Discussion

The gateway peer in this Redundant Group. when Redundant Group is deleted this gateway will not recieve vport associations

Charateristics

Format: free
SDK attribute: gatewayPeer2ID

gatewayPeer2Name string
Discussion

The secondary gateway peer name in this Redundant Group.

Charateristics

Format: free
SDK attribute: gatewayPeer2Name

heartbeatInterval integer
Discussion

Heartbeat interval in milliseconds to declare the neighbor as dead.

Charateristics

Default value: 500
Min value: 500
Max value: 2000
SDK attribute: heartbeatInterval

heartbeatVLANID integer
Discussion

Heartbeat VLAN used for BFD.

Charateristics

Default value: 4094
Max value: 4095
SDK attribute: heartbeatVLANID

lastUpdatedBy string autogenerated  
Discussion

ID of the user who last updated the object.

Charateristics

Format: free
SDK attribute: lastUpdatedBy

name string required   filterable   orderable  
Discussion

Name of the Redundancy Group

Charateristics

Format: free
Min length: 1
Max length: 255
SDK attribute: name

permittedAction enum
Discussion

The permitted action to USE/EXTEND this Gateway.

Charateristics

Allowed values: ALL, DEPLOY, EXTEND, INSTANTIATE, READ, USE
SDK attribute: permittedAction

personality enum filterable   orderable  
Discussion

Derived personality of the Redundancy Group.

Charateristics

Allowed values: DC7X50, HARDWARE_VTEP, NSG, NSGBR, NSGDUC, NUAGE_210_WBX_32_Q, NUAGE_210_WBX_48_S, OTHER, VRSB, VRSG, VSA, VSG
SDK attribute: personality

redundancyPortIDs list
Discussion

Collections resilient port IDs associated with this redundant group.

Charateristics

SDK attribute: redundancyPortIDs

redundantGatewayStatus enum read only  
Discussion

The status of the Redundant Group.

Charateristics

Allowed values: FAILED, SUCCESS
SDK attribute: redundantGatewayStatus