NSPort

Represents a Port of a particular NS Gateway object.

Overview

associatedEgressQOSPolicyID string
associatedRedundantPortID string
description string filterable   orderable  
enableNATProbes boolean
entityScope enum (ENTERPRISE | GLOBAL) autogenerated  
externalID string filterable   orderable   locally unique  
lastUpdatedBy string autogenerated  
mtu integer filterable   orderable  
name string required   filterable   orderable  
NATTraversal enum (FULL_NAT | NONE | ONE_TO_ONE_NAT) deprecated  
permittedAction enum (ALL | DEPLOY | EXTEND | INSTANTIATE | READ | USE)
physicalName string required   creation only   filterable   orderable  
portType enum (ACCESS | NETWORK) required   filterable   orderable  
shuntPort boolean
speed enum (AUTONEGOTIATE | BASET10 | BASET1000 | BASETX100 | BASEX10G) filterable   orderable  
status enum (INITIALIZED | MISMATCH | ORPHAN | READY)
templateID string
TrafficThroughUBROnly boolean
userMnemonic string filterable   orderable  
useUserMnemonic boolean filterable   orderable  
VLANRange string filterable  

API Resource

/nsports/id
delete get put

Parents

/nsredundantports/id/nsports
get
/autodiscoveredgateways/id/nsports
get
/nsgateways/id/nsports
get post put

Children

/nsports/id/permissions
get post
/nsports/id/metadatas
get post
/nsports/id/vlans
get post
/nsports/id/alarms
get
/nsports/id/globalmetadatas
get post put
/nsports/id/enterprisepermissions
get post
/nsports/id/statistics
get
/nsports/id/statisticspolicies
get post
/nsports/id/lteinformations
get
/nsports/id/eventlogs
get

Members

This object has no members.

Attributes documentation

associatedEgressQOSPolicyID string
Discussion

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

Charateristics

Format: free
SDK attribute: associatedEgressQOSPolicyID

associatedRedundantPortID string
Discussion

ID of the redundant port to which the Port is associated to.

Charateristics

Format: free
SDK attribute: associatedRedundantPortID

description string filterable   orderable  
Discussion

A description of the Port

Charateristics

Format: free
Max length: 255
SDK attribute: description

enableNATProbes boolean
Discussion

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.

Charateristics

Default value: true
SDK attribute: enableNATProbes

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

lastUpdatedBy string autogenerated  
Discussion

ID of the user who last updated the object.

Charateristics

Format: free
SDK attribute: lastUpdatedBy

mtu integer filterable   orderable  
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

NATTraversal enum deprecated  
Discussion

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)

Charateristics

Allowed values: FULL_NAT, NONE, ONE_TO_ONE_NAT
Default value: NONE
SDK attribute: NATTraversal

permittedAction enum
Discussion

The permitted action to USE/EXTEND this NSG Port.

Charateristics

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

physicalName string required   creation only   filterable   orderable  
Discussion

Identifier of the Port

Charateristics

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

portType enum required   filterable   orderable  
Discussion

Type of the Port.

Charateristics

Allowed values: ACCESS, NETWORK
SDK attribute: portType

shuntPort boolean
Discussion

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.

Charateristics

Default value: false
SDK attribute: shuntPort

speed enum filterable   orderable  
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
Default value: AUTONEGOTIATE
SDK attribute: speed

status enum
Discussion

Status of the port.

Charateristics

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

templateID string
Discussion

The ID of the template that this Port was created from

Charateristics

Format: free
SDK attribute: templateID

TrafficThroughUBROnly boolean
Discussion

If enabled, cuts down the number of probes to just the number of provisioned UBRs.

Charateristics

Default value: false
SDK attribute: TrafficThroughUBROnly

userMnemonic string filterable   orderable  
Discussion

user mnemonic of the Port

Charateristics

Format: free
Max length: 255
SDK attribute: userMnemonic

useUserMnemonic boolean filterable   orderable  
Discussion

Determines whether to use user mnemonic of the NSG 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 4094.

Charateristics

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