VLANTemplate

Represents VLAN Template under a Port Template object.

Overview

associatedConnectionType enum (BR_CONNECTION | UPLINK_CONNECTION) read only  
associatedEgressQOSPolicyID string
associatedIngressOverlayQoSPolicerID string read only  
associatedIngressQOSPolicyID string
associatedIngressUnderlayQoSPolicerID string read only  
associatedUplinkConnectionID string
associatedVSCProfileID string
description string filterable   orderable  
ducVlan boolean filterable   orderable  
embeddedMetadata list read only   autogenerated  
entityScope enum (ENTERPRISE | GLOBAL) autogenerated  
externalID string filterable   orderable   locally unique  
isUplink boolean read only  
lastUpdatedBy string autogenerated  
type enum (ACCESS | BR | DUC | UPLINK) read only  
value integer required   read only   filterable   orderable  

API Resource

/vlantemplates/id
delete get put

Parents

/nsporttemplates/id/vlantemplates
get post
/porttemplates/id/vlantemplates
get post

Children

/vlantemplates/id/metadatas
get post
/vlantemplates/id/globalmetadatas
get post put
/vlantemplates/id/uplinkconnections
get post
/vlantemplates/id/brconnections
get post

Members

This object has no members.

Attributes documentation

associatedConnectionType enum read only  
Discussion

States the managed object type of the uplink connection associated to this VLAN Template instance.


Charateristics

Allowed values: BR_CONNECTION, UPLINK_CONNECTION
SDK attribute: associatedConnectionType

associatedEgressQOSPolicyID string
Discussion

ID of the Egress QOS Policy associated with this Vlan.


Charateristics

Format: free
SDK attribute: associatedEgressQOSPolicyID

associatedIngressOverlayQoSPolicerID string read only  
Discussion

ID of the Ingress Overlay QoS Policer associated with a VLAN.


Charateristics

Format: free
SDK attribute: associatedIngressOverlayQoSPolicerID

associatedIngressQOSPolicyID string
Discussion

ID of the Ingress QoS Policy associated with this VLAN Template.


Charateristics

Format: free
SDK attribute: associatedIngressQOSPolicyID

associatedIngressUnderlayQoSPolicerID string read only  
Discussion

ID of the Ingress Underlay QoS Policer associated with a VLAN.


Charateristics

Format: free
SDK attribute: associatedIngressUnderlayQoSPolicerID

associatedUplinkConnectionID string
Discussion

ID of the uplink connection making use of this VLAN Template instance.


Charateristics

Format: free
SDK attribute: associatedUplinkConnectionID

associatedVSCProfileID string
Discussion

The ID of the infrastructure VSC profile this is associated with this instance of a vlan or vlan template.


Charateristics

Format: free
SDK attribute: associatedVSCProfileID

description string filterable   orderable  
Discussion

A description of the Port


Charateristics

Format: free
Max length: 255
SDK attribute: description

ducVlan boolean filterable   orderable  
Discussion

When set to true, this specifies that this VLAN template instance serves as an underlay connection endpoint on an NSG-UBR gateway.


Charateristics

SDK attribute: ducVlan

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

type enum read only  
Discussion

This type marks a VLAN for its utility.


Charateristics

Allowed values: ACCESS, BR, DUC, UPLINK
SDK attribute: type

value integer required   read only   filterable   orderable  
Discussion

Value or ID of VLAN instances to be created from this template.


Charateristics

Max value: 4096
SDK attribute: value