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

ibm.getIsVpnServerRoute

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 read-only data source for VPNServerRoute. 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 = ibm.getIsVpnServerRoute({
    id: ibm_is_vpn_server_route.example.vpn_route,
    vpnServer: ibm_is_vpn_server.example.id,
});

    import pulumi
import pulumi_ibm as ibm

example = ibm.get_is_vpn_server_route(id=ibm_is_vpn_server_route["example"]["vpn_route"],
    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.LookupIsVpnServerRoute(ctx, &ibm.LookupIsVpnServerRouteArgs{
			Id:        pulumi.StringRef(ibm_is_vpn_server_route.Example.Vpn_route),
			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.GetIsVpnServerRoute.Invoke(new()
    {
        Id = ibm_is_vpn_server_route.Example.Vpn_route,
        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.GetIsVpnServerRouteArgs;
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.getIsVpnServerRoute(GetIsVpnServerRouteArgs.builder()
            .id(ibm_is_vpn_server_route.example().vpn_route())
            .vpnServer(ibm_is_vpn_server.example().id())
            .build());

    }
}

    variables:
  example:
    fn::invoke:
      function: ibm:getIsVpnServerRoute
      arguments:
        id: ${ibm_is_vpn_server_route.example.vpn_route}
        vpnServer: ${ibm_is_vpn_server.example.id}

    Using getIsVpnServerRoute

    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 getIsVpnServerRoute(args: GetIsVpnServerRouteArgs, opts?: InvokeOptions): Promise<GetIsVpnServerRouteResult>
function getIsVpnServerRouteOutput(args: GetIsVpnServerRouteOutputArgs, opts?: InvokeOptions): Output<GetIsVpnServerRouteResult>
    def get_is_vpn_server_route(id: Optional[str] = None,
                            identifier: Optional[str] = None,
                            name: Optional[str] = None,
                            vpn_server: Optional[str] = None,
                            opts: Optional[InvokeOptions] = None) -> GetIsVpnServerRouteResult
def get_is_vpn_server_route_output(id: Optional[pulumi.Input[str]] = None,
                            identifier: Optional[pulumi.Input[str]] = None,
                            name: Optional[pulumi.Input[str]] = None,
                            vpn_server: Optional[pulumi.Input[str]] = None,
                            opts: Optional[InvokeOptions] = None) -> Output[GetIsVpnServerRouteResult]
    func LookupIsVpnServerRoute(ctx *Context, args *LookupIsVpnServerRouteArgs, opts ...InvokeOption) (*LookupIsVpnServerRouteResult, error)
func LookupIsVpnServerRouteOutput(ctx *Context, args *LookupIsVpnServerRouteOutputArgs, opts ...InvokeOption) LookupIsVpnServerRouteResultOutput

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

    public static class GetIsVpnServerRoute 
{
    public static Task<GetIsVpnServerRouteResult> InvokeAsync(GetIsVpnServerRouteArgs args, InvokeOptions? opts = null)
    public static Output<GetIsVpnServerRouteResult> Invoke(GetIsVpnServerRouteInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetIsVpnServerRouteResult> getIsVpnServerRoute(GetIsVpnServerRouteArgs args, InvokeOptions options)
public static Output<GetIsVpnServerRouteResult> getIsVpnServerRoute(GetIsVpnServerRouteArgs args, InvokeOptions options)

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

    The following arguments are supported:

    VpnServer string

    The VPN server identifier.

    NOTE: identifier and name are mutually exclusive.

    Id string
    The unique identifier of the VPNServerRoute and it has format VPNServerID/VPNServerRouteID.
    Identifier string
    The VPN route identifier.
    Name string
    The VPN route identifier.
    VpnServer string

    The VPN server identifier.

    NOTE: identifier and name are mutually exclusive.

    Id string
    The unique identifier of the VPNServerRoute and it has format VPNServerID/VPNServerRouteID.
    Identifier string
    The VPN route identifier.
    Name string
    The VPN route identifier.
    vpnServer String

    The VPN server identifier.

    NOTE: identifier and name are mutually exclusive.

    id String
    The unique identifier of the VPNServerRoute and it has format VPNServerID/VPNServerRouteID.
    identifier String
    The VPN route identifier.
    name String
    The VPN route identifier.
    vpnServer string

    The VPN server identifier.

    NOTE: identifier and name are mutually exclusive.

    id string
    The unique identifier of the VPNServerRoute and it has format VPNServerID/VPNServerRouteID.
    identifier string
    The VPN route identifier.
    name string
    The VPN route identifier.
    vpn_server str

    The VPN server identifier.

    NOTE: identifier and name are mutually exclusive.

    id str
    The unique identifier of the VPNServerRoute and it has format VPNServerID/VPNServerRouteID.
    identifier str
    The VPN route identifier.
    name str
    The VPN route identifier.
    vpnServer String

    The VPN server identifier.

    NOTE: identifier and name are mutually exclusive.

    id String
    The unique identifier of the VPNServerRoute and it has format VPNServerID/VPNServerRouteID.
    identifier String
    The VPN route identifier.
    name String
    The VPN route identifier.

    getIsVpnServerRoute Result

    The following output properties are available:

    Action string
    (String) The action to perform with a packet matching the VPN route:- translate: translate the source IP address to one of the private IP addresses of the VPN server.- deliver: deliver the packet into the VPC.- drop: drop the packet The enumerated values for this property are expected to expand in the future. When processing this property, check for and log unknown values. Optionally halt processing and surface the error, or bypass the VPN route on which the unexpected property value was encountered.
    CreatedAt string
    (String) The date and time that the VPN route was created.
    Destination string
    (String) The destination for this VPN route in the VPN server. If an incoming packet does not match any destination, it will be dropped.
    HealthReasons List<GetIsVpnServerRouteHealthReason>
    (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 unique identifier of the VPNServerRoute and it has format VPNServerID/VPNServerRouteID.
    LifecycleReasons List<GetIsVpnServerRouteLifecycleReason>
    (List) The reasons for the current lifecycle_reasons (if any).
    LifecycleState string
    (String) The lifecycle state of the VPN route.
    Name string
    (String) The user-defined name for this VPN route.
    ResourceType string
    (String) The resource type.
    VpnServer string
    Identifier string
    Action string
    (String) The action to perform with a packet matching the VPN route:- translate: translate the source IP address to one of the private IP addresses of the VPN server.- deliver: deliver the packet into the VPC.- drop: drop the packet The enumerated values for this property are expected to expand in the future. When processing this property, check for and log unknown values. Optionally halt processing and surface the error, or bypass the VPN route on which the unexpected property value was encountered.
    CreatedAt string
    (String) The date and time that the VPN route was created.
    Destination string
    (String) The destination for this VPN route in the VPN server. If an incoming packet does not match any destination, it will be dropped.
    HealthReasons []GetIsVpnServerRouteHealthReason
    (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 unique identifier of the VPNServerRoute and it has format VPNServerID/VPNServerRouteID.
    LifecycleReasons []GetIsVpnServerRouteLifecycleReason
    (List) The reasons for the current lifecycle_reasons (if any).
    LifecycleState string
    (String) The lifecycle state of the VPN route.
    Name string
    (String) The user-defined name for this VPN route.
    ResourceType string
    (String) The resource type.
    VpnServer string
    Identifier string
    action String
    (String) The action to perform with a packet matching the VPN route:- translate: translate the source IP address to one of the private IP addresses of the VPN server.- deliver: deliver the packet into the VPC.- drop: drop the packet The enumerated values for this property are expected to expand in the future. When processing this property, check for and log unknown values. Optionally halt processing and surface the error, or bypass the VPN route on which the unexpected property value was encountered.
    createdAt String
    (String) The date and time that the VPN route was created.
    destination String
    (String) The destination for this VPN route in the VPN server. If an incoming packet does not match any destination, it will be dropped.
    healthReasons List<GetIsVpnServerRouteHealthReason>
    (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 unique identifier of the VPNServerRoute and it has format VPNServerID/VPNServerRouteID.
    lifecycleReasons List<GetIsVpnServerRouteLifecycleReason>
    (List) The reasons for the current lifecycle_reasons (if any).
    lifecycleState String
    (String) The lifecycle state of the VPN route.
    name String
    (String) The user-defined name for this VPN route.
    resourceType String
    (String) The resource type.
    vpnServer String
    identifier String
    action string
    (String) The action to perform with a packet matching the VPN route:- translate: translate the source IP address to one of the private IP addresses of the VPN server.- deliver: deliver the packet into the VPC.- drop: drop the packet The enumerated values for this property are expected to expand in the future. When processing this property, check for and log unknown values. Optionally halt processing and surface the error, or bypass the VPN route on which the unexpected property value was encountered.
    createdAt string
    (String) The date and time that the VPN route was created.
    destination string
    (String) The destination for this VPN route in the VPN server. If an incoming packet does not match any destination, it will be dropped.
    healthReasons GetIsVpnServerRouteHealthReason[]
    (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 unique identifier of the VPNServerRoute and it has format VPNServerID/VPNServerRouteID.
    lifecycleReasons GetIsVpnServerRouteLifecycleReason[]
    (List) The reasons for the current lifecycle_reasons (if any).
    lifecycleState string
    (String) The lifecycle state of the VPN route.
    name string
    (String) The user-defined name for this VPN route.
    resourceType string
    (String) The resource type.
    vpnServer string
    identifier string
    action str
    (String) The action to perform with a packet matching the VPN route:- translate: translate the source IP address to one of the private IP addresses of the VPN server.- deliver: deliver the packet into the VPC.- drop: drop the packet The enumerated values for this property are expected to expand in the future. When processing this property, check for and log unknown values. Optionally halt processing and surface the error, or bypass the VPN route on which the unexpected property value was encountered.
    created_at str
    (String) The date and time that the VPN route was created.
    destination str
    (String) The destination for this VPN route in the VPN server. If an incoming packet does not match any destination, it will be dropped.
    health_reasons Sequence[GetIsVpnServerRouteHealthReason]
    (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 unique identifier of the VPNServerRoute and it has format VPNServerID/VPNServerRouteID.
    lifecycle_reasons Sequence[GetIsVpnServerRouteLifecycleReason]
    (List) The reasons for the current lifecycle_reasons (if any).
    lifecycle_state str
    (String) The lifecycle state of the VPN route.
    name str
    (String) The user-defined name for this VPN route.
    resource_type str
    (String) The resource type.
    vpn_server str
    identifier str
    action String
    (String) The action to perform with a packet matching the VPN route:- translate: translate the source IP address to one of the private IP addresses of the VPN server.- deliver: deliver the packet into the VPC.- drop: drop the packet The enumerated values for this property are expected to expand in the future. When processing this property, check for and log unknown values. Optionally halt processing and surface the error, or bypass the VPN route on which the unexpected property value was encountered.
    createdAt String
    (String) The date and time that the VPN route was created.
    destination String
    (String) The destination for this VPN route in 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.
    id 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
    (String) The user-defined name for this VPN route.
    resourceType String
    (String) The resource type.
    vpnServer String
    identifier String

    Supporting Types

    GetIsVpnServerRouteHealthReason

    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.

    GetIsVpnServerRouteLifecycleReason

    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.

    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