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  
entityScope enum (ENTERPRISE | GLOBAL) autogenerated  
externalID string filterable   orderable   locally unique  
gatewayPeer1ID string read only   autogenerated   filterable   orderable  
gatewayPeer2ID string read only   autogenerated   filterable   orderable  
lastUpdatedBy string autogenerated  
name string read only   autogenerated   filterable   orderable  
peer1IPAddress string read only  
peer1Subnet string read only  
peer2IPAddress string read only  
peer2Subnet string read only  
VLANPeer1ID string required   filterable   orderable  
VLANPeer2ID string required   filterable   orderable  

API Resource

/shuntlinks/id
delete get put

Parents

/nsgredundancygroups/id/shuntlinks
get post

Children

/shuntlinks/id/metadatas
get post
/shuntlinks/id/alarms
get post
/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

Default value: null
Format: free
Max length: 255
SDK attribute: description

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   filterable   orderable  
Discussion

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

Charateristics

Allowed characters: UUID supported characters.
Default value: null
Format: free
SDK attribute: gatewayPeer1ID

gatewayPeer2ID string read only   autogenerated   filterable   orderable  
Discussion

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

Charateristics

Allowed characters: UUID supported characters.
Default value: null
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
Default value: null
Format: free
Min length: 1
Max length: 255
SDK attribute: name

peer1IPAddress string read only  
Discussion

The IP address of the first peer of the Shunt Link.

Charateristics

Format: ipv4
SDK attribute: peer1IPAddress

peer1Subnet string read only  
Discussion

The subnet given to the first peer of the Shunt Link.

Charateristics

Format: ipv4
SDK attribute: peer1Subnet

peer2IPAddress string read only  
Discussion

The IP address of the second peer of the Shunt Link.

Charateristics

Format: free
SDK attribute: peer2IPAddress

peer2Subnet string read only  
Discussion

The subnet on the second peer of the Shunt Link.

Charateristics

Format: ipv4
SDK attribute: peer2Subnet

VLANPeer1ID string required   filterable   orderable  
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   filterable   orderable  
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