Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. Core
  5. Vtap
Oracle Cloud Infrastructure v2.32.0 published on Thursday, Apr 24, 2025 by Pulumi
pulumi/pulumi-oci

oci.Core.Vtap

Explore with Pulumi AI

Oracle Cloud Infrastructure v2.32.0 published on Thursday, Apr 24, 2025 by Pulumi
pulumi/pulumi-oci

This resource provides the Vtap resource in Oracle Cloud Infrastructure Core service.

Creates a virtual test access point (VTAP) in the specified compartment.

For the purposes of access control, you must provide the OCID of the compartment that contains the VTAP. For more information about compartments and access control, see Overview of the IAM Service. For information about OCIDs, see Resource Identifiers.

You may optionally specify a display name for the VTAP, otherwise a default is provided. It does not have to be unique, and you can change it.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";

const testVtap = new oci.core.Vtap("test_vtap", {
    captureFilterId: testCaptureFilter.id,
    compartmentId: compartmentId,
    sourceId: testSource.id,
    vcnId: testVcn.id,
    definedTags: {
        "Operations.CostCenter": "42",
    },
    displayName: vtapDisplayName,
    encapsulationProtocol: vtapEncapsulationProtocol,
    freeformTags: {
        Department: "Finance",
    },
    isVtapEnabled: vtapIsVtapEnabled,
    maxPacketSize: vtapMaxPacketSize,
    sourcePrivateEndpointIp: vtapSourcePrivateEndpointIp,
    sourcePrivateEndpointSubnetId: testSubnet.id,
    sourceType: vtapSourceType,
    targetId: testTarget.id,
    targetIp: vtapTargetIp,
    targetType: vtapTargetType,
    trafficMode: vtapTrafficMode,
    vxlanNetworkIdentifier: vtapVxlanNetworkIdentifier,
});
Copy
import pulumi
import pulumi_oci as oci

test_vtap = oci.core.Vtap("test_vtap",
    capture_filter_id=test_capture_filter["id"],
    compartment_id=compartment_id,
    source_id=test_source["id"],
    vcn_id=test_vcn["id"],
    defined_tags={
        "Operations.CostCenter": "42",
    },
    display_name=vtap_display_name,
    encapsulation_protocol=vtap_encapsulation_protocol,
    freeform_tags={
        "Department": "Finance",
    },
    is_vtap_enabled=vtap_is_vtap_enabled,
    max_packet_size=vtap_max_packet_size,
    source_private_endpoint_ip=vtap_source_private_endpoint_ip,
    source_private_endpoint_subnet_id=test_subnet["id"],
    source_type=vtap_source_type,
    target_id=test_target["id"],
    target_ip=vtap_target_ip,
    target_type=vtap_target_type,
    traffic_mode=vtap_traffic_mode,
    vxlan_network_identifier=vtap_vxlan_network_identifier)
Copy
package main

import (
	"github.com/pulumi/pulumi-oci/sdk/v2/go/oci/core"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := core.NewVtap(ctx, "test_vtap", &core.VtapArgs{
			CaptureFilterId: pulumi.Any(testCaptureFilter.Id),
			CompartmentId:   pulumi.Any(compartmentId),
			SourceId:        pulumi.Any(testSource.Id),
			VcnId:           pulumi.Any(testVcn.Id),
			DefinedTags: pulumi.StringMap{
				"Operations.CostCenter": pulumi.String("42"),
			},
			DisplayName:           pulumi.Any(vtapDisplayName),
			EncapsulationProtocol: pulumi.Any(vtapEncapsulationProtocol),
			FreeformTags: pulumi.StringMap{
				"Department": pulumi.String("Finance"),
			},
			IsVtapEnabled:                 pulumi.Any(vtapIsVtapEnabled),
			MaxPacketSize:                 pulumi.Any(vtapMaxPacketSize),
			SourcePrivateEndpointIp:       pulumi.Any(vtapSourcePrivateEndpointIp),
			SourcePrivateEndpointSubnetId: pulumi.Any(testSubnet.Id),
			SourceType:                    pulumi.Any(vtapSourceType),
			TargetId:                      pulumi.Any(testTarget.Id),
			TargetIp:                      pulumi.Any(vtapTargetIp),
			TargetType:                    pulumi.Any(vtapTargetType),
			TrafficMode:                   pulumi.Any(vtapTrafficMode),
			VxlanNetworkIdentifier:        pulumi.Any(vtapVxlanNetworkIdentifier),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Oci = Pulumi.Oci;

return await Deployment.RunAsync(() => 
{
    var testVtap = new Oci.Core.Vtap("test_vtap", new()
    {
        CaptureFilterId = testCaptureFilter.Id,
        CompartmentId = compartmentId,
        SourceId = testSource.Id,
        VcnId = testVcn.Id,
        DefinedTags = 
        {
            { "Operations.CostCenter", "42" },
        },
        DisplayName = vtapDisplayName,
        EncapsulationProtocol = vtapEncapsulationProtocol,
        FreeformTags = 
        {
            { "Department", "Finance" },
        },
        IsVtapEnabled = vtapIsVtapEnabled,
        MaxPacketSize = vtapMaxPacketSize,
        SourcePrivateEndpointIp = vtapSourcePrivateEndpointIp,
        SourcePrivateEndpointSubnetId = testSubnet.Id,
        SourceType = vtapSourceType,
        TargetId = testTarget.Id,
        TargetIp = vtapTargetIp,
        TargetType = vtapTargetType,
        TrafficMode = vtapTrafficMode,
        VxlanNetworkIdentifier = vtapVxlanNetworkIdentifier,
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.Core.Vtap;
import com.pulumi.oci.Core.VtapArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var testVtap = new Vtap("testVtap", VtapArgs.builder()
            .captureFilterId(testCaptureFilter.id())
            .compartmentId(compartmentId)
            .sourceId(testSource.id())
            .vcnId(testVcn.id())
            .definedTags(Map.of("Operations.CostCenter", "42"))
            .displayName(vtapDisplayName)
            .encapsulationProtocol(vtapEncapsulationProtocol)
            .freeformTags(Map.of("Department", "Finance"))
            .isVtapEnabled(vtapIsVtapEnabled)
            .maxPacketSize(vtapMaxPacketSize)
            .sourcePrivateEndpointIp(vtapSourcePrivateEndpointIp)
            .sourcePrivateEndpointSubnetId(testSubnet.id())
            .sourceType(vtapSourceType)
            .targetId(testTarget.id())
            .targetIp(vtapTargetIp)
            .targetType(vtapTargetType)
            .trafficMode(vtapTrafficMode)
            .vxlanNetworkIdentifier(vtapVxlanNetworkIdentifier)
            .build());

    }
}
Copy
resources:
  testVtap:
    type: oci:Core:Vtap
    name: test_vtap
    properties:
      captureFilterId: ${testCaptureFilter.id}
      compartmentId: ${compartmentId}
      sourceId: ${testSource.id}
      vcnId: ${testVcn.id}
      definedTags:
        Operations.CostCenter: '42'
      displayName: ${vtapDisplayName}
      encapsulationProtocol: ${vtapEncapsulationProtocol}
      freeformTags:
        Department: Finance
      isVtapEnabled: ${vtapIsVtapEnabled}
      maxPacketSize: ${vtapMaxPacketSize}
      sourcePrivateEndpointIp: ${vtapSourcePrivateEndpointIp}
      sourcePrivateEndpointSubnetId: ${testSubnet.id}
      sourceType: ${vtapSourceType}
      targetId: ${testTarget.id}
      targetIp: ${vtapTargetIp}
      targetType: ${vtapTargetType}
      trafficMode: ${vtapTrafficMode}
      vxlanNetworkIdentifier: ${vtapVxlanNetworkIdentifier}
Copy

Create Vtap Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new Vtap(name: string, args: VtapArgs, opts?: CustomResourceOptions);
@overload
def Vtap(resource_name: str,
         args: VtapArgs,
         opts: Optional[ResourceOptions] = None)

@overload
def Vtap(resource_name: str,
         opts: Optional[ResourceOptions] = None,
         capture_filter_id: Optional[str] = None,
         compartment_id: Optional[str] = None,
         vcn_id: Optional[str] = None,
         source_id: Optional[str] = None,
         encapsulation_protocol: Optional[str] = None,
         source_type: Optional[str] = None,
         is_vtap_enabled: Optional[bool] = None,
         max_packet_size: Optional[int] = None,
         display_name: Optional[str] = None,
         source_private_endpoint_ip: Optional[str] = None,
         source_private_endpoint_subnet_id: Optional[str] = None,
         freeform_tags: Optional[Mapping[str, str]] = None,
         target_id: Optional[str] = None,
         target_ip: Optional[str] = None,
         target_type: Optional[str] = None,
         traffic_mode: Optional[str] = None,
         defined_tags: Optional[Mapping[str, str]] = None,
         vxlan_network_identifier: Optional[str] = None)
func NewVtap(ctx *Context, name string, args VtapArgs, opts ...ResourceOption) (*Vtap, error)
public Vtap(string name, VtapArgs args, CustomResourceOptions? opts = null)
public Vtap(String name, VtapArgs args)
public Vtap(String name, VtapArgs args, CustomResourceOptions options)

type: oci:Core:Vtap
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. VtapArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. VtapArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. VtapArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. VtapArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. VtapArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var vtapResource = new Oci.Core.Vtap("vtapResource", new()
{
    CaptureFilterId = "string",
    CompartmentId = "string",
    VcnId = "string",
    SourceId = "string",
    EncapsulationProtocol = "string",
    SourceType = "string",
    IsVtapEnabled = false,
    MaxPacketSize = 0,
    DisplayName = "string",
    SourcePrivateEndpointIp = "string",
    SourcePrivateEndpointSubnetId = "string",
    FreeformTags = 
    {
        { "string", "string" },
    },
    TargetId = "string",
    TargetIp = "string",
    TargetType = "string",
    TrafficMode = "string",
    DefinedTags = 
    {
        { "string", "string" },
    },
    VxlanNetworkIdentifier = "string",
});
Copy
example, err := core.NewVtap(ctx, "vtapResource", &core.VtapArgs{
	CaptureFilterId:               pulumi.String("string"),
	CompartmentId:                 pulumi.String("string"),
	VcnId:                         pulumi.String("string"),
	SourceId:                      pulumi.String("string"),
	EncapsulationProtocol:         pulumi.String("string"),
	SourceType:                    pulumi.String("string"),
	IsVtapEnabled:                 pulumi.Bool(false),
	MaxPacketSize:                 pulumi.Int(0),
	DisplayName:                   pulumi.String("string"),
	SourcePrivateEndpointIp:       pulumi.String("string"),
	SourcePrivateEndpointSubnetId: pulumi.String("string"),
	FreeformTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	TargetId:    pulumi.String("string"),
	TargetIp:    pulumi.String("string"),
	TargetType:  pulumi.String("string"),
	TrafficMode: pulumi.String("string"),
	DefinedTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	VxlanNetworkIdentifier: pulumi.String("string"),
})
Copy
var vtapResource = new Vtap("vtapResource", VtapArgs.builder()
    .captureFilterId("string")
    .compartmentId("string")
    .vcnId("string")
    .sourceId("string")
    .encapsulationProtocol("string")
    .sourceType("string")
    .isVtapEnabled(false)
    .maxPacketSize(0)
    .displayName("string")
    .sourcePrivateEndpointIp("string")
    .sourcePrivateEndpointSubnetId("string")
    .freeformTags(Map.of("string", "string"))
    .targetId("string")
    .targetIp("string")
    .targetType("string")
    .trafficMode("string")
    .definedTags(Map.of("string", "string"))
    .vxlanNetworkIdentifier("string")
    .build());
Copy
vtap_resource = oci.core.Vtap("vtapResource",
    capture_filter_id="string",
    compartment_id="string",
    vcn_id="string",
    source_id="string",
    encapsulation_protocol="string",
    source_type="string",
    is_vtap_enabled=False,
    max_packet_size=0,
    display_name="string",
    source_private_endpoint_ip="string",
    source_private_endpoint_subnet_id="string",
    freeform_tags={
        "string": "string",
    },
    target_id="string",
    target_ip="string",
    target_type="string",
    traffic_mode="string",
    defined_tags={
        "string": "string",
    },
    vxlan_network_identifier="string")
Copy
const vtapResource = new oci.core.Vtap("vtapResource", {
    captureFilterId: "string",
    compartmentId: "string",
    vcnId: "string",
    sourceId: "string",
    encapsulationProtocol: "string",
    sourceType: "string",
    isVtapEnabled: false,
    maxPacketSize: 0,
    displayName: "string",
    sourcePrivateEndpointIp: "string",
    sourcePrivateEndpointSubnetId: "string",
    freeformTags: {
        string: "string",
    },
    targetId: "string",
    targetIp: "string",
    targetType: "string",
    trafficMode: "string",
    definedTags: {
        string: "string",
    },
    vxlanNetworkIdentifier: "string",
});
Copy
type: oci:Core:Vtap
properties:
    captureFilterId: string
    compartmentId: string
    definedTags:
        string: string
    displayName: string
    encapsulationProtocol: string
    freeformTags:
        string: string
    isVtapEnabled: false
    maxPacketSize: 0
    sourceId: string
    sourcePrivateEndpointIp: string
    sourcePrivateEndpointSubnetId: string
    sourceType: string
    targetId: string
    targetIp: string
    targetType: string
    trafficMode: string
    vcnId: string
    vxlanNetworkIdentifier: string
Copy

Vtap Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The Vtap resource accepts the following input properties:

CaptureFilterId This property is required. string
(Updatable) The capture filter's Oracle ID (OCID).
CompartmentId This property is required. string
(Updatable) The OCID of the compartment containing the Vtap resource.
SourceId This property is required. string
(Updatable) The OCID of the source point where packets are captured.
VcnId
This property is required.
Changes to this property will trigger replacement.
string
The OCID of the VCN containing the Vtap resource.
DefinedTags Dictionary<string, string>
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
DisplayName string
(Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
EncapsulationProtocol string
(Updatable) Defines an encapsulation header type for the VTAP's mirrored traffic.
FreeformTags Dictionary<string, string>
(Updatable) 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"}
IsVtapEnabled bool
(Updatable) Used to start or stop a Vtap resource.

  • TRUE directs the VTAP to start mirroring traffic.
  • FALSE (Default) directs the VTAP to stop mirroring traffic.
MaxPacketSize int
(Updatable) The maximum size of the packets to be included in the filter.
SourcePrivateEndpointIp string
(Updatable) The IP Address of the source private endpoint.
SourcePrivateEndpointSubnetId string
(Updatable) The OCID of the subnet that source private endpoint belongs to.
SourceType string
(Updatable) The source type for the VTAP.
TargetId string
(Updatable) The OCID of the destination resource where mirrored packets are sent.
TargetIp string
(Updatable) The IP address of the destination resource where mirrored packets are sent.
TargetType string
(Updatable) The target type for the VTAP.
TrafficMode string
(Updatable) Used to control the priority of traffic. It is an optional field. If it not passed, the value is DEFAULT
VxlanNetworkIdentifier string

(Updatable) The virtual extensible LAN (VXLAN) network identifier (or VXLAN segment ID) that uniquely identifies the VXLAN.

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

CaptureFilterId This property is required. string
(Updatable) The capture filter's Oracle ID (OCID).
CompartmentId This property is required. string
(Updatable) The OCID of the compartment containing the Vtap resource.
SourceId This property is required. string
(Updatable) The OCID of the source point where packets are captured.
VcnId
This property is required.
Changes to this property will trigger replacement.
string
The OCID of the VCN containing the Vtap resource.
DefinedTags map[string]string
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
DisplayName string
(Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
EncapsulationProtocol string
(Updatable) Defines an encapsulation header type for the VTAP's mirrored traffic.
FreeformTags map[string]string
(Updatable) 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"}
IsVtapEnabled bool
(Updatable) Used to start or stop a Vtap resource.

  • TRUE directs the VTAP to start mirroring traffic.
  • FALSE (Default) directs the VTAP to stop mirroring traffic.
MaxPacketSize int
(Updatable) The maximum size of the packets to be included in the filter.
SourcePrivateEndpointIp string
(Updatable) The IP Address of the source private endpoint.
SourcePrivateEndpointSubnetId string
(Updatable) The OCID of the subnet that source private endpoint belongs to.
SourceType string
(Updatable) The source type for the VTAP.
TargetId string
(Updatable) The OCID of the destination resource where mirrored packets are sent.
TargetIp string
(Updatable) The IP address of the destination resource where mirrored packets are sent.
TargetType string
(Updatable) The target type for the VTAP.
TrafficMode string
(Updatable) Used to control the priority of traffic. It is an optional field. If it not passed, the value is DEFAULT
VxlanNetworkIdentifier string

(Updatable) The virtual extensible LAN (VXLAN) network identifier (or VXLAN segment ID) that uniquely identifies the VXLAN.

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

captureFilterId This property is required. String
(Updatable) The capture filter's Oracle ID (OCID).
compartmentId This property is required. String
(Updatable) The OCID of the compartment containing the Vtap resource.
sourceId This property is required. String
(Updatable) The OCID of the source point where packets are captured.
vcnId
This property is required.
Changes to this property will trigger replacement.
String
The OCID of the VCN containing the Vtap resource.
definedTags Map<String,String>
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
displayName String
(Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
encapsulationProtocol String
(Updatable) Defines an encapsulation header type for the VTAP's mirrored traffic.
freeformTags Map<String,String>
(Updatable) 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"}
isVtapEnabled Boolean
(Updatable) Used to start or stop a Vtap resource.

  • TRUE directs the VTAP to start mirroring traffic.
  • FALSE (Default) directs the VTAP to stop mirroring traffic.
maxPacketSize Integer
(Updatable) The maximum size of the packets to be included in the filter.
sourcePrivateEndpointIp String
(Updatable) The IP Address of the source private endpoint.
sourcePrivateEndpointSubnetId String
(Updatable) The OCID of the subnet that source private endpoint belongs to.
sourceType String
(Updatable) The source type for the VTAP.
targetId String
(Updatable) The OCID of the destination resource where mirrored packets are sent.
targetIp String
(Updatable) The IP address of the destination resource where mirrored packets are sent.
targetType String
(Updatable) The target type for the VTAP.
trafficMode String
(Updatable) Used to control the priority of traffic. It is an optional field. If it not passed, the value is DEFAULT
vxlanNetworkIdentifier String

(Updatable) The virtual extensible LAN (VXLAN) network identifier (or VXLAN segment ID) that uniquely identifies the VXLAN.

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

captureFilterId This property is required. string
(Updatable) The capture filter's Oracle ID (OCID).
compartmentId This property is required. string
(Updatable) The OCID of the compartment containing the Vtap resource.
sourceId This property is required. string
(Updatable) The OCID of the source point where packets are captured.
vcnId
This property is required.
Changes to this property will trigger replacement.
string
The OCID of the VCN containing the Vtap resource.
definedTags {[key: string]: string}
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
displayName string
(Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
encapsulationProtocol string
(Updatable) Defines an encapsulation header type for the VTAP's mirrored traffic.
freeformTags {[key: string]: string}
(Updatable) 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"}
isVtapEnabled boolean
(Updatable) Used to start or stop a Vtap resource.

  • TRUE directs the VTAP to start mirroring traffic.
  • FALSE (Default) directs the VTAP to stop mirroring traffic.
maxPacketSize number
(Updatable) The maximum size of the packets to be included in the filter.
sourcePrivateEndpointIp string
(Updatable) The IP Address of the source private endpoint.
sourcePrivateEndpointSubnetId string
(Updatable) The OCID of the subnet that source private endpoint belongs to.
sourceType string
(Updatable) The source type for the VTAP.
targetId string
(Updatable) The OCID of the destination resource where mirrored packets are sent.
targetIp string
(Updatable) The IP address of the destination resource where mirrored packets are sent.
targetType string
(Updatable) The target type for the VTAP.
trafficMode string
(Updatable) Used to control the priority of traffic. It is an optional field. If it not passed, the value is DEFAULT
vxlanNetworkIdentifier string

(Updatable) The virtual extensible LAN (VXLAN) network identifier (or VXLAN segment ID) that uniquely identifies the VXLAN.

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

capture_filter_id This property is required. str
(Updatable) The capture filter's Oracle ID (OCID).
compartment_id This property is required. str
(Updatable) The OCID of the compartment containing the Vtap resource.
source_id This property is required. str
(Updatable) The OCID of the source point where packets are captured.
vcn_id
This property is required.
Changes to this property will trigger replacement.
str
The OCID of the VCN containing the Vtap resource.
defined_tags Mapping[str, str]
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
display_name str
(Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
encapsulation_protocol str
(Updatable) Defines an encapsulation header type for the VTAP's mirrored traffic.
freeform_tags Mapping[str, str]
(Updatable) 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"}
is_vtap_enabled bool
(Updatable) Used to start or stop a Vtap resource.

  • TRUE directs the VTAP to start mirroring traffic.
  • FALSE (Default) directs the VTAP to stop mirroring traffic.
max_packet_size int
(Updatable) The maximum size of the packets to be included in the filter.
source_private_endpoint_ip str
(Updatable) The IP Address of the source private endpoint.
source_private_endpoint_subnet_id str
(Updatable) The OCID of the subnet that source private endpoint belongs to.
source_type str
(Updatable) The source type for the VTAP.
target_id str
(Updatable) The OCID of the destination resource where mirrored packets are sent.
target_ip str
(Updatable) The IP address of the destination resource where mirrored packets are sent.
target_type str
(Updatable) The target type for the VTAP.
traffic_mode str
(Updatable) Used to control the priority of traffic. It is an optional field. If it not passed, the value is DEFAULT
vxlan_network_identifier str

(Updatable) The virtual extensible LAN (VXLAN) network identifier (or VXLAN segment ID) that uniquely identifies the VXLAN.

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

captureFilterId This property is required. String
(Updatable) The capture filter's Oracle ID (OCID).
compartmentId This property is required. String
(Updatable) The OCID of the compartment containing the Vtap resource.
sourceId This property is required. String
(Updatable) The OCID of the source point where packets are captured.
vcnId
This property is required.
Changes to this property will trigger replacement.
String
The OCID of the VCN containing the Vtap resource.
definedTags Map<String>
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
displayName String
(Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
encapsulationProtocol String
(Updatable) Defines an encapsulation header type for the VTAP's mirrored traffic.
freeformTags Map<String>
(Updatable) 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"}
isVtapEnabled Boolean
(Updatable) Used to start or stop a Vtap resource.

  • TRUE directs the VTAP to start mirroring traffic.
  • FALSE (Default) directs the VTAP to stop mirroring traffic.
maxPacketSize Number
(Updatable) The maximum size of the packets to be included in the filter.
sourcePrivateEndpointIp String
(Updatable) The IP Address of the source private endpoint.
sourcePrivateEndpointSubnetId String
(Updatable) The OCID of the subnet that source private endpoint belongs to.
sourceType String
(Updatable) The source type for the VTAP.
targetId String
(Updatable) The OCID of the destination resource where mirrored packets are sent.
targetIp String
(Updatable) The IP address of the destination resource where mirrored packets are sent.
targetType String
(Updatable) The target type for the VTAP.
trafficMode String
(Updatable) Used to control the priority of traffic. It is an optional field. If it not passed, the value is DEFAULT
vxlanNetworkIdentifier String

(Updatable) The virtual extensible LAN (VXLAN) network identifier (or VXLAN segment ID) that uniquely identifies the VXLAN.

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

Outputs

All input properties are implicitly available as output properties. Additionally, the Vtap resource produces the following output properties:

Id string
The provider-assigned unique ID for this managed resource.
LifecycleStateDetails string
The VTAP's current running state.
State string
The VTAP's administrative lifecycle state.
TimeCreated string
The date and time the VTAP was created, in the format defined by RFC3339. Example: 2020-08-25T21:10:29.600Z
Id string
The provider-assigned unique ID for this managed resource.
LifecycleStateDetails string
The VTAP's current running state.
State string
The VTAP's administrative lifecycle state.
TimeCreated string
The date and time the VTAP was created, in the format defined by RFC3339. Example: 2020-08-25T21:10:29.600Z
id String
The provider-assigned unique ID for this managed resource.
lifecycleStateDetails String
The VTAP's current running state.
state String
The VTAP's administrative lifecycle state.
timeCreated String
The date and time the VTAP was created, in the format defined by RFC3339. Example: 2020-08-25T21:10:29.600Z
id string
The provider-assigned unique ID for this managed resource.
lifecycleStateDetails string
The VTAP's current running state.
state string
The VTAP's administrative lifecycle state.
timeCreated string
The date and time the VTAP was created, in the format defined by RFC3339. Example: 2020-08-25T21:10:29.600Z
id str
The provider-assigned unique ID for this managed resource.
lifecycle_state_details str
The VTAP's current running state.
state str
The VTAP's administrative lifecycle state.
time_created str
The date and time the VTAP was created, in the format defined by RFC3339. Example: 2020-08-25T21:10:29.600Z
id String
The provider-assigned unique ID for this managed resource.
lifecycleStateDetails String
The VTAP's current running state.
state String
The VTAP's administrative lifecycle state.
timeCreated String
The date and time the VTAP was created, in the format defined by RFC3339. Example: 2020-08-25T21:10:29.600Z

Look up Existing Vtap Resource

Get an existing Vtap resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: VtapState, opts?: CustomResourceOptions): Vtap
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        capture_filter_id: Optional[str] = None,
        compartment_id: Optional[str] = None,
        defined_tags: Optional[Mapping[str, str]] = None,
        display_name: Optional[str] = None,
        encapsulation_protocol: Optional[str] = None,
        freeform_tags: Optional[Mapping[str, str]] = None,
        is_vtap_enabled: Optional[bool] = None,
        lifecycle_state_details: Optional[str] = None,
        max_packet_size: Optional[int] = None,
        source_id: Optional[str] = None,
        source_private_endpoint_ip: Optional[str] = None,
        source_private_endpoint_subnet_id: Optional[str] = None,
        source_type: Optional[str] = None,
        state: Optional[str] = None,
        target_id: Optional[str] = None,
        target_ip: Optional[str] = None,
        target_type: Optional[str] = None,
        time_created: Optional[str] = None,
        traffic_mode: Optional[str] = None,
        vcn_id: Optional[str] = None,
        vxlan_network_identifier: Optional[str] = None) -> Vtap
func GetVtap(ctx *Context, name string, id IDInput, state *VtapState, opts ...ResourceOption) (*Vtap, error)
public static Vtap Get(string name, Input<string> id, VtapState? state, CustomResourceOptions? opts = null)
public static Vtap get(String name, Output<String> id, VtapState state, CustomResourceOptions options)
resources:  _:    type: oci:Core:Vtap    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
CaptureFilterId string
(Updatable) The capture filter's Oracle ID (OCID).
CompartmentId string
(Updatable) The OCID of the compartment containing the Vtap resource.
DefinedTags Dictionary<string, string>
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
DisplayName string
(Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
EncapsulationProtocol string
(Updatable) Defines an encapsulation header type for the VTAP's mirrored traffic.
FreeformTags Dictionary<string, string>
(Updatable) 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"}
IsVtapEnabled bool
(Updatable) Used to start or stop a Vtap resource.

  • TRUE directs the VTAP to start mirroring traffic.
  • FALSE (Default) directs the VTAP to stop mirroring traffic.
LifecycleStateDetails string
The VTAP's current running state.
MaxPacketSize int
(Updatable) The maximum size of the packets to be included in the filter.
SourceId string
(Updatable) The OCID of the source point where packets are captured.
SourcePrivateEndpointIp string
(Updatable) The IP Address of the source private endpoint.
SourcePrivateEndpointSubnetId string
(Updatable) The OCID of the subnet that source private endpoint belongs to.
SourceType string
(Updatable) The source type for the VTAP.
State string
The VTAP's administrative lifecycle state.
TargetId string
(Updatable) The OCID of the destination resource where mirrored packets are sent.
TargetIp string
(Updatable) The IP address of the destination resource where mirrored packets are sent.
TargetType string
(Updatable) The target type for the VTAP.
TimeCreated string
The date and time the VTAP was created, in the format defined by RFC3339. Example: 2020-08-25T21:10:29.600Z
TrafficMode string
(Updatable) Used to control the priority of traffic. It is an optional field. If it not passed, the value is DEFAULT
VcnId Changes to this property will trigger replacement. string
The OCID of the VCN containing the Vtap resource.
VxlanNetworkIdentifier string

(Updatable) The virtual extensible LAN (VXLAN) network identifier (or VXLAN segment ID) that uniquely identifies the VXLAN.

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

CaptureFilterId string
(Updatable) The capture filter's Oracle ID (OCID).
CompartmentId string
(Updatable) The OCID of the compartment containing the Vtap resource.
DefinedTags map[string]string
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
DisplayName string
(Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
EncapsulationProtocol string
(Updatable) Defines an encapsulation header type for the VTAP's mirrored traffic.
FreeformTags map[string]string
(Updatable) 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"}
IsVtapEnabled bool
(Updatable) Used to start or stop a Vtap resource.

  • TRUE directs the VTAP to start mirroring traffic.
  • FALSE (Default) directs the VTAP to stop mirroring traffic.
LifecycleStateDetails string
The VTAP's current running state.
MaxPacketSize int
(Updatable) The maximum size of the packets to be included in the filter.
SourceId string
(Updatable) The OCID of the source point where packets are captured.
SourcePrivateEndpointIp string
(Updatable) The IP Address of the source private endpoint.
SourcePrivateEndpointSubnetId string
(Updatable) The OCID of the subnet that source private endpoint belongs to.
SourceType string
(Updatable) The source type for the VTAP.
State string
The VTAP's administrative lifecycle state.
TargetId string
(Updatable) The OCID of the destination resource where mirrored packets are sent.
TargetIp string
(Updatable) The IP address of the destination resource where mirrored packets are sent.
TargetType string
(Updatable) The target type for the VTAP.
TimeCreated string
The date and time the VTAP was created, in the format defined by RFC3339. Example: 2020-08-25T21:10:29.600Z
TrafficMode string
(Updatable) Used to control the priority of traffic. It is an optional field. If it not passed, the value is DEFAULT
VcnId Changes to this property will trigger replacement. string
The OCID of the VCN containing the Vtap resource.
VxlanNetworkIdentifier string

(Updatable) The virtual extensible LAN (VXLAN) network identifier (or VXLAN segment ID) that uniquely identifies the VXLAN.

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

captureFilterId String
(Updatable) The capture filter's Oracle ID (OCID).
compartmentId String
(Updatable) The OCID of the compartment containing the Vtap resource.
definedTags Map<String,String>
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
displayName String
(Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
encapsulationProtocol String
(Updatable) Defines an encapsulation header type for the VTAP's mirrored traffic.
freeformTags Map<String,String>
(Updatable) 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"}
isVtapEnabled Boolean
(Updatable) Used to start or stop a Vtap resource.

  • TRUE directs the VTAP to start mirroring traffic.
  • FALSE (Default) directs the VTAP to stop mirroring traffic.
lifecycleStateDetails String
The VTAP's current running state.
maxPacketSize Integer
(Updatable) The maximum size of the packets to be included in the filter.
sourceId String
(Updatable) The OCID of the source point where packets are captured.
sourcePrivateEndpointIp String
(Updatable) The IP Address of the source private endpoint.
sourcePrivateEndpointSubnetId String
(Updatable) The OCID of the subnet that source private endpoint belongs to.
sourceType String
(Updatable) The source type for the VTAP.
state String
The VTAP's administrative lifecycle state.
targetId String
(Updatable) The OCID of the destination resource where mirrored packets are sent.
targetIp String
(Updatable) The IP address of the destination resource where mirrored packets are sent.
targetType String
(Updatable) The target type for the VTAP.
timeCreated String
The date and time the VTAP was created, in the format defined by RFC3339. Example: 2020-08-25T21:10:29.600Z
trafficMode String
(Updatable) Used to control the priority of traffic. It is an optional field. If it not passed, the value is DEFAULT
vcnId Changes to this property will trigger replacement. String
The OCID of the VCN containing the Vtap resource.
vxlanNetworkIdentifier String

(Updatable) The virtual extensible LAN (VXLAN) network identifier (or VXLAN segment ID) that uniquely identifies the VXLAN.

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

captureFilterId string
(Updatable) The capture filter's Oracle ID (OCID).
compartmentId string
(Updatable) The OCID of the compartment containing the Vtap resource.
definedTags {[key: string]: string}
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
displayName string
(Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
encapsulationProtocol string
(Updatable) Defines an encapsulation header type for the VTAP's mirrored traffic.
freeformTags {[key: string]: string}
(Updatable) 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"}
isVtapEnabled boolean
(Updatable) Used to start or stop a Vtap resource.

  • TRUE directs the VTAP to start mirroring traffic.
  • FALSE (Default) directs the VTAP to stop mirroring traffic.
lifecycleStateDetails string
The VTAP's current running state.
maxPacketSize number
(Updatable) The maximum size of the packets to be included in the filter.
sourceId string
(Updatable) The OCID of the source point where packets are captured.
sourcePrivateEndpointIp string
(Updatable) The IP Address of the source private endpoint.
sourcePrivateEndpointSubnetId string
(Updatable) The OCID of the subnet that source private endpoint belongs to.
sourceType string
(Updatable) The source type for the VTAP.
state string
The VTAP's administrative lifecycle state.
targetId string
(Updatable) The OCID of the destination resource where mirrored packets are sent.
targetIp string
(Updatable) The IP address of the destination resource where mirrored packets are sent.
targetType string
(Updatable) The target type for the VTAP.
timeCreated string
The date and time the VTAP was created, in the format defined by RFC3339. Example: 2020-08-25T21:10:29.600Z
trafficMode string
(Updatable) Used to control the priority of traffic. It is an optional field. If it not passed, the value is DEFAULT
vcnId Changes to this property will trigger replacement. string
The OCID of the VCN containing the Vtap resource.
vxlanNetworkIdentifier string

(Updatable) The virtual extensible LAN (VXLAN) network identifier (or VXLAN segment ID) that uniquely identifies the VXLAN.

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

capture_filter_id str
(Updatable) The capture filter's Oracle ID (OCID).
compartment_id str
(Updatable) The OCID of the compartment containing the Vtap resource.
defined_tags Mapping[str, str]
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
display_name str
(Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
encapsulation_protocol str
(Updatable) Defines an encapsulation header type for the VTAP's mirrored traffic.
freeform_tags Mapping[str, str]
(Updatable) 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"}
is_vtap_enabled bool
(Updatable) Used to start or stop a Vtap resource.

  • TRUE directs the VTAP to start mirroring traffic.
  • FALSE (Default) directs the VTAP to stop mirroring traffic.
lifecycle_state_details str
The VTAP's current running state.
max_packet_size int
(Updatable) The maximum size of the packets to be included in the filter.
source_id str
(Updatable) The OCID of the source point where packets are captured.
source_private_endpoint_ip str
(Updatable) The IP Address of the source private endpoint.
source_private_endpoint_subnet_id str
(Updatable) The OCID of the subnet that source private endpoint belongs to.
source_type str
(Updatable) The source type for the VTAP.
state str
The VTAP's administrative lifecycle state.
target_id str
(Updatable) The OCID of the destination resource where mirrored packets are sent.
target_ip str
(Updatable) The IP address of the destination resource where mirrored packets are sent.
target_type str
(Updatable) The target type for the VTAP.
time_created str
The date and time the VTAP was created, in the format defined by RFC3339. Example: 2020-08-25T21:10:29.600Z
traffic_mode str
(Updatable) Used to control the priority of traffic. It is an optional field. If it not passed, the value is DEFAULT
vcn_id Changes to this property will trigger replacement. str
The OCID of the VCN containing the Vtap resource.
vxlan_network_identifier str

(Updatable) The virtual extensible LAN (VXLAN) network identifier (or VXLAN segment ID) that uniquely identifies the VXLAN.

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

captureFilterId String
(Updatable) The capture filter's Oracle ID (OCID).
compartmentId String
(Updatable) The OCID of the compartment containing the Vtap resource.
definedTags Map<String>
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
displayName String
(Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
encapsulationProtocol String
(Updatable) Defines an encapsulation header type for the VTAP's mirrored traffic.
freeformTags Map<String>
(Updatable) 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"}
isVtapEnabled Boolean
(Updatable) Used to start or stop a Vtap resource.

  • TRUE directs the VTAP to start mirroring traffic.
  • FALSE (Default) directs the VTAP to stop mirroring traffic.
lifecycleStateDetails String
The VTAP's current running state.
maxPacketSize Number
(Updatable) The maximum size of the packets to be included in the filter.
sourceId String
(Updatable) The OCID of the source point where packets are captured.
sourcePrivateEndpointIp String
(Updatable) The IP Address of the source private endpoint.
sourcePrivateEndpointSubnetId String
(Updatable) The OCID of the subnet that source private endpoint belongs to.
sourceType String
(Updatable) The source type for the VTAP.
state String
The VTAP's administrative lifecycle state.
targetId String
(Updatable) The OCID of the destination resource where mirrored packets are sent.
targetIp String
(Updatable) The IP address of the destination resource where mirrored packets are sent.
targetType String
(Updatable) The target type for the VTAP.
timeCreated String
The date and time the VTAP was created, in the format defined by RFC3339. Example: 2020-08-25T21:10:29.600Z
trafficMode String
(Updatable) Used to control the priority of traffic. It is an optional field. If it not passed, the value is DEFAULT
vcnId Changes to this property will trigger replacement. String
The OCID of the VCN containing the Vtap resource.
vxlanNetworkIdentifier String

(Updatable) The virtual extensible LAN (VXLAN) network identifier (or VXLAN segment ID) that uniquely identifies the VXLAN.

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

Import

Vtaps can be imported using the id, e.g.

$ pulumi import oci:Core/vtap:Vtap test_vtap "id"
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
oci pulumi/pulumi-oci
License
Apache-2.0
Notes
This Pulumi package is based on the oci Terraform Provider.
Oracle Cloud Infrastructure v2.32.0 published on Thursday, Apr 24, 2025 by Pulumi
pulumi/pulumi-oci