Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Vcd Provider
  3. API Docs
  4. EdgegatewayVpn
vcd 3.14.1 published on Monday, Apr 14, 2025 by vmware
vmware/terraform-provider-vcd

vcd.EdgegatewayVpn

Explore with Pulumi AI

vcd 3.14.1 published on Monday, Apr 14, 2025 by vmware
vmware/terraform-provider-vcd

Provides a VMware Cloud Director IPsec VPN. This can be used to create, modify, and delete VPN settings and rules.

Example Usage

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

const vpn = new vcd.EdgegatewayVpn("vpn", {
    description: "Description",
    edgeGateway: "Internet_01(nti0000bi2_123-456-2)",
    encryptionProtocol: "AES256",
    localId: "64.121.123.10",
    localIpAddress: "64.121.123.10",
    localSubnets: [
        {
            localSubnetGateway: "10.0.1.1",
            localSubnetMask: "255.255.255.0",
            localSubnetName: "DMZ_EAST",
        },
        {
            localSubnetGateway: "10.0.22.1",
            localSubnetMask: "255.255.255.0",
            localSubnetName: "WEB_EAST",
        },
    ],
    mtu: 1400,
    peerId: "64.121.123.11",
    peerIpAddress: "64.121.123.11",
    peerSubnets: [
        {
            peerSubnetGateway: "10.0.10.1",
            peerSubnetMask: "255.255.255.0",
            peerSubnetName: "DMZ_WEST",
        },
        {
            peerSubnetGateway: "10.0.20.1",
            peerSubnetMask: "255.255.255.0",
            peerSubnetName: "WEB_WEST",
        },
    ],
    sharedSecret: "***********************",
});
Copy
import pulumi
import pulumi_vcd as vcd

vpn = vcd.EdgegatewayVpn("vpn",
    description="Description",
    edge_gateway="Internet_01(nti0000bi2_123-456-2)",
    encryption_protocol="AES256",
    local_id="64.121.123.10",
    local_ip_address="64.121.123.10",
    local_subnets=[
        {
            "local_subnet_gateway": "10.0.1.1",
            "local_subnet_mask": "255.255.255.0",
            "local_subnet_name": "DMZ_EAST",
        },
        {
            "local_subnet_gateway": "10.0.22.1",
            "local_subnet_mask": "255.255.255.0",
            "local_subnet_name": "WEB_EAST",
        },
    ],
    mtu=1400,
    peer_id="64.121.123.11",
    peer_ip_address="64.121.123.11",
    peer_subnets=[
        {
            "peer_subnet_gateway": "10.0.10.1",
            "peer_subnet_mask": "255.255.255.0",
            "peer_subnet_name": "DMZ_WEST",
        },
        {
            "peer_subnet_gateway": "10.0.20.1",
            "peer_subnet_mask": "255.255.255.0",
            "peer_subnet_name": "WEB_WEST",
        },
    ],
    shared_secret="***********************")
Copy
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.NewEdgegatewayVpn(ctx, "vpn", &vcd.EdgegatewayVpnArgs{
			Description:        pulumi.String("Description"),
			EdgeGateway:        pulumi.String("Internet_01(nti0000bi2_123-456-2)"),
			EncryptionProtocol: pulumi.String("AES256"),
			LocalId:            pulumi.String("64.121.123.10"),
			LocalIpAddress:     pulumi.String("64.121.123.10"),
			LocalSubnets: vcd.EdgegatewayVpnLocalSubnetArray{
				&vcd.EdgegatewayVpnLocalSubnetArgs{
					LocalSubnetGateway: pulumi.String("10.0.1.1"),
					LocalSubnetMask:    pulumi.String("255.255.255.0"),
					LocalSubnetName:    pulumi.String("DMZ_EAST"),
				},
				&vcd.EdgegatewayVpnLocalSubnetArgs{
					LocalSubnetGateway: pulumi.String("10.0.22.1"),
					LocalSubnetMask:    pulumi.String("255.255.255.0"),
					LocalSubnetName:    pulumi.String("WEB_EAST"),
				},
			},
			Mtu:           pulumi.Float64(1400),
			PeerId:        pulumi.String("64.121.123.11"),
			PeerIpAddress: pulumi.String("64.121.123.11"),
			PeerSubnets: vcd.EdgegatewayVpnPeerSubnetArray{
				&vcd.EdgegatewayVpnPeerSubnetArgs{
					PeerSubnetGateway: pulumi.String("10.0.10.1"),
					PeerSubnetMask:    pulumi.String("255.255.255.0"),
					PeerSubnetName:    pulumi.String("DMZ_WEST"),
				},
				&vcd.EdgegatewayVpnPeerSubnetArgs{
					PeerSubnetGateway: pulumi.String("10.0.20.1"),
					PeerSubnetMask:    pulumi.String("255.255.255.0"),
					PeerSubnetName:    pulumi.String("WEB_WEST"),
				},
			},
			SharedSecret: pulumi.String("***********************"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Vcd = Pulumi.Vcd;

return await Deployment.RunAsync(() => 
{
    var vpn = new Vcd.EdgegatewayVpn("vpn", new()
    {
        Description = "Description",
        EdgeGateway = "Internet_01(nti0000bi2_123-456-2)",
        EncryptionProtocol = "AES256",
        LocalId = "64.121.123.10",
        LocalIpAddress = "64.121.123.10",
        LocalSubnets = new[]
        {
            new Vcd.Inputs.EdgegatewayVpnLocalSubnetArgs
            {
                LocalSubnetGateway = "10.0.1.1",
                LocalSubnetMask = "255.255.255.0",
                LocalSubnetName = "DMZ_EAST",
            },
            new Vcd.Inputs.EdgegatewayVpnLocalSubnetArgs
            {
                LocalSubnetGateway = "10.0.22.1",
                LocalSubnetMask = "255.255.255.0",
                LocalSubnetName = "WEB_EAST",
            },
        },
        Mtu = 1400,
        PeerId = "64.121.123.11",
        PeerIpAddress = "64.121.123.11",
        PeerSubnets = new[]
        {
            new Vcd.Inputs.EdgegatewayVpnPeerSubnetArgs
            {
                PeerSubnetGateway = "10.0.10.1",
                PeerSubnetMask = "255.255.255.0",
                PeerSubnetName = "DMZ_WEST",
            },
            new Vcd.Inputs.EdgegatewayVpnPeerSubnetArgs
            {
                PeerSubnetGateway = "10.0.20.1",
                PeerSubnetMask = "255.255.255.0",
                PeerSubnetName = "WEB_WEST",
            },
        },
        SharedSecret = "***********************",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.vcd.EdgegatewayVpn;
import com.pulumi.vcd.EdgegatewayVpnArgs;
import com.pulumi.vcd.inputs.EdgegatewayVpnLocalSubnetArgs;
import com.pulumi.vcd.inputs.EdgegatewayVpnPeerSubnetArgs;
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 vpn = new EdgegatewayVpn("vpn", EdgegatewayVpnArgs.builder()
            .description("Description")
            .edgeGateway("Internet_01(nti0000bi2_123-456-2)")
            .encryptionProtocol("AES256")
            .localId("64.121.123.10")
            .localIpAddress("64.121.123.10")
            .localSubnets(            
                EdgegatewayVpnLocalSubnetArgs.builder()
                    .localSubnetGateway("10.0.1.1")
                    .localSubnetMask("255.255.255.0")
                    .localSubnetName("DMZ_EAST")
                    .build(),
                EdgegatewayVpnLocalSubnetArgs.builder()
                    .localSubnetGateway("10.0.22.1")
                    .localSubnetMask("255.255.255.0")
                    .localSubnetName("WEB_EAST")
                    .build())
            .mtu(1400)
            .peerId("64.121.123.11")
            .peerIpAddress("64.121.123.11")
            .peerSubnets(            
                EdgegatewayVpnPeerSubnetArgs.builder()
                    .peerSubnetGateway("10.0.10.1")
                    .peerSubnetMask("255.255.255.0")
                    .peerSubnetName("DMZ_WEST")
                    .build(),
                EdgegatewayVpnPeerSubnetArgs.builder()
                    .peerSubnetGateway("10.0.20.1")
                    .peerSubnetMask("255.255.255.0")
                    .peerSubnetName("WEB_WEST")
                    .build())
            .sharedSecret("***********************")
            .build());

    }
}
Copy
resources:
  vpn:
    type: vcd:EdgegatewayVpn
    properties:
      description: Description
      edgeGateway: Internet_01(nti0000bi2_123-456-2)
      encryptionProtocol: AES256
      localId: 64.121.123.10
      localIpAddress: 64.121.123.10
      localSubnets:
        - localSubnetGateway: 10.0.1.1
          localSubnetMask: 255.255.255.0
          localSubnetName: DMZ_EAST
        - localSubnetGateway: 10.0.22.1
          localSubnetMask: 255.255.255.0
          localSubnetName: WEB_EAST
      mtu: 1400
      peerId: 64.121.123.11
      peerIpAddress: 64.121.123.11
      peerSubnets:
        - peerSubnetGateway: 10.0.10.1
          peerSubnetMask: 255.255.255.0
          peerSubnetName: DMZ_WEST
        - peerSubnetGateway: 10.0.20.1
          peerSubnetMask: 255.255.255.0
          peerSubnetName: WEB_WEST
      sharedSecret: '***********************'
Copy

Local Subnets

Each Local Subnet supports the following attributes:

  • local_subnet_name - (Required) Name of the local subnet
  • local_subnet_gateway - (Required) Gateway of the local subnet
  • local_subnet_mask - (Required) Subnet mask of the local subnet

Peer Subnets

Each Peer Subnet supports the following attributes:

  • peer_subnet_name - (Required) Name of the peer subnet
  • peer_subnet_gateway - (Required) Gateway of the peer subnet
  • peer_subnet_mask - (Required) Subnet mask of the peer subnet

Create EdgegatewayVpn Resource

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

Constructor syntax

new EdgegatewayVpn(name: string, args: EdgegatewayVpnArgs, opts?: CustomResourceOptions);
@overload
def EdgegatewayVpn(resource_name: str,
                   args: EdgegatewayVpnArgs,
                   opts: Optional[ResourceOptions] = None)

@overload
def EdgegatewayVpn(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   peer_id: Optional[str] = None,
                   edge_gateway: Optional[str] = None,
                   shared_secret: Optional[str] = None,
                   encryption_protocol: Optional[str] = None,
                   local_id: Optional[str] = None,
                   local_ip_address: Optional[str] = None,
                   peer_ip_address: Optional[str] = None,
                   mtu: Optional[float] = None,
                   local_subnets: Optional[Sequence[EdgegatewayVpnLocalSubnetArgs]] = None,
                   org: Optional[str] = None,
                   name: Optional[str] = None,
                   description: Optional[str] = None,
                   peer_subnets: Optional[Sequence[EdgegatewayVpnPeerSubnetArgs]] = None,
                   edgegateway_vpn_id: Optional[str] = None,
                   vdc: Optional[str] = None)
func NewEdgegatewayVpn(ctx *Context, name string, args EdgegatewayVpnArgs, opts ...ResourceOption) (*EdgegatewayVpn, error)
public EdgegatewayVpn(string name, EdgegatewayVpnArgs args, CustomResourceOptions? opts = null)
public EdgegatewayVpn(String name, EdgegatewayVpnArgs args)
public EdgegatewayVpn(String name, EdgegatewayVpnArgs args, CustomResourceOptions options)

type: vcd:EdgegatewayVpn
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. EdgegatewayVpnArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. EdgegatewayVpnArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. EdgegatewayVpnArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. EdgegatewayVpnArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. EdgegatewayVpnArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

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

var edgegatewayVpnResource = new Vcd.EdgegatewayVpn("edgegatewayVpnResource", new()
{
    PeerId = "string",
    EdgeGateway = "string",
    SharedSecret = "string",
    EncryptionProtocol = "string",
    LocalId = "string",
    LocalIpAddress = "string",
    PeerIpAddress = "string",
    Mtu = 0,
    LocalSubnets = new[]
    {
        new Vcd.Inputs.EdgegatewayVpnLocalSubnetArgs
        {
            LocalSubnetGateway = "string",
            LocalSubnetMask = "string",
            LocalSubnetName = "string",
        },
    },
    Org = "string",
    Name = "string",
    Description = "string",
    PeerSubnets = new[]
    {
        new Vcd.Inputs.EdgegatewayVpnPeerSubnetArgs
        {
            PeerSubnetGateway = "string",
            PeerSubnetMask = "string",
            PeerSubnetName = "string",
        },
    },
    EdgegatewayVpnId = "string",
    Vdc = "string",
});
Copy
example, err := vcd.NewEdgegatewayVpn(ctx, "edgegatewayVpnResource", &vcd.EdgegatewayVpnArgs{
PeerId: pulumi.String("string"),
EdgeGateway: pulumi.String("string"),
SharedSecret: pulumi.String("string"),
EncryptionProtocol: pulumi.String("string"),
LocalId: pulumi.String("string"),
LocalIpAddress: pulumi.String("string"),
PeerIpAddress: pulumi.String("string"),
Mtu: pulumi.Float64(0),
LocalSubnets: .EdgegatewayVpnLocalSubnetArray{
&.EdgegatewayVpnLocalSubnetArgs{
LocalSubnetGateway: pulumi.String("string"),
LocalSubnetMask: pulumi.String("string"),
LocalSubnetName: pulumi.String("string"),
},
},
Org: pulumi.String("string"),
Name: pulumi.String("string"),
Description: pulumi.String("string"),
PeerSubnets: .EdgegatewayVpnPeerSubnetArray{
&.EdgegatewayVpnPeerSubnetArgs{
PeerSubnetGateway: pulumi.String("string"),
PeerSubnetMask: pulumi.String("string"),
PeerSubnetName: pulumi.String("string"),
},
},
EdgegatewayVpnId: pulumi.String("string"),
Vdc: pulumi.String("string"),
})
Copy
var edgegatewayVpnResource = new EdgegatewayVpn("edgegatewayVpnResource", EdgegatewayVpnArgs.builder()
    .peerId("string")
    .edgeGateway("string")
    .sharedSecret("string")
    .encryptionProtocol("string")
    .localId("string")
    .localIpAddress("string")
    .peerIpAddress("string")
    .mtu(0)
    .localSubnets(EdgegatewayVpnLocalSubnetArgs.builder()
        .localSubnetGateway("string")
        .localSubnetMask("string")
        .localSubnetName("string")
        .build())
    .org("string")
    .name("string")
    .description("string")
    .peerSubnets(EdgegatewayVpnPeerSubnetArgs.builder()
        .peerSubnetGateway("string")
        .peerSubnetMask("string")
        .peerSubnetName("string")
        .build())
    .edgegatewayVpnId("string")
    .vdc("string")
    .build());
Copy
edgegateway_vpn_resource = vcd.EdgegatewayVpn("edgegatewayVpnResource",
    peer_id="string",
    edge_gateway="string",
    shared_secret="string",
    encryption_protocol="string",
    local_id="string",
    local_ip_address="string",
    peer_ip_address="string",
    mtu=0,
    local_subnets=[{
        "local_subnet_gateway": "string",
        "local_subnet_mask": "string",
        "local_subnet_name": "string",
    }],
    org="string",
    name="string",
    description="string",
    peer_subnets=[{
        "peer_subnet_gateway": "string",
        "peer_subnet_mask": "string",
        "peer_subnet_name": "string",
    }],
    edgegateway_vpn_id="string",
    vdc="string")
Copy
const edgegatewayVpnResource = new vcd.EdgegatewayVpn("edgegatewayVpnResource", {
    peerId: "string",
    edgeGateway: "string",
    sharedSecret: "string",
    encryptionProtocol: "string",
    localId: "string",
    localIpAddress: "string",
    peerIpAddress: "string",
    mtu: 0,
    localSubnets: [{
        localSubnetGateway: "string",
        localSubnetMask: "string",
        localSubnetName: "string",
    }],
    org: "string",
    name: "string",
    description: "string",
    peerSubnets: [{
        peerSubnetGateway: "string",
        peerSubnetMask: "string",
        peerSubnetName: "string",
    }],
    edgegatewayVpnId: "string",
    vdc: "string",
});
Copy
type: vcd:EdgegatewayVpn
properties:
    description: string
    edgeGateway: string
    edgegatewayVpnId: string
    encryptionProtocol: string
    localId: string
    localIpAddress: string
    localSubnets:
        - localSubnetGateway: string
          localSubnetMask: string
          localSubnetName: string
    mtu: 0
    name: string
    org: string
    peerId: string
    peerIpAddress: string
    peerSubnets:
        - peerSubnetGateway: string
          peerSubnetMask: string
          peerSubnetName: string
    sharedSecret: string
    vdc: string
Copy

EdgegatewayVpn Resource Properties

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

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The EdgegatewayVpn resource accepts the following input properties:

EdgeGateway This property is required. string
The name of the edge gateway on which to apply the Firewall Rules
EncryptionProtocol This property is required. string
E.g. AES256
LocalId This property is required. string
Local ID
LocalIpAddress This property is required. string
Local IP Address
Mtu This property is required. double
The MTU setting
PeerId This property is required. string
Peer ID
PeerIpAddress This property is required. string
Peer IP Address
SharedSecret This property is required. string
Shared Secret
Description string
A description for the VPN
EdgegatewayVpnId string
LocalSubnets List<EdgegatewayVpnLocalSubnet>
List of Local Subnets see Local Subnets below for details.
Name string
The name of the VPN
Org string
The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations
PeerSubnets List<EdgegatewayVpnPeerSubnet>
List of Peer Subnets see Peer Subnets below for details.
Vdc string

The name of VDC to use, optional if defined at provider level

EdgeGateway This property is required. string
The name of the edge gateway on which to apply the Firewall Rules
EncryptionProtocol This property is required. string
E.g. AES256
LocalId This property is required. string
Local ID
LocalIpAddress This property is required. string
Local IP Address
Mtu This property is required. float64
The MTU setting
PeerId This property is required. string
Peer ID
PeerIpAddress This property is required. string
Peer IP Address
SharedSecret This property is required. string
Shared Secret
Description string
A description for the VPN
EdgegatewayVpnId string
LocalSubnets []EdgegatewayVpnLocalSubnetArgs
List of Local Subnets see Local Subnets below for details.
Name string
The name of the VPN
Org string
The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations
PeerSubnets []EdgegatewayVpnPeerSubnetArgs
List of Peer Subnets see Peer Subnets below for details.
Vdc string

The name of VDC to use, optional if defined at provider level

edgeGateway This property is required. String
The name of the edge gateway on which to apply the Firewall Rules
encryptionProtocol This property is required. String
E.g. AES256
localId This property is required. String
Local ID
localIpAddress This property is required. String
Local IP Address
mtu This property is required. Double
The MTU setting
peerId This property is required. String
Peer ID
peerIpAddress This property is required. String
Peer IP Address
sharedSecret This property is required. String
Shared Secret
description String
A description for the VPN
edgegatewayVpnId String
localSubnets List<EdgegatewayVpnLocalSubnet>
List of Local Subnets see Local Subnets below for details.
name String
The name of the VPN
org String
The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations
peerSubnets List<EdgegatewayVpnPeerSubnet>
List of Peer Subnets see Peer Subnets below for details.
vdc String

The name of VDC to use, optional if defined at provider level

edgeGateway This property is required. string
The name of the edge gateway on which to apply the Firewall Rules
encryptionProtocol This property is required. string
E.g. AES256
localId This property is required. string
Local ID
localIpAddress This property is required. string
Local IP Address
mtu This property is required. number
The MTU setting
peerId This property is required. string
Peer ID
peerIpAddress This property is required. string
Peer IP Address
sharedSecret This property is required. string
Shared Secret
description string
A description for the VPN
edgegatewayVpnId string
localSubnets EdgegatewayVpnLocalSubnet[]
List of Local Subnets see Local Subnets below for details.
name string
The name of the VPN
org string
The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations
peerSubnets EdgegatewayVpnPeerSubnet[]
List of Peer Subnets see Peer Subnets below for details.
vdc string

The name of VDC to use, optional if defined at provider level

edge_gateway This property is required. str
The name of the edge gateway on which to apply the Firewall Rules
encryption_protocol This property is required. str
E.g. AES256
local_id This property is required. str
Local ID
local_ip_address This property is required. str
Local IP Address
mtu This property is required. float
The MTU setting
peer_id This property is required. str
Peer ID
peer_ip_address This property is required. str
Peer IP Address
shared_secret This property is required. str
Shared Secret
description str
A description for the VPN
edgegateway_vpn_id str
local_subnets Sequence[EdgegatewayVpnLocalSubnetArgs]
List of Local Subnets see Local Subnets below for details.
name str
The name of the VPN
org str
The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations
peer_subnets Sequence[EdgegatewayVpnPeerSubnetArgs]
List of Peer Subnets see Peer Subnets below for details.
vdc str

The name of VDC to use, optional if defined at provider level

edgeGateway This property is required. String
The name of the edge gateway on which to apply the Firewall Rules
encryptionProtocol This property is required. String
E.g. AES256
localId This property is required. String
Local ID
localIpAddress This property is required. String
Local IP Address
mtu This property is required. Number
The MTU setting
peerId This property is required. String
Peer ID
peerIpAddress This property is required. String
Peer IP Address
sharedSecret This property is required. String
Shared Secret
description String
A description for the VPN
edgegatewayVpnId String
localSubnets List<Property Map>
List of Local Subnets see Local Subnets below for details.
name String
The name of the VPN
org String
The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations
peerSubnets List<Property Map>
List of Peer Subnets see Peer Subnets below for details.
vdc String

The name of VDC to use, optional if defined at provider level

Outputs

All input properties are implicitly available as output properties. Additionally, the EdgegatewayVpn 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 EdgegatewayVpn Resource

Get an existing EdgegatewayVpn 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?: EdgegatewayVpnState, opts?: CustomResourceOptions): EdgegatewayVpn
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        description: Optional[str] = None,
        edge_gateway: Optional[str] = None,
        edgegateway_vpn_id: Optional[str] = None,
        encryption_protocol: Optional[str] = None,
        local_id: Optional[str] = None,
        local_ip_address: Optional[str] = None,
        local_subnets: Optional[Sequence[EdgegatewayVpnLocalSubnetArgs]] = None,
        mtu: Optional[float] = None,
        name: Optional[str] = None,
        org: Optional[str] = None,
        peer_id: Optional[str] = None,
        peer_ip_address: Optional[str] = None,
        peer_subnets: Optional[Sequence[EdgegatewayVpnPeerSubnetArgs]] = None,
        shared_secret: Optional[str] = None,
        vdc: Optional[str] = None) -> EdgegatewayVpn
func GetEdgegatewayVpn(ctx *Context, name string, id IDInput, state *EdgegatewayVpnState, opts ...ResourceOption) (*EdgegatewayVpn, error)
public static EdgegatewayVpn Get(string name, Input<string> id, EdgegatewayVpnState? state, CustomResourceOptions? opts = null)
public static EdgegatewayVpn get(String name, Output<String> id, EdgegatewayVpnState state, CustomResourceOptions options)
resources:  _:    type: vcd:EdgegatewayVpn    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
Description string
A description for the VPN
EdgeGateway string
The name of the edge gateway on which to apply the Firewall Rules
EdgegatewayVpnId string
EncryptionProtocol string
E.g. AES256
LocalId string
Local ID
LocalIpAddress string
Local IP Address
LocalSubnets List<EdgegatewayVpnLocalSubnet>
List of Local Subnets see Local Subnets below for details.
Mtu double
The MTU setting
Name string
The name of the VPN
Org string
The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations
PeerId string
Peer ID
PeerIpAddress string
Peer IP Address
PeerSubnets List<EdgegatewayVpnPeerSubnet>
List of Peer Subnets see Peer Subnets below for details.
SharedSecret string
Shared Secret
Vdc string

The name of VDC to use, optional if defined at provider level

Description string
A description for the VPN
EdgeGateway string
The name of the edge gateway on which to apply the Firewall Rules
EdgegatewayVpnId string
EncryptionProtocol string
E.g. AES256
LocalId string
Local ID
LocalIpAddress string
Local IP Address
LocalSubnets []EdgegatewayVpnLocalSubnetArgs
List of Local Subnets see Local Subnets below for details.
Mtu float64
The MTU setting
Name string
The name of the VPN
Org string
The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations
PeerId string
Peer ID
PeerIpAddress string
Peer IP Address
PeerSubnets []EdgegatewayVpnPeerSubnetArgs
List of Peer Subnets see Peer Subnets below for details.
SharedSecret string
Shared Secret
Vdc string

The name of VDC to use, optional if defined at provider level

description String
A description for the VPN
edgeGateway String
The name of the edge gateway on which to apply the Firewall Rules
edgegatewayVpnId String
encryptionProtocol String
E.g. AES256
localId String
Local ID
localIpAddress String
Local IP Address
localSubnets List<EdgegatewayVpnLocalSubnet>
List of Local Subnets see Local Subnets below for details.
mtu Double
The MTU setting
name String
The name of the VPN
org String
The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations
peerId String
Peer ID
peerIpAddress String
Peer IP Address
peerSubnets List<EdgegatewayVpnPeerSubnet>
List of Peer Subnets see Peer Subnets below for details.
sharedSecret String
Shared Secret
vdc String

The name of VDC to use, optional if defined at provider level

description string
A description for the VPN
edgeGateway string
The name of the edge gateway on which to apply the Firewall Rules
edgegatewayVpnId string
encryptionProtocol string
E.g. AES256
localId string
Local ID
localIpAddress string
Local IP Address
localSubnets EdgegatewayVpnLocalSubnet[]
List of Local Subnets see Local Subnets below for details.
mtu number
The MTU setting
name string
The name of the VPN
org string
The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations
peerId string
Peer ID
peerIpAddress string
Peer IP Address
peerSubnets EdgegatewayVpnPeerSubnet[]
List of Peer Subnets see Peer Subnets below for details.
sharedSecret string
Shared Secret
vdc string

The name of VDC to use, optional if defined at provider level

description str
A description for the VPN
edge_gateway str
The name of the edge gateway on which to apply the Firewall Rules
edgegateway_vpn_id str
encryption_protocol str
E.g. AES256
local_id str
Local ID
local_ip_address str
Local IP Address
local_subnets Sequence[EdgegatewayVpnLocalSubnetArgs]
List of Local Subnets see Local Subnets below for details.
mtu float
The MTU setting
name str
The name of the VPN
org str
The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations
peer_id str
Peer ID
peer_ip_address str
Peer IP Address
peer_subnets Sequence[EdgegatewayVpnPeerSubnetArgs]
List of Peer Subnets see Peer Subnets below for details.
shared_secret str
Shared Secret
vdc str

The name of VDC to use, optional if defined at provider level

description String
A description for the VPN
edgeGateway String
The name of the edge gateway on which to apply the Firewall Rules
edgegatewayVpnId String
encryptionProtocol String
E.g. AES256
localId String
Local ID
localIpAddress String
Local IP Address
localSubnets List<Property Map>
List of Local Subnets see Local Subnets below for details.
mtu Number
The MTU setting
name String
The name of the VPN
org String
The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations
peerId String
Peer ID
peerIpAddress String
Peer IP Address
peerSubnets List<Property Map>
List of Peer Subnets see Peer Subnets below for details.
sharedSecret String
Shared Secret
vdc String

The name of VDC to use, optional if defined at provider level

Supporting Types

EdgegatewayVpnLocalSubnet
, EdgegatewayVpnLocalSubnetArgs

LocalSubnetGateway This property is required. string
LocalSubnetMask This property is required. string
LocalSubnetName This property is required. string
LocalSubnetGateway This property is required. string
LocalSubnetMask This property is required. string
LocalSubnetName This property is required. string
localSubnetGateway This property is required. String
localSubnetMask This property is required. String
localSubnetName This property is required. String
localSubnetGateway This property is required. string
localSubnetMask This property is required. string
localSubnetName This property is required. string
local_subnet_gateway This property is required. str
local_subnet_mask This property is required. str
local_subnet_name This property is required. str
localSubnetGateway This property is required. String
localSubnetMask This property is required. String
localSubnetName This property is required. String

EdgegatewayVpnPeerSubnet
, EdgegatewayVpnPeerSubnetArgs

PeerSubnetGateway This property is required. string
PeerSubnetMask This property is required. string
PeerSubnetName This property is required. string
PeerSubnetGateway This property is required. string
PeerSubnetMask This property is required. string
PeerSubnetName This property is required. string
peerSubnetGateway This property is required. String
peerSubnetMask This property is required. String
peerSubnetName This property is required. String
peerSubnetGateway This property is required. string
peerSubnetMask This property is required. string
peerSubnetName This property is required. string
peer_subnet_gateway This property is required. str
peer_subnet_mask This property is required. str
peer_subnet_name This property is required. str
peerSubnetGateway This property is required. String
peerSubnetMask This property is required. String
peerSubnetName This property is required. String

Package Details

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