RedundancyGroup

Represents Redundant Group formed by two Gateways.

Overview

description string filterable   orderable  
embeddedMetadata list read only   autogenerated  
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 required  
gatewayPeer2Name string
lastUpdatedBy string autogenerated  
name string required   filterable   orderable  
permittedAction enum (ALL | DEPLOY | EXTEND | INSTANTIATE | READ | USE)
personality enum (DC7X50 | HARDWARE_VTEP | NETCONF_7X50 | NETCONF_THIRDPARTY_HW_VTEP | NUAGE_210_WBX_32_Q | NUAGE_210_WBX_48_S | OTHER | VDFG | 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
/l2domains/id/redundancygroups
get

Children

/redundancygroups/id/l2domains
get
/redundancygroups/id/macfilterprofiles
get
/redundancygroups/id/sapegressqosprofiles
get
/redundancygroups/id/sapingressqosprofiles
get
/redundancygroups/id/gateways
get put
/redundancygroups/id/gatewayredundantports
get post
/redundancygroups/id/deploymentfailures
get
/redundancygroups/id/permissions
get post
/redundancygroups/id/services
get post
/redundancygroups/id/metadatas
get post
/redundancygroups/id/egressprofiles
get post
/redundancygroups/id/alarms
get
/redundancygroups/id/globalmetadatas
get post put
/redundancygroups/id/ingressprofiles
get post
/redundancygroups/id/enterprisepermissions
get post
/redundancygroups/id/jobs
get post
/redundancygroups/id/ports
get post
/redundancygroups/id/ipfilterprofiles
get
/redundancygroups/id/ipv6filterprofiles
get
/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

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
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 receive vPort associated to the group.

Charateristics

Format: free
SDK attribute: gatewayPeer1ID

gatewayPeer1Name string
Discussion

The name of the authoritative gateway of the 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

gatewayPeer2Connected boolean read only  
Discussion

Indicates status of the secondary gateway of this Redundancy Group.

Charateristics

Default value: false
SDK attribute: gatewayPeer2Connected

gatewayPeer2ID string required  
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, VDFG, DC7X50, NSG, HARDWARE_VTEP, OTHER, .

Charateristics

Allowed values: DC7X50, HARDWARE_VTEP, NETCONF_7X50, NETCONF_THIRDPARTY_HW_VTEP, NUAGE_210_WBX_32_Q, NUAGE_210_WBX_48_S, OTHER, VDFG, VRSB, VRSG, VSA, VSG
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