AllRedundancyGroup

A read only API to get all redundancy gateway objects in the VSD environment. Use the ID field to then actually manage the redundancy gateway using the redundancy gateway API entity.

Overview

description string read only   filterable   orderable  
embeddedMetadata list read only   autogenerated  
enterpriseID string read only  
entityScope enum (ENTERPRISE | GLOBAL) autogenerated  
externalID string filterable   orderable   locally unique  
gatewayPeer1AutodiscoveredGatewayID string read only  
gatewayPeer1Connected boolean read only  
gatewayPeer1ID string read only  
gatewayPeer1Name string read only  
gatewayPeer2AutodiscoveredGatewayID string read only  
gatewayPeer2Connected boolean read only  
gatewayPeer2Name string read only  
lastUpdatedBy string autogenerated  
name string read only   filterable   orderable  
permittedAction enum (ALL | DEPLOY | EXTEND | INSTANTIATE | READ | USE) read only  
personality enum (DC7X50 | EVDF | EVDFB | HARDWARE_VTEP | NETCONF_7X50 | NETCONF_THIRDPARTY_HW_VTEP | NSG | NSGBR | NSGDUC | NUAGE_210_WBX_32_Q | NUAGE_210_WBX_48_S | OTHER | VDFG | VRSB | VRSG | VSA | VSG) read only   filterable   orderable  
redundantGatewayStatus enum (FAILED | SUCCESS) read only  
vtep string read only   filterable   orderable  

API Resource

/allredundancygroups/id

Parents

/allredundancygroups
get post

Children

/allredundancygroups/id/permissions
delete get post put
/allredundancygroups/id/metadatas
get post
/allredundancygroups/id/globalmetadatas
get post put

Members

This object has no members.

Attributes documentation

description string read only   filterable   orderable  
Discussion

Description of the Redundancy Group

Charateristics

Format: free
Max length: 255
SDK attribute: description

embeddedMetadata list read only   autogenerated  
Discussion

Metadata objects associated with this entity. This will contain a list of Metadata objects if the API request is made using the special flag to enable the embedded Metadata feature. Only a maximum of Metadata objects is returned based on the value set in the system configuration.

Charateristics

SDK attribute: embeddedMetadata

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 read only  
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

SDK attribute: gatewayPeer1Connected

gatewayPeer1ID string read only  
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 read only  
Discussion

The gateway configuration owner name in this Redundant Group

Charateristics

Format: free
SDK attribute: gatewayPeer1Name

gatewayPeer2AutodiscoveredGatewayID string read only  
Discussion

The Auto Discovered Gateway peer 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

SDK attribute: gatewayPeer2Connected

gatewayPeer2Name string read only  
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 read only   filterable   orderable  
Discussion

Name of the Redundancy Group

Charateristics

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

permittedAction enum read only  
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
SDK attribute: permittedAction

personality enum read only   filterable   orderable  
Discussion

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

Charateristics

Allowed values: DC7X50, EVDF, EVDFB, HARDWARE_VTEP, NETCONF_7X50, NETCONF_THIRDPARTY_HW_VTEP, NSG, NSGBR, NSGDUC, NUAGE_210_WBX_32_Q, NUAGE_210_WBX_48_S, OTHER, VDFG, VRSB, VRSG, VSA, VSG
SDK attribute: personality

redundantGatewayStatus enum read only  
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 read only   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