Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Ibm Provider
  3. API Docs
  4. IsVpnServerClient
ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm

ibm.IsVpnServerClient

Explore with Pulumi AI

ibm logo
ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm

    Provides VPNServer client delete or disconnect functionality for VPNServer. 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 = new ibm.IsVpnServerClient("example", {
    vpnServer: ibm_is_vpn_server.example.vpn_server,
    vpnClient: "id",
    "delete": true,
});

    import pulumi
import pulumi_ibm as ibm

example = ibm.IsVpnServerClient("example",
    vpn_server=ibm_is_vpn_server["example"]["vpn_server"],
    vpn_client="id",
    delete=True)

    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.NewIsVpnServerClient(ctx, "example", &ibm.IsVpnServerClientArgs{
			VpnServer: pulumi.Any(ibm_is_vpn_server.Example.Vpn_server),
			VpnClient: pulumi.String("id"),
			Delete:    pulumi.Bool(true),
		})
		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 = new Ibm.IsVpnServerClient("example", new()
    {
        VpnServer = ibm_is_vpn_server.Example.Vpn_server,
        VpnClient = "id",
        Delete = true,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ibm.IsVpnServerClient;
import com.pulumi.ibm.IsVpnServerClientArgs;
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 example = new IsVpnServerClient("example", IsVpnServerClientArgs.builder()
            .vpnServer(ibm_is_vpn_server.example().vpn_server())
            .vpnClient("id")
            .delete(true)
            .build());

    }
}

    resources:
  example:
    type: ibm:IsVpnServerClient
    properties:
      vpnServer: ${ibm_is_vpn_server.example.vpn_server}
      vpnClient: id
      delete: true

    Create IsVpnServerClient Resource

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

    Constructor syntax

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

@overload
def IsVpnServerClient(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      vpn_client: Optional[str] = None,
                      vpn_server: Optional[str] = None,
                      delete: Optional[bool] = None,
                      is_vpn_server_client_id: Optional[str] = None)
    func NewIsVpnServerClient(ctx *Context, name string, args IsVpnServerClientArgs, opts ...ResourceOption) (*IsVpnServerClient, error)
    public IsVpnServerClient(string name, IsVpnServerClientArgs args, CustomResourceOptions? opts = null)
    public IsVpnServerClient(String name, IsVpnServerClientArgs args)
public IsVpnServerClient(String name, IsVpnServerClientArgs args, CustomResourceOptions options)

    type: ibm:IsVpnServerClient
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 IsVpnServerClientArgs
    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 IsVpnServerClientArgs
    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 IsVpnServerClientArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args IsVpnServerClientArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args IsVpnServerClientArgs
    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 isVpnServerClientResource = new Ibm.IsVpnServerClient("isVpnServerClientResource", new()
{
    VpnClient = "string",
    VpnServer = "string",
    Delete = false,
    IsVpnServerClientId = "string",
});

    example, err := ibm.NewIsVpnServerClient(ctx, "isVpnServerClientResource", &ibm.IsVpnServerClientArgs{
	VpnClient:           pulumi.String("string"),
	VpnServer:           pulumi.String("string"),
	Delete:              pulumi.Bool(false),
	IsVpnServerClientId: pulumi.String("string"),
})

    var isVpnServerClientResource = new IsVpnServerClient("isVpnServerClientResource", IsVpnServerClientArgs.builder()
    .vpnClient("string")
    .vpnServer("string")
    .delete(false)
    .isVpnServerClientId("string")
    .build());

    is_vpn_server_client_resource = ibm.IsVpnServerClient("isVpnServerClientResource",
    vpn_client="string",
    vpn_server="string",
    delete=False,
    is_vpn_server_client_id="string")

    const isVpnServerClientResource = new ibm.IsVpnServerClient("isVpnServerClientResource", {
    vpnClient: "string",
    vpnServer: "string",
    "delete": false,
    isVpnServerClientId: "string",
});

    type: ibm:IsVpnServerClient
properties:
    delete: false
    isVpnServerClientId: string
    vpnClient: string
    vpnServer: string

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

    VpnClient string
    The VPN client identifier.
    VpnServer string
    The VPN server identifier.
    Delete bool
    The delete to use for this VPN client to be deleted or not, when false, client is disconnected and when set to true client is deleted.
    IsVpnServerClientId string
    The unique identifier of the VPNServerClient, it is combination of vpn_server, vpn_client, status_code.
    VpnClient string
    The VPN client identifier.
    VpnServer string
    The VPN server identifier.
    Delete bool
    The delete to use for this VPN client to be deleted or not, when false, client is disconnected and when set to true client is deleted.
    IsVpnServerClientId string
    The unique identifier of the VPNServerClient, it is combination of vpn_server, vpn_client, status_code.
    vpnClient String
    The VPN client identifier.
    vpnServer String
    The VPN server identifier.
    delete Boolean
    The delete to use for this VPN client to be deleted or not, when false, client is disconnected and when set to true client is deleted.
    isVpnServerClientId String
    The unique identifier of the VPNServerClient, it is combination of vpn_server, vpn_client, status_code.
    vpnClient string
    The VPN client identifier.
    vpnServer string
    The VPN server identifier.
    delete boolean
    The delete to use for this VPN client to be deleted or not, when false, client is disconnected and when set to true client is deleted.
    isVpnServerClientId string
    The unique identifier of the VPNServerClient, it is combination of vpn_server, vpn_client, status_code.
    vpn_client str
    The VPN client identifier.
    vpn_server str
    The VPN server identifier.
    delete bool
    The delete to use for this VPN client to be deleted or not, when false, client is disconnected and when set to true client is deleted.
    is_vpn_server_client_id str
    The unique identifier of the VPNServerClient, it is combination of vpn_server, vpn_client, status_code.
    vpnClient String
    The VPN client identifier.
    vpnServer String
    The VPN server identifier.
    delete Boolean
    The delete to use for this VPN client to be deleted or not, when false, client is disconnected and when set to true client is deleted.
    isVpnServerClientId String
    The unique identifier of the VPNServerClient, it is combination of vpn_server, vpn_client, status_code.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the IsVpnServerClient resource produces the following output properties:

    Description string
    description of the result.
    Id string
    The provider-assigned unique ID for this managed resource.
    StatusCode double
    status code of the result.
    Description string
    description of the result.
    Id string
    The provider-assigned unique ID for this managed resource.
    StatusCode float64
    status code of the result.
    description String
    description of the result.
    id String
    The provider-assigned unique ID for this managed resource.
    statusCode Double
    status code of the result.
    description string
    description of the result.
    id string
    The provider-assigned unique ID for this managed resource.
    statusCode number
    status code of the result.
    description str
    description of the result.
    id str
    The provider-assigned unique ID for this managed resource.
    status_code float
    status code of the result.
    description String
    description of the result.
    id String
    The provider-assigned unique ID for this managed resource.
    statusCode Number
    status code of the result.

    Look up Existing IsVpnServerClient Resource

    Get an existing IsVpnServerClient 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?: IsVpnServerClientState, opts?: CustomResourceOptions): IsVpnServerClient
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        delete: Optional[bool] = None,
        description: Optional[str] = None,
        is_vpn_server_client_id: Optional[str] = None,
        status_code: Optional[float] = None,
        vpn_client: Optional[str] = None,
        vpn_server: Optional[str] = None) -> IsVpnServerClient
    func GetIsVpnServerClient(ctx *Context, name string, id IDInput, state *IsVpnServerClientState, opts ...ResourceOption) (*IsVpnServerClient, error)
    public static IsVpnServerClient Get(string name, Input<string> id, IsVpnServerClientState? state, CustomResourceOptions? opts = null)
    public static IsVpnServerClient get(String name, Output<String> id, IsVpnServerClientState state, CustomResourceOptions options)
    resources:  _:    type: ibm:IsVpnServerClient    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:
    Delete bool
    The delete to use for this VPN client to be deleted or not, when false, client is disconnected and when set to true client is deleted.
    Description string
    description of the result.
    IsVpnServerClientId string
    The unique identifier of the VPNServerClient, it is combination of vpn_server, vpn_client, status_code.
    StatusCode double
    status code of the result.
    VpnClient string
    The VPN client identifier.
    VpnServer string
    The VPN server identifier.
    Delete bool
    The delete to use for this VPN client to be deleted or not, when false, client is disconnected and when set to true client is deleted.
    Description string
    description of the result.
    IsVpnServerClientId string
    The unique identifier of the VPNServerClient, it is combination of vpn_server, vpn_client, status_code.
    StatusCode float64
    status code of the result.
    VpnClient string
    The VPN client identifier.
    VpnServer string
    The VPN server identifier.
    delete Boolean
    The delete to use for this VPN client to be deleted or not, when false, client is disconnected and when set to true client is deleted.
    description String
    description of the result.
    isVpnServerClientId String
    The unique identifier of the VPNServerClient, it is combination of vpn_server, vpn_client, status_code.
    statusCode Double
    status code of the result.
    vpnClient String
    The VPN client identifier.
    vpnServer String
    The VPN server identifier.
    delete boolean
    The delete to use for this VPN client to be deleted or not, when false, client is disconnected and when set to true client is deleted.
    description string
    description of the result.
    isVpnServerClientId string
    The unique identifier of the VPNServerClient, it is combination of vpn_server, vpn_client, status_code.
    statusCode number
    status code of the result.
    vpnClient string
    The VPN client identifier.
    vpnServer string
    The VPN server identifier.
    delete bool
    The delete to use for this VPN client to be deleted or not, when false, client is disconnected and when set to true client is deleted.
    description str
    description of the result.
    is_vpn_server_client_id str
    The unique identifier of the VPNServerClient, it is combination of vpn_server, vpn_client, status_code.
    status_code float
    status code of the result.
    vpn_client str
    The VPN client identifier.
    vpn_server str
    The VPN server identifier.
    delete Boolean
    The delete to use for this VPN client to be deleted or not, when false, client is disconnected and when set to true client is deleted.
    description String
    description of the result.
    isVpnServerClientId String
    The unique identifier of the VPNServerClient, it is combination of vpn_server, vpn_client, status_code.
    statusCode Number
    status code of the result.
    vpnClient String
    The VPN client identifier.
    vpnServer String
    The VPN server identifier.

    Import

    You can import the ibm_is_vpn_server_client resource by using id. The unique identifier for this VPN server client.

    Syntax

    $ pulumi import ibm:index/isVpnServerClient:IsVpnServerClient example <id>

    Example

    $ pulumi import ibm:index/isVpnServerClient:IsVpnServerClient example r006-d7cc5196-9864-48c4-82d8-3f30da41fcc5/r006-d7cc5196-9864-48c4-82d8-3h30db41acd5/202

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

    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.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud
    ibm-cloud/terraform-provider-ibm