Represents a Port of a particular NS Gateway object.
This object has no members.
ID of the Egress QoS Policy associated with this NSG Port.
Format: free
SDK attribute: associatedEgressQOSPolicyID
ID of the redundant port to which the Port is associated to.
Format: free
SDK attribute: associatedRedundantPortID
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
If enabled, probes will be sent to other NSGs and DTLS sessions for IPSEC and VXLAN will be set up to the VSCs. If disabled, no NAT probes are sent on that uplink and no DTLS sessions are set up to the VSCs.
Default value: true
SDK attribute: enableNATProbes
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
ID of the user who last updated the object.
Format: free
SDK attribute: lastUpdatedBy
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 Port
Format: free
Min length: 1
Max length: 255
SDK attribute: name
Enum value that states the type of NAT Traversal the NSG instance will use to talk to other NSGs and the Internet. (This field is deprecated in 5.0)
Allowed values: FULL_NAT, NONE, ONE_TO_ONE_NAT
Default value: NONE
SDK attribute: NATTraversal
The permitted action to USE/EXTEND this NSG Port.
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.
Allowed values: ACCESS, NETWORK
SDK attribute: portType
Identifies a Port instance on which a VLAN is shunted. Ports of type Network are the only one that supports being in Shunt mode. Shunted ports are only relevant when NSGs are in redundant mode.
Default value: false
SDK attribute: shuntPort
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
Default value: AUTONEGOTIATE
SDK attribute: speed
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
If enabled, cuts down the number of probes to just the number of provisioned DUCs.
Default value: false
SDK attribute: TrafficThroughUBROnly
user mnemonic of the Port
Format: free
Max length: 255
SDK attribute: userMnemonic
Determines whether to use user mnemonic of the NSG 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 4094.
Default value: 0-4094
Format: free
Max length: 255
SDK attribute: VLANRange