GatewayRedundantPort

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

Overview

associatedEgressQOSPolicyID string
description string filterable   orderable  
entityScope enum (ENTERPRISE | GLOBAL) autogenerated  
externalID string filterable   orderable   locally unique  
lastUpdatedBy string autogenerated  
name string required   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

/gatewayredundantports/id
delete get put

Parents

/redundancygroups/id/gatewayredundantports
get post

Children

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

Members

This object has no members.

Attributes documentation

associatedEgressQOSPolicyID string
Discussion

UUID of the Egress QOS Policy associated with this Vlan.

Charateristics

Format: free
SDK attribute: associatedEgressQOSPolicyID

description string filterable   orderable  
Discussion

A description of the Port

Charateristics

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

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 Port

Charateristics

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

permittedAction enum
Discussion

The permitted action to USE/EXTEND this port.

Charateristics

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

physicalName string required   filterable   orderable  
Discussion

Identifier of the Redundant Port. The name should be corresponding to the Physical Name of the ports belonging to this redundant instance.

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