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

ibm.getIsVpnGateways

Explore with Pulumi AI

ibm logo
ibm 1.77.1 published on Monday, Apr 14, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm

    Retrieve information of an existing VPN gateways. For more information, about IBM Cloud VPN gateways, see configuring ACLs and security groups for use with VPN.

    Note: VPC infrastructure services are a regional specific based endpoint, by default targets to us-south. Please make sure to target right region in the provider block as shown in the provider.tf file, if VPC service is created in region other than us-south.

    provider.tf

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

    import pulumi

    package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
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) {
    }
}

    {}

    Example Usage

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

const example = ibm.getIsVpnGateways({});

    import pulumi
import pulumi_ibm as ibm

example = ibm.get_is_vpn_gateways()

    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.GetIsVpnGateways(ctx, &ibm.GetIsVpnGatewaysArgs{}, 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.GetIsVpnGateways.Invoke();

});

    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.GetIsVpnGatewaysArgs;
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.getIsVpnGateways();

    }
}

    variables:
  example:
    fn::invoke:
      function: ibm:getIsVpnGateways
      arguments: {}

    Using getIsVpnGateways

    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 getIsVpnGateways(args: GetIsVpnGatewaysArgs, opts?: InvokeOptions): Promise<GetIsVpnGatewaysResult>
function getIsVpnGatewaysOutput(args: GetIsVpnGatewaysOutputArgs, opts?: InvokeOptions): Output<GetIsVpnGatewaysResult>
    def get_is_vpn_gateways(id: Optional[str] = None,
                        mode: Optional[str] = None,
                        resource_group: Optional[str] = None,
                        opts: Optional[InvokeOptions] = None) -> GetIsVpnGatewaysResult
def get_is_vpn_gateways_output(id: Optional[pulumi.Input[str]] = None,
                        mode: Optional[pulumi.Input[str]] = None,
                        resource_group: Optional[pulumi.Input[str]] = None,
                        opts: Optional[InvokeOptions] = None) -> Output[GetIsVpnGatewaysResult]
    func GetIsVpnGateways(ctx *Context, args *GetIsVpnGatewaysArgs, opts ...InvokeOption) (*GetIsVpnGatewaysResult, error)
func GetIsVpnGatewaysOutput(ctx *Context, args *GetIsVpnGatewaysOutputArgs, opts ...InvokeOption) GetIsVpnGatewaysResultOutput

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

    public static class GetIsVpnGateways 
{
    public static Task<GetIsVpnGatewaysResult> InvokeAsync(GetIsVpnGatewaysArgs args, InvokeOptions? opts = null)
    public static Output<GetIsVpnGatewaysResult> Invoke(GetIsVpnGatewaysInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetIsVpnGatewaysResult> getIsVpnGateways(GetIsVpnGatewaysArgs args, InvokeOptions options)
public static Output<GetIsVpnGatewaysResult> getIsVpnGateways(GetIsVpnGatewaysArgs args, InvokeOptions options)

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

    The following arguments are supported:

    Id string
    (String) - The unique identifier for this VPC.
    Mode string
    The mode of this VPN Gateway. Available options are policy and route.
    ResourceGroup string
    The ID of the Resource group this vpn gateway belongs to
    Id string
    (String) - The unique identifier for this VPC.
    Mode string
    The mode of this VPN Gateway. Available options are policy and route.
    ResourceGroup string
    The ID of the Resource group this vpn gateway belongs to
    id String
    (String) - The unique identifier for this VPC.
    mode String
    The mode of this VPN Gateway. Available options are policy and route.
    resourceGroup String
    The ID of the Resource group this vpn gateway belongs to
    id string
    (String) - The unique identifier for this VPC.
    mode string
    The mode of this VPN Gateway. Available options are policy and route.
    resourceGroup string
    The ID of the Resource group this vpn gateway belongs to
    id str
    (String) - The unique identifier for this VPC.
    mode str
    The mode of this VPN Gateway. Available options are policy and route.
    resource_group str
    The ID of the Resource group this vpn gateway belongs to
    id String
    (String) - The unique identifier for this VPC.
    mode String
    The mode of this VPN Gateway. Available options are policy and route.
    resourceGroup String
    The ID of the Resource group this vpn gateway belongs to

    getIsVpnGateways Result

    The following output properties are available:

    Id string
    (String) - The unique identifier for this VPC.
    VpnGateways List<GetIsVpnGatewaysVpnGateway>
    (List) Collection of VPN Gateways.
    Mode string
    (String) The VPN gateway mode, supported values are policy and route.
    ResourceGroup string
    (String) The resource group ID.
    Id string
    (String) - The unique identifier for this VPC.
    VpnGateways []GetIsVpnGatewaysVpnGateway
    (List) Collection of VPN Gateways.
    Mode string
    (String) The VPN gateway mode, supported values are policy and route.
    ResourceGroup string
    (String) The resource group ID.
    id String
    (String) - The unique identifier for this VPC.
    vpnGateways List<GetIsVpnGatewaysVpnGateway>
    (List) Collection of VPN Gateways.
    mode String
    (String) The VPN gateway mode, supported values are policy and route.
    resourceGroup String
    (String) The resource group ID.
    id string
    (String) - The unique identifier for this VPC.
    vpnGateways GetIsVpnGatewaysVpnGateway[]
    (List) Collection of VPN Gateways.
    mode string
    (String) The VPN gateway mode, supported values are policy and route.
    resourceGroup string
    (String) The resource group ID.
    id str
    (String) - The unique identifier for this VPC.
    vpn_gateways Sequence[GetIsVpnGatewaysVpnGateway]
    (List) Collection of VPN Gateways.
    mode str
    (String) The VPN gateway mode, supported values are policy and route.
    resource_group str
    (String) The resource group ID.
    id String
    (String) - The unique identifier for this VPC.
    vpnGateways List<Property Map>
    (List) Collection of VPN Gateways.
    mode String
    (String) The VPN gateway mode, supported values are policy and route.
    resourceGroup String
    (String) The resource group ID.

    Supporting Types

    GetIsVpnGatewaysVpnGateway

    AccessTags List<string>
    (List) Access management tags associated for the vpn gateway.
    CreatedAt string
    (Timestamp) The date and time the VPN gateway was created.
    Crn string
    (String) The CRN for this VPC.
    HealthReasons List<GetIsVpnGatewaysVpnGatewayHealthReason>
    (List) The reasons for the current health_state (if any).
    HealthState string
    (String) The health of this resource.
    LifecycleReasons List<GetIsVpnGatewaysVpnGatewayLifecycleReason>
    (List) The reasons for the current lifecycle_reasons (if any).
    LifecycleState string
    (String) The lifecycle state of the VPN gateway.
    Members List<GetIsVpnGatewaysVpnGatewayMember>
    (List) Collection of VPN gateway members.
    Mode string
    The mode of this VPN Gateway. Available options are policy and route.
    Name string
    (String) - The unique user-defined name for this VPC.
    ResourceGroup string
    The ID of the Resource group this vpn gateway belongs to
    ResourceType string
    (String) The resource type, supported value is vpn_gateway.
    Status string
    Subnet string
    (String) The VPN gateway subnet information.
    Tags List<string>
    (Optional, Array of Strings) A list of tags associated with the instance.
    Vpcs List<GetIsVpnGatewaysVpnGatewayVpc>
    (String) The VPC this VPN server resides in.
    AccessTags []string
    (List) Access management tags associated for the vpn gateway.
    CreatedAt string
    (Timestamp) The date and time the VPN gateway was created.
    Crn string
    (String) The CRN for this VPC.
    HealthReasons []GetIsVpnGatewaysVpnGatewayHealthReason
    (List) The reasons for the current health_state (if any).
    HealthState string
    (String) The health of this resource.
    LifecycleReasons []GetIsVpnGatewaysVpnGatewayLifecycleReason
    (List) The reasons for the current lifecycle_reasons (if any).
    LifecycleState string
    (String) The lifecycle state of the VPN gateway.
    Members []GetIsVpnGatewaysVpnGatewayMember
    (List) Collection of VPN gateway members.
    Mode string
    The mode of this VPN Gateway. Available options are policy and route.
    Name string
    (String) - The unique user-defined name for this VPC.
    ResourceGroup string
    The ID of the Resource group this vpn gateway belongs to
    ResourceType string
    (String) The resource type, supported value is vpn_gateway.
    Status string
    Subnet string
    (String) The VPN gateway subnet information.
    Tags []string
    (Optional, Array of Strings) A list of tags associated with the instance.
    Vpcs []GetIsVpnGatewaysVpnGatewayVpc
    (String) The VPC this VPN server resides in.
    accessTags List<String>
    (List) Access management tags associated for the vpn gateway.
    createdAt String
    (Timestamp) The date and time the VPN gateway was created.
    crn String
    (String) The CRN for this VPC.
    healthReasons List<GetIsVpnGatewaysVpnGatewayHealthReason>
    (List) The reasons for the current health_state (if any).
    healthState String
    (String) The health of this resource.
    lifecycleReasons List<GetIsVpnGatewaysVpnGatewayLifecycleReason>
    (List) The reasons for the current lifecycle_reasons (if any).
    lifecycleState String
    (String) The lifecycle state of the VPN gateway.
    members List<GetIsVpnGatewaysVpnGatewayMember>
    (List) Collection of VPN gateway members.
    mode String
    The mode of this VPN Gateway. Available options are policy and route.
    name String
    (String) - The unique user-defined name for this VPC.
    resourceGroup String
    The ID of the Resource group this vpn gateway belongs to
    resourceType String
    (String) The resource type, supported value is vpn_gateway.
    status String
    subnet String
    (String) The VPN gateway subnet information.
    tags List<String>
    (Optional, Array of Strings) A list of tags associated with the instance.
    vpcs List<GetIsVpnGatewaysVpnGatewayVpc>
    (String) The VPC this VPN server resides in.
    accessTags string[]
    (List) Access management tags associated for the vpn gateway.
    createdAt string
    (Timestamp) The date and time the VPN gateway was created.
    crn string
    (String) The CRN for this VPC.
    healthReasons GetIsVpnGatewaysVpnGatewayHealthReason[]
    (List) The reasons for the current health_state (if any).
    healthState string
    (String) The health of this resource.
    lifecycleReasons GetIsVpnGatewaysVpnGatewayLifecycleReason[]
    (List) The reasons for the current lifecycle_reasons (if any).
    lifecycleState string
    (String) The lifecycle state of the VPN gateway.
    members GetIsVpnGatewaysVpnGatewayMember[]
    (List) Collection of VPN gateway members.
    mode string
    The mode of this VPN Gateway. Available options are policy and route.
    name string
    (String) - The unique user-defined name for this VPC.
    resourceGroup string
    The ID of the Resource group this vpn gateway belongs to
    resourceType string
    (String) The resource type, supported value is vpn_gateway.
    status string
    subnet string
    (String) The VPN gateway subnet information.
    tags string[]
    (Optional, Array of Strings) A list of tags associated with the instance.
    vpcs GetIsVpnGatewaysVpnGatewayVpc[]
    (String) The VPC this VPN server resides in.
    access_tags Sequence[str]
    (List) Access management tags associated for the vpn gateway.
    created_at str
    (Timestamp) The date and time the VPN gateway was created.
    crn str
    (String) The CRN for this VPC.
    health_reasons Sequence[GetIsVpnGatewaysVpnGatewayHealthReason]
    (List) The reasons for the current health_state (if any).
    health_state str
    (String) The health of this resource.
    lifecycle_reasons Sequence[GetIsVpnGatewaysVpnGatewayLifecycleReason]
    (List) The reasons for the current lifecycle_reasons (if any).
    lifecycle_state str
    (String) The lifecycle state of the VPN gateway.
    members Sequence[GetIsVpnGatewaysVpnGatewayMember]
    (List) Collection of VPN gateway members.
    mode str
    The mode of this VPN Gateway. Available options are policy and route.
    name str
    (String) - The unique user-defined name for this VPC.
    resource_group str
    The ID of the Resource group this vpn gateway belongs to
    resource_type str
    (String) The resource type, supported value is vpn_gateway.
    status str
    subnet str
    (String) The VPN gateway subnet information.
    tags Sequence[str]
    (Optional, Array of Strings) A list of tags associated with the instance.
    vpcs Sequence[GetIsVpnGatewaysVpnGatewayVpc]
    (String) The VPC this VPN server resides in.
    accessTags List<String>
    (List) Access management tags associated for the vpn gateway.
    createdAt String
    (Timestamp) The date and time the VPN gateway was created.
    crn String
    (String) The CRN for this VPC.
    healthReasons List<Property Map>
    (List) The reasons for the current health_state (if any).
    healthState String
    (String) The health of this resource.
    lifecycleReasons List<Property Map>
    (List) The reasons for the current lifecycle_reasons (if any).
    lifecycleState String
    (String) The lifecycle state of the VPN gateway.
    members List<Property Map>
    (List) Collection of VPN gateway members.
    mode String
    The mode of this VPN Gateway. Available options are policy and route.
    name String
    (String) - The unique user-defined name for this VPC.
    resourceGroup String
    The ID of the Resource group this vpn gateway belongs to
    resourceType String
    (String) The resource type, supported value is vpn_gateway.
    status String
    subnet String
    (String) The VPN gateway subnet information.
    tags List<String>
    (Optional, Array of Strings) A list of tags associated with the instance.
    vpcs List<Property Map>
    (String) The VPC this VPN server resides in.

    GetIsVpnGatewaysVpnGatewayHealthReason

    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 deleted resources.
    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 deleted resources.
    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 deleted resources.
    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 deleted resources.
    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 deleted resources.
    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 deleted resources.

    GetIsVpnGatewaysVpnGatewayLifecycleReason

    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 deleted resources.
    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 deleted resources.
    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 deleted resources.
    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 deleted resources.
    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 deleted resources.
    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 deleted resources.

    GetIsVpnGatewaysVpnGatewayMember

    Address string
    (String) The IP address. If the address has not yet been selected, the value will be 0.0.0.0. This property may add support for IPv6 addresses in the future. When processing a value in this property, verify that the address is in an expected format. If it is not, log an error. Optionally halt processing and surface the error, or bypass the resource on which the unexpected IP address format was encountered.
    PrivateAddress string
    (String) The private IP address assigned to the VPN gateway member. Same as private_ip.0.address.
    Role string
    (String) The high availability role assigned to the VPN gateway member.
    Status string
    Address string
    (String) The IP address. If the address has not yet been selected, the value will be 0.0.0.0. This property may add support for IPv6 addresses in the future. When processing a value in this property, verify that the address is in an expected format. If it is not, log an error. Optionally halt processing and surface the error, or bypass the resource on which the unexpected IP address format was encountered.
    PrivateAddress string
    (String) The private IP address assigned to the VPN gateway member. Same as private_ip.0.address.
    Role string
    (String) The high availability role assigned to the VPN gateway member.
    Status string
    address String
    (String) The IP address. If the address has not yet been selected, the value will be 0.0.0.0. This property may add support for IPv6 addresses in the future. When processing a value in this property, verify that the address is in an expected format. If it is not, log an error. Optionally halt processing and surface the error, or bypass the resource on which the unexpected IP address format was encountered.
    privateAddress String
    (String) The private IP address assigned to the VPN gateway member. Same as private_ip.0.address.
    role String
    (String) The high availability role assigned to the VPN gateway member.
    status String
    address string
    (String) The IP address. If the address has not yet been selected, the value will be 0.0.0.0. This property may add support for IPv6 addresses in the future. When processing a value in this property, verify that the address is in an expected format. If it is not, log an error. Optionally halt processing and surface the error, or bypass the resource on which the unexpected IP address format was encountered.
    privateAddress string
    (String) The private IP address assigned to the VPN gateway member. Same as private_ip.0.address.
    role string
    (String) The high availability role assigned to the VPN gateway member.
    status string
    address str
    (String) The IP address. If the address has not yet been selected, the value will be 0.0.0.0. This property may add support for IPv6 addresses in the future. When processing a value in this property, verify that the address is in an expected format. If it is not, log an error. Optionally halt processing and surface the error, or bypass the resource on which the unexpected IP address format was encountered.
    private_address str
    (String) The private IP address assigned to the VPN gateway member. Same as private_ip.0.address.
    role str
    (String) The high availability role assigned to the VPN gateway member.
    status str
    address String
    (String) The IP address. If the address has not yet been selected, the value will be 0.0.0.0. This property may add support for IPv6 addresses in the future. When processing a value in this property, verify that the address is in an expected format. If it is not, log an error. Optionally halt processing and surface the error, or bypass the resource on which the unexpected IP address format was encountered.
    privateAddress String
    (String) The private IP address assigned to the VPN gateway member. Same as private_ip.0.address.
    role String
    (String) The high availability role assigned to the VPN gateway member.
    status String

    GetIsVpnGatewaysVpnGatewayVpc

    Crn string
    (String) The CRN for this VPC.
    Deleteds List<GetIsVpnGatewaysVpnGatewayVpcDeleted>
    (List) If present, this property indicates the referenced resource has been deleted and provides some supplementary information. Nested scheme for deleted:
    Href string
    (String) - The URL for this VPC
    Id string
    (String) - The unique identifier for this VPC.
    Name string
    (String) - The unique user-defined name for this VPC.
    Crn string
    (String) The CRN for this VPC.
    Deleteds []GetIsVpnGatewaysVpnGatewayVpcDeleted
    (List) If present, this property indicates the referenced resource has been deleted and provides some supplementary information. Nested scheme for deleted:
    Href string
    (String) - The URL for this VPC
    Id string
    (String) - The unique identifier for this VPC.
    Name string
    (String) - The unique user-defined name for this VPC.
    crn String
    (String) The CRN for this VPC.
    deleteds List<GetIsVpnGatewaysVpnGatewayVpcDeleted>
    (List) If present, this property indicates the referenced resource has been deleted and provides some supplementary information. Nested scheme for deleted:
    href String
    (String) - The URL for this VPC
    id String
    (String) - The unique identifier for this VPC.
    name String
    (String) - The unique user-defined name for this VPC.
    crn string
    (String) The CRN for this VPC.
    deleteds GetIsVpnGatewaysVpnGatewayVpcDeleted[]
    (List) If present, this property indicates the referenced resource has been deleted and provides some supplementary information. Nested scheme for deleted:
    href string
    (String) - The URL for this VPC
    id string
    (String) - The unique identifier for this VPC.
    name string
    (String) - The unique user-defined name for this VPC.
    crn str
    (String) The CRN for this VPC.
    deleteds Sequence[GetIsVpnGatewaysVpnGatewayVpcDeleted]
    (List) If present, this property indicates the referenced resource has been deleted and provides some supplementary information. Nested scheme for deleted:
    href str
    (String) - The URL for this VPC
    id str
    (String) - The unique identifier for this VPC.
    name str
    (String) - The unique user-defined name for this VPC.
    crn String
    (String) The CRN for this VPC.
    deleteds List<Property Map>
    (List) If present, this property indicates the referenced resource has been deleted and provides some supplementary information. Nested scheme for deleted:
    href String
    (String) - The URL for this VPC
    id String
    (String) - The unique identifier for this VPC.
    name String
    (String) - The unique user-defined name for this VPC.

    GetIsVpnGatewaysVpnGatewayVpcDeleted

    MoreInfo string
    (String) Link to documentation about deleted resources.
    MoreInfo string
    (String) Link to documentation about deleted resources.
    moreInfo String
    (String) Link to documentation about deleted resources.
    moreInfo string
    (String) Link to documentation about deleted resources.
    more_info str
    (String) Link to documentation about deleted resources.
    moreInfo String
    (String) Link to documentation about deleted 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.77.1 published on Monday, Apr 14, 2025 by ibm-cloud
    ibm-cloud/terraform-provider-ibm