VsgRedundantPort

Represents a redundant Port under a particular gateway object or redundant group object.

Overview

associatedEgressQOSPolicyID string
creationDate string read only   autogenerated   orderable  
description string filterable   orderable  
embeddedMetadata list read only   autogenerated  
entityScope enum (ENTERPRISE | GLOBAL) autogenerated  
externalID string filterable   orderable   locally unique  
lastUpdatedBy string autogenerated  
lastUpdatedDate string read only   autogenerated   orderable  
name string required   filterable   orderable  
operationalState enum (DOWN | INIT | UP) read only  
owner string autogenerated  
peerLink boolean read only   filterable   orderable  
permittedAction enum (ALL | DEPLOY | EXTEND | INSTANTIATE | READ | USE)
physicalName string required   filterable   orderable  
portPeer1ID string
portPeer2ID string
portType enum (ACCESS | NETWORK) required   filterable   orderable  
status enum (INITIALIZED | MISMATCH | ORPHAN | READY)
userMnemonic string filterable   orderable  
useUserMnemonic boolean filterable   orderable  
VLANRange string filterable  

API Resource

/vsgredundantports/id
delete get put

Parents

/redundancygroups/id/vsgredundantports
get post put

Children

/vsgredundantports/id/permissions
get post
/vsgredundantports/id/metadatas
get post
/vsgredundantports/id/vlans
get post
/vsgredundantports/id/alarms
get
/vsgredundantports/id/globalmetadatas
get post put
/vsgredundantports/id/enterprisepermissions
get post

Members

This object has no members.

Attributes documentation

associatedEgressQOSPolicyID string
Discussion

ID of the Egress QOS Policy associated with this Vlan.

Charateristics

Format: free
SDK attribute: associatedEgressQOSPolicyID

creationDate string read only   autogenerated   orderable  
Discussion

Time stamp when this object was created.

Charateristics

SDK attribute: creationDate

description string filterable   orderable  
Discussion

A description of the Port

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

lastUpdatedBy string autogenerated  
Discussion

ID of the user who last updated the object.

Charateristics

Format: free
SDK attribute: lastUpdatedBy

lastUpdatedDate string read only   autogenerated   orderable  
Discussion

Time stamp when this object was last updated.

Charateristics

SDK attribute: lastUpdatedDate

name string required   filterable   orderable  
Discussion

Name of the Port

Charateristics

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

operationalState enum read only  
Discussion

Represents Operational State of the Port. Possible values are INIT, UP, DOWN.

Charateristics

Allowed values: DOWN, INIT, UP
SDK attribute: operationalState

owner string autogenerated  
Discussion

Identifies the user that has created this object.

Charateristics

Format: free
SDK attribute: owner

permittedAction enum
Discussion

The permitted action to USE/EXTEND this Gateway.

Charateristics

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

physicalName string required   filterable   orderable  
Discussion

Identifier of the Port

Charateristics

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

portPeer1ID string
Discussion

The master gateway peer port id.

Charateristics

Format: free
SDK attribute: portPeer1ID

portPeer2ID string
Discussion

The slave gateway peer port id.

Charateristics

Format: free
SDK attribute: portPeer2ID

portType enum required   filterable   orderable  
Discussion

Type of the Port.

Charateristics

Allowed values: ACCESS, NETWORK
SDK attribute: portType

status enum
Discussion

Status of the port.

Charateristics

Allowed values: INITIALIZED, MISMATCH, ORPHAN, READY
SDK attribute: status

userMnemonic string filterable   orderable  
Discussion

user mnemonic of the Port

Charateristics

Format: free
Max length: 255
SDK attribute: userMnemonic

useUserMnemonic boolean filterable   orderable  
Discussion

determines whether to use user mnemonic of the Port

Charateristics

SDK attribute: useUserMnemonic

VLANRange string filterable  
Discussion

VLAN Range of the Port. Format must conform to a-b,c,d-f where a,b,c,d,f are integers between 0 and 4095.

Charateristics

Format: free
Max length: 255
SDK attribute: VLANRange