Vlan

class oci.core.models.Vlan(**kwargs)

Bases: object

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).

Attributes

LIFECYCLE_STATE_AVAILABLE A constant which can be used with the lifecycle_state property of a Vlan.
LIFECYCLE_STATE_PROVISIONING A constant which can be used with the lifecycle_state property of a Vlan.
LIFECYCLE_STATE_TERMINATED A constant which can be used with the lifecycle_state property of a Vlan.
LIFECYCLE_STATE_TERMINATING A constant which can be used with the lifecycle_state property of a Vlan.
LIFECYCLE_STATE_UPDATING A constant which can be used with the lifecycle_state property of a Vlan.
availability_domain Gets the availability_domain of this Vlan.
cidr_block [Required] Gets the cidr_block of this Vlan.
compartment_id [Required] Gets the compartment_id of this Vlan.
defined_tags Gets the defined_tags of this Vlan.
display_name Gets the display_name of this Vlan.
freeform_tags Gets the freeform_tags of this Vlan.
id [Required] Gets the id of this Vlan.
lifecycle_state [Required] Gets the lifecycle_state of this Vlan.
nsg_ids Gets the nsg_ids of this Vlan.
route_table_id Gets the route_table_id of this Vlan.
time_created Gets the time_created of this Vlan.
vcn_id [Required] Gets the vcn_id of this Vlan.
vlan_tag Gets the vlan_tag of this Vlan.

Methods

__init__(**kwargs) Initializes a new Vlan object with values from keyword arguments.
LIFECYCLE_STATE_AVAILABLE = 'AVAILABLE'

A constant which can be used with the lifecycle_state property of a Vlan. This constant has a value of “AVAILABLE”

LIFECYCLE_STATE_PROVISIONING = 'PROVISIONING'

A constant which can be used with the lifecycle_state property of a Vlan. This constant has a value of “PROVISIONING”

LIFECYCLE_STATE_TERMINATED = 'TERMINATED'

A constant which can be used with the lifecycle_state property of a Vlan. This constant has a value of “TERMINATED”

LIFECYCLE_STATE_TERMINATING = 'TERMINATING'

A constant which can be used with the lifecycle_state property of a Vlan. This constant has a value of “TERMINATING”

LIFECYCLE_STATE_UPDATING = 'UPDATING'

A constant which can be used with the lifecycle_state property of a Vlan. This constant has a value of “UPDATING”

__init__(**kwargs)

Initializes a new Vlan object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:
  • availability_domain (str) – The value to assign to the availability_domain property of this Vlan.
  • cidr_block (str) – The value to assign to the cidr_block property of this Vlan.
  • compartment_id (str) – The value to assign to the compartment_id property of this Vlan.
  • defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this Vlan.
  • display_name (str) – The value to assign to the display_name property of this Vlan.
  • freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this Vlan.
  • id (str) – The value to assign to the id property of this Vlan.
  • lifecycle_state (str) – The value to assign to the lifecycle_state property of this Vlan. Allowed values for this property are: “PROVISIONING”, “AVAILABLE”, “TERMINATING”, “TERMINATED”, “UPDATING”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
  • nsg_ids (list[str]) – The value to assign to the nsg_ids property of this Vlan.
  • vlan_tag (int) – The value to assign to the vlan_tag property of this Vlan.
  • route_table_id (str) – The value to assign to the route_table_id property of this Vlan.
  • time_created (datetime) – The value to assign to the time_created property of this Vlan.
  • vcn_id (str) – The value to assign to the vcn_id property of this Vlan.
availability_domain

Gets the availability_domain of this Vlan. The availability domain of the VLAN.

Example: Uocm:PHX-AD-1

Returns:The availability_domain of this Vlan.
Return type:str
cidr_block

[Required] Gets the cidr_block of this Vlan. The range of IPv4 addresses that will be used for layer 3 communication with hosts outside the VLAN.

Example: 192.168.1.0/24

Returns:The cidr_block of this Vlan.
Return type:str
compartment_id

[Required] Gets the compartment_id of this Vlan. The OCID of the compartment containing the VLAN.

Returns:The compartment_id of this Vlan.
Return type:str
defined_tags

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

Example: {“Operations”: {“CostCenter”: “42”}}

Returns:The defined_tags of this Vlan.
Return type:dict(str, dict(str, object))
display_name

Gets the display_name of this Vlan. A user-friendly name. Does not have to be unique, and it’s changeable. Avoid entering confidential information.

Returns:The display_name of this Vlan.
Return type:str
freeform_tags

Gets the freeform_tags of this Vlan. 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”}

Returns:The freeform_tags of this Vlan.
Return type:dict(str, str)
id

[Required] Gets the id of this Vlan. The VLAN’s Oracle ID (OCID).

Returns:The id of this Vlan.
Return type:str
lifecycle_state

[Required] Gets the lifecycle_state of this Vlan. The VLAN’s current state.

Allowed values for this property are: “PROVISIONING”, “AVAILABLE”, “TERMINATING”, “TERMINATED”, “UPDATING”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:The lifecycle_state of this Vlan.
Return type:str
nsg_ids

Gets the nsg_ids of this Vlan. 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.

Returns:The nsg_ids of this Vlan.
Return type:list[str]
route_table_id

Gets the route_table_id of this Vlan. The OCID of the route table that the VLAN uses.

Returns:The route_table_id of this Vlan.
Return type:str
time_created

Gets the time_created of this Vlan. The date and time the VLAN was created, in the format defined by RFC3339.

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

Returns:The time_created of this Vlan.
Return type:datetime
vcn_id

[Required] Gets the vcn_id of this Vlan. The OCID of the VCN the VLAN is in.

Returns:The vcn_id of this Vlan.
Return type:str
vlan_tag

Gets the vlan_tag of this Vlan. The IEEE 802.1Q VLAN tag of this VLAN.

Example: 100

Returns:The vlan_tag of this Vlan.
Return type:int