• Public
  • Public/Protected
  • All

Namespace Vlan

A resource to be used only with the Oracle Cloud VMware Solution.

Conceptually, a virtual LAN (VLAN) is a broadcast domain that is created by partitioning and isolating a network at the data link layer (a *layer 2 network*). VLANs work by using IEEE 802.1Q VLAN tags. Layer 2 traffic is forwarded within the VLAN based on MAC learning.

In the Networking service, a VLAN is an object within a VCN. You use VLANs to partition the VCN at the data link layer (layer 2). A VLAN is analagous to a subnet, which is an object for partitioning the VCN at the IP layer (layer 3).


Optional availabilityDomain

availabilityDomain: undefined | string

The VLAN's availability domain. This attribute will be null if this is a regional VLAN rather than an AD-specific VLAN.

Example: `Uocm:PHX-AD-1`


cidrBlock: string

The range of IPv4 addresses that will be used for layer 3 communication with hosts outside the VLAN.

Example: ``


compartmentId: string

The OCID of the compartment containing the VLAN.

Optional definedTags

definedTags: undefined | object

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

Example: `{\"Operations\": {\"CostCenter\": \"42\"}}`

Optional displayName

displayName: undefined | string

A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

Optional freeformTags

freeformTags: undefined | object

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags.

Example: `{\"Department\": \"Finance\"}`


id: string

The VLAN's Oracle ID (OCID).


lifecycleState: LifecycleState

The VLAN's current state.

Optional nsgIds

nsgIds: Array<string>

A list of the OCIDs of the network security groups (NSGs) to use with this VLAN. All VNICs in the VLAN belong to these NSGs. For more information about NSGs, see NetworkSecurityGroup.

Optional routeTableId

routeTableId: undefined | string

The OCID of the route table that the VLAN uses.

Optional timeCreated

timeCreated: Date

The date and time the VLAN was created, in the format defined by RFC3339.

Example: `2016-08-25T21:10:29.600Z`


vcnId: string

The OCID of the VCN the VLAN is in.

Optional vlanTag

vlanTag: undefined | number

The IEEE 802.1Q VLAN tag of this VLAN.

Example: `100` Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.



  • getDeserializedJsonObj(obj: Vlan): object


  • getJsonObj(obj: Vlan): object