1. Packages
  2. Vcd Provider
  3. API Docs
  4. getNsxtIpsecVpnTunnel
vcd 3.14.1 published on Monday, Apr 14, 2025 by vmware

vcd.getNsxtIpsecVpnTunnel

Explore with Pulumi AI

vcd logo
vcd 3.14.1 published on Monday, Apr 14, 2025 by vmware

    Supported in provider v3.3+ and VCD 10.1+ with NSX-T backed VDCs.

    Provides a data source to read NSX-T IPsec VPN Tunnel. You can configure site-to-site connectivity between an NSX-T Data Center Edge Gateway and remote sites. The remote sites must use NSX-T Data Center, have third-party hardware routers, or VPN gateways that support IPSec.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as vcd from "@pulumi/vcd";
    
    const tunnel1 = vcd.getNsxtIpsecVpnTunnel({
        org: "my-org",
        edgeGatewayId: data.vcd_nsxt_edgegateway.existing.id,
        name: "tunnel-1",
    });
    
    import pulumi
    import pulumi_vcd as vcd
    
    tunnel1 = vcd.get_nsxt_ipsec_vpn_tunnel(org="my-org",
        edge_gateway_id=data["vcd_nsxt_edgegateway"]["existing"]["id"],
        name="tunnel-1")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-terraform-provider/sdks/go/vcd/v3/vcd"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := vcd.LookupNsxtIpsecVpnTunnel(ctx, &vcd.LookupNsxtIpsecVpnTunnelArgs{
    			Org:           pulumi.StringRef("my-org"),
    			EdgeGatewayId: data.Vcd_nsxt_edgegateway.Existing.Id,
    			Name:          "tunnel-1",
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Vcd = Pulumi.Vcd;
    
    return await Deployment.RunAsync(() => 
    {
        var tunnel1 = Vcd.GetNsxtIpsecVpnTunnel.Invoke(new()
        {
            Org = "my-org",
            EdgeGatewayId = data.Vcd_nsxt_edgegateway.Existing.Id,
            Name = "tunnel-1",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.vcd.VcdFunctions;
    import com.pulumi.vcd.inputs.GetNsxtIpsecVpnTunnelArgs;
    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 tunnel1 = VcdFunctions.getNsxtIpsecVpnTunnel(GetNsxtIpsecVpnTunnelArgs.builder()
                .org("my-org")
                .edgeGatewayId(data.vcd_nsxt_edgegateway().existing().id())
                .name("tunnel-1")
                .build());
    
        }
    }
    
    variables:
      tunnel1:
        fn::invoke:
          function: vcd:getNsxtIpsecVpnTunnel
          arguments:
            org: my-org
            edgeGatewayId: ${data.vcd_nsxt_edgegateway.existing.id}
            name: tunnel-1
    

    Using getNsxtIpsecVpnTunnel

    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 getNsxtIpsecVpnTunnel(args: GetNsxtIpsecVpnTunnelArgs, opts?: InvokeOptions): Promise<GetNsxtIpsecVpnTunnelResult>
    function getNsxtIpsecVpnTunnelOutput(args: GetNsxtIpsecVpnTunnelOutputArgs, opts?: InvokeOptions): Output<GetNsxtIpsecVpnTunnelResult>
    def get_nsxt_ipsec_vpn_tunnel(edge_gateway_id: Optional[str] = None,
                                  id: Optional[str] = None,
                                  name: Optional[str] = None,
                                  org: Optional[str] = None,
                                  vdc: Optional[str] = None,
                                  opts: Optional[InvokeOptions] = None) -> GetNsxtIpsecVpnTunnelResult
    def get_nsxt_ipsec_vpn_tunnel_output(edge_gateway_id: Optional[pulumi.Input[str]] = None,
                                  id: Optional[pulumi.Input[str]] = None,
                                  name: Optional[pulumi.Input[str]] = None,
                                  org: Optional[pulumi.Input[str]] = None,
                                  vdc: Optional[pulumi.Input[str]] = None,
                                  opts: Optional[InvokeOptions] = None) -> Output[GetNsxtIpsecVpnTunnelResult]
    func LookupNsxtIpsecVpnTunnel(ctx *Context, args *LookupNsxtIpsecVpnTunnelArgs, opts ...InvokeOption) (*LookupNsxtIpsecVpnTunnelResult, error)
    func LookupNsxtIpsecVpnTunnelOutput(ctx *Context, args *LookupNsxtIpsecVpnTunnelOutputArgs, opts ...InvokeOption) LookupNsxtIpsecVpnTunnelResultOutput

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

    public static class GetNsxtIpsecVpnTunnel 
    {
        public static Task<GetNsxtIpsecVpnTunnelResult> InvokeAsync(GetNsxtIpsecVpnTunnelArgs args, InvokeOptions? opts = null)
        public static Output<GetNsxtIpsecVpnTunnelResult> Invoke(GetNsxtIpsecVpnTunnelInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetNsxtIpsecVpnTunnelResult> getNsxtIpsecVpnTunnel(GetNsxtIpsecVpnTunnelArgs args, InvokeOptions options)
    public static Output<GetNsxtIpsecVpnTunnelResult> getNsxtIpsecVpnTunnel(GetNsxtIpsecVpnTunnelArgs args, InvokeOptions options)
    
    fn::invoke:
      function: vcd:index/getNsxtIpsecVpnTunnel:getNsxtIpsecVpnTunnel
      arguments:
        # arguments dictionary

    The following arguments are supported:

    EdgeGatewayId string
    The ID of the Edge Gateway (NSX-T only). Can be looked up using vcd.NsxtEdgegateway data source
    Name string
    Name of existing IPsec VPN Tunnel
    Id string
    Org string
    The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations.
    Vdc string

    Deprecated: Deprecated

    EdgeGatewayId string
    The ID of the Edge Gateway (NSX-T only). Can be looked up using vcd.NsxtEdgegateway data source
    Name string
    Name of existing IPsec VPN Tunnel
    Id string
    Org string
    The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations.
    Vdc string

    Deprecated: Deprecated

    edgeGatewayId String
    The ID of the Edge Gateway (NSX-T only). Can be looked up using vcd.NsxtEdgegateway data source
    name String
    Name of existing IPsec VPN Tunnel
    id String
    org String
    The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations.
    vdc String

    Deprecated: Deprecated

    edgeGatewayId string
    The ID of the Edge Gateway (NSX-T only). Can be looked up using vcd.NsxtEdgegateway data source
    name string
    Name of existing IPsec VPN Tunnel
    id string
    org string
    The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations.
    vdc string

    Deprecated: Deprecated

    edge_gateway_id str
    The ID of the Edge Gateway (NSX-T only). Can be looked up using vcd.NsxtEdgegateway data source
    name str
    Name of existing IPsec VPN Tunnel
    id str
    org str
    The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations.
    vdc str

    Deprecated: Deprecated

    edgeGatewayId String
    The ID of the Edge Gateway (NSX-T only). Can be looked up using vcd.NsxtEdgegateway data source
    name String
    Name of existing IPsec VPN Tunnel
    id String
    org String
    The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations.
    vdc String

    Deprecated: Deprecated

    getNsxtIpsecVpnTunnel Result

    The following output properties are available:

    authenticationMode String
    caCertificateId String
    certificateId String
    description String
    edgeGatewayId String
    enabled Boolean
    id String
    ikeFailReason String
    ikeServiceStatus String
    localIpAddress String
    localNetworks List<String>
    logging Boolean
    name String
    preSharedKey String
    remoteId String
    remoteIpAddress String
    remoteNetworks List<String>
    securityProfile String
    securityProfileCustomizations List<Property Map>
    status String
    org String
    vdc String

    Deprecated: Deprecated

    Supporting Types

    GetNsxtIpsecVpnTunnelSecurityProfileCustomization

    Package Details

    Repository
    vcd vmware/terraform-provider-vcd
    License
    Notes
    This Pulumi package is based on the vcd Terraform Provider.
    vcd logo
    vcd 3.14.1 published on Monday, Apr 14, 2025 by vmware