Oracle Cloud Infrastructure v1.34.0, May 3 24

Oracle Cloud Infrastructure v1.34.0 published on Friday, May 3, 2024 by Pulumi

oci.VnMonitoring.PathAnalysi

Explore with Pulumi AI

Oracle Cloud Infrastructure v1.34.0 published on Friday, May 3, 2024 by Pulumi

If the work request status is successful, use ListWorkRequestResults with the work request ID to ask for the successful analysis results. If the work request status is failed, use ListWorkRequestErrors with the work request ID to ask for the analysis failure information. The information returned from either of these methods can be used to build a final report.

Example Usage

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

const testPathAnalysi = new oci.vnmonitoring.PathAnalysi("test_path_analysi", {
    type: pathAnalysiType,
    cacheControl: pathAnalysiCacheControl,
    compartmentId: compartmentId,
    destinationEndpoint: {
        type: pathAnalysiDestinationEndpointType,
        address: pathAnalysiDestinationEndpointAddress,
        instanceId: testInstance.id,
        listenerId: testListener.id,
        loadBalancerId: testLoadBalancer.id,
        networkLoadBalancerId: testNetworkLoadBalancer.id,
        subnetId: testSubnet.id,
        vlanId: testVlan.id,
        vnicId: testVnicAttachment.id,
    },
    pathAnalyzerTestId: testPathAnalyzerTest.id,
    protocol: pathAnalysiProtocol,
    protocolParameters: {
        type: pathAnalysiProtocolParametersType,
        destinationPort: pathAnalysiProtocolParametersDestinationPort,
        icmpCode: pathAnalysiProtocolParametersIcmpCode,
        icmpType: pathAnalysiProtocolParametersIcmpType,
        sourcePort: pathAnalysiProtocolParametersSourcePort,
    },
    queryOptions: {
        isBiDirectionalAnalysis: pathAnalysiQueryOptionsIsBiDirectionalAnalysis,
    },
    sourceEndpoint: {
        type: pathAnalysiSourceEndpointType,
        address: pathAnalysiSourceEndpointAddress,
        instanceId: testInstance.id,
        listenerId: testListener.id,
        loadBalancerId: testLoadBalancer.id,
        networkLoadBalancerId: testNetworkLoadBalancer.id,
        subnetId: testSubnet.id,
        vlanId: testVlan.id,
        vnicId: testVnicAttachment.id,
    },
});

import pulumi
import pulumi_oci as oci

test_path_analysi = oci.vn_monitoring.PathAnalysi("test_path_analysi",
    type=path_analysi_type,
    cache_control=path_analysi_cache_control,
    compartment_id=compartment_id,
    destination_endpoint=oci.vn_monitoring.PathAnalysiDestinationEndpointArgs(
        type=path_analysi_destination_endpoint_type,
        address=path_analysi_destination_endpoint_address,
        instance_id=test_instance["id"],
        listener_id=test_listener["id"],
        load_balancer_id=test_load_balancer["id"],
        network_load_balancer_id=test_network_load_balancer["id"],
        subnet_id=test_subnet["id"],
        vlan_id=test_vlan["id"],
        vnic_id=test_vnic_attachment["id"],
    ),
    path_analyzer_test_id=test_path_analyzer_test["id"],
    protocol=path_analysi_protocol,
    protocol_parameters=oci.vn_monitoring.PathAnalysiProtocolParametersArgs(
        type=path_analysi_protocol_parameters_type,
        destination_port=path_analysi_protocol_parameters_destination_port,
        icmp_code=path_analysi_protocol_parameters_icmp_code,
        icmp_type=path_analysi_protocol_parameters_icmp_type,
        source_port=path_analysi_protocol_parameters_source_port,
    ),
    query_options=oci.vn_monitoring.PathAnalysiQueryOptionsArgs(
        is_bi_directional_analysis=path_analysi_query_options_is_bi_directional_analysis,
    ),
    source_endpoint=oci.vn_monitoring.PathAnalysiSourceEndpointArgs(
        type=path_analysi_source_endpoint_type,
        address=path_analysi_source_endpoint_address,
        instance_id=test_instance["id"],
        listener_id=test_listener["id"],
        load_balancer_id=test_load_balancer["id"],
        network_load_balancer_id=test_network_load_balancer["id"],
        subnet_id=test_subnet["id"],
        vlan_id=test_vlan["id"],
        vnic_id=test_vnic_attachment["id"],
    ))

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := VnMonitoring.NewPathAnalysi(ctx, "test_path_analysi", &VnMonitoring.PathAnalysiArgs{
			Type:          pulumi.Any(pathAnalysiType),
			CacheControl:  pulumi.Any(pathAnalysiCacheControl),
			CompartmentId: pulumi.Any(compartmentId),
			DestinationEndpoint: &vnmonitoring.PathAnalysiDestinationEndpointArgs{
				Type:                  pulumi.Any(pathAnalysiDestinationEndpointType),
				Address:               pulumi.Any(pathAnalysiDestinationEndpointAddress),
				InstanceId:            pulumi.Any(testInstance.Id),
				ListenerId:            pulumi.Any(testListener.Id),
				LoadBalancerId:        pulumi.Any(testLoadBalancer.Id),
				NetworkLoadBalancerId: pulumi.Any(testNetworkLoadBalancer.Id),
				SubnetId:              pulumi.Any(testSubnet.Id),
				VlanId:                pulumi.Any(testVlan.Id),
				VnicId:                pulumi.Any(testVnicAttachment.Id),
			},
			PathAnalyzerTestId: pulumi.Any(testPathAnalyzerTest.Id),
			Protocol:           pulumi.Any(pathAnalysiProtocol),
			ProtocolParameters: &vnmonitoring.PathAnalysiProtocolParametersArgs{
				Type:            pulumi.Any(pathAnalysiProtocolParametersType),
				DestinationPort: pulumi.Any(pathAnalysiProtocolParametersDestinationPort),
				IcmpCode:        pulumi.Any(pathAnalysiProtocolParametersIcmpCode),
				IcmpType:        pulumi.Any(pathAnalysiProtocolParametersIcmpType),
				SourcePort:      pulumi.Any(pathAnalysiProtocolParametersSourcePort),
			},
			QueryOptions: &vnmonitoring.PathAnalysiQueryOptionsArgs{
				IsBiDirectionalAnalysis: pulumi.Any(pathAnalysiQueryOptionsIsBiDirectionalAnalysis),
			},
			SourceEndpoint: &vnmonitoring.PathAnalysiSourceEndpointArgs{
				Type:                  pulumi.Any(pathAnalysiSourceEndpointType),
				Address:               pulumi.Any(pathAnalysiSourceEndpointAddress),
				InstanceId:            pulumi.Any(testInstance.Id),
				ListenerId:            pulumi.Any(testListener.Id),
				LoadBalancerId:        pulumi.Any(testLoadBalancer.Id),
				NetworkLoadBalancerId: pulumi.Any(testNetworkLoadBalancer.Id),
				SubnetId:              pulumi.Any(testSubnet.Id),
				VlanId:                pulumi.Any(testVlan.Id),
				VnicId:                pulumi.Any(testVnicAttachment.Id),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var testPathAnalysi = new Oci.VnMonitoring.PathAnalysi("test_path_analysi", new()
    {
        Type = pathAnalysiType,
        CacheControl = pathAnalysiCacheControl,
        CompartmentId = compartmentId,
        DestinationEndpoint = new Oci.VnMonitoring.Inputs.PathAnalysiDestinationEndpointArgs
        {
            Type = pathAnalysiDestinationEndpointType,
            Address = pathAnalysiDestinationEndpointAddress,
            InstanceId = testInstance.Id,
            ListenerId = testListener.Id,
            LoadBalancerId = testLoadBalancer.Id,
            NetworkLoadBalancerId = testNetworkLoadBalancer.Id,
            SubnetId = testSubnet.Id,
            VlanId = testVlan.Id,
            VnicId = testVnicAttachment.Id,
        },
        PathAnalyzerTestId = testPathAnalyzerTest.Id,
        Protocol = pathAnalysiProtocol,
        ProtocolParameters = new Oci.VnMonitoring.Inputs.PathAnalysiProtocolParametersArgs
        {
            Type = pathAnalysiProtocolParametersType,
            DestinationPort = pathAnalysiProtocolParametersDestinationPort,
            IcmpCode = pathAnalysiProtocolParametersIcmpCode,
            IcmpType = pathAnalysiProtocolParametersIcmpType,
            SourcePort = pathAnalysiProtocolParametersSourcePort,
        },
        QueryOptions = new Oci.VnMonitoring.Inputs.PathAnalysiQueryOptionsArgs
        {
            IsBiDirectionalAnalysis = pathAnalysiQueryOptionsIsBiDirectionalAnalysis,
        },
        SourceEndpoint = new Oci.VnMonitoring.Inputs.PathAnalysiSourceEndpointArgs
        {
            Type = pathAnalysiSourceEndpointType,
            Address = pathAnalysiSourceEndpointAddress,
            InstanceId = testInstance.Id,
            ListenerId = testListener.Id,
            LoadBalancerId = testLoadBalancer.Id,
            NetworkLoadBalancerId = testNetworkLoadBalancer.Id,
            SubnetId = testSubnet.Id,
            VlanId = testVlan.Id,
            VnicId = testVnicAttachment.Id,
        },
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.VnMonitoring.PathAnalysi;
import com.pulumi.oci.VnMonitoring.PathAnalysiArgs;
import com.pulumi.oci.VnMonitoring.inputs.PathAnalysiDestinationEndpointArgs;
import com.pulumi.oci.VnMonitoring.inputs.PathAnalysiProtocolParametersArgs;
import com.pulumi.oci.VnMonitoring.inputs.PathAnalysiQueryOptionsArgs;
import com.pulumi.oci.VnMonitoring.inputs.PathAnalysiSourceEndpointArgs;
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 testPathAnalysi = new PathAnalysi("testPathAnalysi", PathAnalysiArgs.builder()        
            .type(pathAnalysiType)
            .cacheControl(pathAnalysiCacheControl)
            .compartmentId(compartmentId)
            .destinationEndpoint(PathAnalysiDestinationEndpointArgs.builder()
                .type(pathAnalysiDestinationEndpointType)
                .address(pathAnalysiDestinationEndpointAddress)
                .instanceId(testInstance.id())
                .listenerId(testListener.id())
                .loadBalancerId(testLoadBalancer.id())
                .networkLoadBalancerId(testNetworkLoadBalancer.id())
                .subnetId(testSubnet.id())
                .vlanId(testVlan.id())
                .vnicId(testVnicAttachment.id())
                .build())
            .pathAnalyzerTestId(testPathAnalyzerTest.id())
            .protocol(pathAnalysiProtocol)
            .protocolParameters(PathAnalysiProtocolParametersArgs.builder()
                .type(pathAnalysiProtocolParametersType)
                .destinationPort(pathAnalysiProtocolParametersDestinationPort)
                .icmpCode(pathAnalysiProtocolParametersIcmpCode)
                .icmpType(pathAnalysiProtocolParametersIcmpType)
                .sourcePort(pathAnalysiProtocolParametersSourcePort)
                .build())
            .queryOptions(PathAnalysiQueryOptionsArgs.builder()
                .isBiDirectionalAnalysis(pathAnalysiQueryOptionsIsBiDirectionalAnalysis)
                .build())
            .sourceEndpoint(PathAnalysiSourceEndpointArgs.builder()
                .type(pathAnalysiSourceEndpointType)
                .address(pathAnalysiSourceEndpointAddress)
                .instanceId(testInstance.id())
                .listenerId(testListener.id())
                .loadBalancerId(testLoadBalancer.id())
                .networkLoadBalancerId(testNetworkLoadBalancer.id())
                .subnetId(testSubnet.id())
                .vlanId(testVlan.id())
                .vnicId(testVnicAttachment.id())
                .build())
            .build());

    }
}

resources:
  testPathAnalysi:
    type: oci:VnMonitoring:PathAnalysi
    name: test_path_analysi
    properties:
      type: ${pathAnalysiType}
      cacheControl: ${pathAnalysiCacheControl}
      compartmentId: ${compartmentId}
      destinationEndpoint:
        type: ${pathAnalysiDestinationEndpointType}
        address: ${pathAnalysiDestinationEndpointAddress}
        instanceId: ${testInstance.id}
        listenerId: ${testListener.id}
        loadBalancerId: ${testLoadBalancer.id}
        networkLoadBalancerId: ${testNetworkLoadBalancer.id}
        subnetId: ${testSubnet.id}
        vlanId: ${testVlan.id}
        vnicId: ${testVnicAttachment.id}
      pathAnalyzerTestId: ${testPathAnalyzerTest.id}
      protocol: ${pathAnalysiProtocol}
      protocolParameters:
        type: ${pathAnalysiProtocolParametersType}
        destinationPort: ${pathAnalysiProtocolParametersDestinationPort}
        icmpCode: ${pathAnalysiProtocolParametersIcmpCode}
        icmpType: ${pathAnalysiProtocolParametersIcmpType}
        sourcePort: ${pathAnalysiProtocolParametersSourcePort}
      queryOptions:
        isBiDirectionalAnalysis: ${pathAnalysiQueryOptionsIsBiDirectionalAnalysis}
      sourceEndpoint:
        type: ${pathAnalysiSourceEndpointType}
        address: ${pathAnalysiSourceEndpointAddress}
        instanceId: ${testInstance.id}
        listenerId: ${testListener.id}
        loadBalancerId: ${testLoadBalancer.id}
        networkLoadBalancerId: ${testNetworkLoadBalancer.id}
        subnetId: ${testSubnet.id}
        vlanId: ${testVlan.id}
        vnicId: ${testVnicAttachment.id}

Create PathAnalysi Resource

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

Constructor syntax

new PathAnalysi(name: string, args: PathAnalysiArgs, opts?: CustomResourceOptions);

@overload
def PathAnalysi(resource_name: str,
                args: PathAnalysiArgs,
                opts: Optional[ResourceOptions] = None)

@overload
def PathAnalysi(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                type: Optional[str] = None,
                cache_control: Optional[str] = None,
                compartment_id: Optional[str] = None,
                destination_endpoint: Optional[_vnmonitoring.PathAnalysiDestinationEndpointArgs] = None,
                path_analyzer_test_id: Optional[str] = None,
                protocol: Optional[int] = None,
                protocol_parameters: Optional[_vnmonitoring.PathAnalysiProtocolParametersArgs] = None,
                query_options: Optional[_vnmonitoring.PathAnalysiQueryOptionsArgs] = None,
                source_endpoint: Optional[_vnmonitoring.PathAnalysiSourceEndpointArgs] = None)

func NewPathAnalysi(ctx *Context, name string, args PathAnalysiArgs, opts ...ResourceOption) (*PathAnalysi, error)

public PathAnalysi(string name, PathAnalysiArgs args, CustomResourceOptions? opts = null)

public PathAnalysi(String name, PathAnalysiArgs args)
public PathAnalysi(String name, PathAnalysiArgs args, CustomResourceOptions options)

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

Parameters

name string: The unique name of the resource.
args PathAnalysiArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
args PathAnalysiArgs: The arguments to resource properties.
opts ResourceOptions: Bag of options to control resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args PathAnalysiArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args PathAnalysiArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args PathAnalysiArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

Example

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

var pathAnalysiResource = new Oci.VnMonitoring.PathAnalysi("pathAnalysiResource", new()
{
    Type = "string",
    CacheControl = "string",
    CompartmentId = "string",
    DestinationEndpoint = new Oci.VnMonitoring.Inputs.PathAnalysiDestinationEndpointArgs
    {
        Type = "string",
        Address = "string",
        InstanceId = "string",
        ListenerId = "string",
        LoadBalancerId = "string",
        NetworkLoadBalancerId = "string",
        State = "string",
        SubnetId = "string",
        VlanId = "string",
        VnicId = "string",
    },
    PathAnalyzerTestId = "string",
    Protocol = 0,
    ProtocolParameters = new Oci.VnMonitoring.Inputs.PathAnalysiProtocolParametersArgs
    {
        Type = "string",
        DestinationPort = 0,
        IcmpCode = 0,
        IcmpType = 0,
        SourcePort = 0,
    },
    QueryOptions = new Oci.VnMonitoring.Inputs.PathAnalysiQueryOptionsArgs
    {
        IsBiDirectionalAnalysis = false,
    },
    SourceEndpoint = new Oci.VnMonitoring.Inputs.PathAnalysiSourceEndpointArgs
    {
        Type = "string",
        Address = "string",
        InstanceId = "string",
        ListenerId = "string",
        LoadBalancerId = "string",
        NetworkLoadBalancerId = "string",
        State = "string",
        SubnetId = "string",
        VlanId = "string",
        VnicId = "string",
    },
});

example, err := VnMonitoring.NewPathAnalysi(ctx, "pathAnalysiResource", &VnMonitoring.PathAnalysiArgs{
	Type:          pulumi.String("string"),
	CacheControl:  pulumi.String("string"),
	CompartmentId: pulumi.String("string"),
	DestinationEndpoint: &vnmonitoring.PathAnalysiDestinationEndpointArgs{
		Type:                  pulumi.String("string"),
		Address:               pulumi.String("string"),
		InstanceId:            pulumi.String("string"),
		ListenerId:            pulumi.String("string"),
		LoadBalancerId:        pulumi.String("string"),
		NetworkLoadBalancerId: pulumi.String("string"),
		State:                 pulumi.String("string"),
		SubnetId:              pulumi.String("string"),
		VlanId:                pulumi.String("string"),
		VnicId:                pulumi.String("string"),
	},
	PathAnalyzerTestId: pulumi.String("string"),
	Protocol:           pulumi.Int(0),
	ProtocolParameters: &vnmonitoring.PathAnalysiProtocolParametersArgs{
		Type:            pulumi.String("string"),
		DestinationPort: pulumi.Int(0),
		IcmpCode:        pulumi.Int(0),
		IcmpType:        pulumi.Int(0),
		SourcePort:      pulumi.Int(0),
	},
	QueryOptions: &vnmonitoring.PathAnalysiQueryOptionsArgs{
		IsBiDirectionalAnalysis: pulumi.Bool(false),
	},
	SourceEndpoint: &vnmonitoring.PathAnalysiSourceEndpointArgs{
		Type:                  pulumi.String("string"),
		Address:               pulumi.String("string"),
		InstanceId:            pulumi.String("string"),
		ListenerId:            pulumi.String("string"),
		LoadBalancerId:        pulumi.String("string"),
		NetworkLoadBalancerId: pulumi.String("string"),
		State:                 pulumi.String("string"),
		SubnetId:              pulumi.String("string"),
		VlanId:                pulumi.String("string"),
		VnicId:                pulumi.String("string"),
	},
})

var pathAnalysiResource = new PathAnalysi("pathAnalysiResource", PathAnalysiArgs.builder()        
    .type("string")
    .cacheControl("string")
    .compartmentId("string")
    .destinationEndpoint(PathAnalysiDestinationEndpointArgs.builder()
        .type("string")
        .address("string")
        .instanceId("string")
        .listenerId("string")
        .loadBalancerId("string")
        .networkLoadBalancerId("string")
        .state("string")
        .subnetId("string")
        .vlanId("string")
        .vnicId("string")
        .build())
    .pathAnalyzerTestId("string")
    .protocol(0)
    .protocolParameters(PathAnalysiProtocolParametersArgs.builder()
        .type("string")
        .destinationPort(0)
        .icmpCode(0)
        .icmpType(0)
        .sourcePort(0)
        .build())
    .queryOptions(PathAnalysiQueryOptionsArgs.builder()
        .isBiDirectionalAnalysis(false)
        .build())
    .sourceEndpoint(PathAnalysiSourceEndpointArgs.builder()
        .type("string")
        .address("string")
        .instanceId("string")
        .listenerId("string")
        .loadBalancerId("string")
        .networkLoadBalancerId("string")
        .state("string")
        .subnetId("string")
        .vlanId("string")
        .vnicId("string")
        .build())
    .build());

path_analysi_resource = oci.vn_monitoring.PathAnalysi("pathAnalysiResource",
    type="string",
    cache_control="string",
    compartment_id="string",
    destination_endpoint=oci.vn_monitoring.PathAnalysiDestinationEndpointArgs(
        type="string",
        address="string",
        instance_id="string",
        listener_id="string",
        load_balancer_id="string",
        network_load_balancer_id="string",
        state="string",
        subnet_id="string",
        vlan_id="string",
        vnic_id="string",
    ),
    path_analyzer_test_id="string",
    protocol=0,
    protocol_parameters=oci.vn_monitoring.PathAnalysiProtocolParametersArgs(
        type="string",
        destination_port=0,
        icmp_code=0,
        icmp_type=0,
        source_port=0,
    ),
    query_options=oci.vn_monitoring.PathAnalysiQueryOptionsArgs(
        is_bi_directional_analysis=False,
    ),
    source_endpoint=oci.vn_monitoring.PathAnalysiSourceEndpointArgs(
        type="string",
        address="string",
        instance_id="string",
        listener_id="string",
        load_balancer_id="string",
        network_load_balancer_id="string",
        state="string",
        subnet_id="string",
        vlan_id="string",
        vnic_id="string",
    ))

const pathAnalysiResource = new oci.vnmonitoring.PathAnalysi("pathAnalysiResource", {
    type: "string",
    cacheControl: "string",
    compartmentId: "string",
    destinationEndpoint: {
        type: "string",
        address: "string",
        instanceId: "string",
        listenerId: "string",
        loadBalancerId: "string",
        networkLoadBalancerId: "string",
        state: "string",
        subnetId: "string",
        vlanId: "string",
        vnicId: "string",
    },
    pathAnalyzerTestId: "string",
    protocol: 0,
    protocolParameters: {
        type: "string",
        destinationPort: 0,
        icmpCode: 0,
        icmpType: 0,
        sourcePort: 0,
    },
    queryOptions: {
        isBiDirectionalAnalysis: false,
    },
    sourceEndpoint: {
        type: "string",
        address: "string",
        instanceId: "string",
        listenerId: "string",
        loadBalancerId: "string",
        networkLoadBalancerId: "string",
        state: "string",
        subnetId: "string",
        vlanId: "string",
        vnicId: "string",
    },
});

type: oci:VnMonitoring:PathAnalysi
properties:
    cacheControl: string
    compartmentId: string
    destinationEndpoint:
        address: string
        instanceId: string
        listenerId: string
        loadBalancerId: string
        networkLoadBalancerId: string
        state: string
        subnetId: string
        type: string
        vlanId: string
        vnicId: string
    pathAnalyzerTestId: string
    protocol: 0
    protocolParameters:
        destinationPort: 0
        icmpCode: 0
        icmpType: 0
        sourcePort: 0
        type: string
    queryOptions:
        isBiDirectionalAnalysis: false
    sourceEndpoint:
        address: string
        instanceId: string
        listenerId: string
        loadBalancerId: string
        networkLoadBalancerId: string
        state: string
        subnetId: string
        type: string
        vlanId: string
        vnicId: string
    type: string

PathAnalysi Resource Properties

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

Inputs

The PathAnalysi resource accepts the following input properties:

Type string

The type of the PathAnalysis query.

** 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

CacheControl string

The Cache-Control HTTP header holds directives (instructions) for caching in both requests and responses.

CompartmentId string

The OCID for the compartment.

DestinationEndpoint PathAnalysiDestinationEndpoint

Information describing a source or destination in a PathAnalyzerTest resource.

PathAnalyzerTestId string

The OCID of the PathAnalyzerTest resource.

Protocol int

The IP protocol to used for the path analysis.

ProtocolParameters PathAnalysiProtocolParameters

Defines the IP protocol parameters for a PathAnalyzerTest resource.

QueryOptions PathAnalysiQueryOptions

Defines the query options required for a PathAnalyzerTest resource.

SourceEndpoint PathAnalysiSourceEndpoint

Information describing a source or destination in a PathAnalyzerTest resource.

Type string

The type of the PathAnalysis query.

** 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

CacheControl string

The Cache-Control HTTP header holds directives (instructions) for caching in both requests and responses.

CompartmentId string

The OCID for the compartment.

DestinationEndpoint PathAnalysiDestinationEndpointArgs

Information describing a source or destination in a PathAnalyzerTest resource.

PathAnalyzerTestId string

The OCID of the PathAnalyzerTest resource.

Protocol int

The IP protocol to used for the path analysis.

ProtocolParameters PathAnalysiProtocolParametersArgs

Defines the IP protocol parameters for a PathAnalyzerTest resource.

QueryOptions PathAnalysiQueryOptionsArgs

Defines the query options required for a PathAnalyzerTest resource.

SourceEndpoint PathAnalysiSourceEndpointArgs

Information describing a source or destination in a PathAnalyzerTest resource.

type String

The type of the PathAnalysis query.

** 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

cacheControl String

The Cache-Control HTTP header holds directives (instructions) for caching in both requests and responses.

compartmentId String

The OCID for the compartment.

destinationEndpoint PathAnalysiDestinationEndpoint

Information describing a source or destination in a PathAnalyzerTest resource.

pathAnalyzerTestId String

The OCID of the PathAnalyzerTest resource.

protocol Integer

The IP protocol to used for the path analysis.

protocolParameters PathAnalysiProtocolParameters

Defines the IP protocol parameters for a PathAnalyzerTest resource.

queryOptions PathAnalysiQueryOptions

Defines the query options required for a PathAnalyzerTest resource.

sourceEndpoint PathAnalysiSourceEndpoint

Information describing a source or destination in a PathAnalyzerTest resource.

type string

The type of the PathAnalysis query.

** 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

cacheControl string

The Cache-Control HTTP header holds directives (instructions) for caching in both requests and responses.

compartmentId string

The OCID for the compartment.

destinationEndpoint PathAnalysiDestinationEndpoint

Information describing a source or destination in a PathAnalyzerTest resource.

pathAnalyzerTestId string

The OCID of the PathAnalyzerTest resource.

protocol number

The IP protocol to used for the path analysis.

protocolParameters PathAnalysiProtocolParameters

Defines the IP protocol parameters for a PathAnalyzerTest resource.

queryOptions PathAnalysiQueryOptions

Defines the query options required for a PathAnalyzerTest resource.

sourceEndpoint PathAnalysiSourceEndpoint

Information describing a source or destination in a PathAnalyzerTest resource.

type str

The type of the PathAnalysis query.

** 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

cache_control str

The Cache-Control HTTP header holds directives (instructions) for caching in both requests and responses.

compartment_id str

The OCID for the compartment.

destination_endpoint vnmonitoring.PathAnalysiDestinationEndpointArgs

Information describing a source or destination in a PathAnalyzerTest resource.

path_analyzer_test_id str

The OCID of the PathAnalyzerTest resource.

protocol int

The IP protocol to used for the path analysis.

protocol_parameters vnmonitoring.PathAnalysiProtocolParametersArgs

Defines the IP protocol parameters for a PathAnalyzerTest resource.

query_options vnmonitoring.PathAnalysiQueryOptionsArgs

Defines the query options required for a PathAnalyzerTest resource.

source_endpoint vnmonitoring.PathAnalysiSourceEndpointArgs

Information describing a source or destination in a PathAnalyzerTest resource.

type String

The type of the PathAnalysis query.

** 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

cacheControl String

The Cache-Control HTTP header holds directives (instructions) for caching in both requests and responses.

compartmentId String

The OCID for the compartment.

destinationEndpoint Property Map

Information describing a source or destination in a PathAnalyzerTest resource.

pathAnalyzerTestId String

The OCID of the PathAnalyzerTest resource.

protocol Number

The IP protocol to used for the path analysis.

protocolParameters Property Map

Defines the IP protocol parameters for a PathAnalyzerTest resource.

queryOptions Property Map

Defines the query options required for a PathAnalyzerTest resource.

sourceEndpoint Property Map

Information describing a source or destination in a PathAnalyzerTest resource.

Outputs

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

Id string: The provider-assigned unique ID for this managed resource.

Id string: The provider-assigned unique ID for this managed resource.

id String: The provider-assigned unique ID for this managed resource.

id string: The provider-assigned unique ID for this managed resource.

id str: The provider-assigned unique ID for this managed resource.

id String: The provider-assigned unique ID for this managed resource.

Look up Existing PathAnalysi Resource

Get an existing PathAnalysi 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?: PathAnalysiState, opts?: CustomResourceOptions): PathAnalysi

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        cache_control: Optional[str] = None,
        compartment_id: Optional[str] = None,
        destination_endpoint: Optional[_vnmonitoring.PathAnalysiDestinationEndpointArgs] = None,
        path_analyzer_test_id: Optional[str] = None,
        protocol: Optional[int] = None,
        protocol_parameters: Optional[_vnmonitoring.PathAnalysiProtocolParametersArgs] = None,
        query_options: Optional[_vnmonitoring.PathAnalysiQueryOptionsArgs] = None,
        source_endpoint: Optional[_vnmonitoring.PathAnalysiSourceEndpointArgs] = None,
        type: Optional[str] = None) -> PathAnalysi

func GetPathAnalysi(ctx *Context, name string, id IDInput, state *PathAnalysiState, opts ...ResourceOption) (*PathAnalysi, error)

public static PathAnalysi Get(string name, Input<string> id, PathAnalysiState? state, CustomResourceOptions? opts = null)

public static PathAnalysi get(String name, Output<String> id, PathAnalysiState state, CustomResourceOptions options)

Resource lookup is not supported in YAML

name: The unique name of the resulting resource.
id: 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: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: 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: The unique name of the resulting resource.
id: 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: The unique name of the resulting resource.
id: 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:

CacheControl string

The Cache-Control HTTP header holds directives (instructions) for caching in both requests and responses.

CompartmentId string

The OCID for the compartment.

DestinationEndpoint PathAnalysiDestinationEndpoint

Information describing a source or destination in a PathAnalyzerTest resource.

PathAnalyzerTestId string

The OCID of the PathAnalyzerTest resource.

Protocol int

The IP protocol to used for the path analysis.

ProtocolParameters PathAnalysiProtocolParameters

Defines the IP protocol parameters for a PathAnalyzerTest resource.

QueryOptions PathAnalysiQueryOptions

Defines the query options required for a PathAnalyzerTest resource.

SourceEndpoint PathAnalysiSourceEndpoint

Information describing a source or destination in a PathAnalyzerTest resource.

Type string

The type of the PathAnalysis query.

** 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

CacheControl string

The Cache-Control HTTP header holds directives (instructions) for caching in both requests and responses.

CompartmentId string

The OCID for the compartment.

DestinationEndpoint PathAnalysiDestinationEndpointArgs

Information describing a source or destination in a PathAnalyzerTest resource.

PathAnalyzerTestId string

The OCID of the PathAnalyzerTest resource.

Protocol int

The IP protocol to used for the path analysis.

ProtocolParameters PathAnalysiProtocolParametersArgs

Defines the IP protocol parameters for a PathAnalyzerTest resource.

QueryOptions PathAnalysiQueryOptionsArgs

Defines the query options required for a PathAnalyzerTest resource.

SourceEndpoint PathAnalysiSourceEndpointArgs

Information describing a source or destination in a PathAnalyzerTest resource.

Type string

The type of the PathAnalysis query.

** 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

cacheControl String

The Cache-Control HTTP header holds directives (instructions) for caching in both requests and responses.

compartmentId String

The OCID for the compartment.

destinationEndpoint PathAnalysiDestinationEndpoint

Information describing a source or destination in a PathAnalyzerTest resource.

pathAnalyzerTestId String

The OCID of the PathAnalyzerTest resource.

protocol Integer

The IP protocol to used for the path analysis.

protocolParameters PathAnalysiProtocolParameters

Defines the IP protocol parameters for a PathAnalyzerTest resource.

queryOptions PathAnalysiQueryOptions

Defines the query options required for a PathAnalyzerTest resource.

sourceEndpoint PathAnalysiSourceEndpoint

Information describing a source or destination in a PathAnalyzerTest resource.

type String

The type of the PathAnalysis query.

** 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

cacheControl string

The Cache-Control HTTP header holds directives (instructions) for caching in both requests and responses.

compartmentId string

The OCID for the compartment.

destinationEndpoint PathAnalysiDestinationEndpoint

Information describing a source or destination in a PathAnalyzerTest resource.

pathAnalyzerTestId string

The OCID of the PathAnalyzerTest resource.

protocol number

The IP protocol to used for the path analysis.

protocolParameters PathAnalysiProtocolParameters

Defines the IP protocol parameters for a PathAnalyzerTest resource.

queryOptions PathAnalysiQueryOptions

Defines the query options required for a PathAnalyzerTest resource.

sourceEndpoint PathAnalysiSourceEndpoint

Information describing a source or destination in a PathAnalyzerTest resource.

type string

The type of the PathAnalysis query.

** 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

cache_control str

The Cache-Control HTTP header holds directives (instructions) for caching in both requests and responses.

compartment_id str

The OCID for the compartment.

destination_endpoint vnmonitoring.PathAnalysiDestinationEndpointArgs

Information describing a source or destination in a PathAnalyzerTest resource.

path_analyzer_test_id str

The OCID of the PathAnalyzerTest resource.

protocol int

The IP protocol to used for the path analysis.

protocol_parameters vnmonitoring.PathAnalysiProtocolParametersArgs

Defines the IP protocol parameters for a PathAnalyzerTest resource.

query_options vnmonitoring.PathAnalysiQueryOptionsArgs

Defines the query options required for a PathAnalyzerTest resource.

source_endpoint vnmonitoring.PathAnalysiSourceEndpointArgs

Information describing a source or destination in a PathAnalyzerTest resource.

type str

The type of the PathAnalysis query.

** 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

cacheControl String

The Cache-Control HTTP header holds directives (instructions) for caching in both requests and responses.

compartmentId String

The OCID for the compartment.

destinationEndpoint Property Map

Information describing a source or destination in a PathAnalyzerTest resource.

pathAnalyzerTestId String

The OCID of the PathAnalyzerTest resource.

protocol Number

The IP protocol to used for the path analysis.

protocolParameters Property Map

Defines the IP protocol parameters for a PathAnalyzerTest resource.

queryOptions Property Map

Defines the query options required for a PathAnalyzerTest resource.

sourceEndpoint Property Map

Information describing a source or destination in a PathAnalyzerTest resource.

type String

The type of the PathAnalysis query.

** 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

Supporting Types

PathAnalysiDestinationEndpoint, PathAnalysiDestinationEndpointArgs

Type string

The type of the PathAnalysis query.

** 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

Address string

The IPv4 address of the COMPUTE_INSTANCE-type Endpoint object.

InstanceId string

The OCID of the compute instance.

ListenerId string

The OCID of the network load balancer listener.

LoadBalancerId string

The OCID of the listener's load balancer.

NetworkLoadBalancerId string

The OCID of the listener's network load balancer.

State string

SubnetId string

The OCID of the subnet containing the IP address. This can be used to disambiguate which subnet is intended, in case the IP address is used in more than one subnet (when there are subnets with overlapping IP ranges).

VlanId string

The OCID of the VLAN containing the IP address. This can be used to disambiguate which VLAN is queried, in case the endpoint IP address belongs to more than one VLAN (when there are VLANs with overlapping IP ranges).

VnicId string

The OCID of the VNIC attached to the compute instance.

Type string

The type of the PathAnalysis query.

** 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

Address string

The IPv4 address of the COMPUTE_INSTANCE-type Endpoint object.

InstanceId string

The OCID of the compute instance.

ListenerId string

The OCID of the network load balancer listener.

LoadBalancerId string

The OCID of the listener's load balancer.

NetworkLoadBalancerId string

The OCID of the listener's network load balancer.

State string

SubnetId string

VlanId string

VnicId string

The OCID of the VNIC attached to the compute instance.

type String

The type of the PathAnalysis query.

** 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

address String

The IPv4 address of the COMPUTE_INSTANCE-type Endpoint object.

instanceId String

The OCID of the compute instance.

listenerId String

The OCID of the network load balancer listener.

loadBalancerId String

The OCID of the listener's load balancer.

networkLoadBalancerId String

The OCID of the listener's network load balancer.

state String

subnetId String

vlanId String

vnicId String

The OCID of the VNIC attached to the compute instance.

type string

The type of the PathAnalysis query.

** 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

address string

The IPv4 address of the COMPUTE_INSTANCE-type Endpoint object.

instanceId string

The OCID of the compute instance.

listenerId string

The OCID of the network load balancer listener.

loadBalancerId string

The OCID of the listener's load balancer.

networkLoadBalancerId string

The OCID of the listener's network load balancer.

state string

subnetId string

vlanId string

vnicId string

The OCID of the VNIC attached to the compute instance.

type str

The type of the PathAnalysis query.

** 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

address str

The IPv4 address of the COMPUTE_INSTANCE-type Endpoint object.

instance_id str

The OCID of the compute instance.

listener_id str

The OCID of the network load balancer listener.

load_balancer_id str

The OCID of the listener's load balancer.

network_load_balancer_id str

The OCID of the listener's network load balancer.

state str

subnet_id str

vlan_id str

vnic_id str

The OCID of the VNIC attached to the compute instance.

type String

The type of the PathAnalysis query.

** 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

address String

The IPv4 address of the COMPUTE_INSTANCE-type Endpoint object.

instanceId String

The OCID of the compute instance.

listenerId String

The OCID of the network load balancer listener.

loadBalancerId String

The OCID of the listener's load balancer.

networkLoadBalancerId String

The OCID of the listener's network load balancer.

state String

subnetId String

vlanId String

vnicId String

The OCID of the VNIC attached to the compute instance.

PathAnalysiProtocolParameters, PathAnalysiProtocolParametersArgs

Type string

The type of the PathAnalysis query.

** 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

DestinationPort int

The destination port to use in a PathAnalyzerTest resource.

IcmpCode int

The ICMP code.

IcmpType int

The ICMP type.

SourcePort int

The source port to use in a PathAnalyzerTest resource.

Type string

The type of the PathAnalysis query.

** 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

DestinationPort int

The destination port to use in a PathAnalyzerTest resource.

IcmpCode int

The ICMP code.

IcmpType int

The ICMP type.

SourcePort int

The source port to use in a PathAnalyzerTest resource.

type String

The type of the PathAnalysis query.

** 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

destinationPort Integer

The destination port to use in a PathAnalyzerTest resource.

icmpCode Integer

The ICMP code.

icmpType Integer

The ICMP type.

sourcePort Integer

The source port to use in a PathAnalyzerTest resource.

type string

The type of the PathAnalysis query.

** 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

destinationPort number

The destination port to use in a PathAnalyzerTest resource.

icmpCode number

The ICMP code.

icmpType number

The ICMP type.

sourcePort number

The source port to use in a PathAnalyzerTest resource.

type str

The type of the PathAnalysis query.

** 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

destination_port int

The destination port to use in a PathAnalyzerTest resource.

icmp_code int

The ICMP code.

icmp_type int

The ICMP type.

source_port int

The source port to use in a PathAnalyzerTest resource.

type String

The type of the PathAnalysis query.

** 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

destinationPort Number

The destination port to use in a PathAnalyzerTest resource.

icmpCode Number

The ICMP code.

icmpType Number

The ICMP type.

sourcePort Number

The source port to use in a PathAnalyzerTest resource.

PathAnalysiQueryOptions, PathAnalysiQueryOptionsArgs

IsBiDirectionalAnalysis bool: If true, a path analysis is done for both the forward and reverse routes.

IsBiDirectionalAnalysis bool: If true, a path analysis is done for both the forward and reverse routes.

isBiDirectionalAnalysis Boolean: If true, a path analysis is done for both the forward and reverse routes.

isBiDirectionalAnalysis boolean: If true, a path analysis is done for both the forward and reverse routes.

is_bi_directional_analysis bool: If true, a path analysis is done for both the forward and reverse routes.

isBiDirectionalAnalysis Boolean: If true, a path analysis is done for both the forward and reverse routes.

PathAnalysiSourceEndpoint, PathAnalysiSourceEndpointArgs

Type string

The type of the PathAnalysis query.

** 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

Address string

The IPv4 address of the COMPUTE_INSTANCE-type Endpoint object.

InstanceId string

The OCID of the compute instance.

ListenerId string

The OCID of the network load balancer listener.

LoadBalancerId string

The OCID of the listener's load balancer.

NetworkLoadBalancerId string

The OCID of the listener's network load balancer.

State string

SubnetId string

VlanId string

VnicId string

The OCID of the VNIC attached to the compute instance.

Type string

The type of the PathAnalysis query.

** 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

Address string

The IPv4 address of the COMPUTE_INSTANCE-type Endpoint object.

InstanceId string

The OCID of the compute instance.

ListenerId string

The OCID of the network load balancer listener.

LoadBalancerId string

The OCID of the listener's load balancer.

NetworkLoadBalancerId string

The OCID of the listener's network load balancer.

State string

SubnetId string

VlanId string

VnicId string

The OCID of the VNIC attached to the compute instance.

type String

The type of the PathAnalysis query.

** 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

address String

The IPv4 address of the COMPUTE_INSTANCE-type Endpoint object.

instanceId String

The OCID of the compute instance.

listenerId String

The OCID of the network load balancer listener.

loadBalancerId String

The OCID of the listener's load balancer.

networkLoadBalancerId String

The OCID of the listener's network load balancer.

state String

subnetId String

vlanId String

vnicId String

The OCID of the VNIC attached to the compute instance.

type string

The type of the PathAnalysis query.

** 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

address string

The IPv4 address of the COMPUTE_INSTANCE-type Endpoint object.

instanceId string

The OCID of the compute instance.

listenerId string

The OCID of the network load balancer listener.

loadBalancerId string

The OCID of the listener's load balancer.

networkLoadBalancerId string

The OCID of the listener's network load balancer.

state string

subnetId string

vlanId string

vnicId string

The OCID of the VNIC attached to the compute instance.

type str

The type of the PathAnalysis query.

** 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

address str

The IPv4 address of the COMPUTE_INSTANCE-type Endpoint object.

instance_id str

The OCID of the compute instance.

listener_id str

The OCID of the network load balancer listener.

load_balancer_id str

The OCID of the listener's load balancer.

network_load_balancer_id str

The OCID of the listener's network load balancer.

state str

subnet_id str

vlan_id str

vnic_id str

The OCID of the VNIC attached to the compute instance.

type String

The type of the PathAnalysis query.

** 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

address String

The IPv4 address of the COMPUTE_INSTANCE-type Endpoint object.

instanceId String

The OCID of the compute instance.

listenerId String

The OCID of the network load balancer listener.

loadBalancerId String

The OCID of the listener's load balancer.

networkLoadBalancerId String

The OCID of the listener's network load balancer.

state String

subnetId String

vlanId String

vnicId String

The OCID of the VNIC attached to the compute instance.

Import

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

$ pulumi import oci:VnMonitoring/pathAnalysi:PathAnalysi test_path_analysi "id"

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 v1.34.0 published on Friday, May 3, 2024 by Pulumi

pulumi/pulumi-oci

oci.VnMonitoring.PathAnalysi

On this page

On this page

Example Usage

Create PathAnalysi Resource

Constructor syntax

Parameters

Example

PathAnalysi Resource Properties

Inputs

Outputs

Look up Existing PathAnalysi Resource

Supporting Types

PathAnalysiDestinationEndpoint, PathAnalysiDestinationEndpointArgs

PathAnalysiProtocolParameters, PathAnalysiProtocolParametersArgs

PathAnalysiQueryOptions, PathAnalysiQueryOptionsArgs

PathAnalysiSourceEndpoint, PathAnalysiSourceEndpointArgs

Import

Package Details

On this page

On this page