1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. Core
  5. getVtap
Oracle Cloud Infrastructure v2.30.0 published on Monday, Apr 14, 2025 by Pulumi

oci.Core.getVtap

Explore with Pulumi AI

Oracle Cloud Infrastructure v2.30.0 published on Monday, Apr 14, 2025 by Pulumi

This data source provides details about a specific Vtap resource in Oracle Cloud Infrastructure Core service.

Gets the specified Vtap resource.

Example Usage

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

const testVtap = oci.Core.getVtap({
    vtapId: testVtapOciCoreVtap.id,
});
Copy
import pulumi
import pulumi_oci as oci

test_vtap = oci.Core.get_vtap(vtap_id=test_vtap_oci_core_vtap["id"])
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.GetVtap(ctx, &core.GetVtapArgs{
			VtapId: testVtapOciCoreVtap.Id,
		}, nil)
		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 = Oci.Core.GetVtap.Invoke(new()
    {
        VtapId = testVtapOciCoreVtap.Id,
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.Core.CoreFunctions;
import com.pulumi.oci.Core.inputs.GetVtapArgs;
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) {
        final var testVtap = CoreFunctions.getVtap(GetVtapArgs.builder()
            .vtapId(testVtapOciCoreVtap.id())
            .build());

    }
}
Copy
variables:
  testVtap:
    fn::invoke:
      function: oci:Core:getVtap
      arguments:
        vtapId: ${testVtapOciCoreVtap.id}
Copy

Using getVtap

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getVtap(args: GetVtapArgs, opts?: InvokeOptions): Promise<GetVtapResult>
function getVtapOutput(args: GetVtapOutputArgs, opts?: InvokeOptions): Output<GetVtapResult>
Copy
def get_vtap(vtap_id: Optional[str] = None,
             opts: Optional[InvokeOptions] = None) -> GetVtapResult
def get_vtap_output(vtap_id: Optional[pulumi.Input[str]] = None,
             opts: Optional[InvokeOptions] = None) -> Output[GetVtapResult]
Copy
func GetVtap(ctx *Context, args *GetVtapArgs, opts ...InvokeOption) (*GetVtapResult, error)
func GetVtapOutput(ctx *Context, args *GetVtapOutputArgs, opts ...InvokeOption) GetVtapResultOutput
Copy

> Note: This function is named GetVtap in the Go SDK.

public static class GetVtap 
{
    public static Task<GetVtapResult> InvokeAsync(GetVtapArgs args, InvokeOptions? opts = null)
    public static Output<GetVtapResult> Invoke(GetVtapInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetVtapResult> getVtap(GetVtapArgs args, InvokeOptions options)
public static Output<GetVtapResult> getVtap(GetVtapArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: oci:Core/getVtap:getVtap
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

VtapId This property is required. string
The OCID of the VTAP.
VtapId This property is required. string
The OCID of the VTAP.
vtapId This property is required. String
The OCID of the VTAP.
vtapId This property is required. string
The OCID of the VTAP.
vtap_id This property is required. str
The OCID of the VTAP.
vtapId This property is required. String
The OCID of the VTAP.

getVtap Result

The following output properties are available:

CaptureFilterId string
The capture filter's Oracle ID (OCID).
CompartmentId string
The OCID of the compartment containing the Vtap resource.
DefinedTags Dictionary<string, string>
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
A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
EncapsulationProtocol string
Defines an encapsulation header type for the VTAP's mirrored traffic.
FreeformTags Dictionary<string, string>
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 VTAP's Oracle ID (OCID).
IsVtapEnabled bool
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
The maximum size of the packets to be included in the filter.
SourceId string
The OCID of the source point where packets are captured.
SourcePrivateEndpointIp string
The IP Address of the source private endpoint.
SourcePrivateEndpointSubnetId string
The OCID of the subnet that source private endpoint belongs to.
SourceType string
The source type for the VTAP.
State string
The VTAP's administrative lifecycle state.
TargetId string
The OCID of the destination resource where mirrored packets are sent.
TargetIp string
The IP address of the destination resource where mirrored packets are sent.
TargetType string
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
Used to control the priority of traffic. It is an optional field. If it not passed, the value is DEFAULT
VcnId string
The OCID of the VCN containing the Vtap resource.
VtapId string
VxlanNetworkIdentifier string
The virtual extensible LAN (VXLAN) network identifier (or VXLAN segment ID) that uniquely identifies the VXLAN.
CaptureFilterId string
The capture filter's Oracle ID (OCID).
CompartmentId string
The OCID of the compartment containing the Vtap resource.
DefinedTags map[string]string
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
A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
EncapsulationProtocol string
Defines an encapsulation header type for the VTAP's mirrored traffic.
FreeformTags map[string]string
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 VTAP's Oracle ID (OCID).
IsVtapEnabled bool
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
The maximum size of the packets to be included in the filter.
SourceId string
The OCID of the source point where packets are captured.
SourcePrivateEndpointIp string
The IP Address of the source private endpoint.
SourcePrivateEndpointSubnetId string
The OCID of the subnet that source private endpoint belongs to.
SourceType string
The source type for the VTAP.
State string
The VTAP's administrative lifecycle state.
TargetId string
The OCID of the destination resource where mirrored packets are sent.
TargetIp string
The IP address of the destination resource where mirrored packets are sent.
TargetType string
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
Used to control the priority of traffic. It is an optional field. If it not passed, the value is DEFAULT
VcnId string
The OCID of the VCN containing the Vtap resource.
VtapId string
VxlanNetworkIdentifier string
The virtual extensible LAN (VXLAN) network identifier (or VXLAN segment ID) that uniquely identifies the VXLAN.
captureFilterId String
The capture filter's Oracle ID (OCID).
compartmentId String
The OCID of the compartment containing the Vtap resource.
definedTags Map<String,String>
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
A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
encapsulationProtocol String
Defines an encapsulation header type for the VTAP's mirrored traffic.
freeformTags Map<String,String>
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 VTAP's Oracle ID (OCID).
isVtapEnabled Boolean
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
The maximum size of the packets to be included in the filter.
sourceId String
The OCID of the source point where packets are captured.
sourcePrivateEndpointIp String
The IP Address of the source private endpoint.
sourcePrivateEndpointSubnetId String
The OCID of the subnet that source private endpoint belongs to.
sourceType String
The source type for the VTAP.
state String
The VTAP's administrative lifecycle state.
targetId String
The OCID of the destination resource where mirrored packets are sent.
targetIp String
The IP address of the destination resource where mirrored packets are sent.
targetType String
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
Used to control the priority of traffic. It is an optional field. If it not passed, the value is DEFAULT
vcnId String
The OCID of the VCN containing the Vtap resource.
vtapId String
vxlanNetworkIdentifier String
The virtual extensible LAN (VXLAN) network identifier (or VXLAN segment ID) that uniquely identifies the VXLAN.
captureFilterId string
The capture filter's Oracle ID (OCID).
compartmentId string
The OCID of the compartment containing the Vtap resource.
definedTags {[key: string]: string}
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
A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
encapsulationProtocol string
Defines an encapsulation header type for the VTAP's mirrored traffic.
freeformTags {[key: string]: string}
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 VTAP's Oracle ID (OCID).
isVtapEnabled boolean
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
The maximum size of the packets to be included in the filter.
sourceId string
The OCID of the source point where packets are captured.
sourcePrivateEndpointIp string
The IP Address of the source private endpoint.
sourcePrivateEndpointSubnetId string
The OCID of the subnet that source private endpoint belongs to.
sourceType string
The source type for the VTAP.
state string
The VTAP's administrative lifecycle state.
targetId string
The OCID of the destination resource where mirrored packets are sent.
targetIp string
The IP address of the destination resource where mirrored packets are sent.
targetType string
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
Used to control the priority of traffic. It is an optional field. If it not passed, the value is DEFAULT
vcnId string
The OCID of the VCN containing the Vtap resource.
vtapId string
vxlanNetworkIdentifier string
The virtual extensible LAN (VXLAN) network identifier (or VXLAN segment ID) that uniquely identifies the VXLAN.
capture_filter_id str
The capture filter's Oracle ID (OCID).
compartment_id str
The OCID of the compartment containing the Vtap resource.
defined_tags Mapping[str, str]
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
A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
encapsulation_protocol str
Defines an encapsulation header type for the VTAP's mirrored traffic.
freeform_tags Mapping[str, str]
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 str
The VTAP's Oracle ID (OCID).
is_vtap_enabled bool
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
The maximum size of the packets to be included in the filter.
source_id str
The OCID of the source point where packets are captured.
source_private_endpoint_ip str
The IP Address of the source private endpoint.
source_private_endpoint_subnet_id str
The OCID of the subnet that source private endpoint belongs to.
source_type str
The source type for the VTAP.
state str
The VTAP's administrative lifecycle state.
target_id str
The OCID of the destination resource where mirrored packets are sent.
target_ip str
The IP address of the destination resource where mirrored packets are sent.
target_type str
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
Used to control the priority of traffic. It is an optional field. If it not passed, the value is DEFAULT
vcn_id str
The OCID of the VCN containing the Vtap resource.
vtap_id str
vxlan_network_identifier str
The virtual extensible LAN (VXLAN) network identifier (or VXLAN segment ID) that uniquely identifies the VXLAN.
captureFilterId String
The capture filter's Oracle ID (OCID).
compartmentId String
The OCID of the compartment containing the Vtap resource.
definedTags Map<String>
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
A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
encapsulationProtocol String
Defines an encapsulation header type for the VTAP's mirrored traffic.
freeformTags Map<String>
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 VTAP's Oracle ID (OCID).
isVtapEnabled Boolean
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
The maximum size of the packets to be included in the filter.
sourceId String
The OCID of the source point where packets are captured.
sourcePrivateEndpointIp String
The IP Address of the source private endpoint.
sourcePrivateEndpointSubnetId String
The OCID of the subnet that source private endpoint belongs to.
sourceType String
The source type for the VTAP.
state String
The VTAP's administrative lifecycle state.
targetId String
The OCID of the destination resource where mirrored packets are sent.
targetIp String
The IP address of the destination resource where mirrored packets are sent.
targetType String
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
Used to control the priority of traffic. It is an optional field. If it not passed, the value is DEFAULT
vcnId String
The OCID of the VCN containing the Vtap resource.
vtapId String
vxlanNetworkIdentifier String
The virtual extensible LAN (VXLAN) network identifier (or VXLAN segment ID) that uniquely identifies the VXLAN.

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.30.0 published on Monday, Apr 14, 2025 by Pulumi