Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Ibm Provider
  3. API Docs
  4. getIsVpnServerClient
ibm 1.77.1 published on Monday, Apr 14, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm

ibm.getIsVpnServerClient

Explore with Pulumi AI

ibm 1.77.1 published on Monday, Apr 14, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm

Provides a read-only data source for VPNServerClient. For more information, about VPN Server Client, see Setting up a client VPN environment and connecting to a VPN server.

Example Usage

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

const example = ibm.getIsVpnServerClient({
    identifier: "id",
    vpnServer: ibm_is_vpn_server.example.id,
});
Copy
import pulumi
import pulumi_ibm as ibm

example = ibm.get_is_vpn_server_client(identifier="id",
    vpn_server=ibm_is_vpn_server["example"]["id"])
Copy
package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/ibm/ibm"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ibm.LookupIsVpnServerClient(ctx, &ibm.LookupIsVpnServerClientArgs{
			Identifier: "id",
			VpnServer:  ibm_is_vpn_server.Example.Id,
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Ibm = Pulumi.Ibm;

return await Deployment.RunAsync(() => 
{
    var example = Ibm.GetIsVpnServerClient.Invoke(new()
    {
        Identifier = "id",
        VpnServer = ibm_is_vpn_server.Example.Id,
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ibm.IbmFunctions;
import com.pulumi.ibm.inputs.GetIsVpnServerClientArgs;
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 example = IbmFunctions.getIsVpnServerClient(GetIsVpnServerClientArgs.builder()
            .identifier("id")
            .vpnServer(ibm_is_vpn_server.example().id())
            .build());

    }
}
Copy
variables:
  example:
    fn::invoke:
      function: ibm:getIsVpnServerClient
      arguments:
        identifier: id
        vpnServer: ${ibm_is_vpn_server.example.id}
Copy

Using getIsVpnServerClient

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 getIsVpnServerClient(args: GetIsVpnServerClientArgs, opts?: InvokeOptions): Promise<GetIsVpnServerClientResult>
function getIsVpnServerClientOutput(args: GetIsVpnServerClientOutputArgs, opts?: InvokeOptions): Output<GetIsVpnServerClientResult>
Copy
def get_is_vpn_server_client(id: Optional[str] = None,
                             identifier: Optional[str] = None,
                             vpn_server: Optional[str] = None,
                             opts: Optional[InvokeOptions] = None) -> GetIsVpnServerClientResult
def get_is_vpn_server_client_output(id: Optional[pulumi.Input[str]] = None,
                             identifier: Optional[pulumi.Input[str]] = None,
                             vpn_server: Optional[pulumi.Input[str]] = None,
                             opts: Optional[InvokeOptions] = None) -> Output[GetIsVpnServerClientResult]
Copy
func LookupIsVpnServerClient(ctx *Context, args *LookupIsVpnServerClientArgs, opts ...InvokeOption) (*LookupIsVpnServerClientResult, error)
func LookupIsVpnServerClientOutput(ctx *Context, args *LookupIsVpnServerClientOutputArgs, opts ...InvokeOption) LookupIsVpnServerClientResultOutput
Copy

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

public static class GetIsVpnServerClient 
{
    public static Task<GetIsVpnServerClientResult> InvokeAsync(GetIsVpnServerClientArgs args, InvokeOptions? opts = null)
    public static Output<GetIsVpnServerClientResult> Invoke(GetIsVpnServerClientInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetIsVpnServerClientResult> getIsVpnServerClient(GetIsVpnServerClientArgs args, InvokeOptions options)
public static Output<GetIsVpnServerClientResult> getIsVpnServerClient(GetIsVpnServerClientArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: ibm:index/getIsVpnServerClient:getIsVpnServerClient
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Identifier This property is required. string
The VPN client identifier.
VpnServer This property is required. string
The VPN server identifier.
Id string
The unique identifier of the VPNServerClient.
Identifier This property is required. string
The VPN client identifier.
VpnServer This property is required. string
The VPN server identifier.
Id string
The unique identifier of the VPNServerClient.
identifier This property is required. String
The VPN client identifier.
vpnServer This property is required. String
The VPN server identifier.
id String
The unique identifier of the VPNServerClient.
identifier This property is required. string
The VPN client identifier.
vpnServer This property is required. string
The VPN server identifier.
id string
The unique identifier of the VPNServerClient.
identifier This property is required. str
The VPN client identifier.
vpn_server This property is required. str
The VPN server identifier.
id str
The unique identifier of the VPNServerClient.
identifier This property is required. String
The VPN client identifier.
vpnServer This property is required. String
The VPN server identifier.
id String
The unique identifier of the VPNServerClient.

getIsVpnServerClient Result

The following output properties are available:

ClientIps List<GetIsVpnServerClientClientIp>
(List) The IP address assigned to this VPN client from client_ip_pool.
CommonName string
(String) The common name of client certificate that the VPN client provided when connecting to the server.
CreatedAt string
(String) The date and time that the VPN client was created.
DisconnectedAt string
(String) The date and time that the VPN client was disconnected.
Href string
(String) The URL for this VPN client.
Id string
The unique identifier of the VPNServerClient.
Identifier string
RemoteIps List<GetIsVpnServerClientRemoteIp>
(List) The remote IP address of this VPN client.
RemotePort double
(Integer) The remote port of this VPN client.
ResourceType string
(String) The resource type.
Status string
(String) The status of the VPN client.
Username string
(String) The username that this VPN client provided when connecting to the VPN server.
VpnServer string
ClientIps []GetIsVpnServerClientClientIp
(List) The IP address assigned to this VPN client from client_ip_pool.
CommonName string
(String) The common name of client certificate that the VPN client provided when connecting to the server.
CreatedAt string
(String) The date and time that the VPN client was created.
DisconnectedAt string
(String) The date and time that the VPN client was disconnected.
Href string
(String) The URL for this VPN client.
Id string
The unique identifier of the VPNServerClient.
Identifier string
RemoteIps []GetIsVpnServerClientRemoteIp
(List) The remote IP address of this VPN client.
RemotePort float64
(Integer) The remote port of this VPN client.
ResourceType string
(String) The resource type.
Status string
(String) The status of the VPN client.
Username string
(String) The username that this VPN client provided when connecting to the VPN server.
VpnServer string
clientIps List<GetIsVpnServerClientClientIp>
(List) The IP address assigned to this VPN client from client_ip_pool.
commonName String
(String) The common name of client certificate that the VPN client provided when connecting to the server.
createdAt String
(String) The date and time that the VPN client was created.
disconnectedAt String
(String) The date and time that the VPN client was disconnected.
href String
(String) The URL for this VPN client.
id String
The unique identifier of the VPNServerClient.
identifier String
remoteIps List<GetIsVpnServerClientRemoteIp>
(List) The remote IP address of this VPN client.
remotePort Double
(Integer) The remote port of this VPN client.
resourceType String
(String) The resource type.
status String
(String) The status of the VPN client.
username String
(String) The username that this VPN client provided when connecting to the VPN server.
vpnServer String
clientIps GetIsVpnServerClientClientIp[]
(List) The IP address assigned to this VPN client from client_ip_pool.
commonName string
(String) The common name of client certificate that the VPN client provided when connecting to the server.
createdAt string
(String) The date and time that the VPN client was created.
disconnectedAt string
(String) The date and time that the VPN client was disconnected.
href string
(String) The URL for this VPN client.
id string
The unique identifier of the VPNServerClient.
identifier string
remoteIps GetIsVpnServerClientRemoteIp[]
(List) The remote IP address of this VPN client.
remotePort number
(Integer) The remote port of this VPN client.
resourceType string
(String) The resource type.
status string
(String) The status of the VPN client.
username string
(String) The username that this VPN client provided when connecting to the VPN server.
vpnServer string
client_ips Sequence[GetIsVpnServerClientClientIp]
(List) The IP address assigned to this VPN client from client_ip_pool.
common_name str
(String) The common name of client certificate that the VPN client provided when connecting to the server.
created_at str
(String) The date and time that the VPN client was created.
disconnected_at str
(String) The date and time that the VPN client was disconnected.
href str
(String) The URL for this VPN client.
id str
The unique identifier of the VPNServerClient.
identifier str
remote_ips Sequence[GetIsVpnServerClientRemoteIp]
(List) The remote IP address of this VPN client.
remote_port float
(Integer) The remote port of this VPN client.
resource_type str
(String) The resource type.
status str
(String) The status of the VPN client.
username str
(String) The username that this VPN client provided when connecting to the VPN server.
vpn_server str
clientIps List<Property Map>
(List) The IP address assigned to this VPN client from client_ip_pool.
commonName String
(String) The common name of client certificate that the VPN client provided when connecting to the server.
createdAt String
(String) The date and time that the VPN client was created.
disconnectedAt String
(String) The date and time that the VPN client was disconnected.
href String
(String) The URL for this VPN client.
id String
The unique identifier of the VPNServerClient.
identifier String
remoteIps List<Property Map>
(List) The remote IP address of this VPN client.
remotePort Number
(Integer) The remote port of this VPN client.
resourceType String
(String) The resource type.
status String
(String) The status of the VPN client.
username String
(String) The username that this VPN client provided when connecting to the VPN server.
vpnServer String

Supporting Types

GetIsVpnServerClientClientIp

Address This property is required. string
(String) The IP address. This property may add support for IPv6 addresses in the future. When processing a value in this property, verify that the address is in an expected format. If it is not, log an error. Optionally halt processing and surface the error, or bypass the resource on which the unexpected IP address format was encountered.
Address This property is required. string
(String) The IP address. This property may add support for IPv6 addresses in the future. When processing a value in this property, verify that the address is in an expected format. If it is not, log an error. Optionally halt processing and surface the error, or bypass the resource on which the unexpected IP address format was encountered.
address This property is required. String
(String) The IP address. This property may add support for IPv6 addresses in the future. When processing a value in this property, verify that the address is in an expected format. If it is not, log an error. Optionally halt processing and surface the error, or bypass the resource on which the unexpected IP address format was encountered.
address This property is required. string
(String) The IP address. This property may add support for IPv6 addresses in the future. When processing a value in this property, verify that the address is in an expected format. If it is not, log an error. Optionally halt processing and surface the error, or bypass the resource on which the unexpected IP address format was encountered.
address This property is required. str
(String) The IP address. This property may add support for IPv6 addresses in the future. When processing a value in this property, verify that the address is in an expected format. If it is not, log an error. Optionally halt processing and surface the error, or bypass the resource on which the unexpected IP address format was encountered.
address This property is required. String
(String) The IP address. This property may add support for IPv6 addresses in the future. When processing a value in this property, verify that the address is in an expected format. If it is not, log an error. Optionally halt processing and surface the error, or bypass the resource on which the unexpected IP address format was encountered.

GetIsVpnServerClientRemoteIp

Address This property is required. string
(String) The IP address. This property may add support for IPv6 addresses in the future. When processing a value in this property, verify that the address is in an expected format. If it is not, log an error. Optionally halt processing and surface the error, or bypass the resource on which the unexpected IP address format was encountered.
Address This property is required. string
(String) The IP address. This property may add support for IPv6 addresses in the future. When processing a value in this property, verify that the address is in an expected format. If it is not, log an error. Optionally halt processing and surface the error, or bypass the resource on which the unexpected IP address format was encountered.
address This property is required. String
(String) The IP address. This property may add support for IPv6 addresses in the future. When processing a value in this property, verify that the address is in an expected format. If it is not, log an error. Optionally halt processing and surface the error, or bypass the resource on which the unexpected IP address format was encountered.
address This property is required. string
(String) The IP address. This property may add support for IPv6 addresses in the future. When processing a value in this property, verify that the address is in an expected format. If it is not, log an error. Optionally halt processing and surface the error, or bypass the resource on which the unexpected IP address format was encountered.
address This property is required. str
(String) The IP address. This property may add support for IPv6 addresses in the future. When processing a value in this property, verify that the address is in an expected format. If it is not, log an error. Optionally halt processing and surface the error, or bypass the resource on which the unexpected IP address format was encountered.
address This property is required. String
(String) The IP address. This property may add support for IPv6 addresses in the future. When processing a value in this property, verify that the address is in an expected format. If it is not, log an error. Optionally halt processing and surface the error, or bypass the resource on which the unexpected IP address format was encountered.

Package Details

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