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

ibm.getIsVpnServerClients

Explore with Pulumi AI

ibm logo
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 VPNServerClientCollection. For more information, about VPN Server Clients, 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.getIsVpnServerClients({
    vpnServer: ibm_is_vpn_server.example.id,
});

    import pulumi
import pulumi_ibm as ibm

example = ibm.get_is_vpn_server_clients(vpn_server=ibm_is_vpn_server["example"]["id"])

    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.GetIsVpnServerClients(ctx, &ibm.GetIsVpnServerClientsArgs{
			VpnServer: ibm_is_vpn_server.Example.Id,
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

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

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

});

    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.GetIsVpnServerClientsArgs;
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.getIsVpnServerClients(GetIsVpnServerClientsArgs.builder()
            .vpnServer(ibm_is_vpn_server.example().id())
            .build());

    }
}

    variables:
  example:
    fn::invoke:
      function: ibm:getIsVpnServerClients
      arguments:
        vpnServer: ${ibm_is_vpn_server.example.id}

    Using getIsVpnServerClients

    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 getIsVpnServerClients(args: GetIsVpnServerClientsArgs, opts?: InvokeOptions): Promise<GetIsVpnServerClientsResult>
function getIsVpnServerClientsOutput(args: GetIsVpnServerClientsOutputArgs, opts?: InvokeOptions): Output<GetIsVpnServerClientsResult>
    def get_is_vpn_server_clients(id: Optional[str] = None,
                              vpn_server: Optional[str] = None,
                              opts: Optional[InvokeOptions] = None) -> GetIsVpnServerClientsResult
def get_is_vpn_server_clients_output(id: Optional[pulumi.Input[str]] = None,
                              vpn_server: Optional[pulumi.Input[str]] = None,
                              opts: Optional[InvokeOptions] = None) -> Output[GetIsVpnServerClientsResult]
    func GetIsVpnServerClients(ctx *Context, args *GetIsVpnServerClientsArgs, opts ...InvokeOption) (*GetIsVpnServerClientsResult, error)
func GetIsVpnServerClientsOutput(ctx *Context, args *GetIsVpnServerClientsOutputArgs, opts ...InvokeOption) GetIsVpnServerClientsResultOutput

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

    public static class GetIsVpnServerClients 
{
    public static Task<GetIsVpnServerClientsResult> InvokeAsync(GetIsVpnServerClientsArgs args, InvokeOptions? opts = null)
    public static Output<GetIsVpnServerClientsResult> Invoke(GetIsVpnServerClientsInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetIsVpnServerClientsResult> getIsVpnServerClients(GetIsVpnServerClientsArgs args, InvokeOptions options)
public static Output<GetIsVpnServerClientsResult> getIsVpnServerClients(GetIsVpnServerClientsArgs args, InvokeOptions options)

    fn::invoke:
  function: ibm:index/getIsVpnServerClients:getIsVpnServerClients
  arguments:
    # arguments dictionary

    The following arguments are supported:

    VpnServer string
    The VPN server identifier.
    Id string
    (String) The unique identifier for this VPN client.
    VpnServer string
    The VPN server identifier.
    Id string
    (String) The unique identifier for this VPN client.
    vpnServer String
    The VPN server identifier.
    id String
    (String) The unique identifier for this VPN client.
    vpnServer string
    The VPN server identifier.
    id string
    (String) The unique identifier for this VPN client.
    vpn_server str
    The VPN server identifier.
    id str
    (String) The unique identifier for this VPN client.
    vpnServer String
    The VPN server identifier.
    id String
    (String) The unique identifier for this VPN client.

    getIsVpnServerClients Result

    The following output properties are available:

    Clients List<GetIsVpnServerClientsClient>
    (List) Collection of VPN clients. Nested scheme for clients:
    Id string
    (String) The unique identifier for this VPN client.
    VpnServer string
    Clients []GetIsVpnServerClientsClient
    (List) Collection of VPN clients. Nested scheme for clients:
    Id string
    (String) The unique identifier for this VPN client.
    VpnServer string
    clients List<GetIsVpnServerClientsClient>
    (List) Collection of VPN clients. Nested scheme for clients:
    id String
    (String) The unique identifier for this VPN client.
    vpnServer String
    clients GetIsVpnServerClientsClient[]
    (List) Collection of VPN clients. Nested scheme for clients:
    id string
    (String) The unique identifier for this VPN client.
    vpnServer string
    clients Sequence[GetIsVpnServerClientsClient]
    (List) Collection of VPN clients. Nested scheme for clients:
    id str
    (String) The unique identifier for this VPN client.
    vpn_server str
    clients List<Property Map>
    (List) Collection of VPN clients. Nested scheme for clients:
    id String
    (String) The unique identifier for this VPN client.
    vpnServer String

    Supporting Types

    GetIsVpnServerClientsClient

    ClientIps List<GetIsVpnServerClientsClientClientIp>
    (List) The IP address assigned to this VPN client from client_ip_pool. Nested scheme for client_ip:
    CommonName string
    (String) The common name of client certificate that the VPN client provided when connecting to the server.This property will be present only when the certificate client authentication method is enabled on the VPN 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
    (String) The unique identifier for this VPN client.
    RemoteIps List<GetIsVpnServerClientsClientRemoteIp>
    (List) The remote IP address of this VPN client. Nested scheme for remote_ip:
    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.
    ClientIps []GetIsVpnServerClientsClientClientIp
    (List) The IP address assigned to this VPN client from client_ip_pool. Nested scheme for client_ip:
    CommonName string
    (String) The common name of client certificate that the VPN client provided when connecting to the server.This property will be present only when the certificate client authentication method is enabled on the VPN 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
    (String) The unique identifier for this VPN client.
    RemoteIps []GetIsVpnServerClientsClientRemoteIp
    (List) The remote IP address of this VPN client. Nested scheme for remote_ip:
    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.
    clientIps List<GetIsVpnServerClientsClientClientIp>
    (List) The IP address assigned to this VPN client from client_ip_pool. Nested scheme for client_ip:
    commonName String
    (String) The common name of client certificate that the VPN client provided when connecting to the server.This property will be present only when the certificate client authentication method is enabled on the VPN 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
    (String) The unique identifier for this VPN client.
    remoteIps List<GetIsVpnServerClientsClientRemoteIp>
    (List) The remote IP address of this VPN client. Nested scheme for remote_ip:
    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.
    clientIps GetIsVpnServerClientsClientClientIp[]
    (List) The IP address assigned to this VPN client from client_ip_pool. Nested scheme for client_ip:
    commonName string
    (String) The common name of client certificate that the VPN client provided when connecting to the server.This property will be present only when the certificate client authentication method is enabled on the VPN 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
    (String) The unique identifier for this VPN client.
    remoteIps GetIsVpnServerClientsClientRemoteIp[]
    (List) The remote IP address of this VPN client. Nested scheme for remote_ip:
    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.
    client_ips Sequence[GetIsVpnServerClientsClientClientIp]
    (List) The IP address assigned to this VPN client from client_ip_pool. Nested scheme for client_ip:
    common_name str
    (String) The common name of client certificate that the VPN client provided when connecting to the server.This property will be present only when the certificate client authentication method is enabled on the VPN 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
    (String) The unique identifier for this VPN client.
    remote_ips Sequence[GetIsVpnServerClientsClientRemoteIp]
    (List) The remote IP address of this VPN client. Nested scheme for remote_ip:
    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.
    clientIps List<Property Map>
    (List) The IP address assigned to this VPN client from client_ip_pool. Nested scheme for client_ip:
    commonName String
    (String) The common name of client certificate that the VPN client provided when connecting to the server.This property will be present only when the certificate client authentication method is enabled on the VPN 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
    (String) The unique identifier for this VPN client.
    remoteIps List<Property Map>
    (List) The remote IP address of this VPN client. Nested scheme for remote_ip:
    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.

    GetIsVpnServerClientsClientClientIp

    Address 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 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 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 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 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 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.

    GetIsVpnServerClientsClientRemoteIp

    Address 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 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 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 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 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 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 logo
    ibm 1.77.1 published on Monday, Apr 14, 2025 by ibm-cloud
    ibm-cloud/terraform-provider-ibm