PortTemplate

Represents a Port Template object under a given gateway template object.

Overview

associatedEgressQOSPolicyID string
description string filterable   orderable  
embeddedMetadata list read only   autogenerated  
entityScope enum (ENTERPRISE | GLOBAL) autogenerated  
externalID string filterable   orderable   locally unique  
lastUpdatedBy string autogenerated  
name string required   filterable   orderable  
physicalName string required   read only   filterable   orderable  
portType enum (ACCESS | MANAGEMENT | NETWORK) required   filterable   orderable  
VLANRange string filterable  

API Resource

/porttemplates/id
delete get put

Parents

/gatewaytemplates/id/porttemplates
get post

Children

/porttemplates/id/metadatas
get post
/porttemplates/id/vlantemplates
get post
/porttemplates/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 Vlan.


Charateristics

Format: free
SDK attribute: associatedEgressQOSPolicyID

description string filterable   orderable  
Discussion

A description of the Port


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

name string required   filterable   orderable  
Discussion

Name of the Port


Charateristics

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

physicalName string required   read 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. Possible values are ACCESS, NETWORK, MANAGEMENT.


Charateristics

Allowed values: ACCESS, MANAGEMENT, NETWORK
Format: free
SDK attribute: portType

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

Format: free
Max length: 255
SDK attribute: VLANRange