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

ibm.IsVpnServerRoute

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 a resource for VPNServerRoute. This allows VPNServerRoute to be created, updated and deleted. For more information, about VPN Server Routes, see Managing VPN Server routes.

    Example Usage

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

const example = new ibm.IsVpnServerRoute("example", {
    vpnServer: ibm_is_vpn_server.example.vpn_server,
    destination: "172.16.0.0/16",
    action: "translate",
});

    import pulumi
import pulumi_ibm as ibm

example = ibm.IsVpnServerRoute("example",
    vpn_server=ibm_is_vpn_server["example"]["vpn_server"],
    destination="172.16.0.0/16",
    action="translate")

    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.NewIsVpnServerRoute(ctx, "example", &ibm.IsVpnServerRouteArgs{
			VpnServer:   pulumi.Any(ibm_is_vpn_server.Example.Vpn_server),
			Destination: pulumi.String("172.16.0.0/16"),
			Action:      pulumi.String("translate"),
		})
		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.IsVpnServerRoute("example", new()
    {
        VpnServer = ibm_is_vpn_server.Example.Vpn_server,
        Destination = "172.16.0.0/16",
        Action = "translate",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ibm.IsVpnServerRoute;
import com.pulumi.ibm.IsVpnServerRouteArgs;
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 IsVpnServerRoute("example", IsVpnServerRouteArgs.builder()
            .vpnServer(ibm_is_vpn_server.example().vpn_server())
            .destination("172.16.0.0/16")
            .action("translate")
            .build());

    }
}

    resources:
  example:
    type: ibm:IsVpnServerRoute
    properties:
      vpnServer: ${ibm_is_vpn_server.example.vpn_server}
      destination: 172.16.0.0/16
      action: translate

    Create IsVpnServerRoute Resource

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

    Constructor syntax

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

@overload
def IsVpnServerRoute(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     destination: Optional[str] = None,
                     vpn_server: Optional[str] = None,
                     action: Optional[str] = None,
                     is_vpn_server_route_id: Optional[str] = None,
                     name: Optional[str] = None,
                     timeouts: Optional[IsVpnServerRouteTimeoutsArgs] = None)
    func NewIsVpnServerRoute(ctx *Context, name string, args IsVpnServerRouteArgs, opts ...ResourceOption) (*IsVpnServerRoute, error)
    public IsVpnServerRoute(string name, IsVpnServerRouteArgs args, CustomResourceOptions? opts = null)
    public IsVpnServerRoute(String name, IsVpnServerRouteArgs args)
public IsVpnServerRoute(String name, IsVpnServerRouteArgs args, CustomResourceOptions options)

    type: ibm:IsVpnServerRoute
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 IsVpnServerRouteArgs
    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 IsVpnServerRouteArgs
    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 IsVpnServerRouteArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args IsVpnServerRouteArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args IsVpnServerRouteArgs
    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 isVpnServerRouteResource = new Ibm.IsVpnServerRoute("isVpnServerRouteResource", new()
{
    Destination = "string",
    VpnServer = "string",
    Action = "string",
    IsVpnServerRouteId = "string",
    Name = "string",
    Timeouts = new Ibm.Inputs.IsVpnServerRouteTimeoutsArgs
    {
        Create = "string",
        Delete = "string",
        Update = "string",
    },
});

    example, err := ibm.NewIsVpnServerRoute(ctx, "isVpnServerRouteResource", &ibm.IsVpnServerRouteArgs{
	Destination:        pulumi.String("string"),
	VpnServer:          pulumi.String("string"),
	Action:             pulumi.String("string"),
	IsVpnServerRouteId: pulumi.String("string"),
	Name:               pulumi.String("string"),
	Timeouts: &ibm.IsVpnServerRouteTimeoutsArgs{
		Create: pulumi.String("string"),
		Delete: pulumi.String("string"),
		Update: pulumi.String("string"),
	},
})

    var isVpnServerRouteResource = new IsVpnServerRoute("isVpnServerRouteResource", IsVpnServerRouteArgs.builder()
    .destination("string")
    .vpnServer("string")
    .action("string")
    .isVpnServerRouteId("string")
    .name("string")
    .timeouts(IsVpnServerRouteTimeoutsArgs.builder()
        .create("string")
        .delete("string")
        .update("string")
        .build())
    .build());

    is_vpn_server_route_resource = ibm.IsVpnServerRoute("isVpnServerRouteResource",
    destination="string",
    vpn_server="string",
    action="string",
    is_vpn_server_route_id="string",
    name="string",
    timeouts={
        "create": "string",
        "delete": "string",
        "update": "string",
    })

    const isVpnServerRouteResource = new ibm.IsVpnServerRoute("isVpnServerRouteResource", {
    destination: "string",
    vpnServer: "string",
    action: "string",
    isVpnServerRouteId: "string",
    name: "string",
    timeouts: {
        create: "string",
        "delete": "string",
        update: "string",
    },
});

    type: ibm:IsVpnServerRoute
properties:
    action: string
    destination: string
    isVpnServerRouteId: string
    name: string
    timeouts:
        create: string
        delete: string
        update: string
    vpnServer: string

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

    Destination string
    The destination to use for this VPN route in the VPN server. Must be unique within the VPN server. If an incoming packet does not match any destination, it will be dropped.
    VpnServer string
    The VPN server identifier.
    Action string

    The action to perform with a packet matching the VPN route.

    Note: Allowed values are : • translate: translate the source IP address to one of the private IP addresses of the VPN server, then deliver the packet to target. • deliver: deliver the packet to the target. • drop: drop the packet. The enumerated values for this property are expected to expand in the future.

    IsVpnServerRouteId string
    The unique identifier of the VPNServerRoute and it has format VPNServerID/VPNServerRouteID.
    Name string
    The user-defined name for this VPN route. If unspecified, the name will be a hyphenated list of randomly-selected words.Names must be unique within the VPN server the VPN route resides in.
    Timeouts IsVpnServerRouteTimeouts
    Destination string
    The destination to use for this VPN route in the VPN server. Must be unique within the VPN server. If an incoming packet does not match any destination, it will be dropped.
    VpnServer string
    The VPN server identifier.
    Action string

    The action to perform with a packet matching the VPN route.

    Note: Allowed values are : • translate: translate the source IP address to one of the private IP addresses of the VPN server, then deliver the packet to target. • deliver: deliver the packet to the target. • drop: drop the packet. The enumerated values for this property are expected to expand in the future.

    IsVpnServerRouteId string
    The unique identifier of the VPNServerRoute and it has format VPNServerID/VPNServerRouteID.
    Name string
    The user-defined name for this VPN route. If unspecified, the name will be a hyphenated list of randomly-selected words.Names must be unique within the VPN server the VPN route resides in.
    Timeouts IsVpnServerRouteTimeoutsArgs
    destination String
    The destination to use for this VPN route in the VPN server. Must be unique within the VPN server. If an incoming packet does not match any destination, it will be dropped.
    vpnServer String
    The VPN server identifier.
    action String

    The action to perform with a packet matching the VPN route.

    Note: Allowed values are : • translate: translate the source IP address to one of the private IP addresses of the VPN server, then deliver the packet to target. • deliver: deliver the packet to the target. • drop: drop the packet. The enumerated values for this property are expected to expand in the future.

    isVpnServerRouteId String
    The unique identifier of the VPNServerRoute and it has format VPNServerID/VPNServerRouteID.
    name String
    The user-defined name for this VPN route. If unspecified, the name will be a hyphenated list of randomly-selected words.Names must be unique within the VPN server the VPN route resides in.
    timeouts IsVpnServerRouteTimeouts
    destination string
    The destination to use for this VPN route in the VPN server. Must be unique within the VPN server. If an incoming packet does not match any destination, it will be dropped.
    vpnServer string
    The VPN server identifier.
    action string

    The action to perform with a packet matching the VPN route.

    Note: Allowed values are : • translate: translate the source IP address to one of the private IP addresses of the VPN server, then deliver the packet to target. • deliver: deliver the packet to the target. • drop: drop the packet. The enumerated values for this property are expected to expand in the future.

    isVpnServerRouteId string
    The unique identifier of the VPNServerRoute and it has format VPNServerID/VPNServerRouteID.
    name string
    The user-defined name for this VPN route. If unspecified, the name will be a hyphenated list of randomly-selected words.Names must be unique within the VPN server the VPN route resides in.
    timeouts IsVpnServerRouteTimeouts
    destination str
    The destination to use for this VPN route in the VPN server. Must be unique within the VPN server. If an incoming packet does not match any destination, it will be dropped.
    vpn_server str
    The VPN server identifier.
    action str

    The action to perform with a packet matching the VPN route.

    Note: Allowed values are : • translate: translate the source IP address to one of the private IP addresses of the VPN server, then deliver the packet to target. • deliver: deliver the packet to the target. • drop: drop the packet. The enumerated values for this property are expected to expand in the future.

    is_vpn_server_route_id str
    The unique identifier of the VPNServerRoute and it has format VPNServerID/VPNServerRouteID.
    name str
    The user-defined name for this VPN route. If unspecified, the name will be a hyphenated list of randomly-selected words.Names must be unique within the VPN server the VPN route resides in.
    timeouts IsVpnServerRouteTimeoutsArgs
    destination String
    The destination to use for this VPN route in the VPN server. Must be unique within the VPN server. If an incoming packet does not match any destination, it will be dropped.
    vpnServer String
    The VPN server identifier.
    action String

    The action to perform with a packet matching the VPN route.

    Note: Allowed values are : • translate: translate the source IP address to one of the private IP addresses of the VPN server, then deliver the packet to target. • deliver: deliver the packet to the target. • drop: drop the packet. The enumerated values for this property are expected to expand in the future.

    isVpnServerRouteId String
    The unique identifier of the VPNServerRoute and it has format VPNServerID/VPNServerRouteID.
    name String
    The user-defined name for this VPN route. If unspecified, the name will be a hyphenated list of randomly-selected words.Names must be unique within the VPN server the VPN route resides in.
    timeouts Property Map

    Outputs

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

    CreatedAt string
    (String) The date and time that the VPN route was created.
    HealthReasons List<IsVpnServerRouteHealthReason>
    (List) The reasons for the current health_state (if any).
    HealthState string
    (String) The health of this resource.
    Href string
    (String) The URL for this VPN route.
    Id string
    The provider-assigned unique ID for this managed resource.
    LifecycleReasons List<IsVpnServerRouteLifecycleReason>
    (List) The reasons for the current lifecycle_reasons (if any).
    LifecycleState string
    (String) The lifecycle state of the VPN route.
    ResourceType string
    (String) The resource type.
    VpnRoute string
    The identifier of the VPNServerRoute.
    CreatedAt string
    (String) The date and time that the VPN route was created.
    HealthReasons []IsVpnServerRouteHealthReason
    (List) The reasons for the current health_state (if any).
    HealthState string
    (String) The health of this resource.
    Href string
    (String) The URL for this VPN route.
    Id string
    The provider-assigned unique ID for this managed resource.
    LifecycleReasons []IsVpnServerRouteLifecycleReason
    (List) The reasons for the current lifecycle_reasons (if any).
    LifecycleState string
    (String) The lifecycle state of the VPN route.
    ResourceType string
    (String) The resource type.
    VpnRoute string
    The identifier of the VPNServerRoute.
    createdAt String
    (String) The date and time that the VPN route was created.
    healthReasons List<IsVpnServerRouteHealthReason>
    (List) The reasons for the current health_state (if any).
    healthState String
    (String) The health of this resource.
    href String
    (String) The URL for this VPN route.
    id String
    The provider-assigned unique ID for this managed resource.
    lifecycleReasons List<IsVpnServerRouteLifecycleReason>
    (List) The reasons for the current lifecycle_reasons (if any).
    lifecycleState String
    (String) The lifecycle state of the VPN route.
    resourceType String
    (String) The resource type.
    vpnRoute String
    The identifier of the VPNServerRoute.
    createdAt string
    (String) The date and time that the VPN route was created.
    healthReasons IsVpnServerRouteHealthReason[]
    (List) The reasons for the current health_state (if any).
    healthState string
    (String) The health of this resource.
    href string
    (String) The URL for this VPN route.
    id string
    The provider-assigned unique ID for this managed resource.
    lifecycleReasons IsVpnServerRouteLifecycleReason[]
    (List) The reasons for the current lifecycle_reasons (if any).
    lifecycleState string
    (String) The lifecycle state of the VPN route.
    resourceType string
    (String) The resource type.
    vpnRoute string
    The identifier of the VPNServerRoute.
    created_at str
    (String) The date and time that the VPN route was created.
    health_reasons Sequence[IsVpnServerRouteHealthReason]
    (List) The reasons for the current health_state (if any).
    health_state str
    (String) The health of this resource.
    href str
    (String) The URL for this VPN route.
    id str
    The provider-assigned unique ID for this managed resource.
    lifecycle_reasons Sequence[IsVpnServerRouteLifecycleReason]
    (List) The reasons for the current lifecycle_reasons (if any).
    lifecycle_state str
    (String) The lifecycle state of the VPN route.
    resource_type str
    (String) The resource type.
    vpn_route str
    The identifier of the VPNServerRoute.
    createdAt String
    (String) The date and time that the VPN route was created.
    healthReasons List<Property Map>
    (List) The reasons for the current health_state (if any).
    healthState String
    (String) The health of this resource.
    href String
    (String) The URL for this VPN route.
    id String
    The provider-assigned unique ID for this managed resource.
    lifecycleReasons List<Property Map>
    (List) The reasons for the current lifecycle_reasons (if any).
    lifecycleState String
    (String) The lifecycle state of the VPN route.
    resourceType String
    (String) The resource type.
    vpnRoute String
    The identifier of the VPNServerRoute.

    Look up Existing IsVpnServerRoute Resource

    Get an existing IsVpnServerRoute 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?: IsVpnServerRouteState, opts?: CustomResourceOptions): IsVpnServerRoute
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        action: Optional[str] = None,
        created_at: Optional[str] = None,
        destination: Optional[str] = None,
        health_reasons: Optional[Sequence[IsVpnServerRouteHealthReasonArgs]] = None,
        health_state: Optional[str] = None,
        href: Optional[str] = None,
        is_vpn_server_route_id: Optional[str] = None,
        lifecycle_reasons: Optional[Sequence[IsVpnServerRouteLifecycleReasonArgs]] = None,
        lifecycle_state: Optional[str] = None,
        name: Optional[str] = None,
        resource_type: Optional[str] = None,
        timeouts: Optional[IsVpnServerRouteTimeoutsArgs] = None,
        vpn_route: Optional[str] = None,
        vpn_server: Optional[str] = None) -> IsVpnServerRoute
    func GetIsVpnServerRoute(ctx *Context, name string, id IDInput, state *IsVpnServerRouteState, opts ...ResourceOption) (*IsVpnServerRoute, error)
    public static IsVpnServerRoute Get(string name, Input<string> id, IsVpnServerRouteState? state, CustomResourceOptions? opts = null)
    public static IsVpnServerRoute get(String name, Output<String> id, IsVpnServerRouteState state, CustomResourceOptions options)
    resources:  _:    type: ibm:IsVpnServerRoute    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:
    Action string

    The action to perform with a packet matching the VPN route.

    Note: Allowed values are : • translate: translate the source IP address to one of the private IP addresses of the VPN server, then deliver the packet to target. • deliver: deliver the packet to the target. • drop: drop the packet. The enumerated values for this property are expected to expand in the future.

    CreatedAt string
    (String) The date and time that the VPN route was created.
    Destination string
    The destination to use for this VPN route in the VPN server. Must be unique within the VPN server. If an incoming packet does not match any destination, it will be dropped.
    HealthReasons List<IsVpnServerRouteHealthReason>
    (List) The reasons for the current health_state (if any).
    HealthState string
    (String) The health of this resource.
    Href string
    (String) The URL for this VPN route.
    IsVpnServerRouteId string
    The unique identifier of the VPNServerRoute and it has format VPNServerID/VPNServerRouteID.
    LifecycleReasons List<IsVpnServerRouteLifecycleReason>
    (List) The reasons for the current lifecycle_reasons (if any).
    LifecycleState string
    (String) The lifecycle state of the VPN route.
    Name string
    The user-defined name for this VPN route. If unspecified, the name will be a hyphenated list of randomly-selected words.Names must be unique within the VPN server the VPN route resides in.
    ResourceType string
    (String) The resource type.
    Timeouts IsVpnServerRouteTimeouts
    VpnRoute string
    The identifier of the VPNServerRoute.
    VpnServer string
    The VPN server identifier.
    Action string

    The action to perform with a packet matching the VPN route.

    Note: Allowed values are : • translate: translate the source IP address to one of the private IP addresses of the VPN server, then deliver the packet to target. • deliver: deliver the packet to the target. • drop: drop the packet. The enumerated values for this property are expected to expand in the future.

    CreatedAt string
    (String) The date and time that the VPN route was created.
    Destination string
    The destination to use for this VPN route in the VPN server. Must be unique within the VPN server. If an incoming packet does not match any destination, it will be dropped.
    HealthReasons []IsVpnServerRouteHealthReasonArgs
    (List) The reasons for the current health_state (if any).
    HealthState string
    (String) The health of this resource.
    Href string
    (String) The URL for this VPN route.
    IsVpnServerRouteId string
    The unique identifier of the VPNServerRoute and it has format VPNServerID/VPNServerRouteID.
    LifecycleReasons []IsVpnServerRouteLifecycleReasonArgs
    (List) The reasons for the current lifecycle_reasons (if any).
    LifecycleState string
    (String) The lifecycle state of the VPN route.
    Name string
    The user-defined name for this VPN route. If unspecified, the name will be a hyphenated list of randomly-selected words.Names must be unique within the VPN server the VPN route resides in.
    ResourceType string
    (String) The resource type.
    Timeouts IsVpnServerRouteTimeoutsArgs
    VpnRoute string
    The identifier of the VPNServerRoute.
    VpnServer string
    The VPN server identifier.
    action String

    The action to perform with a packet matching the VPN route.

    Note: Allowed values are : • translate: translate the source IP address to one of the private IP addresses of the VPN server, then deliver the packet to target. • deliver: deliver the packet to the target. • drop: drop the packet. The enumerated values for this property are expected to expand in the future.

    createdAt String
    (String) The date and time that the VPN route was created.
    destination String
    The destination to use for this VPN route in the VPN server. Must be unique within the VPN server. If an incoming packet does not match any destination, it will be dropped.
    healthReasons List<IsVpnServerRouteHealthReason>
    (List) The reasons for the current health_state (if any).
    healthState String
    (String) The health of this resource.
    href String
    (String) The URL for this VPN route.
    isVpnServerRouteId String
    The unique identifier of the VPNServerRoute and it has format VPNServerID/VPNServerRouteID.
    lifecycleReasons List<IsVpnServerRouteLifecycleReason>
    (List) The reasons for the current lifecycle_reasons (if any).
    lifecycleState String
    (String) The lifecycle state of the VPN route.
    name String
    The user-defined name for this VPN route. If unspecified, the name will be a hyphenated list of randomly-selected words.Names must be unique within the VPN server the VPN route resides in.
    resourceType String
    (String) The resource type.
    timeouts IsVpnServerRouteTimeouts
    vpnRoute String
    The identifier of the VPNServerRoute.
    vpnServer String
    The VPN server identifier.
    action string

    The action to perform with a packet matching the VPN route.

    Note: Allowed values are : • translate: translate the source IP address to one of the private IP addresses of the VPN server, then deliver the packet to target. • deliver: deliver the packet to the target. • drop: drop the packet. The enumerated values for this property are expected to expand in the future.

    createdAt string
    (String) The date and time that the VPN route was created.
    destination string
    The destination to use for this VPN route in the VPN server. Must be unique within the VPN server. If an incoming packet does not match any destination, it will be dropped.
    healthReasons IsVpnServerRouteHealthReason[]
    (List) The reasons for the current health_state (if any).
    healthState string
    (String) The health of this resource.
    href string
    (String) The URL for this VPN route.
    isVpnServerRouteId string
    The unique identifier of the VPNServerRoute and it has format VPNServerID/VPNServerRouteID.
    lifecycleReasons IsVpnServerRouteLifecycleReason[]
    (List) The reasons for the current lifecycle_reasons (if any).
    lifecycleState string
    (String) The lifecycle state of the VPN route.
    name string
    The user-defined name for this VPN route. If unspecified, the name will be a hyphenated list of randomly-selected words.Names must be unique within the VPN server the VPN route resides in.
    resourceType string
    (String) The resource type.
    timeouts IsVpnServerRouteTimeouts
    vpnRoute string
    The identifier of the VPNServerRoute.
    vpnServer string
    The VPN server identifier.
    action str

    The action to perform with a packet matching the VPN route.

    Note: Allowed values are : • translate: translate the source IP address to one of the private IP addresses of the VPN server, then deliver the packet to target. • deliver: deliver the packet to the target. • drop: drop the packet. The enumerated values for this property are expected to expand in the future.

    created_at str
    (String) The date and time that the VPN route was created.
    destination str
    The destination to use for this VPN route in the VPN server. Must be unique within the VPN server. If an incoming packet does not match any destination, it will be dropped.
    health_reasons Sequence[IsVpnServerRouteHealthReasonArgs]
    (List) The reasons for the current health_state (if any).
    health_state str
    (String) The health of this resource.
    href str
    (String) The URL for this VPN route.
    is_vpn_server_route_id str
    The unique identifier of the VPNServerRoute and it has format VPNServerID/VPNServerRouteID.
    lifecycle_reasons Sequence[IsVpnServerRouteLifecycleReasonArgs]
    (List) The reasons for the current lifecycle_reasons (if any).
    lifecycle_state str
    (String) The lifecycle state of the VPN route.
    name str
    The user-defined name for this VPN route. If unspecified, the name will be a hyphenated list of randomly-selected words.Names must be unique within the VPN server the VPN route resides in.
    resource_type str
    (String) The resource type.
    timeouts IsVpnServerRouteTimeoutsArgs
    vpn_route str
    The identifier of the VPNServerRoute.
    vpn_server str
    The VPN server identifier.
    action String

    The action to perform with a packet matching the VPN route.

    Note: Allowed values are : • translate: translate the source IP address to one of the private IP addresses of the VPN server, then deliver the packet to target. • deliver: deliver the packet to the target. • drop: drop the packet. The enumerated values for this property are expected to expand in the future.

    createdAt String
    (String) The date and time that the VPN route was created.
    destination String
    The destination to use for this VPN route in the VPN server. Must be unique within the VPN server. If an incoming packet does not match any destination, it will be dropped.
    healthReasons List<Property Map>
    (List) The reasons for the current health_state (if any).
    healthState String
    (String) The health of this resource.
    href String
    (String) The URL for this VPN route.
    isVpnServerRouteId String
    The unique identifier of the VPNServerRoute and it has format VPNServerID/VPNServerRouteID.
    lifecycleReasons List<Property Map>
    (List) The reasons for the current lifecycle_reasons (if any).
    lifecycleState String
    (String) The lifecycle state of the VPN route.
    name String
    The user-defined name for this VPN route. If unspecified, the name will be a hyphenated list of randomly-selected words.Names must be unique within the VPN server the VPN route resides in.
    resourceType String
    (String) The resource type.
    timeouts Property Map
    vpnRoute String
    The identifier of the VPNServerRoute.
    vpnServer String
    The VPN server identifier.

    Supporting Types

    IsVpnServerRouteHealthReason, IsVpnServerRouteHealthReasonArgs

    Code string
    (String) A snake case string succinctly identifying the reason for this lifecycle reason.
    Message string
    (String) An explanation of the reason for this lifecycle reason.
    MoreInfo string
    (String) Link to documentation about the reason for this lifecycle reason.
    Code string
    (String) A snake case string succinctly identifying the reason for this lifecycle reason.
    Message string
    (String) An explanation of the reason for this lifecycle reason.
    MoreInfo string
    (String) Link to documentation about the reason for this lifecycle reason.
    code String
    (String) A snake case string succinctly identifying the reason for this lifecycle reason.
    message String
    (String) An explanation of the reason for this lifecycle reason.
    moreInfo String
    (String) Link to documentation about the reason for this lifecycle reason.
    code string
    (String) A snake case string succinctly identifying the reason for this lifecycle reason.
    message string
    (String) An explanation of the reason for this lifecycle reason.
    moreInfo string
    (String) Link to documentation about the reason for this lifecycle reason.
    code str
    (String) A snake case string succinctly identifying the reason for this lifecycle reason.
    message str
    (String) An explanation of the reason for this lifecycle reason.
    more_info str
    (String) Link to documentation about the reason for this lifecycle reason.
    code String
    (String) A snake case string succinctly identifying the reason for this lifecycle reason.
    message String
    (String) An explanation of the reason for this lifecycle reason.
    moreInfo String
    (String) Link to documentation about the reason for this lifecycle reason.

    IsVpnServerRouteLifecycleReason, IsVpnServerRouteLifecycleReasonArgs

    Code string
    (String) A snake case string succinctly identifying the reason for this lifecycle reason.
    Message string
    (String) An explanation of the reason for this lifecycle reason.
    MoreInfo string
    (String) Link to documentation about the reason for this lifecycle reason.
    Code string
    (String) A snake case string succinctly identifying the reason for this lifecycle reason.
    Message string
    (String) An explanation of the reason for this lifecycle reason.
    MoreInfo string
    (String) Link to documentation about the reason for this lifecycle reason.
    code String
    (String) A snake case string succinctly identifying the reason for this lifecycle reason.
    message String
    (String) An explanation of the reason for this lifecycle reason.
    moreInfo String
    (String) Link to documentation about the reason for this lifecycle reason.
    code string
    (String) A snake case string succinctly identifying the reason for this lifecycle reason.
    message string
    (String) An explanation of the reason for this lifecycle reason.
    moreInfo string
    (String) Link to documentation about the reason for this lifecycle reason.
    code str
    (String) A snake case string succinctly identifying the reason for this lifecycle reason.
    message str
    (String) An explanation of the reason for this lifecycle reason.
    more_info str
    (String) Link to documentation about the reason for this lifecycle reason.
    code String
    (String) A snake case string succinctly identifying the reason for this lifecycle reason.
    message String
    (String) An explanation of the reason for this lifecycle reason.
    moreInfo String
    (String) Link to documentation about the reason for this lifecycle reason.

    IsVpnServerRouteTimeouts, IsVpnServerRouteTimeoutsArgs

    Create string
    Delete string
    Update string
    Create string
    Delete string
    Update string
    create String
    delete String
    update String
    create string
    delete string
    update string
    create str
    delete str
    update str
    create String
    delete String
    update String

    Import

    You can import the ibm_is_vpn_server_route resource by using id.

    The id property can be formed from vpn_server, and vpn_route in the following format:

    • vpn_server: A string. The VPN server identifier.

    • vpn_route: A string. The VPN route identifier.

    r134-0b5b3bed-8c95-4ded-81bf-913bf8ec5fa9/r134-299ed4f0-b279-4db3-8dfe-eff69a9fb66a

    Syntax

    $ pulumi import ibm:index/isVpnServerRoute:IsVpnServerRoute is_vpn_server_route r134-0b5b3bed-8c95-4ded-81bf-913bf8ec5fa9/r134-299ed4f0-b279-4db3-8dfe-eff69a9fb66a

    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