VLANs are Virtual Local Area Networks. They allow to differentiate several traffic flows inside a single Port. A VLAN with a value set to 0 can be used to tell the system to not use any tagging.
The ID of the associated BGP profile
Format: free
SDK attribute: associatedBGPProfileID
Specifies the type of Connection (uplink, BR) associated to this VLAN instance.
Allowed values: BR_CONNECTION, UPLINK_CONNECTION
SDK attribute: associatedConnectionType
ID of the Egress QOS Policy associated with this VLAN.
Format: free
SDK attribute: associatedEgressQOSPolicyID
ID of the Ingress Overlay QoS Policer associated with this VLAN.
Format: free
SDK attribute: associatedIngressOverlayQoSPolicerID
ID of the Ingress QoS Policy / Tunnel Shaper associated with this VLAN.
Format: free
SDK attribute: associatedIngressQOSPolicyID
ID of the Ingress Underlay QoS Policer associated with this VLAN.
Format: free
SDK attribute: associatedIngressUnderlayQoSPolicerID
Associated uplink connection ID
Format: free
SDK attribute: associatedUplinkConnectionID
The associated VSC profile for the uplink VLANS. This should be only be valid for the uplinks
Format: free
SDK attribute: associatedVSCProfileID
Time stamp when this object was created.
SDK attribute: creationDate
A description of the VLAN instance.
Format: free
Max length: 255
SDK attribute: description
When set to true, this specifies that this VLAN instance serves as an underlay connection endpoint on an NSG-UBR gateway.
Default value: false
SDK attribute: ducVlan
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
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
The Gateway associated with this VLAN. This is a read only attribute
Format: free
SDK attribute: gatewayID
Indicates if the VLAN is used as an uplink.
Default value: false
SDK attribute: isUplink
ID of the user who last updated the object.
Format: free
SDK attribute: lastUpdatedBy
Time stamp when this object was last updated.
SDK attribute: lastUpdatedDate
Identifies the user that has created this object.
Format: free
SDK attribute: owner
The permitted action to USE/EXTEND this Gateway.
Allowed values: ALL, DEPLOY, EXTEND, INSTANTIATE, READ, USE
SDK attribute: permittedAction
Determines whether this entity is read only. Read only objects cannot be modified or deleted.
SDK attribute: readonly
Determines whether this entity can be used in associations with other properties.
SDK attribute: restricted
A flag to mark this instance of a VLAN as a candidate to be a termination point of a Shunt Link. Only VLANs residing on a Network Port can have this attribute set to true.
Default value: false
SDK attribute: shuntVLAN
Status of the VLAN.
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
This type marks a VLAN for its utility.
Allowed values: ACCESS, BR, DUC, UPLINK
SDK attribute: type
User mnemonic of the VLAN instance.
Format: free
Max length: 255
SDK attribute: userMnemonic
Determines whether to use the defined mnemonic for this VLAN instance.
SDK attribute: useUserMnemonic
value of VLAN
Max value: 4096
SDK attribute: value
The Vport associated with this VLAN. This is a read only attribute
Format: free
SDK attribute: vportID