Represents a Port under a particular gateway object or redundant group object.
This object has no members.
ID of the Egress QoS Policy associated with this Redundant Port.
Format: free
SDK attribute: associatedEgressQOSPolicyID
Time stamp when this object was created.
SDK attribute: creationDate
A description of the Redundant Port instance.
Format: free
Max length: 255
SDK attribute: description
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.
SDK attribute: embeddedMetadata
Specify if scope of entity is Data center or Enterprise level
Allowed values: ENTERPRISE, GLOBAL
SDK attribute: entityScope
External object ID. Used for integration with third party systems
Format: free
SDK attribute: externalID
The ID of the infrastructure port profile this instance is associated with.
Format: free
SDK attribute: infrastructureProfileID
ID of the user who last updated the object.
Format: free
SDK attribute: lastUpdatedBy
Time stamp when this object was last updated.
SDK attribute: lastUpdatedDate
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.
Default value: 1500
Min value: 68
Max value: 9198
SDK attribute: MTU
Name of the Redundant Port
Format: free
Min length: 1
Max length: 255
SDK attribute: name
Identifies the user that has created this object.
Format: free
SDK attribute: owner
The permitted action to USE/EXTEND this Redundant Port.
Allowed values: ALL, DEPLOY, EXTEND, INSTANTIATE, READ, USE
SDK attribute: permittedAction
Identifier of the Redundant Port. The name should be corresponding to the Physical Name of the ports belonging to this redundant instance.
Format: free
Min length: 1
Max length: 255
SDK attribute: physicalName
Port ID of the port acting as master component of the redundant port instance.
Format: free
SDK attribute: portPeer1ID
Port ID of the port acting as slave component of the redundant port instance.
Format: free
SDK attribute: portPeer2ID
Type of the Redundant Port.
Allowed values: ACCESS
SDK attribute: portType
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.
Allowed values: AUTONEGOTIATE, BASET10, BASET1000, BASETX100, BASEX10G
SDK attribute: speed
Status of the redundant port.
Allowed values: INITIALIZED, MISMATCH, ORPHAN, READY
SDK attribute: status
User mnemonic of the Redundant Port.
Format: free
Max length: 255
SDK attribute: userMnemonic
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
Format: free
SDK attribute: useUntaggedHeartbeatVlan
Determines whether to use user mnemonic of the Port
SDK attribute: useUserMnemonic
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.
Default value: 0-4094
Format: free
Max length: 255
SDK attribute: VLANRange