NSPortTemplate

Represents Port Template object under a given gateway template 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  
lastUpdatedBy string autogenerated  
lastUpdatedDate string read only   autogenerated   orderable  
mtu integer filterable   orderable  
name string required   filterable   orderable  
owner string autogenerated  
physicalName string required   creation only   filterable   orderable  
portType enum (ACCESS | NETWORK) required   filterable   orderable  
speed enum (AUTONEGOTIATE | BASET10 | BASET1000 | BASETX100 | BASEX10G) filterable   orderable  
VLANRange string filterable  

API Resource

/nsporttemplates/id
delete get put

Parents

/nsgatewaytemplates/id/nsporttemplates
get post

Children

/nsporttemplates/id/permissions
delete get post put
/nsporttemplates/id/metadatas
get post
/nsporttemplates/id/vlantemplates
get post
/nsporttemplates/id/globalmetadatas
get post put

Members

This object has no members.

Attributes documentation

associatedEgressQOSPolicyID string
Discussion

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

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 NSG Port Template

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

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 filterable   orderable  
Discussion

Port MTU (Maximum Transmission Unit) : The size in octets of the largest protocol data unit hat the layer can pass on.

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

owner string autogenerated  
Discussion

Identifies the user that has created this object.

Charateristics

Format: free
SDK attribute: owner

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 Ports that will be instantiated from this template.

Charateristics

Allowed values: ACCESS, NETWORK
SDK attribute: portType

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

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 4095.

Charateristics

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