VLAN

Represents VLAN object under a given Port object.

Overview

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

API Resource

/vlans/id
delete get put

Parents

/ports/id/vlans
get post
/vsgredundantports/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
/vlans/id/brconnections
get post
/vlans/id/ltestatistics
get post
/vlans/id/eventlogs
get

Members

/vlans/id/patnatpools
get put

Attributes documentation

associatedBGPProfileID string filterable   orderable  
Discussion

The ID of the associated BGP profile

Charateristics

Format: free
SDK attribute: associatedBGPProfileID

associatedEgressQOSPolicyID string
Discussion

ID of the Egress QOS Policy associated with this VLAN.

Charateristics

Format: free
SDK attribute: associatedEgressQOSPolicyID

associatedIngressQOSPolicyID string
Discussion

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

Charateristics

Format: free
SDK attribute: associatedIngressQOSPolicyID

associatedUplinkConnectionID string filterable   orderable  
Discussion

Associated uplink connection ID

Charateristics

Format: free
SDK attribute: associatedUplinkConnectionID

associatedVSCProfileID string filterable   orderable  
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 Port

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

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

Charateristics

Format: free
SDK attribute: readonly

restricted boolean filterable   orderable  
Discussion

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

Charateristics

Format: free
SDK attribute: restricted

status enum
Discussion

Status of the VLAN.

Charateristics

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

templateID string
Discussion

The ID of the template that this Port was created from

Charateristics

Format: free
SDK attribute: templateID

type enum read only   filterable   orderable  
Discussion

This type marks a VLAN for it's utility.

Charateristics

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

userMnemonic string filterable   orderable  
Discussion

user mnemonic of the Port

Charateristics

Format: free
Max length: 255
SDK attribute: userMnemonic

useUserMnemonic boolean filterable   orderable  
Discussion

determines whether to use user mnemonic of the Port

Charateristics

Format: free
SDK attribute: useUserMnemonic

value integer required   filterable   orderable  
Discussion

value of VLAN

Charateristics

Format: free
Max value: 4096
SDK attribute: value

vportID string filterable   orderable  
Discussion

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

Charateristics

Format: free
SDK attribute: vportID