RedundantPort

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

Overview

associatedEgressQOSPolicyID string
description string filterable   orderable  
entityScope enum (ENTERPRISE | GLOBAL) autogenerated   filterable   orderable  
externalID string filterable   orderable   locally unique  
infrastructureProfileID string
lastUpdatedBy string autogenerated  
MTU integer
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  
speed enum (AUTONEGOTIATE | BASE10 | BASET1000 | BASETX100 | BASEX10G)
status enum (INITIALIZED | MISMATCH | ORPHAN | READY)
userMnemonic string filterable   orderable  
useUntaggedHeartbeatVlan boolean
useUserMnemonic boolean filterable   orderable  
VLANRange string filterable  

API Resource

/nsredundantports/id
delete get put

Parents

/nsgredundancygroups/id/nsredundantports
get post put

Children

/nsredundantports/id/metadatas
get post
/nsredundantports/id/vlans
get post
/nsredundantports/id/globalmetadatas
get post put
/nsredundantports/id/nsports
get

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

description string filterable   orderable  
Discussion

A description of the Port


Charateristics

Format: free
Max length: 255
SDK attribute: description

entityScope enum autogenerated   filterable   orderable  
Discussion

Specify if scope of entity is Data center or Enterprise level


Charateristics

Allowed values: ENTERPRISE, GLOBAL
Format: free
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

infrastructureProfileID string
Discussion

The ID of the infrastructure profile this instance is associated with.


Charateristics

Format: free
SDK attribute: infrastructureProfileID

lastUpdatedBy string autogenerated  
Discussion

ID of the user who last updated the object.


Charateristics

Format: free
SDK attribute: lastUpdatedBy

MTU integer
Discussion

Port MTU (Maximum Transmission Unit) : The size in octets of the largest protocol data unit (PDU) that the layer can pass on. The default value is normally 1500 octets for Ethernet v2 and can go up to 9198 for Jumbo Frames.


Charateristics

Default value: 1500
Min value: 68
Max value: 9198
SDK attribute: MTU

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 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

speed enum
Discussion

Port Speed in Mb/s : Supported Ethernet speeds are 10 (10Base-T), 100 (Fast-ethernet 100Base-TX), 1000 (Gigabit Ethernet 1000Base-T), 10 000 (10 Gigabit Ethernet 10GBase-X), and Auto-Negotiate.


Charateristics

Allowed values: AUTONEGOTIATE, BASE10, BASET1000, BASETX100, BASEX10G
SDK attribute: speed

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

useUntaggedHeartbeatVlan boolean
Discussion

A flag to indicate if for this redundant port an untagged heartbeat VLAN is to be used. If this is not set then will use the heartbeat VLAN set by the NS redundant group


Charateristics

Format: free
SDK attribute: useUntaggedHeartbeatVlan

useUserMnemonic boolean filterable   orderable  
Discussion

determines whether to use user mnemonic of the Port


Charateristics

Format: free
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