vcd.getNsxtIpsecVpnTunnel
Explore with Pulumi AI
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 dictionaryThe following arguments are supported:
- Edge
Gateway stringId  - The ID of the Edge Gateway (NSX-T only). Can be looked up using 
vcd.NsxtEdgegatewaydata 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
 
- Edge
Gateway stringId  - The ID of the Edge Gateway (NSX-T only). Can be looked up using 
vcd.NsxtEdgegatewaydata 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
 
- edge
Gateway StringId  - The ID of the Edge Gateway (NSX-T only). Can be looked up using 
vcd.NsxtEdgegatewaydata 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
 
- edge
Gateway stringId  - The ID of the Edge Gateway (NSX-T only). Can be looked up using 
vcd.NsxtEdgegatewaydata 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
 
- edge_
gateway_ strid  - The ID of the Edge Gateway (NSX-T only). Can be looked up using 
vcd.NsxtEdgegatewaydata 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
 
- edge
Gateway StringId  - The ID of the Edge Gateway (NSX-T only). Can be looked up using 
vcd.NsxtEdgegatewaydata 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
 
getNsxtIpsecVpnTunnel Result
The following output properties are available:
- Authentication
Mode string - Ca
Certificate stringId  - Certificate
Id string - Description string
 - Edge
Gateway stringId  - Enabled bool
 - Id string
 - Ike
Fail stringReason  - Ike
Service stringStatus  - Local
Ip stringAddress  - Local
Networks List<string> - Logging bool
 - Name string
 - string
 - Remote
Id string - Remote
Ip stringAddress  - Remote
Networks List<string> - Security
Profile string - Security
Profile List<GetCustomizations Nsxt Ipsec Vpn Tunnel Security Profile Customization>  - Status string
 - Org string
 - Vdc string
 
- Authentication
Mode string - Ca
Certificate stringId  - Certificate
Id string - Description string
 - Edge
Gateway stringId  - Enabled bool
 - Id string
 - Ike
Fail stringReason  - Ike
Service stringStatus  - Local
Ip stringAddress  - Local
Networks []string - Logging bool
 - Name string
 - string
 - Remote
Id string - Remote
Ip stringAddress  - Remote
Networks []string - Security
Profile string - Security
Profile []GetCustomizations Nsxt Ipsec Vpn Tunnel Security Profile Customization  - Status string
 - Org string
 - Vdc string
 
- authentication
Mode String - ca
Certificate StringId  - certificate
Id String - description String
 - edge
Gateway StringId  - enabled Boolean
 - id String
 - ike
Fail StringReason  - ike
Service StringStatus  - local
Ip StringAddress  - local
Networks List<String> - logging Boolean
 - name String
 - String
 - remote
Id String - remote
Ip StringAddress  - remote
Networks List<String> - security
Profile String - security
Profile List<GetCustomizations Nsxt Ipsec Vpn Tunnel Security Profile Customization>  - status String
 - org String
 - vdc String
 
- authentication
Mode string - ca
Certificate stringId  - certificate
Id string - description string
 - edge
Gateway stringId  - enabled boolean
 - id string
 - ike
Fail stringReason  - ike
Service stringStatus  - local
Ip stringAddress  - local
Networks string[] - logging boolean
 - name string
 - string
 - remote
Id string - remote
Ip stringAddress  - remote
Networks string[] - security
Profile string - security
Profile GetCustomizations Nsxt Ipsec Vpn Tunnel Security Profile Customization[]  - status string
 - org string
 - vdc string
 
- authentication_
mode str - ca_
certificate_ strid  - certificate_
id str - description str
 - edge_
gateway_ strid  - enabled bool
 - id str
 - ike_
fail_ strreason  - ike_
service_ strstatus  - local_
ip_ straddress  - local_
networks Sequence[str] - logging bool
 - name str
 - str
 - remote_
id str - remote_
ip_ straddress  - remote_
networks Sequence[str] - security_
profile str - security_
profile_ Sequence[Getcustomizations Nsxt Ipsec Vpn Tunnel Security Profile Customization]  - status str
 - org str
 - vdc str
 
- authentication
Mode String - ca
Certificate StringId  - certificate
Id String - description String
 - edge
Gateway StringId  - enabled Boolean
 - id String
 - ike
Fail StringReason  - ike
Service StringStatus  - local
Ip StringAddress  - local
Networks List<String> - logging Boolean
 - name String
 - String
 - remote
Id String - remote
Ip StringAddress  - remote
Networks List<String> - security
Profile String - security
Profile List<Property Map>Customizations  - status String
 - org String
 - vdc String
 
Supporting Types
GetNsxtIpsecVpnTunnelSecurityProfileCustomization       
- Dpd
Probe doubleInternal  - Ike
Dh List<string>Groups  - Ike
Digest List<string>Algorithms  - Ike
Encryption List<string>Algorithms  - Ike
Sa doubleLifetime  - Ike
Version string - Tunnel
Df stringPolicy  - Tunnel
Dh List<string>Groups  - Tunnel
Digest List<string>Algorithms  - Tunnel
Encryption List<string>Algorithms  - Tunnel
Pfs boolEnabled  - Tunnel
Sa doubleLifetime  
- Dpd
Probe float64Internal  - Ike
Dh []stringGroups  - Ike
Digest []stringAlgorithms  - Ike
Encryption []stringAlgorithms  - Ike
Sa float64Lifetime  - Ike
Version string - Tunnel
Df stringPolicy  - Tunnel
Dh []stringGroups  - Tunnel
Digest []stringAlgorithms  - Tunnel
Encryption []stringAlgorithms  - Tunnel
Pfs boolEnabled  - Tunnel
Sa float64Lifetime  
- dpd
Probe DoubleInternal  - ike
Dh List<String>Groups  - ike
Digest List<String>Algorithms  - ike
Encryption List<String>Algorithms  - ike
Sa DoubleLifetime  - ike
Version String - tunnel
Df StringPolicy  - tunnel
Dh List<String>Groups  - tunnel
Digest List<String>Algorithms  - tunnel
Encryption List<String>Algorithms  - tunnel
Pfs BooleanEnabled  - tunnel
Sa DoubleLifetime  
- dpd
Probe numberInternal  - ike
Dh string[]Groups  - ike
Digest string[]Algorithms  - ike
Encryption string[]Algorithms  - ike
Sa numberLifetime  - ike
Version string - tunnel
Df stringPolicy  - tunnel
Dh string[]Groups  - tunnel
Digest string[]Algorithms  - tunnel
Encryption string[]Algorithms  - tunnel
Pfs booleanEnabled  - tunnel
Sa numberLifetime  
- dpd_
probe_ floatinternal  - ike_
dh_ Sequence[str]groups  - ike_
digest_ Sequence[str]algorithms  - ike_
encryption_ Sequence[str]algorithms  - ike_
sa_ floatlifetime  - ike_
version str - tunnel_
df_ strpolicy  - tunnel_
dh_ Sequence[str]groups  - tunnel_
digest_ Sequence[str]algorithms  - tunnel_
encryption_ Sequence[str]algorithms  - tunnel_
pfs_ boolenabled  - tunnel_
sa_ floatlifetime  
- dpd
Probe NumberInternal  - ike
Dh List<String>Groups  - ike
Digest List<String>Algorithms  - ike
Encryption List<String>Algorithms  - ike
Sa NumberLifetime  - ike
Version String - tunnel
Df StringPolicy  - tunnel
Dh List<String>Groups  - tunnel
Digest List<String>Algorithms  - tunnel
Encryption List<String>Algorithms  - tunnel
Pfs BooleanEnabled  - tunnel
Sa NumberLifetime  
Package Details
- Repository
 - vcd vmware/terraform-provider-vcd
 - License
 - Notes
 - This Pulumi package is based on the 
vcdTerraform Provider.