Skip to main content

vtaps

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

Overview​

Namevtaps
TypeResource
Idoci.network.vtaps

Fields​

The following fields are returned by SELECT queries:

The VTAP was retrieved.

NameDatatypeDescription
idstringThe VTAP's Oracle ID ([OCID](/iaas/Content/General/Concepts/identifiers.htm)).
captureFilterIdstringThe capture filter's Oracle ID ([OCID](/iaas/Content/General/Concepts/identifiers.htm)).
compartmentIdstringThe [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the Vtap resource.
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.
encapsulationProtocolstringDefines an encapsulation header type for the VTAP's mirrored traffic. (VXLAN)
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"}
isVtapEnabledbooleanUsed to start or stop a Vtap resource. * TRUE directs the VTAP to start mirroring traffic. * FALSE (Default) directs the VTAP to stop mirroring traffic.
lifecycleStatestringThe VTAP's administrative lifecycle state. (PROVISIONING, AVAILABLE, UPDATING, TERMINATING, TERMINATED)
lifecycleStateDetailsstringThe VTAP's current running state. (RUNNING, STOPPED)
maxPacketSizeinteger (int32)The maximum size of the packets to be included in the filter.
sourceIdstringThe [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the source point where packets are captured.
sourcePrivateEndpointIpstringThe IP Address of the source private endpoint.
sourcePrivateEndpointSubnetIdstringThe [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the subnet that source private endpoint belongs to.
sourceTypestringThe source type for the VTAP. (VNIC, SUBNET, LOAD_BALANCER, DB_SYSTEM, EXADATA_VM_CLUSTER, AUTONOMOUS_DATA_WAREHOUSE)
targetIdstringThe [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the destination resource where mirrored packets are sent.
targetIpstringThe IP address of the destination resource where mirrored packets are sent.
targetTypestringThe target type for the VTAP. (VNIC, NETWORK_LOAD_BALANCER, IP_ADDRESS)
timeCreatedstring (date-time)The date and time the VTAP was created, in the format defined by [RFC3339](https:​//tools.ietf.org/html/rfc3339). Example: 2020-08-25T21:10:29.600Z
trafficModestringUsed to control the priority of traffic. It is an optional field. If it not passed, the value is DEFAULT (DEFAULT, PRIORITY) (default: DEFAULT)
vcnIdstringThe [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VCN containing the Vtap resource.
vxlanNetworkIdentifierinteger (int64)The virtual extensible LAN (VXLAN) network identifier (or VXLAN segment ID) that uniquely identifies the VXLAN.

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
getselectvtapId, regionopc-request-idGets the specified Vtap resource.
listselectcompartmentId, regionvcnId, source, targetId, targetIp, isVtapEnabled, limit, page, opc-request-id, sortBy, sortOrder, displayName, lifecycleStateLists the virtual test access points (VTAPs) in the specified compartment.<br />
createinsertregion, compartmentId, vcnId, sourceId, captureFilterIdopc-retry-token, opc-request-idCreates a virtual test access point (VTAP) in the specified compartment.<br /><br />For the purposes of access control, you must provide the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains the VTAP.<br />For more information about compartments and access control, see<br />[Overview of the IAM Service](/iaas/Content/Identity/Concepts/overview.htm).<br />For information about OCIDs, see [Resource Identifiers](/iaas/Content/General/Concepts/identifiers.htm).<br /><br />You may optionally specify a display name for the VTAP, otherwise a default is provided.<br />It does not have to be unique, and you can change it.<br />
updateupdatevtapId, regionif-match, opc-request-idUpdates the specified VTAP's display name or tags.<br />
deletedeletevtapId, regionif-match, opc-request-idDeletes the specified VTAP. This is an asynchronous operation. The VTAP's lifecycleState will change to<br />TERMINATING temporarily until the VTAP is completely removed.<br />
change_compartmentexecvtapId, region, compartmentIdif-match, opc-request-id, opc-retry-tokenMoves a VTAP to a new compartment within the same tenancy. For information<br />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)
vtapIdstringThe [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VTAP.
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.
isVtapEnabledbooleanIndicates whether to list all VTAPs or only running VTAPs. * When FALSE, lists ALL running and stopped VTAPs. * When TRUE, lists only running VTAPs (VTAPs where isVtapEnabled = TRUE).
lifecycleStatestringA filter to return only resources that match the given VTAP administrative 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.
sourcestringThe [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VTAP source.
targetIdstringThe [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VTAP target.
targetIpstringThe IP address of the VTAP target.
vcnIdstringThe [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VCN.

SELECT examples​

Gets the specified Vtap resource.

SELECT
id,
captureFilterId,
compartmentId,
definedTags,
displayName,
encapsulationProtocol,
freeformTags,
isVtapEnabled,
lifecycleState,
lifecycleStateDetails,
maxPacketSize,
sourceId,
sourcePrivateEndpointIp,
sourcePrivateEndpointSubnetId,
sourceType,
targetId,
targetIp,
targetType,
timeCreated,
trafficMode,
vcnId,
vxlanNetworkIdentifier
FROM oci.network.vtaps
WHERE vtapId = '{{ vtapId }}' -- required
AND region = '{{ region }}' -- required
AND opc-request-id = '{{ opc-request-id }}'
;

INSERT examples​

Creates a virtual test access point (VTAP) in the specified compartment.<br /><br />For the purposes of access control, you must provide the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains the VTAP.<br />For more information about compartments and access control, see<br />[Overview of the IAM Service](/iaas/Content/Identity/Concepts/overview.htm).<br />For information about OCIDs, see [Resource Identifiers](/iaas/Content/General/Concepts/identifiers.htm).<br /><br />You may optionally specify a display name for the VTAP, otherwise a default is provided.<br />It does not have to be unique, and you can change it.<br />

INSERT INTO oci.network.vtaps (
captureFilterId,
compartmentId,
definedTags,
displayName,
encapsulationProtocol,
freeformTags,
isVtapEnabled,
maxPacketSize,
sourceId,
sourcePrivateEndpointIp,
sourcePrivateEndpointSubnetId,
sourceType,
targetId,
targetIp,
targetType,
trafficMode,
vcnId,
vxlanNetworkIdentifier,
region,
opc-retry-token,
opc-request-id
)
SELECT 
'{{ captureFilterId }}' /* required */,
'{{ compartmentId }}' /* required */,
'{{ definedTags }}',
'{{ displayName }}',
'{{ encapsulationProtocol }}',
'{{ freeformTags }}',
{{ isVtapEnabled }},
{{ maxPacketSize }},
'{{ sourceId }}' /* required */,
'{{ sourcePrivateEndpointIp }}',
'{{ sourcePrivateEndpointSubnetId }}',
'{{ sourceType }}',
'{{ targetId }}',
'{{ targetIp }}',
'{{ targetType }}',
'{{ trafficMode }}',
'{{ vcnId }}' /* required */,
{{ vxlanNetworkIdentifier }},
'{{ region }}',
'{{ opc-retry-token }}',
'{{ opc-request-id }}'
RETURNING
id,
captureFilterId,
compartmentId,
definedTags,
displayName,
encapsulationProtocol,
freeformTags,
isVtapEnabled,
lifecycleState,
lifecycleStateDetails,
maxPacketSize,
sourceId,
sourcePrivateEndpointIp,
sourcePrivateEndpointSubnetId,
sourceType,
targetId,
targetIp,
targetType,
timeCreated,
trafficMode,
vcnId,
vxlanNetworkIdentifier
;

UPDATE examples​

Updates the specified VTAP's display name or tags.<br />

UPDATE oci.network.vtaps
SET 
captureFilterId = '{{ captureFilterId }}',
definedTags = '{{ definedTags }}',
displayName = '{{ displayName }}',
encapsulationProtocol = '{{ encapsulationProtocol }}',
freeformTags = '{{ freeformTags }}',
isVtapEnabled = {{ isVtapEnabled }},
maxPacketSize = {{ maxPacketSize }},
sourceId = '{{ sourceId }}',
sourcePrivateEndpointIp = '{{ sourcePrivateEndpointIp }}',
sourcePrivateEndpointSubnetId = '{{ sourcePrivateEndpointSubnetId }}',
sourceType = '{{ sourceType }}',
targetId = '{{ targetId }}',
targetIp = '{{ targetIp }}',
targetType = '{{ targetType }}',
trafficMode = '{{ trafficMode }}',
vxlanNetworkIdentifier = {{ vxlanNetworkIdentifier }}
WHERE 
vtapId = '{{ vtapId }}' --required
AND region = '{{ region }}' --required
AND if-match = '{{ if-match}}'
AND opc-request-id = '{{ opc-request-id}}'
RETURNING
id,
captureFilterId,
compartmentId,
definedTags,
displayName,
encapsulationProtocol,
freeformTags,
isVtapEnabled,
lifecycleState,
lifecycleStateDetails,
maxPacketSize,
sourceId,
sourcePrivateEndpointIp,
sourcePrivateEndpointSubnetId,
sourceType,
targetId,
targetIp,
targetType,
timeCreated,
trafficMode,
vcnId,
vxlanNetworkIdentifier;

DELETE examples​

Deletes the specified VTAP. This is an asynchronous operation. The VTAP's lifecycleState will change to<br />TERMINATING temporarily until the VTAP is completely removed.<br />

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

Lifecycle Methods​

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

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