RedundancyGroup

Represents Redundant Group formed by two Gateways.

Overview

description string filterable   orderable  
enterpriseID string
entityScope enum (ENTERPRISE | GLOBAL) autogenerated  
externalID string filterable   orderable   locally unique  
gatewayPeer1AutodiscoveredGatewayID string
gatewayPeer1ID string
gatewayPeer1Name string
gatewayPeer2AutodiscoveredGatewayID string
gatewayPeer2ID string
gatewayPeer2Name string
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  
redundantGatewayStatus enum (FAILED | SUCCESS)
vtep string filterable   orderable  

API Resource

/redundancygroups/id
delete get put

Parents

/enterprises/id/redundancygroups
get post
/redundancygroups
get post

Children

/redundancygroups/id/gateways
get put
/redundancygroups/id/permissions
get post
/redundancygroups/id/services
get post
/redundancygroups/id/metadatas
get post
/redundancygroups/id/alarms
get
/redundancygroups/id/globalmetadatas
get post put
/redundancygroups/id/enterprisepermissions
get post
/redundancygroups/id/ports
get post
/redundancygroups/id/vsgredundantports
get post put
/redundancygroups/id/eventlogs
get

Members

This object has no members.

Attributes documentation

description string filterable   orderable  
Discussion

Description of the Redundancy Group


Charateristics

Format: free
Max length: 255
SDK attribute: description

enterpriseID string
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

gatewayPeer1ID string
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 gateway configuration owner name in this Redundant Group


Charateristics

Format: free
SDK attribute: gatewayPeer1Name

gatewayPeer2AutodiscoveredGatewayID string
Discussion

The Auto Discovered Gateway peer in this Redundant Group


Charateristics

Format: free
SDK attribute: gatewayPeer2AutodiscoveredGatewayID

gatewayPeer2ID string
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 gateway peer name in this Redundant Group


Charateristics

Format: free
SDK attribute: gatewayPeer2Name

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 Possible values are USE, READ, ALL, INSTANTIATE, EXTEND, DEPLOY, .


Charateristics

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

personality enum filterable   orderable  
Discussion

derived personality of the Redundancy Group - VSG,VRSG,NSG,OTHER Possible values are VSG, VSA, VRSG, DC7X50, NSG, HARDWARE_VTEP, OTHER, .


Charateristics

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

redundantGatewayStatus enum
Discussion

The status of Redundant Group, possible values are FAILED, SUCCESS Possible values are FAILED, SUCCESS, .


Charateristics

Allowed values: FAILED, SUCCESS
SDK attribute: redundantGatewayStatus

vtep string filterable   orderable  
Discussion

Represent the system ID or the Virtual IP of a service used by a Gateway (VSG for now) to establish a tunnel with a remote VSG or hypervisor. The format of this field is consistent with an IP address.


Charateristics

Format: free
Max length: 255
SDK attribute: vtep