Alibaba Cloud v3.34.0, Mar 17 23

alicloud.vpc.getIpsecServers

This data source provides the Vpn Ipsec Servers of the current Alibaba Cloud user.

NOTE: Available in v1.161.0+.

Example Usage

Basic Usage

using System.Collections.Generic;
using Pulumi;
using AliCloud = Pulumi.AliCloud;

return await Deployment.RunAsync(() => 
{
    var ids = AliCloud.Vpc.GetIpsecServers.Invoke(new()
    {
        Ids = new[]
        {
            "example_id",
        },
    });

    var nameRegex = AliCloud.Vpc.GetIpsecServers.Invoke(new()
    {
        NameRegex = "^my-IpsecServer",
    });

    return new Dictionary<string, object?>
    {
        ["vpnIpsecServerId1"] = ids.Apply(getIpsecServersResult => getIpsecServersResult.Servers[0]?.Id),
        ["vpnIpsecServerId2"] = nameRegex.Apply(getIpsecServersResult => getIpsecServersResult.Servers[0]?.Id),
    };
});

package main

import (
	"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/vpc"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		ids, err := vpc.GetIpsecServers(ctx, &vpc.GetIpsecServersArgs{
			Ids: []string{
				"example_id",
			},
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("vpnIpsecServerId1", ids.Servers[0].Id)
		nameRegex, err := vpc.GetIpsecServers(ctx, &vpc.GetIpsecServersArgs{
			NameRegex: pulumi.StringRef("^my-IpsecServer"),
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("vpnIpsecServerId2", nameRegex.Servers[0].Id)
		return nil
	})
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.alicloud.vpc.VpcFunctions;
import com.pulumi.alicloud.vpc.inputs.GetIpsecServersArgs;
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 ids = VpcFunctions.getIpsecServers(GetIpsecServersArgs.builder()
            .ids("example_id")
            .build());

        ctx.export("vpnIpsecServerId1", ids.applyValue(getIpsecServersResult -> getIpsecServersResult.servers()[0].id()));
        final var nameRegex = VpcFunctions.getIpsecServers(GetIpsecServersArgs.builder()
            .nameRegex("^my-IpsecServer")
            .build());

        ctx.export("vpnIpsecServerId2", nameRegex.applyValue(getIpsecServersResult -> getIpsecServersResult.servers()[0].id()));
    }
}

import pulumi
import pulumi_alicloud as alicloud

ids = alicloud.vpc.get_ipsec_servers(ids=["example_id"])
pulumi.export("vpnIpsecServerId1", ids.servers[0].id)
name_regex = alicloud.vpc.get_ipsec_servers(name_regex="^my-IpsecServer")
pulumi.export("vpnIpsecServerId2", name_regex.servers[0].id)

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

const ids = alicloud.vpc.getIpsecServers({
    ids: ["example_id"],
});
export const vpnIpsecServerId1 = ids.then(ids => ids.servers?.[0]?.id);
const nameRegex = alicloud.vpc.getIpsecServers({
    nameRegex: "^my-IpsecServer",
});
export const vpnIpsecServerId2 = nameRegex.then(nameRegex => nameRegex.servers?.[0]?.id);

variables:
  ids:
    fn::invoke:
      Function: alicloud:vpc:getIpsecServers
      Arguments:
        ids:
          - example_id
  nameRegex:
    fn::invoke:
      Function: alicloud:vpc:getIpsecServers
      Arguments:
        nameRegex: ^my-IpsecServer
outputs:
  vpnIpsecServerId1: ${ids.servers[0].id}
  vpnIpsecServerId2: ${nameRegex.servers[0].id}

Using getIpsecServers

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 getIpsecServers(args: GetIpsecServersArgs, opts?: InvokeOptions): Promise<GetIpsecServersResult>
function getIpsecServersOutput(args: GetIpsecServersOutputArgs, opts?: InvokeOptions): Output<GetIpsecServersResult>

def get_ipsec_servers(ids: Optional[Sequence[str]] = None,
                      ipsec_server_name: Optional[str] = None,
                      name_regex: Optional[str] = None,
                      output_file: Optional[str] = None,
                      vpn_gateway_id: Optional[str] = None,
                      opts: Optional[InvokeOptions] = None) -> GetIpsecServersResult
def get_ipsec_servers_output(ids: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                      ipsec_server_name: Optional[pulumi.Input[str]] = None,
                      name_regex: Optional[pulumi.Input[str]] = None,
                      output_file: Optional[pulumi.Input[str]] = None,
                      vpn_gateway_id: Optional[pulumi.Input[str]] = None,
                      opts: Optional[InvokeOptions] = None) -> Output[GetIpsecServersResult]

func GetIpsecServers(ctx *Context, args *GetIpsecServersArgs, opts ...InvokeOption) (*GetIpsecServersResult, error)
func GetIpsecServersOutput(ctx *Context, args *GetIpsecServersOutputArgs, opts ...InvokeOption) GetIpsecServersResultOutput

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

public static class GetIpsecServers 
{
    public static Task<GetIpsecServersResult> InvokeAsync(GetIpsecServersArgs args, InvokeOptions? opts = null)
    public static Output<GetIpsecServersResult> Invoke(GetIpsecServersInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetIpsecServersResult> getIpsecServers(GetIpsecServersArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: alicloud:vpc/getIpsecServers:getIpsecServers
  arguments:
    # arguments dictionary

The following arguments are supported:

Ids List<string>: A list of Ipsec Server IDs.
IpsecServerName string: The name of the IPsec server.
NameRegex string: A regex string to filter results by Ipsec Server name.
OutputFile string
VpnGatewayId string: The ID of the VPN gateway.

Ids []string: A list of Ipsec Server IDs.
IpsecServerName string: The name of the IPsec server.
NameRegex string: A regex string to filter results by Ipsec Server name.
OutputFile string
VpnGatewayId string: The ID of the VPN gateway.

ids List<String>: A list of Ipsec Server IDs.
ipsecServerName String: The name of the IPsec server.
nameRegex String: A regex string to filter results by Ipsec Server name.
outputFile String
vpnGatewayId String: The ID of the VPN gateway.

ids string[]: A list of Ipsec Server IDs.
ipsecServerName string: The name of the IPsec server.
nameRegex string: A regex string to filter results by Ipsec Server name.
outputFile string
vpnGatewayId string: The ID of the VPN gateway.

ids Sequence[str]: A list of Ipsec Server IDs.
ipsec_server_name str: The name of the IPsec server.
name_regex str: A regex string to filter results by Ipsec Server name.
output_file str
vpn_gateway_id str: The ID of the VPN gateway.

ids List<String>: A list of Ipsec Server IDs.
ipsecServerName String: The name of the IPsec server.
nameRegex String: A regex string to filter results by Ipsec Server name.
outputFile String
vpnGatewayId String: The ID of the VPN gateway.

getIpsecServers Result

The following output properties are available:

Id string: The provider-assigned unique ID for this managed resource.
Ids List<string>
Names List<string>
Servers List<Pulumi.AliCloud.Vpc.Outputs.GetIpsecServersServer>
IpsecServerName string
NameRegex string
OutputFile string
VpnGatewayId string

Id string: The provider-assigned unique ID for this managed resource.
Ids []string
Names []string
Servers []GetIpsecServersServer
IpsecServerName string
NameRegex string
OutputFile string
VpnGatewayId string

id String: The provider-assigned unique ID for this managed resource.
ids List<String>
names List<String>
servers List<GetIpsecServersServer>
ipsecServerName String
nameRegex String
outputFile String
vpnGatewayId String

id string: The provider-assigned unique ID for this managed resource.
ids string[]
names string[]
servers GetIpsecServersServer[]
ipsecServerName string
nameRegex string
outputFile string
vpnGatewayId string

id str: The provider-assigned unique ID for this managed resource.
ids Sequence[str]
names Sequence[str]
servers Sequence[GetIpsecServersServer]
ipsec_server_name str
name_regex str
output_file str
vpn_gateway_id str

id String: The provider-assigned unique ID for this managed resource.
ids List<String>
names List<String>
servers List<Property Map>
ipsecServerName String
nameRegex String
outputFile String
vpnGatewayId String

Supporting Types

GetIpsecServersServer

ClientIpPool string: The CIDR block of the client, which is assigned an access address to the virtual NIC of the client.
CreateTime string: The creation time of the IPsec server. T represents the delimiter, and Z represents UTC, which is World Standard Time.
EffectImmediately bool: Indicates whether the current IPsec tunnel is deleted and negotiations are reinitiated.
Id string: The ID of the Ipsec Server.
IdaasInstanceId string: The ID of the Identity as a Service (IDaaS) instance.
IkeConfigs List<Pulumi.AliCloud.Vpc.Inputs.GetIpsecServersServerIkeConfig>: The configurations of Phase 1 negotiations.
InternetIp string: The public IP address of the VPN gateway.
IpsecConfigs List<Pulumi.AliCloud.Vpc.Inputs.GetIpsecServersServerIpsecConfig>: The configuration of Phase 2 negotiations.
IpsecServerId string: The ID of the IPsec server.
IpsecServerName string: The name of the IPsec server.
LocalSubnet string: Local network segment: the network segment on The VPC side that needs to be interconnected with the client network segment.
MaxConnections int: The number of SSL connections of the VPN gateway. SSL-VPN the number of SSL connections shared with the IPsec server. For example, if the number of SSL connections is 5 and you have three SSL clients connected to the SSL-VPN, you can also use two clients to connect to the IPsec server.
MultiFactorAuthEnabled bool: Whether the two-factor authentication function has been turned on.
OnlineClientCount int: The number of clients that have connected to the IPsec server.
Psk string: The pre-shared key.
PskEnabled bool: Whether to enable the pre-shared key authentication method. The value is only true, which indicates that the pre-shared key authentication method is enabled.
VpnGatewayId string: The ID of the VPN gateway.

ClientIpPool string: The CIDR block of the client, which is assigned an access address to the virtual NIC of the client.
CreateTime string: The creation time of the IPsec server. T represents the delimiter, and Z represents UTC, which is World Standard Time.
EffectImmediately bool: Indicates whether the current IPsec tunnel is deleted and negotiations are reinitiated.
Id string: The ID of the Ipsec Server.
IdaasInstanceId string: The ID of the Identity as a Service (IDaaS) instance.
IkeConfigs []GetIpsecServersServerIkeConfig: The configurations of Phase 1 negotiations.
InternetIp string: The public IP address of the VPN gateway.
IpsecConfigs []GetIpsecServersServerIpsecConfig: The configuration of Phase 2 negotiations.
IpsecServerId string: The ID of the IPsec server.
IpsecServerName string: The name of the IPsec server.
LocalSubnet string: Local network segment: the network segment on The VPC side that needs to be interconnected with the client network segment.
MaxConnections int: The number of SSL connections of the VPN gateway. SSL-VPN the number of SSL connections shared with the IPsec server. For example, if the number of SSL connections is 5 and you have three SSL clients connected to the SSL-VPN, you can also use two clients to connect to the IPsec server.
MultiFactorAuthEnabled bool: Whether the two-factor authentication function has been turned on.
OnlineClientCount int: The number of clients that have connected to the IPsec server.
Psk string: The pre-shared key.
PskEnabled bool: Whether to enable the pre-shared key authentication method. The value is only true, which indicates that the pre-shared key authentication method is enabled.
VpnGatewayId string: The ID of the VPN gateway.

clientIpPool String: The CIDR block of the client, which is assigned an access address to the virtual NIC of the client.
createTime String: The creation time of the IPsec server. T represents the delimiter, and Z represents UTC, which is World Standard Time.
effectImmediately Boolean: Indicates whether the current IPsec tunnel is deleted and negotiations are reinitiated.
id String: The ID of the Ipsec Server.
idaasInstanceId String: The ID of the Identity as a Service (IDaaS) instance.
ikeConfigs List<GetIpsecServersServerIkeConfig>: The configurations of Phase 1 negotiations.
internetIp String: The public IP address of the VPN gateway.
ipsecConfigs List<GetIpsecServersServerIpsecConfig>: The configuration of Phase 2 negotiations.
ipsecServerId String: The ID of the IPsec server.
ipsecServerName String: The name of the IPsec server.
localSubnet String: Local network segment: the network segment on The VPC side that needs to be interconnected with the client network segment.
maxConnections Integer: The number of SSL connections of the VPN gateway. SSL-VPN the number of SSL connections shared with the IPsec server. For example, if the number of SSL connections is 5 and you have three SSL clients connected to the SSL-VPN, you can also use two clients to connect to the IPsec server.
multiFactorAuthEnabled Boolean: Whether the two-factor authentication function has been turned on.
onlineClientCount Integer: The number of clients that have connected to the IPsec server.
psk String: The pre-shared key.
pskEnabled Boolean: Whether to enable the pre-shared key authentication method. The value is only true, which indicates that the pre-shared key authentication method is enabled.
vpnGatewayId String: The ID of the VPN gateway.

clientIpPool string: The CIDR block of the client, which is assigned an access address to the virtual NIC of the client.
createTime string: The creation time of the IPsec server. T represents the delimiter, and Z represents UTC, which is World Standard Time.
effectImmediately boolean: Indicates whether the current IPsec tunnel is deleted and negotiations are reinitiated.
id string: The ID of the Ipsec Server.
idaasInstanceId string: The ID of the Identity as a Service (IDaaS) instance.
ikeConfigs GetIpsecServersServerIkeConfig[]: The configurations of Phase 1 negotiations.
internetIp string: The public IP address of the VPN gateway.
ipsecConfigs GetIpsecServersServerIpsecConfig[]: The configuration of Phase 2 negotiations.
ipsecServerId string: The ID of the IPsec server.
ipsecServerName string: The name of the IPsec server.
localSubnet string: Local network segment: the network segment on The VPC side that needs to be interconnected with the client network segment.
maxConnections number: The number of SSL connections of the VPN gateway. SSL-VPN the number of SSL connections shared with the IPsec server. For example, if the number of SSL connections is 5 and you have three SSL clients connected to the SSL-VPN, you can also use two clients to connect to the IPsec server.
multiFactorAuthEnabled boolean: Whether the two-factor authentication function has been turned on.
onlineClientCount number: The number of clients that have connected to the IPsec server.
psk string: The pre-shared key.
pskEnabled boolean: Whether to enable the pre-shared key authentication method. The value is only true, which indicates that the pre-shared key authentication method is enabled.
vpnGatewayId string: The ID of the VPN gateway.

client_ip_pool str: The CIDR block of the client, which is assigned an access address to the virtual NIC of the client.
create_time str: The creation time of the IPsec server. T represents the delimiter, and Z represents UTC, which is World Standard Time.
effect_immediately bool: Indicates whether the current IPsec tunnel is deleted and negotiations are reinitiated.
id str: The ID of the Ipsec Server.
idaas_instance_id str: The ID of the Identity as a Service (IDaaS) instance.
ike_configs Sequence[GetIpsecServersServerIkeConfig]: The configurations of Phase 1 negotiations.
internet_ip str: The public IP address of the VPN gateway.
ipsec_configs Sequence[GetIpsecServersServerIpsecConfig]: The configuration of Phase 2 negotiations.
ipsec_server_id str: The ID of the IPsec server.
ipsec_server_name str: The name of the IPsec server.
local_subnet str: Local network segment: the network segment on The VPC side that needs to be interconnected with the client network segment.
max_connections int: The number of SSL connections of the VPN gateway. SSL-VPN the number of SSL connections shared with the IPsec server. For example, if the number of SSL connections is 5 and you have three SSL clients connected to the SSL-VPN, you can also use two clients to connect to the IPsec server.
multi_factor_auth_enabled bool: Whether the two-factor authentication function has been turned on.
online_client_count int: The number of clients that have connected to the IPsec server.
psk str: The pre-shared key.
psk_enabled bool: Whether to enable the pre-shared key authentication method. The value is only true, which indicates that the pre-shared key authentication method is enabled.
vpn_gateway_id str: The ID of the VPN gateway.

clientIpPool String: The CIDR block of the client, which is assigned an access address to the virtual NIC of the client.
createTime String: The creation time of the IPsec server. T represents the delimiter, and Z represents UTC, which is World Standard Time.
effectImmediately Boolean: Indicates whether the current IPsec tunnel is deleted and negotiations are reinitiated.
id String: The ID of the Ipsec Server.
idaasInstanceId String: The ID of the Identity as a Service (IDaaS) instance.
ikeConfigs List<Property Map>: The configurations of Phase 1 negotiations.
internetIp String: The public IP address of the VPN gateway.
ipsecConfigs List<Property Map>: The configuration of Phase 2 negotiations.
ipsecServerId String: The ID of the IPsec server.
ipsecServerName String: The name of the IPsec server.
localSubnet String: Local network segment: the network segment on The VPC side that needs to be interconnected with the client network segment.
maxConnections Number: The number of SSL connections of the VPN gateway. SSL-VPN the number of SSL connections shared with the IPsec server. For example, if the number of SSL connections is 5 and you have three SSL clients connected to the SSL-VPN, you can also use two clients to connect to the IPsec server.
multiFactorAuthEnabled Boolean: Whether the two-factor authentication function has been turned on.
onlineClientCount Number: The number of clients that have connected to the IPsec server.
psk String: The pre-shared key.
pskEnabled Boolean: Whether to enable the pre-shared key authentication method. The value is only true, which indicates that the pre-shared key authentication method is enabled.
vpnGatewayId String: The ID of the VPN gateway.

GetIpsecServersServerIkeConfig

IkeAuthAlg string: The IKE authentication algorithm.
IkeEncAlg string: The IKE encryption algorithm.
IkeLifetime int: The IKE lifetime. Unit: seconds.
IkeMode string: The IKE negotiation mode.
IkePfs string: Diffie-Hellman key exchange algorithm.
IkeVersion string: The IKE version.
LocalId string: IPsec server identifier. Supports the format of FQDN and IP address. The public IP address of the VPN gateway is selected by default.
RemoteId string: The peer identifier. Supports the format of FQDN and IP address, which is empty by default.

IkeAuthAlg string: The IKE authentication algorithm.
IkeEncAlg string: The IKE encryption algorithm.
IkeLifetime int: The IKE lifetime. Unit: seconds.
IkeMode string: The IKE negotiation mode.
IkePfs string: Diffie-Hellman key exchange algorithm.
IkeVersion string: The IKE version.
LocalId string: IPsec server identifier. Supports the format of FQDN and IP address. The public IP address of the VPN gateway is selected by default.
RemoteId string: The peer identifier. Supports the format of FQDN and IP address, which is empty by default.

ikeAuthAlg String: The IKE authentication algorithm.
ikeEncAlg String: The IKE encryption algorithm.
ikeLifetime Integer: The IKE lifetime. Unit: seconds.
ikeMode String: The IKE negotiation mode.
ikePfs String: Diffie-Hellman key exchange algorithm.
ikeVersion String: The IKE version.
localId String: IPsec server identifier. Supports the format of FQDN and IP address. The public IP address of the VPN gateway is selected by default.
remoteId String: The peer identifier. Supports the format of FQDN and IP address, which is empty by default.

ikeAuthAlg string: The IKE authentication algorithm.
ikeEncAlg string: The IKE encryption algorithm.
ikeLifetime number: The IKE lifetime. Unit: seconds.
ikeMode string: The IKE negotiation mode.
ikePfs string: Diffie-Hellman key exchange algorithm.
ikeVersion string: The IKE version.
localId string: IPsec server identifier. Supports the format of FQDN and IP address. The public IP address of the VPN gateway is selected by default.
remoteId string: The peer identifier. Supports the format of FQDN and IP address, which is empty by default.

ike_auth_alg str: The IKE authentication algorithm.
ike_enc_alg str: The IKE encryption algorithm.
ike_lifetime int: The IKE lifetime. Unit: seconds.
ike_mode str: The IKE negotiation mode.
ike_pfs str: Diffie-Hellman key exchange algorithm.
ike_version str: The IKE version.
local_id str: IPsec server identifier. Supports the format of FQDN and IP address. The public IP address of the VPN gateway is selected by default.
remote_id str: The peer identifier. Supports the format of FQDN and IP address, which is empty by default.

ikeAuthAlg String: The IKE authentication algorithm.
ikeEncAlg String: The IKE encryption algorithm.
ikeLifetime Number: The IKE lifetime. Unit: seconds.
ikeMode String: The IKE negotiation mode.
ikePfs String: Diffie-Hellman key exchange algorithm.
ikeVersion String: The IKE version.
localId String: IPsec server identifier. Supports the format of FQDN and IP address. The public IP address of the VPN gateway is selected by default.
remoteId String: The peer identifier. Supports the format of FQDN and IP address, which is empty by default.

GetIpsecServersServerIpsecConfig

IpsecAuthAlg string: IPsec authentication algorithm.
IpsecEncAlg string: IPsec encryption algorithm.
IpsecLifetime int: IPsec survival time. Unit: seconds.
IpsecPfs string: Diffie-Hellman key exchange algorithm.

IpsecAuthAlg string: IPsec authentication algorithm.
IpsecEncAlg string: IPsec encryption algorithm.
IpsecLifetime int: IPsec survival time. Unit: seconds.
IpsecPfs string: Diffie-Hellman key exchange algorithm.

ipsecAuthAlg String: IPsec authentication algorithm.
ipsecEncAlg String: IPsec encryption algorithm.
ipsecLifetime Integer: IPsec survival time. Unit: seconds.
ipsecPfs String: Diffie-Hellman key exchange algorithm.

ipsecAuthAlg string: IPsec authentication algorithm.
ipsecEncAlg string: IPsec encryption algorithm.
ipsecLifetime number: IPsec survival time. Unit: seconds.
ipsecPfs string: Diffie-Hellman key exchange algorithm.

ipsec_auth_alg str: IPsec authentication algorithm.
ipsec_enc_alg str: IPsec encryption algorithm.
ipsec_lifetime int: IPsec survival time. Unit: seconds.
ipsec_pfs str: Diffie-Hellman key exchange algorithm.

ipsecAuthAlg String: IPsec authentication algorithm.
ipsecEncAlg String: IPsec encryption algorithm.
ipsecLifetime Number: IPsec survival time. Unit: seconds.
ipsecPfs String: Diffie-Hellman key exchange algorithm.

Package Details

Repository: Alibaba Cloud pulumi/pulumi-alicloud
License: Apache-2.0
Notes: This Pulumi package is based on the alicloud Terraform Provider.