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

ibm.getIsVpnServerRoutes

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 VPNServerRouteCollection. 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.getIsVpnServerRoutes({
    vpnServer: ibm_is_vpn_server.example.id,
});
Copy
import pulumi
import pulumi_ibm as ibm

example = ibm.get_is_vpn_server_routes(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.GetIsVpnServerRoutes(ctx, &ibm.GetIsVpnServerRoutesArgs{
			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.GetIsVpnServerRoutes.Invoke(new()
    {
        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.GetIsVpnServerRoutesArgs;
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.getIsVpnServerRoutes(GetIsVpnServerRoutesArgs.builder()
            .vpnServer(ibm_is_vpn_server.example().id())
            .build());

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

Using getIsVpnServerRoutes

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 getIsVpnServerRoutes(args: GetIsVpnServerRoutesArgs, opts?: InvokeOptions): Promise<GetIsVpnServerRoutesResult>
function getIsVpnServerRoutesOutput(args: GetIsVpnServerRoutesOutputArgs, opts?: InvokeOptions): Output<GetIsVpnServerRoutesResult>
Copy
def get_is_vpn_server_routes(id: Optional[str] = None,
                             vpn_server: Optional[str] = None,
                             opts: Optional[InvokeOptions] = None) -> GetIsVpnServerRoutesResult
def get_is_vpn_server_routes_output(id: Optional[pulumi.Input[str]] = None,
                             vpn_server: Optional[pulumi.Input[str]] = None,
                             opts: Optional[InvokeOptions] = None) -> Output[GetIsVpnServerRoutesResult]
Copy
func GetIsVpnServerRoutes(ctx *Context, args *GetIsVpnServerRoutesArgs, opts ...InvokeOption) (*GetIsVpnServerRoutesResult, error)
func GetIsVpnServerRoutesOutput(ctx *Context, args *GetIsVpnServerRoutesOutputArgs, opts ...InvokeOption) GetIsVpnServerRoutesResultOutput
Copy

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

public static class GetIsVpnServerRoutes 
{
    public static Task<GetIsVpnServerRoutesResult> InvokeAsync(GetIsVpnServerRoutesArgs args, InvokeOptions? opts = null)
    public static Output<GetIsVpnServerRoutesResult> Invoke(GetIsVpnServerRoutesInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetIsVpnServerRoutesResult> getIsVpnServerRoutes(GetIsVpnServerRoutesArgs args, InvokeOptions options)
public static Output<GetIsVpnServerRoutesResult> getIsVpnServerRoutes(GetIsVpnServerRoutesArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: ibm:index/getIsVpnServerRoutes:getIsVpnServerRoutes
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

VpnServer This property is required. string
The VPN server identifier.
Id string
(String) The unique identifier for this VPN route.
VpnServer This property is required. string
The VPN server identifier.
Id string
(String) The unique identifier for this VPN route.
vpnServer This property is required. String
The VPN server identifier.
id String
(String) The unique identifier for this VPN route.
vpnServer This property is required. string
The VPN server identifier.
id string
(String) The unique identifier for this VPN route.
vpn_server This property is required. str
The VPN server identifier.
id str
(String) The unique identifier for this VPN route.
vpnServer This property is required. String
The VPN server identifier.
id String
(String) The unique identifier for this VPN route.

getIsVpnServerRoutes Result

The following output properties are available:

Id string
(String) The unique identifier for this VPN route.
Routes List<GetIsVpnServerRoutesRoute>
(List) Collection of VPN routes. Nested scheme for routes:
VpnServer string
Id string
(String) The unique identifier for this VPN route.
Routes []GetIsVpnServerRoutesRoute
(List) Collection of VPN routes. Nested scheme for routes:
VpnServer string
id String
(String) The unique identifier for this VPN route.
routes List<GetIsVpnServerRoutesRoute>
(List) Collection of VPN routes. Nested scheme for routes:
vpnServer String
id string
(String) The unique identifier for this VPN route.
routes GetIsVpnServerRoutesRoute[]
(List) Collection of VPN routes. Nested scheme for routes:
vpnServer string
id str
(String) The unique identifier for this VPN route.
routes Sequence[GetIsVpnServerRoutesRoute]
(List) Collection of VPN routes. Nested scheme for routes:
vpn_server str
id String
(String) The unique identifier for this VPN route.
routes List<Property Map>
(List) Collection of VPN routes. Nested scheme for routes:
vpnServer String

Supporting Types

GetIsVpnServerRoutesRoute

Action This property is required. 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 This property is required. string
(String) The date and time that the VPN route was created.
Destination This property is required. 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 This property is required. List<GetIsVpnServerRoutesRouteHealthReason>
(List) The reasons for the current health_state (if any).
HealthState This property is required. string
(String) The health of this resource.
Href This property is required. string
(String) The URL for this VPN route.
Id This property is required. string
(String) The unique identifier for this VPN route.
LifecycleReasons This property is required. List<GetIsVpnServerRoutesRouteLifecycleReason>
(List) The reasons for the current lifecycle_reasons (if any).
LifecycleState This property is required. string
(String) The lifecycle state of the VPN route.
Name This property is required. string
(String) The user-defined name for this VPN route.
ResourceType This property is required. string
(String) The resource type.
Action This property is required. 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 This property is required. string
(String) The date and time that the VPN route was created.
Destination This property is required. 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 This property is required. []GetIsVpnServerRoutesRouteHealthReason
(List) The reasons for the current health_state (if any).
HealthState This property is required. string
(String) The health of this resource.
Href This property is required. string
(String) The URL for this VPN route.
Id This property is required. string
(String) The unique identifier for this VPN route.
LifecycleReasons This property is required. []GetIsVpnServerRoutesRouteLifecycleReason
(List) The reasons for the current lifecycle_reasons (if any).
LifecycleState This property is required. string
(String) The lifecycle state of the VPN route.
Name This property is required. string
(String) The user-defined name for this VPN route.
ResourceType This property is required. string
(String) The resource type.
action This property is required. 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 This property is required. String
(String) The date and time that the VPN route was created.
destination This property is required. 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 This property is required. List<GetIsVpnServerRoutesRouteHealthReason>
(List) The reasons for the current health_state (if any).
healthState This property is required. String
(String) The health of this resource.
href This property is required. String
(String) The URL for this VPN route.
id This property is required. String
(String) The unique identifier for this VPN route.
lifecycleReasons This property is required. List<GetIsVpnServerRoutesRouteLifecycleReason>
(List) The reasons for the current lifecycle_reasons (if any).
lifecycleState This property is required. String
(String) The lifecycle state of the VPN route.
name This property is required. String
(String) The user-defined name for this VPN route.
resourceType This property is required. String
(String) The resource type.
action This property is required. 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 This property is required. string
(String) The date and time that the VPN route was created.
destination This property is required. 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 This property is required. GetIsVpnServerRoutesRouteHealthReason[]
(List) The reasons for the current health_state (if any).
healthState This property is required. string
(String) The health of this resource.
href This property is required. string
(String) The URL for this VPN route.
id This property is required. string
(String) The unique identifier for this VPN route.
lifecycleReasons This property is required. GetIsVpnServerRoutesRouteLifecycleReason[]
(List) The reasons for the current lifecycle_reasons (if any).
lifecycleState This property is required. string
(String) The lifecycle state of the VPN route.
name This property is required. string
(String) The user-defined name for this VPN route.
resourceType This property is required. string
(String) The resource type.
action This property is required. 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 This property is required. str
(String) The date and time that the VPN route was created.
destination This property is required. 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 This property is required. Sequence[GetIsVpnServerRoutesRouteHealthReason]
(List) The reasons for the current health_state (if any).
health_state This property is required. str
(String) The health of this resource.
href This property is required. str
(String) The URL for this VPN route.
id This property is required. str
(String) The unique identifier for this VPN route.
lifecycle_reasons This property is required. Sequence[GetIsVpnServerRoutesRouteLifecycleReason]
(List) The reasons for the current lifecycle_reasons (if any).
lifecycle_state This property is required. str
(String) The lifecycle state of the VPN route.
name This property is required. str
(String) The user-defined name for this VPN route.
resource_type This property is required. str
(String) The resource type.
action This property is required. 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 This property is required. String
(String) The date and time that the VPN route was created.
destination This property is required. 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 This property is required. List<Property Map>
(List) The reasons for the current health_state (if any).
healthState This property is required. String
(String) The health of this resource.
href This property is required. String
(String) The URL for this VPN route.
id This property is required. String
(String) The unique identifier for this VPN route.
lifecycleReasons This property is required. List<Property Map>
(List) The reasons for the current lifecycle_reasons (if any).
lifecycleState This property is required. String
(String) The lifecycle state of the VPN route.
name This property is required. String
(String) The user-defined name for this VPN route.
resourceType This property is required. String
(String) The resource type.

GetIsVpnServerRoutesRouteHealthReason

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

GetIsVpnServerRoutesRouteLifecycleReason

Code This property is required. string
(String) A snake case string succinctly identifying the reason for this lifecycle reason.
Message This property is required. string
(String) An explanation of the reason for this lifecycle reason.
MoreInfo This property is required. string
(String) Link to documentation about the reason for this lifecycle reason.
Code This property is required. string
(String) A snake case string succinctly identifying the reason for this lifecycle reason.
Message This property is required. string
(String) An explanation of the reason for this lifecycle reason.
MoreInfo This property is required. string
(String) Link to documentation about the reason for this lifecycle reason.
code This property is required. String
(String) A snake case string succinctly identifying the reason for this lifecycle reason.
message This property is required. String
(String) An explanation of the reason for this lifecycle reason.
moreInfo This property is required. String
(String) Link to documentation about the reason for this lifecycle reason.
code This property is required. string
(String) A snake case string succinctly identifying the reason for this lifecycle reason.
message This property is required. string
(String) An explanation of the reason for this lifecycle reason.
moreInfo This property is required. string
(String) Link to documentation about the reason for this lifecycle reason.
code This property is required. str
(String) A snake case string succinctly identifying the reason for this lifecycle reason.
message This property is required. str
(String) An explanation of the reason for this lifecycle reason.
more_info This property is required. str
(String) Link to documentation about the reason for this lifecycle reason.
code This property is required. String
(String) A snake case string succinctly identifying the reason for this lifecycle reason.
message This property is required. String
(String) An explanation of the reason for this lifecycle reason.
moreInfo This property is required. 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 1.77.1 published on Monday, Apr 14, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm