Skip to main content

vlans

Creates, updates, deletes, gets or lists a vlans resource.

Overview​

Namevlans
TypeResource
Idoci.network.vlans

Fields​

The following fields are returned by SELECT queries:

The VLAN was retrieved.

NameDatatypeDescription
idstringThe VLAN's Oracle ID ([OCID](/iaas/Content/General/Concepts/identifiers.htm)).
availabilityDomainstringThe availability domain of the VLAN. Example: Uocm:PHX-AD-1
cidrBlockstringThe range of IPv4 addresses that will be used for layer 3 communication with hosts outside the VLAN. Example: 192.168.1.0/24
compartmentIdstringThe [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the VLAN.
definedTagsobjectDefined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Operations": {"CostCenter": "42"}}
displayNamestringA user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
freeformTagsobjectFree-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](/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Department": "Finance"}
lifecycleStatestringThe VLAN's current state. (PROVISIONING, AVAILABLE, TERMINATING, TERMINATED, UPDATING)
nsgIdsarrayA 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](#/en/iaas/latest/NetworkSecurityGroup/).
routeTableIdstringThe [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the route table that the VLAN uses.
timeCreatedstring (date-time)The date and time the VLAN was created, in the format defined by [RFC3339](https:​//tools.ietf.org/html/rfc3339). Example: 2016-08-25T21:10:29.600Z
vcnIdstringThe [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VCN the VLAN is in.
vlanTaginteger (int32)The IEEE 802.1Q VLAN tag of this VLAN. Example: 100

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
getselectvlanId, regionopc-request-idGets the specified VLAN's information.
listselectcompartmentId, vcnId, regionlimit, page, displayName, sortBy, sortOrder, opc-request-id, lifecycleStateLists the VLANs in the specified VCN and the specified compartment.<br />
createinsertregion, availabilityDomain, compartmentId, cidrBlock, vcnIdopc-retry-token, opc-request-idCreates a VLAN in the specified VCN and the specified compartment.<br />
updateupdatevlanId, regionif-match, opc-request-idUpdates the specified VLAN. Note that this operation might require changes to all<br />the VNICs in the VLAN, which can take a while. The VLAN will be in the UPDATING state until the changes are complete.<br />
deletedeletevlanId, regionif-match, opc-request-idDeletes the specified VLAN, but only if there are no VNICs in the VLAN.<br />
change_compartmentexecvlanId, region, compartmentIdif-match, opc-request-id, opc-retry-tokenMoves a VLAN into a different compartment within the same tenancy.<br />For information about moving resources between compartments, see<br />[Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).<br />

Parameters​

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

NameDatatypeDescription
compartmentIdstringThe [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.
regionstringOCI region identifier (e.g. us-ashburn-1, ap-sydney-1); resolves from OCI_REGION when not supplied in the query. (default: us-ashburn-1, x-stackQL-envVar: OCI_REGION)
vcnIdstringThe [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VCN.
vlanIdstringThe [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VLAN.
displayNamestringA filter to return only resources that match the given display name exactly.
if-matchstringFor optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
lifecycleStatestringA filter to only return resources that match the given lifecycle state. The state value is case-insensitive.
limitintegerFor list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). Example: 50
opc-request-idstringUnique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
opc-retry-tokenstringA token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
pagestringFor list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).
sortBystringThe field to sort by. You can provide one sort order (sortOrder). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. Note: In general, some "List" operations (for example, ListInstances) let you optionally filter by availability domain if the scope of the resource type is within a single availability domain. If you call one of these "List" operations without specifying an availability domain, the resources are grouped by availability domain, then sorted.
sortOrderstringThe sort order to use, either ascending (ASC) or descending (DESC). The DISPLAYNAME sort order is case sensitive.

SELECT examples​

Gets the specified VLAN's information.

SELECT
id,
availabilityDomain,
cidrBlock,
compartmentId,
definedTags,
displayName,
freeformTags,
lifecycleState,
nsgIds,
routeTableId,
timeCreated,
vcnId,
vlanTag
FROM oci.network.vlans
WHERE vlanId = '{{ vlanId }}' -- required
AND region = '{{ region }}' -- required
AND opc-request-id = '{{ opc-request-id }}'
;

INSERT examples​

Creates a VLAN in the specified VCN and the specified compartment.<br />

INSERT INTO oci.network.vlans (
availabilityDomain,
cidrBlock,
compartmentId,
definedTags,
displayName,
freeformTags,
nsgIds,
routeTableId,
vcnId,
vlanTag,
region,
opc-retry-token,
opc-request-id
)
SELECT 
'{{ availabilityDomain }}' /* required */,
'{{ cidrBlock }}' /* required */,
'{{ compartmentId }}' /* required */,
'{{ definedTags }}',
'{{ displayName }}',
'{{ freeformTags }}',
'{{ nsgIds }}',
'{{ routeTableId }}',
'{{ vcnId }}' /* required */,
{{ vlanTag }},
'{{ region }}',
'{{ opc-retry-token }}',
'{{ opc-request-id }}'
RETURNING
id,
availabilityDomain,
cidrBlock,
compartmentId,
definedTags,
displayName,
freeformTags,
lifecycleState,
nsgIds,
routeTableId,
timeCreated,
vcnId,
vlanTag
;

UPDATE examples​

Updates the specified VLAN. Note that this operation might require changes to all<br />the VNICs in the VLAN, which can take a while. The VLAN will be in the UPDATING state until the changes are complete.<br />

UPDATE oci.network.vlans
SET 
definedTags = '{{ definedTags }}',
displayName = '{{ displayName }}',
freeformTags = '{{ freeformTags }}',
nsgIds = '{{ nsgIds }}',
routeTableId = '{{ routeTableId }}'
WHERE 
vlanId = '{{ vlanId }}' --required
AND region = '{{ region }}' --required
AND if-match = '{{ if-match}}'
AND opc-request-id = '{{ opc-request-id}}'
RETURNING
id,
availabilityDomain,
cidrBlock,
compartmentId,
definedTags,
displayName,
freeformTags,
lifecycleState,
nsgIds,
routeTableId,
timeCreated,
vcnId,
vlanTag;

DELETE examples​

Deletes the specified VLAN, but only if there are no VNICs in the VLAN.<br />

DELETE FROM oci.network.vlans
WHERE vlanId = '{{ vlanId }}' --required
AND region = '{{ region }}' --required
AND if-match = '{{ if-match }}'
AND opc-request-id = '{{ opc-request-id }}'
;

Lifecycle Methods​

Moves a VLAN into a different compartment within the same tenancy.<br />For information about moving resources between compartments, see<br />[Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).<br />

EXEC oci.network.vlans.change_compartment 
@vlanId='{{ vlanId }}' --required, 
@region='{{ region }}' --required, 
@if-match='{{ if-match }}', 
@opc-request-id='{{ opc-request-id }}', 
@opc-retry-token='{{ opc-retry-token }}' 
@@json=
'{
"compartmentId": "{{ compartmentId }}"
}'
;