IonosCloud v0.2.3, May 13 25

IonosCloud v0.2.3 published on Tuesday, May 13, 2025 by ionos-cloud

ionoscloud.vpn.getIpsecTunnel

Explore with Pulumi AI

IonosCloud v0.2.3 published on Tuesday, May 13, 2025 by ionos-cloud

The VPN IPSec Gateway Tunnel data source can be used to search for and return an existing IPSec Gateway Tunnel. You can provide a string for the name parameter which will be compared with provisioned IPSec Gateway Tunnels. If a single match is found, it will be returned. If your search results in multiple matches, an error will be returned. When this happens, please refine your search string so that it is specific enough to return only one result.

Example Usage

By ID

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

const example = ionoscloud.vpn.getIpsecTunnel({
    id: "tunnel_id",
    gatewayId: "gateway_id",
    location: "gateway_location",
});

import pulumi
import pulumi_ionoscloud as ionoscloud

example = ionoscloud.vpn.get_ipsec_tunnel(id="tunnel_id",
    gateway_id="gateway_id",
    location="gateway_location")

package main

import (
	"github.com/ionos-cloud/pulumi-ionoscloud/sdk/go/ionoscloud/vpn"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := vpn.LookupIpsecTunnel(ctx, &vpn.LookupIpsecTunnelArgs{
			Id:        pulumi.StringRef("tunnel_id"),
			GatewayId: "gateway_id",
			Location:  pulumi.StringRef("gateway_location"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var example = Ionoscloud.Vpn.GetIpsecTunnel.Invoke(new()
    {
        Id = "tunnel_id",
        GatewayId = "gateway_id",
        Location = "gateway_location",
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ionoscloud.vpn.VpnFunctions;
import com.pulumi.ionoscloud.vpn.inputs.GetIpsecTunnelArgs;
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 example = VpnFunctions.getIpsecTunnel(GetIpsecTunnelArgs.builder()
            .id("tunnel_id")
            .gatewayId("gateway_id")
            .location("gateway_location")
            .build());

    }
}

variables:
  example:
    fn::invoke:
      function: ionoscloud:vpn:getIpsecTunnel
      arguments:
        id: tunnel_id
        gatewayId: gateway_id
        location: gateway_location

By Name

Needs to have the resource be previously created, or a depends_on clause to ensure that the resource is created before this data source is called.

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

const example = ionoscloud.vpn.getIpsecTunnel({
    name: "ipsec-tunnel",
    gatewayId: "gateway_id",
    location: "gateway_location",
});

import pulumi
import pulumi_ionoscloud as ionoscloud

example = ionoscloud.vpn.get_ipsec_tunnel(name="ipsec-tunnel",
    gateway_id="gateway_id",
    location="gateway_location")

package main

import (
	"github.com/ionos-cloud/pulumi-ionoscloud/sdk/go/ionoscloud/vpn"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := vpn.LookupIpsecTunnel(ctx, &vpn.LookupIpsecTunnelArgs{
			Name:      pulumi.StringRef("ipsec-tunnel"),
			GatewayId: "gateway_id",
			Location:  pulumi.StringRef("gateway_location"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var example = Ionoscloud.Vpn.GetIpsecTunnel.Invoke(new()
    {
        Name = "ipsec-tunnel",
        GatewayId = "gateway_id",
        Location = "gateway_location",
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ionoscloud.vpn.VpnFunctions;
import com.pulumi.ionoscloud.vpn.inputs.GetIpsecTunnelArgs;
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 example = VpnFunctions.getIpsecTunnel(GetIpsecTunnelArgs.builder()
            .name("ipsec-tunnel")
            .gatewayId("gateway_id")
            .location("gateway_location")
            .build());

    }
}

variables:
  example:
    fn::invoke:
      function: ionoscloud:vpn:getIpsecTunnel
      arguments:
        name: ipsec-tunnel
        gatewayId: gateway_id
        location: gateway_location

Attributes reference

The following attributes are returned by the datasource:

id - The unique ID of the IPSec Gateway Tunnel.
name - The name of the IPSec Gateway Tunnel.
description - The human-readable description of your IPSec Gateway Tunnel.
remote_host - The remote peer host fully qualified domain name or public IPV4 IP to connect to.
ike - Settings for the initial security exchange phase.
- diffie_hellman_group - The Diffie-Hellman Group to use for IPSec Encryption.
- encryption_algorithm - The encryption algorithm to use for IPSec Encryption.
- integrity_algorithm - The integrity algorithm to use for IPSec Encryption.
- lifetime - The phase lifetime in seconds.
esp - Settings for the IPSec SA (ESP) phase.
- diffie_hellman_group - The Diffie-Hellman Group to use for IPSec Encryption.
- encryption_algorithm - The encryption algorithm to use for IPSec Encryption.
- integrity_algorithm - The integrity algorithm to use for IPSec Encryption.
- lifetime - The phase lifetime in seconds.
auth - Properties with all data needed to define IPSec Authentication.
- method - The authentication method to use for IPSec Authentication.
cloud_network_cidrs - The network CIDRs on the “Left” side that are allowed to connect to the IPSec tunnel, i.e. the CIDRs within your IONOS Cloud LAN. Specify “0.0.0.0/0” or “::/0” for all addresses.
peer_network_cidrs - The network CIDRs on the “Right” side that are allowed to connect to the IPSec tunnel. Specify “0.0.0.0/0” or “::/0” for all addresses.

Using getIpsecTunnel

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 getIpsecTunnel(args: GetIpsecTunnelArgs, opts?: InvokeOptions): Promise<GetIpsecTunnelResult>
function getIpsecTunnelOutput(args: GetIpsecTunnelOutputArgs, opts?: InvokeOptions): Output<GetIpsecTunnelResult>

def get_ipsec_tunnel(gateway_id: Optional[str] = None,
                     id: Optional[str] = None,
                     location: Optional[str] = None,
                     name: Optional[str] = None,
                     opts: Optional[InvokeOptions] = None) -> GetIpsecTunnelResult
def get_ipsec_tunnel_output(gateway_id: Optional[pulumi.Input[str]] = None,
                     id: Optional[pulumi.Input[str]] = None,
                     location: Optional[pulumi.Input[str]] = None,
                     name: Optional[pulumi.Input[str]] = None,
                     opts: Optional[InvokeOptions] = None) -> Output[GetIpsecTunnelResult]

func LookupIpsecTunnel(ctx *Context, args *LookupIpsecTunnelArgs, opts ...InvokeOption) (*LookupIpsecTunnelResult, error)
func LookupIpsecTunnelOutput(ctx *Context, args *LookupIpsecTunnelOutputArgs, opts ...InvokeOption) LookupIpsecTunnelResultOutput

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

public static class GetIpsecTunnel 
{
    public static Task<GetIpsecTunnelResult> InvokeAsync(GetIpsecTunnelArgs args, InvokeOptions? opts = null)
    public static Output<GetIpsecTunnelResult> Invoke(GetIpsecTunnelInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetIpsecTunnelResult> getIpsecTunnel(GetIpsecTunnelArgs args, InvokeOptions options)
public static Output<GetIpsecTunnelResult> getIpsecTunnel(GetIpsecTunnelArgs args, InvokeOptions options)

fn::invoke:
  function: ionoscloud:vpn/getIpsecTunnel:getIpsecTunnel
  arguments:
    # arguments dictionary

The following arguments are supported:

GatewayId string: The ID of the IPSec Gateway that the tunnel belongs to.
Id string: ID of an existing IPSec Gateway Tunnel that you want to search for.
Location string: The location of the IPSec Gateway Tunnel.
Name string: Name of an existing IPSec Gateway Tunnel that you want to search for.

GatewayId string: The ID of the IPSec Gateway that the tunnel belongs to.
Id string: ID of an existing IPSec Gateway Tunnel that you want to search for.
Location string: The location of the IPSec Gateway Tunnel.
Name string: Name of an existing IPSec Gateway Tunnel that you want to search for.

gatewayId String: The ID of the IPSec Gateway that the tunnel belongs to.
id String: ID of an existing IPSec Gateway Tunnel that you want to search for.
location String: The location of the IPSec Gateway Tunnel.
name String: Name of an existing IPSec Gateway Tunnel that you want to search for.

gatewayId string: The ID of the IPSec Gateway that the tunnel belongs to.
id string: ID of an existing IPSec Gateway Tunnel that you want to search for.
location string: The location of the IPSec Gateway Tunnel.
name string: Name of an existing IPSec Gateway Tunnel that you want to search for.

gateway_id str: The ID of the IPSec Gateway that the tunnel belongs to.
id str: ID of an existing IPSec Gateway Tunnel that you want to search for.
location str: The location of the IPSec Gateway Tunnel.
name str: Name of an existing IPSec Gateway Tunnel that you want to search for.

gatewayId String: The ID of the IPSec Gateway that the tunnel belongs to.
id String: ID of an existing IPSec Gateway Tunnel that you want to search for.
location String: The location of the IPSec Gateway Tunnel.
name String: Name of an existing IPSec Gateway Tunnel that you want to search for.

getIpsecTunnel Result

The following output properties are available:

Auths List<Ionoscloud.GetIpsecTunnelAuth>
CloudNetworkCidrs List<string>
Description string
Esps List<Ionoscloud.GetIpsecTunnelEsp>
GatewayId string
Id string
Ikes List<Ionoscloud.GetIpsecTunnelIke>
Name string
PeerNetworkCidrs List<string>
RemoteHost string
Location string

Auths []GetIpsecTunnelAuth
CloudNetworkCidrs []string
Description string
Esps []GetIpsecTunnelEsp
GatewayId string
Id string
Ikes []GetIpsecTunnelIke
Name string
PeerNetworkCidrs []string
RemoteHost string
Location string

auths List<GetIpsecTunnelAuth>
cloudNetworkCidrs List<String>
description String
esps List<GetIpsecTunnelEsp>
gatewayId String
id String
ikes List<GetIpsecTunnelIke>
name String
peerNetworkCidrs List<String>
remoteHost String
location String

auths GetIpsecTunnelAuth[]
cloudNetworkCidrs string[]
description string
esps GetIpsecTunnelEsp[]
gatewayId string
id string
ikes GetIpsecTunnelIke[]
name string
peerNetworkCidrs string[]
remoteHost string
location string

auths Sequence[GetIpsecTunnelAuth]
cloud_network_cidrs Sequence[str]
description str
esps Sequence[GetIpsecTunnelEsp]
gateway_id str
id str
ikes Sequence[GetIpsecTunnelIke]
name str
peer_network_cidrs Sequence[str]
remote_host str
location str

auths List<Property Map>
cloudNetworkCidrs List<String>
description String
esps List<Property Map>
gatewayId String
id String
ikes List<Property Map>
name String
peerNetworkCidrs List<String>
remoteHost String
location String

Supporting Types

GetIpsecTunnelAuth

Method string: The Authentication Method to use for IPSec Authentication.

Method string: The Authentication Method to use for IPSec Authentication.

method String: The Authentication Method to use for IPSec Authentication.

method string: The Authentication Method to use for IPSec Authentication.

method str: The Authentication Method to use for IPSec Authentication.

method String: The Authentication Method to use for IPSec Authentication.

GetIpsecTunnelEsp

DiffieHellmanGroup string: The Diffie-Hellman Group to use for IPSec Encryption.
EncryptionAlgorithm string: The encryption algorithm to use for IPSec Encryption.
IntegrityAlgorithm string: The integrity algorithm to use for IPSec Encryption.
Lifetime int: The phase lifetime in seconds.

DiffieHellmanGroup string: The Diffie-Hellman Group to use for IPSec Encryption.
EncryptionAlgorithm string: The encryption algorithm to use for IPSec Encryption.
IntegrityAlgorithm string: The integrity algorithm to use for IPSec Encryption.
Lifetime int: The phase lifetime in seconds.

diffieHellmanGroup String: The Diffie-Hellman Group to use for IPSec Encryption.
encryptionAlgorithm String: The encryption algorithm to use for IPSec Encryption.
integrityAlgorithm String: The integrity algorithm to use for IPSec Encryption.
lifetime Integer: The phase lifetime in seconds.

diffieHellmanGroup string: The Diffie-Hellman Group to use for IPSec Encryption.
encryptionAlgorithm string: The encryption algorithm to use for IPSec Encryption.
integrityAlgorithm string: The integrity algorithm to use for IPSec Encryption.
lifetime number: The phase lifetime in seconds.

diffie_hellman_group str: The Diffie-Hellman Group to use for IPSec Encryption.
encryption_algorithm str: The encryption algorithm to use for IPSec Encryption.
integrity_algorithm str: The integrity algorithm to use for IPSec Encryption.
lifetime int: The phase lifetime in seconds.

diffieHellmanGroup String: The Diffie-Hellman Group to use for IPSec Encryption.
encryptionAlgorithm String: The encryption algorithm to use for IPSec Encryption.
integrityAlgorithm String: The integrity algorithm to use for IPSec Encryption.
lifetime Number: The phase lifetime in seconds.

GetIpsecTunnelIke

DiffieHellmanGroup string: The Diffie-Hellman Group to use for IPSec Encryption.
EncryptionAlgorithm string: The encryption algorithm to use for IPSec Encryption.
IntegrityAlgorithm string: The integrity algorithm to use for IPSec Encryption.
Lifetime int: The phase lifetime in seconds.

DiffieHellmanGroup string: The Diffie-Hellman Group to use for IPSec Encryption.
EncryptionAlgorithm string: The encryption algorithm to use for IPSec Encryption.
IntegrityAlgorithm string: The integrity algorithm to use for IPSec Encryption.
Lifetime int: The phase lifetime in seconds.

diffieHellmanGroup String: The Diffie-Hellman Group to use for IPSec Encryption.
encryptionAlgorithm String: The encryption algorithm to use for IPSec Encryption.
integrityAlgorithm String: The integrity algorithm to use for IPSec Encryption.
lifetime Integer: The phase lifetime in seconds.

diffieHellmanGroup string: The Diffie-Hellman Group to use for IPSec Encryption.
encryptionAlgorithm string: The encryption algorithm to use for IPSec Encryption.
integrityAlgorithm string: The integrity algorithm to use for IPSec Encryption.
lifetime number: The phase lifetime in seconds.

diffie_hellman_group str: The Diffie-Hellman Group to use for IPSec Encryption.
encryption_algorithm str: The encryption algorithm to use for IPSec Encryption.
integrity_algorithm str: The integrity algorithm to use for IPSec Encryption.
lifetime int: The phase lifetime in seconds.

diffieHellmanGroup String: The Diffie-Hellman Group to use for IPSec Encryption.
encryptionAlgorithm String: The encryption algorithm to use for IPSec Encryption.
integrityAlgorithm String: The integrity algorithm to use for IPSec Encryption.
lifetime Number: The phase lifetime in seconds.

Package Details

Repository: ionoscloud ionos-cloud/pulumi-ionoscloud
License: Apache-2.0
Notes: This Pulumi package is based on the ionoscloud Terraform Provider.

IonosCloud v0.2.3 published on Tuesday, May 13, 2025 by ionos-cloud

ionos-cloud/pulumi-ionoscloud

ionoscloud.vpn.getIpsecTunnel

On this page

On this page

Example Usage

By ID

By Name

Attributes reference

Using getIpsecTunnel

getIpsecTunnel Result

Supporting Types

GetIpsecTunnelAuth

GetIpsecTunnelEsp

GetIpsecTunnelIke

Package Details

On this page

On this page