A port represents specific connection point of a gateway. It can be used for internal networking, like an uplink connection or a management network. It can also be used for domain's access.
This object has no members.
ID of the Egress QOS Policy associated with this Vlan.
Format: free
SDK attribute: associatedEgressQOSPolicyID
ID of the Ethernet Segment Group to which this Port instance may be associated to.
Format: free
Max length: 255
SDK attribute: associatedEthernetSegmentGroupID
Identifier of the Ethernet Segment to which this Port is associated to.
Format: free
Max length: 255
SDK attribute: associatedEthernetSegmentID
Indicates if associated Ethernet Segment is virtual.
Default value: false
SDK attribute: associatedEthernetSegmentVirtual
VLAN Range of the associated Ethernet Segment. Format must conform to a-b,c,d-f where a,b,c,d,f are integers between 0 and 4095.
Format: free
Max length: 255
SDK attribute: associatedEthernetSegmentVLANRange
ID of the redundant port to which this Port instance may be associated to.
Format: free
SDK attribute: associatedRedundantPortID
Time stamp when this object was created.
SDK attribute: creationDate
A description of the Port
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
States if this port instance is resilient (redundant). An example would be a Multi-Chassis LAG port.
Format: free
SDK attribute: isResilient
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
Name of the Port
Format: free
Min length: 1
Max length: 255
SDK attribute: name
Native VLAN to carry untagged traffic on this port. Applicable for Access Ports on third-party Netconf Gateways only. Possible values are 1-3967.
Format: free
Max length: 255
SDK attribute: nativeVLAN
Represents Operational State of the Port. Possible values are INIT, UP, DOWN.
Allowed values: DOWN, INIT, UP
SDK attribute: operationalState
Identifies the user that has created this object.
Format: free
SDK attribute: owner
The permitted action to USE/EXTEND this Gateway.
Allowed values: ALL, DEPLOY, EXTEND, INSTANTIATE, READ, USE
SDK attribute: permittedAction
Identifier of the Port
Format: free
Min length: 1
Max length: 255
SDK attribute: physicalName
Type of the Port. Possible values are ACCESS, NETWORK, MANAGEMENT.
Allowed values: ACCESS, MANAGEMENT, NETWORK
Format: free
SDK attribute: portType
Indicates if this Port is a routed interface. Applicable for Access Ports on third-party Netconf Gateways only.
Default value: false
SDK attribute: routed
Status of the port.
Allowed values: INITIALIZED, MISMATCH, ORPHAN, READY
SDK attribute: status
The ID of the template that this Port was created from
Format: free
SDK attribute: templateID
user mnemonic of the Port
Format: free
Max length: 255
SDK attribute: userMnemonic
determines whether to use user mnemonic of the Port
Format: free
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.
Format: free
Max length: 255
SDK attribute: VLANRange