ShuntLink

A shunt link represents an alliance of uplink interface resources between two NSGs belonging to a Redundant Group. An operator specifies which network port-VLAN from each NSG peers to be considered as shunted together so that control uplinks from each NSG may be used by the other.

Overview

description string filterable   orderable  
embeddedMetadata list read only   autogenerated  
entityScope enum (ENTERPRISE | GLOBAL) autogenerated  
externalID string filterable   orderable   locally unique  
gatewayPeer1ID string read only   autogenerated  
gatewayPeer2ID string read only   autogenerated  
lastUpdatedBy string autogenerated  
name string read only   autogenerated   filterable   orderable  
permittedAction enum (ALL | DEPLOY | EXTEND | INSTANTIATE | READ | USE)
VLANPeer1ID string required  
VLANPeer2ID string required  

API Resource

/shuntlinks/id
delete get put

Parents

/nsgredundancygroups/id/shuntlinks
get post put

Children

/shuntlinks/id/metadatas
get post
/shuntlinks/id/alarms
get
/shuntlinks/id/globalmetadatas
get post put

Members

This object has no members.

Attributes documentation

description string filterable   orderable  
Discussion

Extra information entered by the operator to define the Shunt Link.

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

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

gatewayPeer1ID string read only   autogenerated  
Discussion

The ID of the first NSG of the redundant gateway group part of this Shunt Link.

Charateristics

Allowed characters: UUID supported characters.
Format: free
SDK attribute: gatewayPeer1ID

gatewayPeer2ID string read only   autogenerated  
Discussion

The ID of the second NSG of the redundant gateway group part of this Shunt Link.

Charateristics

Allowed characters: UUID supported characters.
Format: free
SDK attribute: gatewayPeer2ID

lastUpdatedBy string autogenerated  
Discussion

ID of the user who last updated the object.

Charateristics

Format: free
SDK attribute: lastUpdatedBy

name string read only   autogenerated   filterable   orderable  
Discussion

The name auto-generated by VSD and given to a newly created Shunt Link.

Charateristics

Allowed characters: Almost everything
Format: free
Min length: 1
Max length: 255
SDK attribute: name

permittedAction enum
Discussion

The permitted action to USE/EXTEND this Shunt Link

Charateristics

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

VLANPeer1ID string required  
Discussion

The ID of the shunted VLAN from the first NSG of the redundant gateway group.

Charateristics

Allowed characters: UUID supported characters
Format: free
SDK attribute: VLANPeer1ID

VLANPeer2ID string required  
Discussion

The ID of the shunted VLAN from the second NSG of the redundant gateway group.

Charateristics

Allowed characters: UUID supported characters.
Format: free
SDK attribute: VLANPeer2ID