Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Openstack Provider
  3. API Docs
  4. vpnaas
  5. SiteConnection
OpenStack v5.0.3 published on Wednesday, Feb 12, 2025 by Pulumi
pulumi/pulumi-openstack

openstack.vpnaas.SiteConnection

Explore with Pulumi AI

openstack logo
OpenStack v5.0.3 published on Wednesday, Feb 12, 2025 by Pulumi
pulumi/pulumi-openstack

    Manages a V2 Neutron IPSec site connection resource within OpenStack.

    Example Usage

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

const conn1 = new openstack.vpnaas.SiteConnection("conn_1", {
    name: "connection_1",
    ikepolicyId: policy2.id,
    ipsecpolicyId: policy1.id,
    vpnserviceId: service1.id,
    psk: "secret",
    peerAddress: "192.168.10.1",
    localEpGroupId: group2.id,
    peerEpGroupId: group1.id,
    dpds: [{
        action: "restart",
        timeout: 42,
        interval: 21,
    }],
});

    import pulumi
import pulumi_openstack as openstack

conn1 = openstack.vpnaas.SiteConnection("conn_1",
    name="connection_1",
    ikepolicy_id=policy2["id"],
    ipsecpolicy_id=policy1["id"],
    vpnservice_id=service1["id"],
    psk="secret",
    peer_address="192.168.10.1",
    local_ep_group_id=group2["id"],
    peer_ep_group_id=group1["id"],
    dpds=[{
        "action": "restart",
        "timeout": 42,
        "interval": 21,
    }])

    package main

import (
	"github.com/pulumi/pulumi-openstack/sdk/v5/go/openstack/vpnaas"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := vpnaas.NewSiteConnection(ctx, "conn_1", &vpnaas.SiteConnectionArgs{
			Name:           pulumi.String("connection_1"),
			IkepolicyId:    pulumi.Any(policy2.Id),
			IpsecpolicyId:  pulumi.Any(policy1.Id),
			VpnserviceId:   pulumi.Any(service1.Id),
			Psk:            pulumi.String("secret"),
			PeerAddress:    pulumi.String("192.168.10.1"),
			LocalEpGroupId: pulumi.Any(group2.Id),
			PeerEpGroupId:  pulumi.Any(group1.Id),
			Dpds: vpnaas.SiteConnectionDpdArray{
				&vpnaas.SiteConnectionDpdArgs{
					Action:   pulumi.String("restart"),
					Timeout:  pulumi.Int(42),
					Interval: pulumi.Int(21),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var conn1 = new OpenStack.VPNaaS.SiteConnection("conn_1", new()
    {
        Name = "connection_1",
        IkepolicyId = policy2.Id,
        IpsecpolicyId = policy1.Id,
        VpnserviceId = service1.Id,
        Psk = "secret",
        PeerAddress = "192.168.10.1",
        LocalEpGroupId = group2.Id,
        PeerEpGroupId = group1.Id,
        Dpds = new[]
        {
            new OpenStack.VPNaaS.Inputs.SiteConnectionDpdArgs
            {
                Action = "restart",
                Timeout = 42,
                Interval = 21,
            },
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.openstack.vpnaas.SiteConnection;
import com.pulumi.openstack.vpnaas.SiteConnectionArgs;
import com.pulumi.openstack.vpnaas.inputs.SiteConnectionDpdArgs;
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 conn1 = new SiteConnection("conn1", SiteConnectionArgs.builder()
            .name("connection_1")
            .ikepolicyId(policy2.id())
            .ipsecpolicyId(policy1.id())
            .vpnserviceId(service1.id())
            .psk("secret")
            .peerAddress("192.168.10.1")
            .localEpGroupId(group2.id())
            .peerEpGroupId(group1.id())
            .dpds(SiteConnectionDpdArgs.builder()
                .action("restart")
                .timeout(42)
                .interval(21)
                .build())
            .build());

    }
}

    resources:
  conn1:
    type: openstack:vpnaas:SiteConnection
    name: conn_1
    properties:
      name: connection_1
      ikepolicyId: ${policy2.id}
      ipsecpolicyId: ${policy1.id}
      vpnserviceId: ${service1.id}
      psk: secret
      peerAddress: 192.168.10.1
      localEpGroupId: ${group2.id}
      peerEpGroupId: ${group1.id}
      dpds:
        - action: restart
          timeout: 42
          interval: 21

    Create SiteConnection Resource

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

    Constructor syntax

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

@overload
def SiteConnection(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   peer_address: Optional[str] = None,
                   vpnservice_id: Optional[str] = None,
                   psk: Optional[str] = None,
                   ikepolicy_id: Optional[str] = None,
                   peer_id: Optional[str] = None,
                   ipsecpolicy_id: Optional[str] = None,
                   mtu: Optional[int] = None,
                   local_id: Optional[str] = None,
                   admin_state_up: Optional[bool] = None,
                   name: Optional[str] = None,
                   local_ep_group_id: Optional[str] = None,
                   peer_cidrs: Optional[Sequence[str]] = None,
                   peer_ep_group_id: Optional[str] = None,
                   initiator: Optional[str] = None,
                   dpds: Optional[Sequence[SiteConnectionDpdArgs]] = None,
                   region: Optional[str] = None,
                   tenant_id: Optional[str] = None,
                   value_specs: Optional[Mapping[str, str]] = None,
                   description: Optional[str] = None)
    func NewSiteConnection(ctx *Context, name string, args SiteConnectionArgs, opts ...ResourceOption) (*SiteConnection, error)
    public SiteConnection(string name, SiteConnectionArgs args, CustomResourceOptions? opts = null)
    public SiteConnection(String name, SiteConnectionArgs args)
public SiteConnection(String name, SiteConnectionArgs args, CustomResourceOptions options)

    type: openstack:vpnaas:SiteConnection
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args SiteConnectionArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args SiteConnectionArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args SiteConnectionArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SiteConnectionArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SiteConnectionArgs
    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 siteConnectionResource = new OpenStack.VPNaaS.SiteConnection("siteConnectionResource", new()
{
    PeerAddress = "string",
    VpnserviceId = "string",
    Psk = "string",
    IkepolicyId = "string",
    PeerId = "string",
    IpsecpolicyId = "string",
    Mtu = 0,
    LocalId = "string",
    AdminStateUp = false,
    Name = "string",
    LocalEpGroupId = "string",
    PeerCidrs = new[]
    {
        "string",
    },
    PeerEpGroupId = "string",
    Initiator = "string",
    Dpds = new[]
    {
        new OpenStack.VPNaaS.Inputs.SiteConnectionDpdArgs
        {
            Action = "string",
            Interval = 0,
            Timeout = 0,
        },
    },
    Region = "string",
    TenantId = "string",
    ValueSpecs = 
    {
        { "string", "string" },
    },
    Description = "string",
});

    example, err := vpnaas.NewSiteConnection(ctx, "siteConnectionResource", &vpnaas.SiteConnectionArgs{
	PeerAddress:    pulumi.String("string"),
	VpnserviceId:   pulumi.String("string"),
	Psk:            pulumi.String("string"),
	IkepolicyId:    pulumi.String("string"),
	PeerId:         pulumi.String("string"),
	IpsecpolicyId:  pulumi.String("string"),
	Mtu:            pulumi.Int(0),
	LocalId:        pulumi.String("string"),
	AdminStateUp:   pulumi.Bool(false),
	Name:           pulumi.String("string"),
	LocalEpGroupId: pulumi.String("string"),
	PeerCidrs: pulumi.StringArray{
		pulumi.String("string"),
	},
	PeerEpGroupId: pulumi.String("string"),
	Initiator:     pulumi.String("string"),
	Dpds: vpnaas.SiteConnectionDpdArray{
		&vpnaas.SiteConnectionDpdArgs{
			Action:   pulumi.String("string"),
			Interval: pulumi.Int(0),
			Timeout:  pulumi.Int(0),
		},
	},
	Region:   pulumi.String("string"),
	TenantId: pulumi.String("string"),
	ValueSpecs: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Description: pulumi.String("string"),
})

    var siteConnectionResource = new SiteConnection("siteConnectionResource", SiteConnectionArgs.builder()
    .peerAddress("string")
    .vpnserviceId("string")
    .psk("string")
    .ikepolicyId("string")
    .peerId("string")
    .ipsecpolicyId("string")
    .mtu(0)
    .localId("string")
    .adminStateUp(false)
    .name("string")
    .localEpGroupId("string")
    .peerCidrs("string")
    .peerEpGroupId("string")
    .initiator("string")
    .dpds(SiteConnectionDpdArgs.builder()
        .action("string")
        .interval(0)
        .timeout(0)
        .build())
    .region("string")
    .tenantId("string")
    .valueSpecs(Map.of("string", "string"))
    .description("string")
    .build());

    site_connection_resource = openstack.vpnaas.SiteConnection("siteConnectionResource",
    peer_address="string",
    vpnservice_id="string",
    psk="string",
    ikepolicy_id="string",
    peer_id="string",
    ipsecpolicy_id="string",
    mtu=0,
    local_id="string",
    admin_state_up=False,
    name="string",
    local_ep_group_id="string",
    peer_cidrs=["string"],
    peer_ep_group_id="string",
    initiator="string",
    dpds=[{
        "action": "string",
        "interval": 0,
        "timeout": 0,
    }],
    region="string",
    tenant_id="string",
    value_specs={
        "string": "string",
    },
    description="string")

    const siteConnectionResource = new openstack.vpnaas.SiteConnection("siteConnectionResource", {
    peerAddress: "string",
    vpnserviceId: "string",
    psk: "string",
    ikepolicyId: "string",
    peerId: "string",
    ipsecpolicyId: "string",
    mtu: 0,
    localId: "string",
    adminStateUp: false,
    name: "string",
    localEpGroupId: "string",
    peerCidrs: ["string"],
    peerEpGroupId: "string",
    initiator: "string",
    dpds: [{
        action: "string",
        interval: 0,
        timeout: 0,
    }],
    region: "string",
    tenantId: "string",
    valueSpecs: {
        string: "string",
    },
    description: "string",
});

    type: openstack:vpnaas:SiteConnection
properties:
    adminStateUp: false
    description: string
    dpds:
        - action: string
          interval: 0
          timeout: 0
    ikepolicyId: string
    initiator: string
    ipsecpolicyId: string
    localEpGroupId: string
    localId: string
    mtu: 0
    name: string
    peerAddress: string
    peerCidrs:
        - string
    peerEpGroupId: string
    peerId: string
    psk: string
    region: string
    tenantId: string
    valueSpecs:
        string: string
    vpnserviceId: string

    SiteConnection 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 SiteConnection resource accepts the following input properties:

    IkepolicyId string
    The ID of the IKE policy. Changing this creates a new connection.
    IpsecpolicyId string
    The ID of the IPsec policy. Changing this creates a new connection.
    PeerAddress string
    The peer gateway public IPv4 or IPv6 address or FQDN.
    PeerId string
    The peer router identity for authentication. A valid value is an IPv4 address, IPv6 address, e-mail address, key ID, or FQDN. Typically, this value matches the peer_address value. Changing this updates the existing policy.
    Psk string
    The pre-shared key. A valid value is any string.
    VpnserviceId string
    The ID of the VPN service. Changing this creates a new connection.
    AdminStateUp bool
    The administrative state of the resource. Can either be up(true) or down(false). Changing this updates the administrative state of the existing connection.
    Description string
    The human-readable description for the connection. Changing this updates the description of the existing connection.
    Dpds List<Pulumi.OpenStack.VPNaaS.Inputs.SiteConnectionDpd>
    A dictionary with dead peer detection (DPD) protocol controls.
    Initiator string
    A valid value is response-only or bi-directional. Default is bi-directional.
    LocalEpGroupId string
    The ID for the endpoint group that contains private subnets for the local side of the connection. You must specify this parameter with the peer_ep_group_id parameter unless in backward- compatible mode where peer_cidrs is provided with a subnet_id for the VPN service. Changing this updates the existing connection.
    LocalId string
    An ID to be used instead of the external IP address for a virtual router used in traffic between instances on different networks in east-west traffic. Most often, local ID would be domain name, email address, etc. If this is not configured then the external IP address will be used as the ID.
    Mtu int
    The maximum transmission unit (MTU) value to address fragmentation. Minimum value is 68 for IPv4, and 1280 for IPv6.
    Name string
    The name of the connection. Changing this updates the name of the existing connection.
    PeerCidrs List<string>
    Unique list of valid peer private CIDRs in the form < net_address > / < prefix > .
    PeerEpGroupId string
    The ID for the endpoint group that contains private CIDRs in the form < net_address > / < prefix > for the peer side of the connection. You must specify this parameter with the local_ep_group_id parameter unless in backward-compatible mode where peer_cidrs is provided with a subnet_id for the VPN service.
    Region string
    The region in which to obtain the V2 Networking client. A Networking client is needed to create an IPSec site connection. If omitted, the region argument of the provider is used. Changing this creates a new site connection.
    TenantId string
    The owner of the connection. Required if admin wants to create a connection for another project. Changing this creates a new connection.
    ValueSpecs Dictionary<string, string>
    Map of additional options.
    IkepolicyId string
    The ID of the IKE policy. Changing this creates a new connection.
    IpsecpolicyId string
    The ID of the IPsec policy. Changing this creates a new connection.
    PeerAddress string
    The peer gateway public IPv4 or IPv6 address or FQDN.
    PeerId string
    The peer router identity for authentication. A valid value is an IPv4 address, IPv6 address, e-mail address, key ID, or FQDN. Typically, this value matches the peer_address value. Changing this updates the existing policy.
    Psk string
    The pre-shared key. A valid value is any string.
    VpnserviceId string
    The ID of the VPN service. Changing this creates a new connection.
    AdminStateUp bool
    The administrative state of the resource. Can either be up(true) or down(false). Changing this updates the administrative state of the existing connection.
    Description string
    The human-readable description for the connection. Changing this updates the description of the existing connection.
    Dpds []SiteConnectionDpdArgs
    A dictionary with dead peer detection (DPD) protocol controls.
    Initiator string
    A valid value is response-only or bi-directional. Default is bi-directional.
    LocalEpGroupId string
    The ID for the endpoint group that contains private subnets for the local side of the connection. You must specify this parameter with the peer_ep_group_id parameter unless in backward- compatible mode where peer_cidrs is provided with a subnet_id for the VPN service. Changing this updates the existing connection.
    LocalId string
    An ID to be used instead of the external IP address for a virtual router used in traffic between instances on different networks in east-west traffic. Most often, local ID would be domain name, email address, etc. If this is not configured then the external IP address will be used as the ID.
    Mtu int
    The maximum transmission unit (MTU) value to address fragmentation. Minimum value is 68 for IPv4, and 1280 for IPv6.
    Name string
    The name of the connection. Changing this updates the name of the existing connection.
    PeerCidrs []string
    Unique list of valid peer private CIDRs in the form < net_address > / < prefix > .
    PeerEpGroupId string
    The ID for the endpoint group that contains private CIDRs in the form < net_address > / < prefix > for the peer side of the connection. You must specify this parameter with the local_ep_group_id parameter unless in backward-compatible mode where peer_cidrs is provided with a subnet_id for the VPN service.
    Region string
    The region in which to obtain the V2 Networking client. A Networking client is needed to create an IPSec site connection. If omitted, the region argument of the provider is used. Changing this creates a new site connection.
    TenantId string
    The owner of the connection. Required if admin wants to create a connection for another project. Changing this creates a new connection.
    ValueSpecs map[string]string
    Map of additional options.
    ikepolicyId String
    The ID of the IKE policy. Changing this creates a new connection.
    ipsecpolicyId String
    The ID of the IPsec policy. Changing this creates a new connection.
    peerAddress String
    The peer gateway public IPv4 or IPv6 address or FQDN.
    peerId String
    The peer router identity for authentication. A valid value is an IPv4 address, IPv6 address, e-mail address, key ID, or FQDN. Typically, this value matches the peer_address value. Changing this updates the existing policy.
    psk String
    The pre-shared key. A valid value is any string.
    vpnserviceId String
    The ID of the VPN service. Changing this creates a new connection.
    adminStateUp Boolean
    The administrative state of the resource. Can either be up(true) or down(false). Changing this updates the administrative state of the existing connection.
    description String
    The human-readable description for the connection. Changing this updates the description of the existing connection.
    dpds List<SiteConnectionDpd>
    A dictionary with dead peer detection (DPD) protocol controls.
    initiator String
    A valid value is response-only or bi-directional. Default is bi-directional.
    localEpGroupId String
    The ID for the endpoint group that contains private subnets for the local side of the connection. You must specify this parameter with the peer_ep_group_id parameter unless in backward- compatible mode where peer_cidrs is provided with a subnet_id for the VPN service. Changing this updates the existing connection.
    localId String
    An ID to be used instead of the external IP address for a virtual router used in traffic between instances on different networks in east-west traffic. Most often, local ID would be domain name, email address, etc. If this is not configured then the external IP address will be used as the ID.
    mtu Integer
    The maximum transmission unit (MTU) value to address fragmentation. Minimum value is 68 for IPv4, and 1280 for IPv6.
    name String
    The name of the connection. Changing this updates the name of the existing connection.
    peerCidrs List<String>
    Unique list of valid peer private CIDRs in the form < net_address > / < prefix > .
    peerEpGroupId String
    The ID for the endpoint group that contains private CIDRs in the form < net_address > / < prefix > for the peer side of the connection. You must specify this parameter with the local_ep_group_id parameter unless in backward-compatible mode where peer_cidrs is provided with a subnet_id for the VPN service.
    region String
    The region in which to obtain the V2 Networking client. A Networking client is needed to create an IPSec site connection. If omitted, the region argument of the provider is used. Changing this creates a new site connection.
    tenantId String
    The owner of the connection. Required if admin wants to create a connection for another project. Changing this creates a new connection.
    valueSpecs Map<String,String>
    Map of additional options.
    ikepolicyId string
    The ID of the IKE policy. Changing this creates a new connection.
    ipsecpolicyId string
    The ID of the IPsec policy. Changing this creates a new connection.
    peerAddress string
    The peer gateway public IPv4 or IPv6 address or FQDN.
    peerId string
    The peer router identity for authentication. A valid value is an IPv4 address, IPv6 address, e-mail address, key ID, or FQDN. Typically, this value matches the peer_address value. Changing this updates the existing policy.
    psk string
    The pre-shared key. A valid value is any string.
    vpnserviceId string
    The ID of the VPN service. Changing this creates a new connection.
    adminStateUp boolean
    The administrative state of the resource. Can either be up(true) or down(false). Changing this updates the administrative state of the existing connection.
    description string
    The human-readable description for the connection. Changing this updates the description of the existing connection.
    dpds SiteConnectionDpd[]
    A dictionary with dead peer detection (DPD) protocol controls.
    initiator string
    A valid value is response-only or bi-directional. Default is bi-directional.
    localEpGroupId string
    The ID for the endpoint group that contains private subnets for the local side of the connection. You must specify this parameter with the peer_ep_group_id parameter unless in backward- compatible mode where peer_cidrs is provided with a subnet_id for the VPN service. Changing this updates the existing connection.
    localId string
    An ID to be used instead of the external IP address for a virtual router used in traffic between instances on different networks in east-west traffic. Most often, local ID would be domain name, email address, etc. If this is not configured then the external IP address will be used as the ID.
    mtu number
    The maximum transmission unit (MTU) value to address fragmentation. Minimum value is 68 for IPv4, and 1280 for IPv6.
    name string
    The name of the connection. Changing this updates the name of the existing connection.
    peerCidrs string[]
    Unique list of valid peer private CIDRs in the form < net_address > / < prefix > .
    peerEpGroupId string
    The ID for the endpoint group that contains private CIDRs in the form < net_address > / < prefix > for the peer side of the connection. You must specify this parameter with the local_ep_group_id parameter unless in backward-compatible mode where peer_cidrs is provided with a subnet_id for the VPN service.
    region string
    The region in which to obtain the V2 Networking client. A Networking client is needed to create an IPSec site connection. If omitted, the region argument of the provider is used. Changing this creates a new site connection.
    tenantId string
    The owner of the connection. Required if admin wants to create a connection for another project. Changing this creates a new connection.
    valueSpecs {[key: string]: string}
    Map of additional options.
    ikepolicy_id str
    The ID of the IKE policy. Changing this creates a new connection.
    ipsecpolicy_id str
    The ID of the IPsec policy. Changing this creates a new connection.
    peer_address str
    The peer gateway public IPv4 or IPv6 address or FQDN.
    peer_id str
    The peer router identity for authentication. A valid value is an IPv4 address, IPv6 address, e-mail address, key ID, or FQDN. Typically, this value matches the peer_address value. Changing this updates the existing policy.
    psk str
    The pre-shared key. A valid value is any string.
    vpnservice_id str
    The ID of the VPN service. Changing this creates a new connection.
    admin_state_up bool
    The administrative state of the resource. Can either be up(true) or down(false). Changing this updates the administrative state of the existing connection.
    description str
    The human-readable description for the connection. Changing this updates the description of the existing connection.
    dpds Sequence[SiteConnectionDpdArgs]
    A dictionary with dead peer detection (DPD) protocol controls.
    initiator str
    A valid value is response-only or bi-directional. Default is bi-directional.
    local_ep_group_id str
    The ID for the endpoint group that contains private subnets for the local side of the connection. You must specify this parameter with the peer_ep_group_id parameter unless in backward- compatible mode where peer_cidrs is provided with a subnet_id for the VPN service. Changing this updates the existing connection.
    local_id str
    An ID to be used instead of the external IP address for a virtual router used in traffic between instances on different networks in east-west traffic. Most often, local ID would be domain name, email address, etc. If this is not configured then the external IP address will be used as the ID.
    mtu int
    The maximum transmission unit (MTU) value to address fragmentation. Minimum value is 68 for IPv4, and 1280 for IPv6.
    name str
    The name of the connection. Changing this updates the name of the existing connection.
    peer_cidrs Sequence[str]
    Unique list of valid peer private CIDRs in the form < net_address > / < prefix > .
    peer_ep_group_id str
    The ID for the endpoint group that contains private CIDRs in the form < net_address > / < prefix > for the peer side of the connection. You must specify this parameter with the local_ep_group_id parameter unless in backward-compatible mode where peer_cidrs is provided with a subnet_id for the VPN service.
    region str
    The region in which to obtain the V2 Networking client. A Networking client is needed to create an IPSec site connection. If omitted, the region argument of the provider is used. Changing this creates a new site connection.
    tenant_id str
    The owner of the connection. Required if admin wants to create a connection for another project. Changing this creates a new connection.
    value_specs Mapping[str, str]
    Map of additional options.
    ikepolicyId String
    The ID of the IKE policy. Changing this creates a new connection.
    ipsecpolicyId String
    The ID of the IPsec policy. Changing this creates a new connection.
    peerAddress String
    The peer gateway public IPv4 or IPv6 address or FQDN.
    peerId String
    The peer router identity for authentication. A valid value is an IPv4 address, IPv6 address, e-mail address, key ID, or FQDN. Typically, this value matches the peer_address value. Changing this updates the existing policy.
    psk String
    The pre-shared key. A valid value is any string.
    vpnserviceId String
    The ID of the VPN service. Changing this creates a new connection.
    adminStateUp Boolean
    The administrative state of the resource. Can either be up(true) or down(false). Changing this updates the administrative state of the existing connection.
    description String
    The human-readable description for the connection. Changing this updates the description of the existing connection.
    dpds List<Property Map>
    A dictionary with dead peer detection (DPD) protocol controls.
    initiator String
    A valid value is response-only or bi-directional. Default is bi-directional.
    localEpGroupId String
    The ID for the endpoint group that contains private subnets for the local side of the connection. You must specify this parameter with the peer_ep_group_id parameter unless in backward- compatible mode where peer_cidrs is provided with a subnet_id for the VPN service. Changing this updates the existing connection.
    localId String
    An ID to be used instead of the external IP address for a virtual router used in traffic between instances on different networks in east-west traffic. Most often, local ID would be domain name, email address, etc. If this is not configured then the external IP address will be used as the ID.
    mtu Number
    The maximum transmission unit (MTU) value to address fragmentation. Minimum value is 68 for IPv4, and 1280 for IPv6.
    name String
    The name of the connection. Changing this updates the name of the existing connection.
    peerCidrs List<String>
    Unique list of valid peer private CIDRs in the form < net_address > / < prefix > .
    peerEpGroupId String
    The ID for the endpoint group that contains private CIDRs in the form < net_address > / < prefix > for the peer side of the connection. You must specify this parameter with the local_ep_group_id parameter unless in backward-compatible mode where peer_cidrs is provided with a subnet_id for the VPN service.
    region String
    The region in which to obtain the V2 Networking client. A Networking client is needed to create an IPSec site connection. If omitted, the region argument of the provider is used. Changing this creates a new site connection.
    tenantId String
    The owner of the connection. Required if admin wants to create a connection for another project. Changing this creates a new connection.
    valueSpecs Map<String>
    Map of additional options.

    Outputs

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

    Get an existing SiteConnection 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?: SiteConnectionState, opts?: CustomResourceOptions): SiteConnection
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        admin_state_up: Optional[bool] = None,
        description: Optional[str] = None,
        dpds: Optional[Sequence[SiteConnectionDpdArgs]] = None,
        ikepolicy_id: Optional[str] = None,
        initiator: Optional[str] = None,
        ipsecpolicy_id: Optional[str] = None,
        local_ep_group_id: Optional[str] = None,
        local_id: Optional[str] = None,
        mtu: Optional[int] = None,
        name: Optional[str] = None,
        peer_address: Optional[str] = None,
        peer_cidrs: Optional[Sequence[str]] = None,
        peer_ep_group_id: Optional[str] = None,
        peer_id: Optional[str] = None,
        psk: Optional[str] = None,
        region: Optional[str] = None,
        tenant_id: Optional[str] = None,
        value_specs: Optional[Mapping[str, str]] = None,
        vpnservice_id: Optional[str] = None) -> SiteConnection
    func GetSiteConnection(ctx *Context, name string, id IDInput, state *SiteConnectionState, opts ...ResourceOption) (*SiteConnection, error)
    public static SiteConnection Get(string name, Input<string> id, SiteConnectionState? state, CustomResourceOptions? opts = null)
    public static SiteConnection get(String name, Output<String> id, SiteConnectionState state, CustomResourceOptions options)
    resources:  _:    type: openstack:vpnaas:SiteConnection    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    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:
    AdminStateUp bool
    The administrative state of the resource. Can either be up(true) or down(false). Changing this updates the administrative state of the existing connection.
    Description string
    The human-readable description for the connection. Changing this updates the description of the existing connection.
    Dpds List<Pulumi.OpenStack.VPNaaS.Inputs.SiteConnectionDpd>
    A dictionary with dead peer detection (DPD) protocol controls.
    IkepolicyId string
    The ID of the IKE policy. Changing this creates a new connection.
    Initiator string
    A valid value is response-only or bi-directional. Default is bi-directional.
    IpsecpolicyId string
    The ID of the IPsec policy. Changing this creates a new connection.
    LocalEpGroupId string
    The ID for the endpoint group that contains private subnets for the local side of the connection. You must specify this parameter with the peer_ep_group_id parameter unless in backward- compatible mode where peer_cidrs is provided with a subnet_id for the VPN service. Changing this updates the existing connection.
    LocalId string
    An ID to be used instead of the external IP address for a virtual router used in traffic between instances on different networks in east-west traffic. Most often, local ID would be domain name, email address, etc. If this is not configured then the external IP address will be used as the ID.
    Mtu int
    The maximum transmission unit (MTU) value to address fragmentation. Minimum value is 68 for IPv4, and 1280 for IPv6.
    Name string
    The name of the connection. Changing this updates the name of the existing connection.
    PeerAddress string
    The peer gateway public IPv4 or IPv6 address or FQDN.
    PeerCidrs List<string>
    Unique list of valid peer private CIDRs in the form < net_address > / < prefix > .
    PeerEpGroupId string
    The ID for the endpoint group that contains private CIDRs in the form < net_address > / < prefix > for the peer side of the connection. You must specify this parameter with the local_ep_group_id parameter unless in backward-compatible mode where peer_cidrs is provided with a subnet_id for the VPN service.
    PeerId string
    The peer router identity for authentication. A valid value is an IPv4 address, IPv6 address, e-mail address, key ID, or FQDN. Typically, this value matches the peer_address value. Changing this updates the existing policy.
    Psk string
    The pre-shared key. A valid value is any string.
    Region string
    The region in which to obtain the V2 Networking client. A Networking client is needed to create an IPSec site connection. If omitted, the region argument of the provider is used. Changing this creates a new site connection.
    TenantId string
    The owner of the connection. Required if admin wants to create a connection for another project. Changing this creates a new connection.
    ValueSpecs Dictionary<string, string>
    Map of additional options.
    VpnserviceId string
    The ID of the VPN service. Changing this creates a new connection.
    AdminStateUp bool
    The administrative state of the resource. Can either be up(true) or down(false). Changing this updates the administrative state of the existing connection.
    Description string
    The human-readable description for the connection. Changing this updates the description of the existing connection.
    Dpds []SiteConnectionDpdArgs
    A dictionary with dead peer detection (DPD) protocol controls.
    IkepolicyId string
    The ID of the IKE policy. Changing this creates a new connection.
    Initiator string
    A valid value is response-only or bi-directional. Default is bi-directional.
    IpsecpolicyId string
    The ID of the IPsec policy. Changing this creates a new connection.
    LocalEpGroupId string
    The ID for the endpoint group that contains private subnets for the local side of the connection. You must specify this parameter with the peer_ep_group_id parameter unless in backward- compatible mode where peer_cidrs is provided with a subnet_id for the VPN service. Changing this updates the existing connection.
    LocalId string
    An ID to be used instead of the external IP address for a virtual router used in traffic between instances on different networks in east-west traffic. Most often, local ID would be domain name, email address, etc. If this is not configured then the external IP address will be used as the ID.
    Mtu int
    The maximum transmission unit (MTU) value to address fragmentation. Minimum value is 68 for IPv4, and 1280 for IPv6.
    Name string
    The name of the connection. Changing this updates the name of the existing connection.
    PeerAddress string
    The peer gateway public IPv4 or IPv6 address or FQDN.
    PeerCidrs []string
    Unique list of valid peer private CIDRs in the form < net_address > / < prefix > .
    PeerEpGroupId string
    The ID for the endpoint group that contains private CIDRs in the form < net_address > / < prefix > for the peer side of the connection. You must specify this parameter with the local_ep_group_id parameter unless in backward-compatible mode where peer_cidrs is provided with a subnet_id for the VPN service.
    PeerId string
    The peer router identity for authentication. A valid value is an IPv4 address, IPv6 address, e-mail address, key ID, or FQDN. Typically, this value matches the peer_address value. Changing this updates the existing policy.
    Psk string
    The pre-shared key. A valid value is any string.
    Region string
    The region in which to obtain the V2 Networking client. A Networking client is needed to create an IPSec site connection. If omitted, the region argument of the provider is used. Changing this creates a new site connection.
    TenantId string
    The owner of the connection. Required if admin wants to create a connection for another project. Changing this creates a new connection.
    ValueSpecs map[string]string
    Map of additional options.
    VpnserviceId string
    The ID of the VPN service. Changing this creates a new connection.
    adminStateUp Boolean
    The administrative state of the resource. Can either be up(true) or down(false). Changing this updates the administrative state of the existing connection.
    description String
    The human-readable description for the connection. Changing this updates the description of the existing connection.
    dpds List<SiteConnectionDpd>
    A dictionary with dead peer detection (DPD) protocol controls.
    ikepolicyId String
    The ID of the IKE policy. Changing this creates a new connection.
    initiator String
    A valid value is response-only or bi-directional. Default is bi-directional.
    ipsecpolicyId String
    The ID of the IPsec policy. Changing this creates a new connection.
    localEpGroupId String
    The ID for the endpoint group that contains private subnets for the local side of the connection. You must specify this parameter with the peer_ep_group_id parameter unless in backward- compatible mode where peer_cidrs is provided with a subnet_id for the VPN service. Changing this updates the existing connection.
    localId String
    An ID to be used instead of the external IP address for a virtual router used in traffic between instances on different networks in east-west traffic. Most often, local ID would be domain name, email address, etc. If this is not configured then the external IP address will be used as the ID.
    mtu Integer
    The maximum transmission unit (MTU) value to address fragmentation. Minimum value is 68 for IPv4, and 1280 for IPv6.
    name String
    The name of the connection. Changing this updates the name of the existing connection.
    peerAddress String
    The peer gateway public IPv4 or IPv6 address or FQDN.
    peerCidrs List<String>
    Unique list of valid peer private CIDRs in the form < net_address > / < prefix > .
    peerEpGroupId String
    The ID for the endpoint group that contains private CIDRs in the form < net_address > / < prefix > for the peer side of the connection. You must specify this parameter with the local_ep_group_id parameter unless in backward-compatible mode where peer_cidrs is provided with a subnet_id for the VPN service.
    peerId String
    The peer router identity for authentication. A valid value is an IPv4 address, IPv6 address, e-mail address, key ID, or FQDN. Typically, this value matches the peer_address value. Changing this updates the existing policy.
    psk String
    The pre-shared key. A valid value is any string.
    region String
    The region in which to obtain the V2 Networking client. A Networking client is needed to create an IPSec site connection. If omitted, the region argument of the provider is used. Changing this creates a new site connection.
    tenantId String
    The owner of the connection. Required if admin wants to create a connection for another project. Changing this creates a new connection.
    valueSpecs Map<String,String>
    Map of additional options.
    vpnserviceId String
    The ID of the VPN service. Changing this creates a new connection.
    adminStateUp boolean
    The administrative state of the resource. Can either be up(true) or down(false). Changing this updates the administrative state of the existing connection.
    description string
    The human-readable description for the connection. Changing this updates the description of the existing connection.
    dpds SiteConnectionDpd[]
    A dictionary with dead peer detection (DPD) protocol controls.
    ikepolicyId string
    The ID of the IKE policy. Changing this creates a new connection.
    initiator string
    A valid value is response-only or bi-directional. Default is bi-directional.
    ipsecpolicyId string
    The ID of the IPsec policy. Changing this creates a new connection.
    localEpGroupId string
    The ID for the endpoint group that contains private subnets for the local side of the connection. You must specify this parameter with the peer_ep_group_id parameter unless in backward- compatible mode where peer_cidrs is provided with a subnet_id for the VPN service. Changing this updates the existing connection.
    localId string
    An ID to be used instead of the external IP address for a virtual router used in traffic between instances on different networks in east-west traffic. Most often, local ID would be domain name, email address, etc. If this is not configured then the external IP address will be used as the ID.
    mtu number
    The maximum transmission unit (MTU) value to address fragmentation. Minimum value is 68 for IPv4, and 1280 for IPv6.
    name string
    The name of the connection. Changing this updates the name of the existing connection.
    peerAddress string
    The peer gateway public IPv4 or IPv6 address or FQDN.
    peerCidrs string[]
    Unique list of valid peer private CIDRs in the form < net_address > / < prefix > .
    peerEpGroupId string
    The ID for the endpoint group that contains private CIDRs in the form < net_address > / < prefix > for the peer side of the connection. You must specify this parameter with the local_ep_group_id parameter unless in backward-compatible mode where peer_cidrs is provided with a subnet_id for the VPN service.
    peerId string
    The peer router identity for authentication. A valid value is an IPv4 address, IPv6 address, e-mail address, key ID, or FQDN. Typically, this value matches the peer_address value. Changing this updates the existing policy.
    psk string
    The pre-shared key. A valid value is any string.
    region string
    The region in which to obtain the V2 Networking client. A Networking client is needed to create an IPSec site connection. If omitted, the region argument of the provider is used. Changing this creates a new site connection.
    tenantId string
    The owner of the connection. Required if admin wants to create a connection for another project. Changing this creates a new connection.
    valueSpecs {[key: string]: string}
    Map of additional options.
    vpnserviceId string
    The ID of the VPN service. Changing this creates a new connection.
    admin_state_up bool
    The administrative state of the resource. Can either be up(true) or down(false). Changing this updates the administrative state of the existing connection.
    description str
    The human-readable description for the connection. Changing this updates the description of the existing connection.
    dpds Sequence[SiteConnectionDpdArgs]
    A dictionary with dead peer detection (DPD) protocol controls.
    ikepolicy_id str
    The ID of the IKE policy. Changing this creates a new connection.
    initiator str
    A valid value is response-only or bi-directional. Default is bi-directional.
    ipsecpolicy_id str
    The ID of the IPsec policy. Changing this creates a new connection.
    local_ep_group_id str
    The ID for the endpoint group that contains private subnets for the local side of the connection. You must specify this parameter with the peer_ep_group_id parameter unless in backward- compatible mode where peer_cidrs is provided with a subnet_id for the VPN service. Changing this updates the existing connection.
    local_id str
    An ID to be used instead of the external IP address for a virtual router used in traffic between instances on different networks in east-west traffic. Most often, local ID would be domain name, email address, etc. If this is not configured then the external IP address will be used as the ID.
    mtu int
    The maximum transmission unit (MTU) value to address fragmentation. Minimum value is 68 for IPv4, and 1280 for IPv6.
    name str
    The name of the connection. Changing this updates the name of the existing connection.
    peer_address str
    The peer gateway public IPv4 or IPv6 address or FQDN.
    peer_cidrs Sequence[str]
    Unique list of valid peer private CIDRs in the form < net_address > / < prefix > .
    peer_ep_group_id str
    The ID for the endpoint group that contains private CIDRs in the form < net_address > / < prefix > for the peer side of the connection. You must specify this parameter with the local_ep_group_id parameter unless in backward-compatible mode where peer_cidrs is provided with a subnet_id for the VPN service.
    peer_id str
    The peer router identity for authentication. A valid value is an IPv4 address, IPv6 address, e-mail address, key ID, or FQDN. Typically, this value matches the peer_address value. Changing this updates the existing policy.
    psk str
    The pre-shared key. A valid value is any string.
    region str
    The region in which to obtain the V2 Networking client. A Networking client is needed to create an IPSec site connection. If omitted, the region argument of the provider is used. Changing this creates a new site connection.
    tenant_id str
    The owner of the connection. Required if admin wants to create a connection for another project. Changing this creates a new connection.
    value_specs Mapping[str, str]
    Map of additional options.
    vpnservice_id str
    The ID of the VPN service. Changing this creates a new connection.
    adminStateUp Boolean
    The administrative state of the resource. Can either be up(true) or down(false). Changing this updates the administrative state of the existing connection.
    description String
    The human-readable description for the connection. Changing this updates the description of the existing connection.
    dpds List<Property Map>
    A dictionary with dead peer detection (DPD) protocol controls.
    ikepolicyId String
    The ID of the IKE policy. Changing this creates a new connection.
    initiator String
    A valid value is response-only or bi-directional. Default is bi-directional.
    ipsecpolicyId String
    The ID of the IPsec policy. Changing this creates a new connection.
    localEpGroupId String
    The ID for the endpoint group that contains private subnets for the local side of the connection. You must specify this parameter with the peer_ep_group_id parameter unless in backward- compatible mode where peer_cidrs is provided with a subnet_id for the VPN service. Changing this updates the existing connection.
    localId String
    An ID to be used instead of the external IP address for a virtual router used in traffic between instances on different networks in east-west traffic. Most often, local ID would be domain name, email address, etc. If this is not configured then the external IP address will be used as the ID.
    mtu Number
    The maximum transmission unit (MTU) value to address fragmentation. Minimum value is 68 for IPv4, and 1280 for IPv6.
    name String
    The name of the connection. Changing this updates the name of the existing connection.
    peerAddress String
    The peer gateway public IPv4 or IPv6 address or FQDN.
    peerCidrs List<String>
    Unique list of valid peer private CIDRs in the form < net_address > / < prefix > .
    peerEpGroupId String
    The ID for the endpoint group that contains private CIDRs in the form < net_address > / < prefix > for the peer side of the connection. You must specify this parameter with the local_ep_group_id parameter unless in backward-compatible mode where peer_cidrs is provided with a subnet_id for the VPN service.
    peerId String
    The peer router identity for authentication. A valid value is an IPv4 address, IPv6 address, e-mail address, key ID, or FQDN. Typically, this value matches the peer_address value. Changing this updates the existing policy.
    psk String
    The pre-shared key. A valid value is any string.
    region String
    The region in which to obtain the V2 Networking client. A Networking client is needed to create an IPSec site connection. If omitted, the region argument of the provider is used. Changing this creates a new site connection.
    tenantId String
    The owner of the connection. Required if admin wants to create a connection for another project. Changing this creates a new connection.
    valueSpecs Map<String>
    Map of additional options.
    vpnserviceId String
    The ID of the VPN service. Changing this creates a new connection.

    Supporting Types

    SiteConnectionDpd, SiteConnectionDpdArgs

    Action string
    The dead peer detection (DPD) action. A valid value is clear, hold, restart, disabled, or restart-by-peer. Default value is hold.
    Interval int
    The dead peer detection (DPD) interval, in seconds. A valid value is a positive integer. Default is 30.
    Timeout int
    The dead peer detection (DPD) timeout in seconds. A valid value is a positive integer that is greater than the DPD interval value. Default is 120.
    Action string
    The dead peer detection (DPD) action. A valid value is clear, hold, restart, disabled, or restart-by-peer. Default value is hold.
    Interval int
    The dead peer detection (DPD) interval, in seconds. A valid value is a positive integer. Default is 30.
    Timeout int
    The dead peer detection (DPD) timeout in seconds. A valid value is a positive integer that is greater than the DPD interval value. Default is 120.
    action String
    The dead peer detection (DPD) action. A valid value is clear, hold, restart, disabled, or restart-by-peer. Default value is hold.
    interval Integer
    The dead peer detection (DPD) interval, in seconds. A valid value is a positive integer. Default is 30.
    timeout Integer
    The dead peer detection (DPD) timeout in seconds. A valid value is a positive integer that is greater than the DPD interval value. Default is 120.
    action string
    The dead peer detection (DPD) action. A valid value is clear, hold, restart, disabled, or restart-by-peer. Default value is hold.
    interval number
    The dead peer detection (DPD) interval, in seconds. A valid value is a positive integer. Default is 30.
    timeout number
    The dead peer detection (DPD) timeout in seconds. A valid value is a positive integer that is greater than the DPD interval value. Default is 120.
    action str
    The dead peer detection (DPD) action. A valid value is clear, hold, restart, disabled, or restart-by-peer. Default value is hold.
    interval int
    The dead peer detection (DPD) interval, in seconds. A valid value is a positive integer. Default is 30.
    timeout int
    The dead peer detection (DPD) timeout in seconds. A valid value is a positive integer that is greater than the DPD interval value. Default is 120.
    action String
    The dead peer detection (DPD) action. A valid value is clear, hold, restart, disabled, or restart-by-peer. Default value is hold.
    interval Number
    The dead peer detection (DPD) interval, in seconds. A valid value is a positive integer. Default is 30.
    timeout Number
    The dead peer detection (DPD) timeout in seconds. A valid value is a positive integer that is greater than the DPD interval value. Default is 120.

    Import

    Site Connections can be imported using the id, e.g.

    $ pulumi import openstack:vpnaas/siteConnection:SiteConnection conn_1 832cb7f3-59fe-40cf-8f64-8350ffc03272

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    OpenStack pulumi/pulumi-openstack
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the openstack Terraform Provider.
    openstack logo
    OpenStack v5.0.3 published on Wednesday, Feb 12, 2025 by Pulumi
    pulumi/pulumi-openstack