Oracle Cloud Infrastructure

v0.5.0 published on Monday, Sep 12, 2022 by Pulumi

getCaptureFilter

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

Gets information about the specified VTAP capture filter.

Example Usage

using System.Collections.Generic;
using Pulumi;
using Oci = Pulumi.Oci;

return await Deployment.RunAsync(() => 
{
    var testCaptureFilter = Oci.Core.GetCaptureFilter.Invoke(new()
    {
        CaptureFilterId = oci_core_capture_filter.Test_capture_filter.Id,
    });

});
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := Core.GetCaptureFilter(ctx, &core.GetCaptureFilterArgs{
			CaptureFilterId: oci_core_capture_filter.Test_capture_filter.Id,
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
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.GetCaptureFilterArgs;
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 testCaptureFilter = CoreFunctions.getCaptureFilter(GetCaptureFilterArgs.builder()
            .captureFilterId(oci_core_capture_filter.test_capture_filter().id())
            .build());

    }
}
import pulumi
import pulumi_oci as oci

test_capture_filter = oci.Core.get_capture_filter(capture_filter_id=oci_core_capture_filter["test_capture_filter"]["id"])
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";

const testCaptureFilter = oci.Core.getCaptureFilter({
    captureFilterId: oci_core_capture_filter.test_capture_filter.id,
});
variables:
  testCaptureFilter:
    Fn::Invoke:
      Function: oci:Core:getCaptureFilter
      Arguments:
        captureFilterId: ${oci_core_capture_filter.test_capture_filter.id}

Using getCaptureFilter

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 getCaptureFilter(args: GetCaptureFilterArgs, opts?: InvokeOptions): Promise<GetCaptureFilterResult>
function getCaptureFilterOutput(args: GetCaptureFilterOutputArgs, opts?: InvokeOptions): Output<GetCaptureFilterResult>
def get_capture_filter(capture_filter_id: Optional[str] = None,
                       opts: Optional[InvokeOptions] = None) -> GetCaptureFilterResult
def get_capture_filter_output(capture_filter_id: Optional[pulumi.Input[str]] = None,
                       opts: Optional[InvokeOptions] = None) -> Output[GetCaptureFilterResult]
func GetCaptureFilter(ctx *Context, args *GetCaptureFilterArgs, opts ...InvokeOption) (*GetCaptureFilterResult, error)
func GetCaptureFilterOutput(ctx *Context, args *GetCaptureFilterOutputArgs, opts ...InvokeOption) GetCaptureFilterResultOutput

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

public static class GetCaptureFilter 
{
    public static Task<GetCaptureFilterResult> InvokeAsync(GetCaptureFilterArgs args, InvokeOptions? opts = null)
    public static Output<GetCaptureFilterResult> Invoke(GetCaptureFilterInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetCaptureFilterResult> getCaptureFilter(GetCaptureFilterArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
Fn::Invoke:
  Function: oci:Core/getCaptureFilter:getCaptureFilter
  Arguments:
    # Arguments dictionary

The following arguments are supported:

CaptureFilterId string

The OCID of the capture filter.

CaptureFilterId string

The OCID of the capture filter.

captureFilterId String

The OCID of the capture filter.

captureFilterId string

The OCID of the capture filter.

capture_filter_id str

The OCID of the capture filter.

captureFilterId String

The OCID of the capture filter.

getCaptureFilter Result

The following output properties are available:

CaptureFilterId string
CompartmentId string

The OCID of the compartment containing the capture filter.

DefinedTags Dictionary<string, object>

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.

FilterType string

Indicates which service will use this capture filter

FreeformTags Dictionary<string, object>

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 capture filter's Oracle ID (OCID).

State string

The capture filter's current administrative state.

TimeCreated string

The date and time the capture filter was created, in the format defined by RFC3339. Example: 2021-08-25T21:10:29.600Z

VtapCaptureFilterRules List<GetCaptureFilterVtapCaptureFilterRule>

The set of rules governing what traffic a VTAP mirrors.

CaptureFilterId string
CompartmentId string

The OCID of the compartment containing the capture filter.

DefinedTags map[string]interface{}

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.

FilterType string

Indicates which service will use this capture filter

FreeformTags map[string]interface{}

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 capture filter's Oracle ID (OCID).

State string

The capture filter's current administrative state.

TimeCreated string

The date and time the capture filter was created, in the format defined by RFC3339. Example: 2021-08-25T21:10:29.600Z

VtapCaptureFilterRules []GetCaptureFilterVtapCaptureFilterRule

The set of rules governing what traffic a VTAP mirrors.

captureFilterId String
compartmentId String

The OCID of the compartment containing the capture filter.

definedTags Map<String,Object>

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.

filterType String

Indicates which service will use this capture filter

freeformTags Map<String,Object>

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 capture filter's Oracle ID (OCID).

state String

The capture filter's current administrative state.

timeCreated String

The date and time the capture filter was created, in the format defined by RFC3339. Example: 2021-08-25T21:10:29.600Z

vtapCaptureFilterRules List<GetCaptureFilterVtapCaptureFilterRule>

The set of rules governing what traffic a VTAP mirrors.

captureFilterId string
compartmentId string

The OCID of the compartment containing the capture filter.

definedTags {[key: string]: any}

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.

filterType string

Indicates which service will use this capture filter

freeformTags {[key: string]: any}

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 capture filter's Oracle ID (OCID).

state string

The capture filter's current administrative state.

timeCreated string

The date and time the capture filter was created, in the format defined by RFC3339. Example: 2021-08-25T21:10:29.600Z

vtapCaptureFilterRules GetCaptureFilterVtapCaptureFilterRule[]

The set of rules governing what traffic a VTAP mirrors.

capture_filter_id str
compartment_id str

The OCID of the compartment containing the capture filter.

defined_tags Mapping[str, Any]

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.

filter_type str

Indicates which service will use this capture filter

freeform_tags Mapping[str, Any]

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 capture filter's Oracle ID (OCID).

state str

The capture filter's current administrative state.

time_created str

The date and time the capture filter was created, in the format defined by RFC3339. Example: 2021-08-25T21:10:29.600Z

vtap_capture_filter_rules GetCaptureFilterVtapCaptureFilterRule]

The set of rules governing what traffic a VTAP mirrors.

captureFilterId String
compartmentId String

The OCID of the compartment containing the capture filter.

definedTags Map<Any>

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.

filterType String

Indicates which service will use this capture filter

freeformTags Map<Any>

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 capture filter's Oracle ID (OCID).

state String

The capture filter's current administrative state.

timeCreated String

The date and time the capture filter was created, in the format defined by RFC3339. Example: 2021-08-25T21:10:29.600Z

vtapCaptureFilterRules List<Property Map>

The set of rules governing what traffic a VTAP mirrors.

Supporting Types

GetCaptureFilterVtapCaptureFilterRule

DestinationCidr string

Traffic sent to this CIDR block through the VTAP source will be mirrored to the VTAP target.

IcmpOptions List<GetCaptureFilterVtapCaptureFilterRuleIcmpOption>

Optional and valid only for ICMP and ICMPv6. Use to specify a particular ICMP type and code as defined in:

Protocol string

The transport protocol used in the filter. If do not choose a protocol, all protocols will be used in the filter. Supported options are:

  • 1 = ICMP
  • 6 = TCP
  • 17 = UDP
RuleAction string

Include or exclude packets meeting this definition from mirrored traffic.

SourceCidr string

Traffic from this CIDR block to the VTAP source will be mirrored to the VTAP target.

TcpOptions List<GetCaptureFilterVtapCaptureFilterRuleTcpOption>

Optional and valid only for TCP. Use to specify particular destination ports for TCP rules. If you specify TCP as the protocol but omit this object, then all destination ports are allowed.

TrafficDirection string

The traffic direction the VTAP is configured to mirror.

UdpOptions List<GetCaptureFilterVtapCaptureFilterRuleUdpOption>

Optional and valid only for UDP. Use to specify particular destination ports for UDP rules. If you specify UDP as the protocol but omit this object, then all destination ports are allowed.

DestinationCidr string

Traffic sent to this CIDR block through the VTAP source will be mirrored to the VTAP target.

IcmpOptions []GetCaptureFilterVtapCaptureFilterRuleIcmpOption

Optional and valid only for ICMP and ICMPv6. Use to specify a particular ICMP type and code as defined in:

Protocol string

The transport protocol used in the filter. If do not choose a protocol, all protocols will be used in the filter. Supported options are:

  • 1 = ICMP
  • 6 = TCP
  • 17 = UDP
RuleAction string

Include or exclude packets meeting this definition from mirrored traffic.

SourceCidr string

Traffic from this CIDR block to the VTAP source will be mirrored to the VTAP target.

TcpOptions []GetCaptureFilterVtapCaptureFilterRuleTcpOption

Optional and valid only for TCP. Use to specify particular destination ports for TCP rules. If you specify TCP as the protocol but omit this object, then all destination ports are allowed.

TrafficDirection string

The traffic direction the VTAP is configured to mirror.

UdpOptions []GetCaptureFilterVtapCaptureFilterRuleUdpOption

Optional and valid only for UDP. Use to specify particular destination ports for UDP rules. If you specify UDP as the protocol but omit this object, then all destination ports are allowed.

destinationCidr String

Traffic sent to this CIDR block through the VTAP source will be mirrored to the VTAP target.

icmpOptions List<GetCaptureFilterVtapCaptureFilterRuleIcmpOption>

Optional and valid only for ICMP and ICMPv6. Use to specify a particular ICMP type and code as defined in:

protocol String

The transport protocol used in the filter. If do not choose a protocol, all protocols will be used in the filter. Supported options are:

  • 1 = ICMP
  • 6 = TCP
  • 17 = UDP
ruleAction String

Include or exclude packets meeting this definition from mirrored traffic.

sourceCidr String

Traffic from this CIDR block to the VTAP source will be mirrored to the VTAP target.

tcpOptions List<GetCaptureFilterVtapCaptureFilterRuleTcpOption>

Optional and valid only for TCP. Use to specify particular destination ports for TCP rules. If you specify TCP as the protocol but omit this object, then all destination ports are allowed.

trafficDirection String

The traffic direction the VTAP is configured to mirror.

udpOptions List<GetCaptureFilterVtapCaptureFilterRuleUdpOption>

Optional and valid only for UDP. Use to specify particular destination ports for UDP rules. If you specify UDP as the protocol but omit this object, then all destination ports are allowed.

destinationCidr string

Traffic sent to this CIDR block through the VTAP source will be mirrored to the VTAP target.

icmpOptions GetCaptureFilterVtapCaptureFilterRuleIcmpOption[]

Optional and valid only for ICMP and ICMPv6. Use to specify a particular ICMP type and code as defined in:

protocol string

The transport protocol used in the filter. If do not choose a protocol, all protocols will be used in the filter. Supported options are:

  • 1 = ICMP
  • 6 = TCP
  • 17 = UDP
ruleAction string

Include or exclude packets meeting this definition from mirrored traffic.

sourceCidr string

Traffic from this CIDR block to the VTAP source will be mirrored to the VTAP target.

tcpOptions GetCaptureFilterVtapCaptureFilterRuleTcpOption[]

Optional and valid only for TCP. Use to specify particular destination ports for TCP rules. If you specify TCP as the protocol but omit this object, then all destination ports are allowed.

trafficDirection string

The traffic direction the VTAP is configured to mirror.

udpOptions GetCaptureFilterVtapCaptureFilterRuleUdpOption[]

Optional and valid only for UDP. Use to specify particular destination ports for UDP rules. If you specify UDP as the protocol but omit this object, then all destination ports are allowed.

destination_cidr str

Traffic sent to this CIDR block through the VTAP source will be mirrored to the VTAP target.

icmp_options GetCaptureFilterVtapCaptureFilterRuleIcmpOption]

Optional and valid only for ICMP and ICMPv6. Use to specify a particular ICMP type and code as defined in:

protocol str

The transport protocol used in the filter. If do not choose a protocol, all protocols will be used in the filter. Supported options are:

  • 1 = ICMP
  • 6 = TCP
  • 17 = UDP
rule_action str

Include or exclude packets meeting this definition from mirrored traffic.

source_cidr str

Traffic from this CIDR block to the VTAP source will be mirrored to the VTAP target.

tcp_options GetCaptureFilterVtapCaptureFilterRuleTcpOption]

Optional and valid only for TCP. Use to specify particular destination ports for TCP rules. If you specify TCP as the protocol but omit this object, then all destination ports are allowed.

traffic_direction str

The traffic direction the VTAP is configured to mirror.

udp_options GetCaptureFilterVtapCaptureFilterRuleUdpOption]

Optional and valid only for UDP. Use to specify particular destination ports for UDP rules. If you specify UDP as the protocol but omit this object, then all destination ports are allowed.

destinationCidr String

Traffic sent to this CIDR block through the VTAP source will be mirrored to the VTAP target.

icmpOptions List<Property Map>

Optional and valid only for ICMP and ICMPv6. Use to specify a particular ICMP type and code as defined in:

protocol String

The transport protocol used in the filter. If do not choose a protocol, all protocols will be used in the filter. Supported options are:

  • 1 = ICMP
  • 6 = TCP
  • 17 = UDP
ruleAction String

Include or exclude packets meeting this definition from mirrored traffic.

sourceCidr String

Traffic from this CIDR block to the VTAP source will be mirrored to the VTAP target.

tcpOptions List<Property Map>

Optional and valid only for TCP. Use to specify particular destination ports for TCP rules. If you specify TCP as the protocol but omit this object, then all destination ports are allowed.

trafficDirection String

The traffic direction the VTAP is configured to mirror.

udpOptions List<Property Map>

Optional and valid only for UDP. Use to specify particular destination ports for UDP rules. If you specify UDP as the protocol but omit this object, then all destination ports are allowed.

GetCaptureFilterVtapCaptureFilterRuleIcmpOption

Code int

The ICMP code (optional).

Type int

The ICMP type.

Code int

The ICMP code (optional).

Type int

The ICMP type.

code Integer

The ICMP code (optional).

type Integer

The ICMP type.

code number

The ICMP code (optional).

type number

The ICMP type.

code int

The ICMP code (optional).

type int

The ICMP type.

code Number

The ICMP code (optional).

type Number

The ICMP type.

GetCaptureFilterVtapCaptureFilterRuleTcpOption

GetCaptureFilterVtapCaptureFilterRuleTcpOptionDestinationPortRange

Max int

The maximum port number, which must not be less than the minimum port number. To specify a single port number, set both the min and max to the same value.

Min int

The minimum port number, which must not be greater than the maximum port number.

Max int

The maximum port number, which must not be less than the minimum port number. To specify a single port number, set both the min and max to the same value.

Min int

The minimum port number, which must not be greater than the maximum port number.

max Integer

The maximum port number, which must not be less than the minimum port number. To specify a single port number, set both the min and max to the same value.

min Integer

The minimum port number, which must not be greater than the maximum port number.

max number

The maximum port number, which must not be less than the minimum port number. To specify a single port number, set both the min and max to the same value.

min number

The minimum port number, which must not be greater than the maximum port number.

max int

The maximum port number, which must not be less than the minimum port number. To specify a single port number, set both the min and max to the same value.

min int

The minimum port number, which must not be greater than the maximum port number.

max Number

The maximum port number, which must not be less than the minimum port number. To specify a single port number, set both the min and max to the same value.

min Number

The minimum port number, which must not be greater than the maximum port number.

GetCaptureFilterVtapCaptureFilterRuleTcpOptionSourcePortRange

Max int

The maximum port number, which must not be less than the minimum port number. To specify a single port number, set both the min and max to the same value.

Min int

The minimum port number, which must not be greater than the maximum port number.

Max int

The maximum port number, which must not be less than the minimum port number. To specify a single port number, set both the min and max to the same value.

Min int

The minimum port number, which must not be greater than the maximum port number.

max Integer

The maximum port number, which must not be less than the minimum port number. To specify a single port number, set both the min and max to the same value.

min Integer

The minimum port number, which must not be greater than the maximum port number.

max number

The maximum port number, which must not be less than the minimum port number. To specify a single port number, set both the min and max to the same value.

min number

The minimum port number, which must not be greater than the maximum port number.

max int

The maximum port number, which must not be less than the minimum port number. To specify a single port number, set both the min and max to the same value.

min int

The minimum port number, which must not be greater than the maximum port number.

max Number

The maximum port number, which must not be less than the minimum port number. To specify a single port number, set both the min and max to the same value.

min Number

The minimum port number, which must not be greater than the maximum port number.

GetCaptureFilterVtapCaptureFilterRuleUdpOption

GetCaptureFilterVtapCaptureFilterRuleUdpOptionDestinationPortRange

Max int

The maximum port number, which must not be less than the minimum port number. To specify a single port number, set both the min and max to the same value.

Min int

The minimum port number, which must not be greater than the maximum port number.

Max int

The maximum port number, which must not be less than the minimum port number. To specify a single port number, set both the min and max to the same value.

Min int

The minimum port number, which must not be greater than the maximum port number.

max Integer

The maximum port number, which must not be less than the minimum port number. To specify a single port number, set both the min and max to the same value.

min Integer

The minimum port number, which must not be greater than the maximum port number.

max number

The maximum port number, which must not be less than the minimum port number. To specify a single port number, set both the min and max to the same value.

min number

The minimum port number, which must not be greater than the maximum port number.

max int

The maximum port number, which must not be less than the minimum port number. To specify a single port number, set both the min and max to the same value.

min int

The minimum port number, which must not be greater than the maximum port number.

max Number

The maximum port number, which must not be less than the minimum port number. To specify a single port number, set both the min and max to the same value.

min Number

The minimum port number, which must not be greater than the maximum port number.

GetCaptureFilterVtapCaptureFilterRuleUdpOptionSourcePortRange

Max int

The maximum port number, which must not be less than the minimum port number. To specify a single port number, set both the min and max to the same value.

Min int

The minimum port number, which must not be greater than the maximum port number.

Max int

The maximum port number, which must not be less than the minimum port number. To specify a single port number, set both the min and max to the same value.

Min int

The minimum port number, which must not be greater than the maximum port number.

max Integer

The maximum port number, which must not be less than the minimum port number. To specify a single port number, set both the min and max to the same value.

min Integer

The minimum port number, which must not be greater than the maximum port number.

max number

The maximum port number, which must not be less than the minimum port number. To specify a single port number, set both the min and max to the same value.

min number

The minimum port number, which must not be greater than the maximum port number.

max int

The maximum port number, which must not be less than the minimum port number. To specify a single port number, set both the min and max to the same value.

min int

The minimum port number, which must not be greater than the maximum port number.

max Number

The maximum port number, which must not be less than the minimum port number. To specify a single port number, set both the min and max to the same value.

min Number

The minimum port number, which must not be greater than the maximum port number.

Package Details

Repository
https://github.com/pulumi/pulumi-oci
License
Apache-2.0
Notes

This Pulumi package is based on the oci Terraform Provider.