oci.Core.getIpsecConnections

Explore with Pulumi AI

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

Example Usage

TypeScript
Python
Go
C#
Java
YAML

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

const testIpSecConnections = oci.Core.getIpsecConnections({
    compartmentId: compartmentId,
    cpeId: testCpe.id,
    drgId: testDrg.id,
});

import pulumi
import pulumi_oci as oci

test_ip_sec_connections = oci.Core.get_ipsec_connections(compartment_id=compartment_id,
    cpe_id=test_cpe["id"],
    drg_id=test_drg["id"])

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.GetIpsecConnections(ctx, &core.GetIpsecConnectionsArgs{
			CompartmentId: compartmentId,
			CpeId:         pulumi.StringRef(testCpe.Id),
			DrgId:         pulumi.StringRef(testDrg.Id),
		}, nil)
		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 testIpSecConnections = Oci.Core.GetIpsecConnections.Invoke(new()
    {
        CompartmentId = compartmentId,
        CpeId = testCpe.Id,
        DrgId = testDrg.Id,
    });

});

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.GetIpsecConnectionsArgs;
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 testIpSecConnections = CoreFunctions.getIpsecConnections(GetIpsecConnectionsArgs.builder()
            .compartmentId(compartmentId)
            .cpeId(testCpe.id())
            .drgId(testDrg.id())
            .build());

    }
}

variables:
  testIpSecConnections:
    fn::invoke:
      function: oci:Core:getIpsecConnections
      arguments:
        compartmentId: ${compartmentId}
        cpeId: ${testCpe.id}
        drgId: ${testDrg.id}

Using getIpsecConnections

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.

TypeScript
Python
Go
C#
Java
YAML

function getIpsecConnections(args: GetIpsecConnectionsArgs, opts?: InvokeOptions): Promise<GetIpsecConnectionsResult>
function getIpsecConnectionsOutput(args: GetIpsecConnectionsOutputArgs, opts?: InvokeOptions): Output<GetIpsecConnectionsResult>

def get_ipsec_connections(compartment_id: Optional[str] = None,
                          cpe_id: Optional[str] = None,
                          drg_id: Optional[str] = None,
                          filters: Optional[Sequence[_core.GetIpsecConnectionsFilter]] = None,
                          opts: Optional[InvokeOptions] = None) -> GetIpsecConnectionsResult
def get_ipsec_connections_output(compartment_id: Optional[pulumi.Input[str]] = None,
                          cpe_id: Optional[pulumi.Input[str]] = None,
                          drg_id: Optional[pulumi.Input[str]] = None,
                          filters: Optional[pulumi.Input[Sequence[pulumi.Input[_core.GetIpsecConnectionsFilterArgs]]]] = None,
                          opts: Optional[InvokeOptions] = None) -> Output[GetIpsecConnectionsResult]

func GetIpsecConnections(ctx *Context, args *GetIpsecConnectionsArgs, opts ...InvokeOption) (*GetIpsecConnectionsResult, error)
func GetIpsecConnectionsOutput(ctx *Context, args *GetIpsecConnectionsOutputArgs, opts ...InvokeOption) GetIpsecConnectionsResultOutput

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

public static class GetIpsecConnections 
{
    public static Task<GetIpsecConnectionsResult> InvokeAsync(GetIpsecConnectionsArgs args, InvokeOptions? opts = null)
    public static Output<GetIpsecConnectionsResult> Invoke(GetIpsecConnectionsInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetIpsecConnectionsResult> getIpsecConnections(GetIpsecConnectionsArgs args, InvokeOptions options)
public static Output<GetIpsecConnectionsResult> getIpsecConnections(GetIpsecConnectionsArgs args, InvokeOptions options)

fn::invoke:
  function: oci:Core/getIpsecConnections:getIpsecConnections
  arguments:
    # arguments dictionary

The following arguments are supported:

CompartmentId string: The OCID of the compartment.
CpeId string: The OCID of the CPE.
DrgId string: The OCID of the DRG.
Filters List<GetIpsecConnectionsFilter>

CompartmentId string: The OCID of the compartment.
CpeId string: The OCID of the CPE.
DrgId string: The OCID of the DRG.
Filters []GetIpsecConnectionsFilter

compartmentId String: The OCID of the compartment.
cpeId String: The OCID of the CPE.
drgId String: The OCID of the DRG.
filters List<GetIpsecConnectionsFilter>

compartmentId string: The OCID of the compartment.
cpeId string: The OCID of the CPE.
drgId string: The OCID of the DRG.
filters GetIpsecConnectionsFilter[]

compartment_id str: The OCID of the compartment.
cpe_id str: The OCID of the CPE.
drg_id str: The OCID of the DRG.
filters Sequence[core.GetIpsecConnectionsFilter]

compartmentId String: The OCID of the compartment.
cpeId String: The OCID of the CPE.
drgId String: The OCID of the DRG.
filters List<Property Map>

getIpsecConnections Result

The following output properties are available:

CompartmentId string: The OCID of the compartment containing the IPSec connection.
Connections List<GetIpsecConnectionsConnection>: The list of connections.
Id string: The provider-assigned unique ID for this managed resource.
CpeId string: The OCID of the Cpe object.
DrgId string: The OCID of the DRG.
Filters List<GetIpsecConnectionsFilter>

CompartmentId string: The OCID of the compartment containing the IPSec connection.
Connections []GetIpsecConnectionsConnection: The list of connections.
Id string: The provider-assigned unique ID for this managed resource.
CpeId string: The OCID of the Cpe object.
DrgId string: The OCID of the DRG.
Filters []GetIpsecConnectionsFilter

compartmentId String: The OCID of the compartment containing the IPSec connection.
connections List<GetIpsecConnectionsConnection>: The list of connections.
id String: The provider-assigned unique ID for this managed resource.
cpeId String: The OCID of the Cpe object.
drgId String: The OCID of the DRG.
filters List<GetIpsecConnectionsFilter>

compartmentId string: The OCID of the compartment containing the IPSec connection.
connections GetIpsecConnectionsConnection[]: The list of connections.
id string: The provider-assigned unique ID for this managed resource.
cpeId string: The OCID of the Cpe object.
drgId string: The OCID of the DRG.
filters GetIpsecConnectionsFilter[]

compartment_id str: The OCID of the compartment containing the IPSec connection.
connections Sequence[core.GetIpsecConnectionsConnection]: The list of connections.
id str: The provider-assigned unique ID for this managed resource.
cpe_id str: The OCID of the Cpe object.
drg_id str: The OCID of the DRG.
filters Sequence[core.GetIpsecConnectionsFilter]

compartmentId String: The OCID of the compartment containing the IPSec connection.
connections List<Property Map>: The list of connections.
id String: The provider-assigned unique ID for this managed resource.
cpeId String: The OCID of the Cpe object.
drgId String: The OCID of the DRG.
filters List<Property Map>

Supporting Types

GetIpsecConnectionsConnection

CompartmentId string: The OCID of the compartment.
CpeId string: The OCID of the CPE.
CpeLocalIdentifier string: Your identifier for your CPE device. Can be either an IP address or a hostname (specifically, the fully qualified domain name (FQDN)). The type of identifier here must correspond to the value for cpeLocalIdentifierType.
CpeLocalIdentifierType string: The type of identifier for your CPE device. The value here must correspond to the value for cpeLocalIdentifier.
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.
DrgId string: The OCID of the DRG.
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 IPSec connection's Oracle ID (OCID).
State string: The IPSec connection's current state.
StaticRoutes List<string>: Static routes to the CPE. The CIDR must not be a multicast address or class E address.
TimeCreated string: The date and time the IPSec connection was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
TransportType string: The transport type used for the IPSec connection.
TunnelConfigurations List<GetIpsecConnectionsConnectionTunnelConfiguration>

CompartmentId string: The OCID of the compartment.
CpeId string: The OCID of the CPE.
CpeLocalIdentifier string: Your identifier for your CPE device. Can be either an IP address or a hostname (specifically, the fully qualified domain name (FQDN)). The type of identifier here must correspond to the value for cpeLocalIdentifierType.
CpeLocalIdentifierType string: The type of identifier for your CPE device. The value here must correspond to the value for cpeLocalIdentifier.
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.
DrgId string: The OCID of the DRG.
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 IPSec connection's Oracle ID (OCID).
State string: The IPSec connection's current state.
StaticRoutes []string: Static routes to the CPE. The CIDR must not be a multicast address or class E address.
TimeCreated string: The date and time the IPSec connection was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
TransportType string: The transport type used for the IPSec connection.
TunnelConfigurations []GetIpsecConnectionsConnectionTunnelConfiguration

compartmentId String: The OCID of the compartment.
cpeId String: The OCID of the CPE.
cpeLocalIdentifier String: Your identifier for your CPE device. Can be either an IP address or a hostname (specifically, the fully qualified domain name (FQDN)). The type of identifier here must correspond to the value for cpeLocalIdentifierType.
cpeLocalIdentifierType String: The type of identifier for your CPE device. The value here must correspond to the value for cpeLocalIdentifier.
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.
drgId String: The OCID of the DRG.
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 IPSec connection's Oracle ID (OCID).
state String: The IPSec connection's current state.
staticRoutes List<String>: Static routes to the CPE. The CIDR must not be a multicast address or class E address.
timeCreated String: The date and time the IPSec connection was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
transportType String: The transport type used for the IPSec connection.
tunnelConfigurations List<GetIpsecConnectionsConnectionTunnelConfiguration>

compartmentId string: The OCID of the compartment.
cpeId string: The OCID of the CPE.
cpeLocalIdentifier string: Your identifier for your CPE device. Can be either an IP address or a hostname (specifically, the fully qualified domain name (FQDN)). The type of identifier here must correspond to the value for cpeLocalIdentifierType.
cpeLocalIdentifierType string: The type of identifier for your CPE device. The value here must correspond to the value for cpeLocalIdentifier.
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.
drgId string: The OCID of the DRG.
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 IPSec connection's Oracle ID (OCID).
state string: The IPSec connection's current state.
staticRoutes string[]: Static routes to the CPE. The CIDR must not be a multicast address or class E address.
timeCreated string: The date and time the IPSec connection was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
transportType string: The transport type used for the IPSec connection.
tunnelConfigurations GetIpsecConnectionsConnectionTunnelConfiguration[]

compartment_id str: The OCID of the compartment.
cpe_id str: The OCID of the CPE.
cpe_local_identifier str: Your identifier for your CPE device. Can be either an IP address or a hostname (specifically, the fully qualified domain name (FQDN)). The type of identifier here must correspond to the value for cpeLocalIdentifierType.
cpe_local_identifier_type str: The type of identifier for your CPE device. The value here must correspond to the value for cpeLocalIdentifier.
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.
drg_id str: The OCID of the DRG.
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 IPSec connection's Oracle ID (OCID).
state str: The IPSec connection's current state.
static_routes Sequence[str]: Static routes to the CPE. The CIDR must not be a multicast address or class E address.
time_created str: The date and time the IPSec connection was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
transport_type str: The transport type used for the IPSec connection.
tunnel_configurations Sequence[core.GetIpsecConnectionsConnectionTunnelConfiguration]

compartmentId String: The OCID of the compartment.
cpeId String: The OCID of the CPE.
cpeLocalIdentifier String: Your identifier for your CPE device. Can be either an IP address or a hostname (specifically, the fully qualified domain name (FQDN)). The type of identifier here must correspond to the value for cpeLocalIdentifierType.
cpeLocalIdentifierType String: The type of identifier for your CPE device. The value here must correspond to the value for cpeLocalIdentifier.
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.
drgId String: The OCID of the DRG.
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 IPSec connection's Oracle ID (OCID).
state String: The IPSec connection's current state.
staticRoutes List<String>: Static routes to the CPE. The CIDR must not be a multicast address or class E address.
timeCreated String: The date and time the IPSec connection was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
transportType String: The transport type used for the IPSec connection.
tunnelConfigurations List<Property Map>