1. Packages
  2. Opentelekomcloud Provider
  3. API Docs
  4. getVpnaasServiceV2
opentelekomcloud 1.36.37 published on Thursday, Apr 24, 2025 by opentelekomcloud

opentelekomcloud.getVpnaasServiceV2

Explore with Pulumi AI

opentelekomcloud logo
opentelekomcloud 1.36.37 published on Thursday, Apr 24, 2025 by opentelekomcloud

    Up-to-date reference of API arguments for VPN service you can get at documentation portal

    Use this data source to get details about a specific VPN.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as opentelekomcloud from "@pulumi/opentelekomcloud";
    
    const config = new pulumi.Config();
    const vpnName = config.requireObject("vpnName");
    const vpn = opentelekomcloud.getVpnaasServiceV2({
        name: vpnName,
        adminStateUp: true,
    });
    
    import pulumi
    import pulumi_opentelekomcloud as opentelekomcloud
    
    config = pulumi.Config()
    vpn_name = config.require_object("vpnName")
    vpn = opentelekomcloud.get_vpnaas_service_v2(name=vpn_name,
        admin_state_up=True)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-terraform-provider/sdks/go/opentelekomcloud/opentelekomcloud"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		cfg := config.New(ctx, "")
    		vpnName := cfg.RequireObject("vpnName")
    		_, err := opentelekomcloud.LookupVpnaasServiceV2(ctx, &opentelekomcloud.LookupVpnaasServiceV2Args{
    			Name:         pulumi.StringRef(vpnName),
    			AdminStateUp: pulumi.BoolRef(true),
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Opentelekomcloud = Pulumi.Opentelekomcloud;
    
    return await Deployment.RunAsync(() => 
    {
        var config = new Config();
        var vpnName = config.RequireObject<dynamic>("vpnName");
        var vpn = Opentelekomcloud.GetVpnaasServiceV2.Invoke(new()
        {
            Name = vpnName,
            AdminStateUp = true,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.opentelekomcloud.OpentelekomcloudFunctions;
    import com.pulumi.opentelekomcloud.inputs.GetVpnaasServiceV2Args;
    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 config = ctx.config();
            final var vpnName = config.get("vpnName");
            final var vpn = OpentelekomcloudFunctions.getVpnaasServiceV2(GetVpnaasServiceV2Args.builder()
                .name(vpnName)
                .adminStateUp("true")
                .build());
    
        }
    }
    
    configuration:
      vpnName:
        type: dynamic
    variables:
      vpn:
        fn::invoke:
          function: opentelekomcloud:getVpnaasServiceV2
          arguments:
            name: ${vpnName}
            adminStateUp: 'true'
    

    Using getVpnaasServiceV2

    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 getVpnaasServiceV2(args: GetVpnaasServiceV2Args, opts?: InvokeOptions): Promise<GetVpnaasServiceV2Result>
    function getVpnaasServiceV2Output(args: GetVpnaasServiceV2OutputArgs, opts?: InvokeOptions): Output<GetVpnaasServiceV2Result>
    def get_vpnaas_service_v2(admin_state_up: Optional[bool] = None,
                              description: Optional[str] = None,
                              external_v4_ip: Optional[str] = None,
                              external_v6_ip: Optional[str] = None,
                              flavor_id: Optional[str] = None,
                              id: Optional[str] = None,
                              name: Optional[str] = None,
                              project_id: Optional[str] = None,
                              region: Optional[str] = None,
                              router_id: Optional[str] = None,
                              status: Optional[str] = None,
                              subnet_id: Optional[str] = None,
                              tenant_id: Optional[str] = None,
                              opts: Optional[InvokeOptions] = None) -> GetVpnaasServiceV2Result
    def get_vpnaas_service_v2_output(admin_state_up: Optional[pulumi.Input[bool]] = None,
                              description: Optional[pulumi.Input[str]] = None,
                              external_v4_ip: Optional[pulumi.Input[str]] = None,
                              external_v6_ip: Optional[pulumi.Input[str]] = None,
                              flavor_id: Optional[pulumi.Input[str]] = None,
                              id: Optional[pulumi.Input[str]] = None,
                              name: Optional[pulumi.Input[str]] = None,
                              project_id: Optional[pulumi.Input[str]] = None,
                              region: Optional[pulumi.Input[str]] = None,
                              router_id: Optional[pulumi.Input[str]] = None,
                              status: Optional[pulumi.Input[str]] = None,
                              subnet_id: Optional[pulumi.Input[str]] = None,
                              tenant_id: Optional[pulumi.Input[str]] = None,
                              opts: Optional[InvokeOptions] = None) -> Output[GetVpnaasServiceV2Result]
    func LookupVpnaasServiceV2(ctx *Context, args *LookupVpnaasServiceV2Args, opts ...InvokeOption) (*LookupVpnaasServiceV2Result, error)
    func LookupVpnaasServiceV2Output(ctx *Context, args *LookupVpnaasServiceV2OutputArgs, opts ...InvokeOption) LookupVpnaasServiceV2ResultOutput

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

    public static class GetVpnaasServiceV2 
    {
        public static Task<GetVpnaasServiceV2Result> InvokeAsync(GetVpnaasServiceV2Args args, InvokeOptions? opts = null)
        public static Output<GetVpnaasServiceV2Result> Invoke(GetVpnaasServiceV2InvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetVpnaasServiceV2Result> getVpnaasServiceV2(GetVpnaasServiceV2Args args, InvokeOptions options)
    public static Output<GetVpnaasServiceV2Result> getVpnaasServiceV2(GetVpnaasServiceV2Args args, InvokeOptions options)
    
    fn::invoke:
      function: opentelekomcloud:index/getVpnaasServiceV2:getVpnaasServiceV2
      arguments:
        # arguments dictionary

    The following arguments are supported:

    AdminStateUp bool
    The administrative state of the resource. Can either be true (Up) or false (Down). Default is false.
    Description string
    The human-readable description for the service.
    ExternalV4Ip string
    The read-only external (public) IPv4 address that is used for the VPN service.
    ExternalV6Ip string
    The read-only external (public) IPv6 address that is used for the VPN service.
    FlavorId string
    Id string
    Name string
    The name of the service.
    ProjectId string
    Region string
    The region in which to obtain details about the V2 VPN service.
    RouterId string
    The ID of the router. Default is null.
    Status string
    Indicates whether IPsec VPN service is currently operational. Values are ACTIVE, DOWN, BUILD, ERROR, PENDING_CREATE, PENDING_UPDATE or PENDING_DELETE.
    SubnetId string
    SubnetID is the ID of the subnet. Default is null.
    TenantId string
    The owner of the service.
    AdminStateUp bool
    The administrative state of the resource. Can either be true (Up) or false (Down). Default is false.
    Description string
    The human-readable description for the service.
    ExternalV4Ip string
    The read-only external (public) IPv4 address that is used for the VPN service.
    ExternalV6Ip string
    The read-only external (public) IPv6 address that is used for the VPN service.
    FlavorId string
    Id string
    Name string
    The name of the service.
    ProjectId string
    Region string
    The region in which to obtain details about the V2 VPN service.
    RouterId string
    The ID of the router. Default is null.
    Status string
    Indicates whether IPsec VPN service is currently operational. Values are ACTIVE, DOWN, BUILD, ERROR, PENDING_CREATE, PENDING_UPDATE or PENDING_DELETE.
    SubnetId string
    SubnetID is the ID of the subnet. Default is null.
    TenantId string
    The owner of the service.
    adminStateUp Boolean
    The administrative state of the resource. Can either be true (Up) or false (Down). Default is false.
    description String
    The human-readable description for the service.
    externalV4Ip String
    The read-only external (public) IPv4 address that is used for the VPN service.
    externalV6Ip String
    The read-only external (public) IPv6 address that is used for the VPN service.
    flavorId String
    id String
    name String
    The name of the service.
    projectId String
    region String
    The region in which to obtain details about the V2 VPN service.
    routerId String
    The ID of the router. Default is null.
    status String
    Indicates whether IPsec VPN service is currently operational. Values are ACTIVE, DOWN, BUILD, ERROR, PENDING_CREATE, PENDING_UPDATE or PENDING_DELETE.
    subnetId String
    SubnetID is the ID of the subnet. Default is null.
    tenantId String
    The owner of the service.
    adminStateUp boolean
    The administrative state of the resource. Can either be true (Up) or false (Down). Default is false.
    description string
    The human-readable description for the service.
    externalV4Ip string
    The read-only external (public) IPv4 address that is used for the VPN service.
    externalV6Ip string
    The read-only external (public) IPv6 address that is used for the VPN service.
    flavorId string
    id string
    name string
    The name of the service.
    projectId string
    region string
    The region in which to obtain details about the V2 VPN service.
    routerId string
    The ID of the router. Default is null.
    status string
    Indicates whether IPsec VPN service is currently operational. Values are ACTIVE, DOWN, BUILD, ERROR, PENDING_CREATE, PENDING_UPDATE or PENDING_DELETE.
    subnetId string
    SubnetID is the ID of the subnet. Default is null.
    tenantId string
    The owner of the service.
    admin_state_up bool
    The administrative state of the resource. Can either be true (Up) or false (Down). Default is false.
    description str
    The human-readable description for the service.
    external_v4_ip str
    The read-only external (public) IPv4 address that is used for the VPN service.
    external_v6_ip str
    The read-only external (public) IPv6 address that is used for the VPN service.
    flavor_id str
    id str
    name str
    The name of the service.
    project_id str
    region str
    The region in which to obtain details about the V2 VPN service.
    router_id str
    The ID of the router. Default is null.
    status str
    Indicates whether IPsec VPN service is currently operational. Values are ACTIVE, DOWN, BUILD, ERROR, PENDING_CREATE, PENDING_UPDATE or PENDING_DELETE.
    subnet_id str
    SubnetID is the ID of the subnet. Default is null.
    tenant_id str
    The owner of the service.
    adminStateUp Boolean
    The administrative state of the resource. Can either be true (Up) or false (Down). Default is false.
    description String
    The human-readable description for the service.
    externalV4Ip String
    The read-only external (public) IPv4 address that is used for the VPN service.
    externalV6Ip String
    The read-only external (public) IPv6 address that is used for the VPN service.
    flavorId String
    id String
    name String
    The name of the service.
    projectId String
    region String
    The region in which to obtain details about the V2 VPN service.
    routerId String
    The ID of the router. Default is null.
    status String
    Indicates whether IPsec VPN service is currently operational. Values are ACTIVE, DOWN, BUILD, ERROR, PENDING_CREATE, PENDING_UPDATE or PENDING_DELETE.
    subnetId String
    SubnetID is the ID of the subnet. Default is null.
    tenantId String
    The owner of the service.

    getVpnaasServiceV2 Result

    The following output properties are available:

    Region string
    See Argument Reference above.
    AdminStateUp bool
    See Argument Reference above.
    Description string
    See Argument Reference above.
    ExternalV4Ip string
    The read-only external (public) IPv4 address that is used for the VPN service.
    ExternalV6Ip string
    The read-only external (public) IPv6 address that is used for the VPN service.
    FlavorId string
    Id string
    Name string
    See Argument Reference above.
    ProjectId string
    RouterId string
    See Argument Reference above.
    Status string
    Indicates whether IPsec VPN service is currently operational. Values are ACTIVE, DOWN, BUILD, ERROR, PENDING_CREATE, PENDING_UPDATE or PENDING_DELETE.
    SubnetId string
    See Argument Reference above.
    TenantId string
    See Argument Reference above.
    Region string
    See Argument Reference above.
    AdminStateUp bool
    See Argument Reference above.
    Description string
    See Argument Reference above.
    ExternalV4Ip string
    The read-only external (public) IPv4 address that is used for the VPN service.
    ExternalV6Ip string
    The read-only external (public) IPv6 address that is used for the VPN service.
    FlavorId string
    Id string
    Name string
    See Argument Reference above.
    ProjectId string
    RouterId string
    See Argument Reference above.
    Status string
    Indicates whether IPsec VPN service is currently operational. Values are ACTIVE, DOWN, BUILD, ERROR, PENDING_CREATE, PENDING_UPDATE or PENDING_DELETE.
    SubnetId string
    See Argument Reference above.
    TenantId string
    See Argument Reference above.
    region String
    See Argument Reference above.
    adminStateUp Boolean
    See Argument Reference above.
    description String
    See Argument Reference above.
    externalV4Ip String
    The read-only external (public) IPv4 address that is used for the VPN service.
    externalV6Ip String
    The read-only external (public) IPv6 address that is used for the VPN service.
    flavorId String
    id String
    name String
    See Argument Reference above.
    projectId String
    routerId String
    See Argument Reference above.
    status String
    Indicates whether IPsec VPN service is currently operational. Values are ACTIVE, DOWN, BUILD, ERROR, PENDING_CREATE, PENDING_UPDATE or PENDING_DELETE.
    subnetId String
    See Argument Reference above.
    tenantId String
    See Argument Reference above.
    region string
    See Argument Reference above.
    adminStateUp boolean
    See Argument Reference above.
    description string
    See Argument Reference above.
    externalV4Ip string
    The read-only external (public) IPv4 address that is used for the VPN service.
    externalV6Ip string
    The read-only external (public) IPv6 address that is used for the VPN service.
    flavorId string
    id string
    name string
    See Argument Reference above.
    projectId string
    routerId string
    See Argument Reference above.
    status string
    Indicates whether IPsec VPN service is currently operational. Values are ACTIVE, DOWN, BUILD, ERROR, PENDING_CREATE, PENDING_UPDATE or PENDING_DELETE.
    subnetId string
    See Argument Reference above.
    tenantId string
    See Argument Reference above.
    region str
    See Argument Reference above.
    admin_state_up bool
    See Argument Reference above.
    description str
    See Argument Reference above.
    external_v4_ip str
    The read-only external (public) IPv4 address that is used for the VPN service.
    external_v6_ip str
    The read-only external (public) IPv6 address that is used for the VPN service.
    flavor_id str
    id str
    name str
    See Argument Reference above.
    project_id str
    router_id str
    See Argument Reference above.
    status str
    Indicates whether IPsec VPN service is currently operational. Values are ACTIVE, DOWN, BUILD, ERROR, PENDING_CREATE, PENDING_UPDATE or PENDING_DELETE.
    subnet_id str
    See Argument Reference above.
    tenant_id str
    See Argument Reference above.
    region String
    See Argument Reference above.
    adminStateUp Boolean
    See Argument Reference above.
    description String
    See Argument Reference above.
    externalV4Ip String
    The read-only external (public) IPv4 address that is used for the VPN service.
    externalV6Ip String
    The read-only external (public) IPv6 address that is used for the VPN service.
    flavorId String
    id String
    name String
    See Argument Reference above.
    projectId String
    routerId String
    See Argument Reference above.
    status String
    Indicates whether IPsec VPN service is currently operational. Values are ACTIVE, DOWN, BUILD, ERROR, PENDING_CREATE, PENDING_UPDATE or PENDING_DELETE.
    subnetId String
    See Argument Reference above.
    tenantId String
    See Argument Reference above.

    Package Details

    Repository
    opentelekomcloud opentelekomcloud/terraform-provider-opentelekomcloud
    License
    Notes
    This Pulumi package is based on the opentelekomcloud Terraform Provider.
    opentelekomcloud logo
    opentelekomcloud 1.36.37 published on Thursday, Apr 24, 2025 by opentelekomcloud