RedundantPort

Represents a 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  
infrastructureProfileID string
lastUpdatedBy string autogenerated  
lastUpdatedDate string read only   autogenerated   orderable  
MTU integer
name string required   filterable   orderable  
owner string autogenerated  
permittedAction enum (ALL | DEPLOY | EXTEND | INSTANTIATE | READ | USE)
physicalName string required   creation only   filterable   orderable  
portPeer1ID string
portPeer2ID string
portType enum (ACCESS) required   filterable   orderable  
speed enum (AUTONEGOTIATE | BASET10 | BASET1000 | BASETX100 | BASEX10G)
status enum (INITIALIZED | MISMATCH | ORPHAN | READY)
userMnemonic string filterable   orderable  
useUntaggedHeartbeatVlan boolean
useUserMnemonic boolean filterable   orderable  
VLANRange string required   filterable  

API Resource

/nsredundantports/id
delete get put

Parents

/nsgredundancygroups/id/nsredundantports
get post put

Children

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

Members

This object has no members.

Attributes documentation

associatedEgressQOSPolicyID string
Discussion

ID of the Egress QoS Policy associated with this Redundant Port.


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 Redundant Port instance.


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

infrastructureProfileID string
Discussion

The ID of the infrastructure port 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

lastUpdatedDate string read only   autogenerated   orderable  
Discussion

Time stamp when this object was last updated.


Charateristics

SDK attribute: lastUpdatedDate

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


Charateristics

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

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 Redundant Port.


Charateristics

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

physicalName string required   creation only   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

Port ID of the port acting as master component of the redundant port instance.


Charateristics

Format: free
SDK attribute: portPeer1ID

portPeer2ID string
Discussion

Port ID of the port acting as slave component of the redundant port instance.


Charateristics

Format: free
SDK attribute: portPeer2ID

portType enum required   filterable   orderable  
Discussion

Type of the Redundant Port.


Charateristics

Allowed values: ACCESS
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, BASET10, BASET1000, BASETX100, BASEX10G
SDK attribute: speed

status enum
Discussion

Status of the redundant port.


Charateristics

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

userMnemonic string filterable   orderable  
Discussion

User mnemonic of the Redundant 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

SDK attribute: useUserMnemonic

VLANRange string required   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

Default value: 0-4094
Format: free
Max length: 255
SDK attribute: VLANRange