VLAN

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.

Overview

associatedBGPProfileID string
associatedConnectionType enum (BR_CONNECTION | UPLINK_CONNECTION) read only  
associatedEgressQOSPolicyID string
associatedIngressOverlayQoSPolicerID string
associatedIngressQOSPolicyID string
associatedIngressUnderlayQoSPolicerID string
associatedUplinkConnectionID string
associatedVSCProfileID string
description string filterable   orderable  
ducVlan boolean filterable   orderable  
entityScope enum (ENTERPRISE | GLOBAL) autogenerated  
externalID string filterable   orderable   locally unique  
gatewayID string read only  
isUplink boolean read only  
lastUpdatedBy string autogenerated  
permittedAction enum (ALL | DEPLOY | EXTEND | INSTANTIATE | READ | USE)
readonly boolean read only   filterable   orderable  
restricted boolean read only   filterable   orderable  
shuntVLAN boolean filterable   orderable  
status enum (INITIALIZED | MISMATCH | ORPHAN | READY)
templateID string read only  
type enum (ACCESS | BR | DUC | UPLINK) read only  
userMnemonic string filterable   orderable  
useUserMnemonic boolean filterable   orderable  
value integer required   read only   filterable   orderable  
vportID string read only   filterable   orderable  

API Resource

/vlans/id
delete get put

Parents

/ports/id/vlans
get post
/vsgredundantports/id/vlans
get post
/gatewayredundantports/id/vlans
get post
/nsredundantports/id/vlans
get post
/nsports/id/vlans
get post

Children

/vlans/id/permissions
get post
/vlans/id/metadatas
get post
/vlans/id/bgpneighbors
get post
/vlans/id/ikegatewayconnections
get post
/vlans/id/alarms
get
/vlans/id/globalmetadatas
get post put
/vlans/id/enterprisepermissions
get post
/vlans/id/uplinkconnections
get post put
/vlans/id/brconnections
get post
/vlans/id/statistics
get
/vlans/id/ltestatistics
get
/vlans/id/eventlogs
get

Members

/vlans/id/patnatpools
get put

Attributes documentation

associatedBGPProfileID string
Discussion

The ID of the associated BGP profile

Charateristics

Format: free
SDK attribute: associatedBGPProfileID

associatedConnectionType enum read only  
Discussion

Specifies the type of Connection (uplink, BR) associated to this VLAN 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
Discussion

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

Charateristics

Format: free
SDK attribute: associatedIngressOverlayQoSPolicerID

associatedIngressQOSPolicyID string
Discussion

ID of the Ingress QoS Policy / Tunnel Shaper associated with this VLAN.

Charateristics

Format: free
SDK attribute: associatedIngressQOSPolicyID

associatedIngressUnderlayQoSPolicerID string
Discussion

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

Charateristics

Format: free
SDK attribute: associatedIngressUnderlayQoSPolicerID

associatedUplinkConnectionID string
Discussion

Associated uplink connection ID

Charateristics

Format: free
SDK attribute: associatedUplinkConnectionID

associatedVSCProfileID string
Discussion

The associated VSC profile for the uplink VLANS. This should be only be valid for the uplinks

Charateristics

Format: free
SDK attribute: associatedVSCProfileID

description string filterable   orderable  
Discussion

A description of the VLAN instance.

Charateristics

Format: free
Max length: 255
SDK attribute: description

ducVlan boolean filterable   orderable  
Discussion

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

Charateristics

Default value: false
SDK attribute: ducVlan

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

gatewayID string read only  
Discussion

The Gateway associated with this VLAN. This is a read only attribute

Charateristics

Format: free
SDK attribute: gatewayID

lastUpdatedBy string autogenerated  
Discussion

ID of the user who last updated the object.

Charateristics

Format: free
SDK attribute: lastUpdatedBy

permittedAction enum
Discussion

The permitted action to USE/EXTEND this Gateway.

Charateristics

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

readonly boolean read only   filterable   orderable  
Discussion

Determines whether this entity is read only. Read only objects cannot be modified or deleted.

Charateristics

SDK attribute: readonly

restricted boolean read only   filterable   orderable  
Discussion

Determines whether this entity can be used in associations with other properties.

Charateristics

SDK attribute: restricted

shuntVLAN boolean filterable   orderable  
Discussion

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.

Charateristics

Default value: false
SDK attribute: shuntVLAN

status enum
Discussion

Status of the VLAN.

Charateristics

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

templateID string read only  
Discussion

The ID of the template that this Port was created from

Charateristics

Format: free
SDK attribute: templateID

type enum read only  
Discussion

This type marks a VLAN for its utility.

Charateristics

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

userMnemonic string filterable   orderable  
Discussion

User mnemonic of the VLAN instance.

Charateristics

Format: free
Max length: 255
SDK attribute: userMnemonic

useUserMnemonic boolean filterable   orderable  
Discussion

Determines whether to use the defined mnemonic for this VLAN instance.

Charateristics

SDK attribute: useUserMnemonic

value integer required   read only   filterable   orderable  
Discussion

value of VLAN

Charateristics

Max value: 4096
SDK attribute: value

vportID string read only   filterable   orderable  
Discussion

The Vport associated with this VLAN. This is a read only attribute

Charateristics

Format: free
SDK attribute: vportID