Zscaler Internet Access v0.0.6, Apr 10 24

Zscaler Internet Access v0.0.6 published on Wednesday, Apr 10, 2024 by Zscaler

zia.getTrafficForwardingVPNCredentials

Explore with Pulumi AI

Zscaler Internet Access v0.0.6 published on Wednesday, Apr 10, 2024 by Zscaler

Use the zia_traffic_forwarding_vpn_credentials data source to get information about VPN credentials that can be associated to locations. VPN is one way to route traffic from customer locations to the cloud. Site-to-Site IPSec VPN credentials can be identified by the cloud through one of the following methods:

Common Name (CN) of IPSec Certificate
VPN User FQDN - requires VPN_SITE_TO_SITE subscription
VPN IP Address - requires VPN_SITE_TO_SITE subscription
Extended Authentication (XAUTH) or hosted mobile UserID - requires VPN_MOBILE subscription

Example Usage

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

const example = zia.getTrafficForwardingVPNCredentials({
    fqdn: "sjc-1-37@acme.com",
});

import pulumi
import pulumi_zia as zia

example = zia.get_traffic_forwarding_vpn_credentials(fqdn="sjc-1-37@acme.com")

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := zia.LookupTrafficForwardingVPNCredentials(ctx, &zia.LookupTrafficForwardingVPNCredentialsArgs{
			Fqdn: pulumi.StringRef("sjc-1-37@acme.com"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var example = Zia.GetTrafficForwardingVPNCredentials.Invoke(new()
    {
        Fqdn = "sjc-1-37@acme.com",
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.zia.ZiaFunctions;
import com.pulumi.zia.inputs.GetTrafficForwardingVPNCredentialsArgs;
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 = ZiaFunctions.getTrafficForwardingVPNCredentials(GetTrafficForwardingVPNCredentialsArgs.builder()
            .fqdn("sjc-1-37@acme.com")
            .build());

    }
}

variables:
  example:
    fn::invoke:
      Function: zia:getTrafficForwardingVPNCredentials
      Arguments:
        fqdn: sjc-1-37@acme.com

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

const example = zia.getTrafficForwardingVPNCredentials({
    ipAddress: "1.1.1.1",
});

import pulumi
import pulumi_zia as zia

example = zia.get_traffic_forwarding_vpn_credentials(ip_address="1.1.1.1")

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := zia.LookupTrafficForwardingVPNCredentials(ctx, &zia.LookupTrafficForwardingVPNCredentialsArgs{
			IpAddress: pulumi.StringRef("1.1.1.1"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var example = Zia.GetTrafficForwardingVPNCredentials.Invoke(new()
    {
        IpAddress = "1.1.1.1",
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.zia.ZiaFunctions;
import com.pulumi.zia.inputs.GetTrafficForwardingVPNCredentialsArgs;
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 = ZiaFunctions.getTrafficForwardingVPNCredentials(GetTrafficForwardingVPNCredentialsArgs.builder()
            .ipAddress("1.1.1.1")
            .build());

    }
}

variables:
  example:
    fn::invoke:
      Function: zia:getTrafficForwardingVPNCredentials
      Arguments:
        ipAddress: 1.1.1.1

Using getTrafficForwardingVPNCredentials

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 getTrafficForwardingVPNCredentials(args: GetTrafficForwardingVPNCredentialsArgs, opts?: InvokeOptions): Promise<GetTrafficForwardingVPNCredentialsResult>
function getTrafficForwardingVPNCredentialsOutput(args: GetTrafficForwardingVPNCredentialsOutputArgs, opts?: InvokeOptions): Output<GetTrafficForwardingVPNCredentialsResult>

def get_traffic_forwarding_vpn_credentials(fqdn: Optional[str] = None,
                                           id: Optional[int] = None,
                                           ip_address: Optional[str] = None,
                                           type: Optional[str] = None,
                                           opts: Optional[InvokeOptions] = None) -> GetTrafficForwardingVPNCredentialsResult
def get_traffic_forwarding_vpn_credentials_output(fqdn: Optional[pulumi.Input[str]] = None,
                                           id: Optional[pulumi.Input[int]] = None,
                                           ip_address: Optional[pulumi.Input[str]] = None,
                                           type: Optional[pulumi.Input[str]] = None,
                                           opts: Optional[InvokeOptions] = None) -> Output[GetTrafficForwardingVPNCredentialsResult]

func LookupTrafficForwardingVPNCredentials(ctx *Context, args *LookupTrafficForwardingVPNCredentialsArgs, opts ...InvokeOption) (*LookupTrafficForwardingVPNCredentialsResult, error)
func LookupTrafficForwardingVPNCredentialsOutput(ctx *Context, args *LookupTrafficForwardingVPNCredentialsOutputArgs, opts ...InvokeOption) LookupTrafficForwardingVPNCredentialsResultOutput

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

public static class GetTrafficForwardingVPNCredentials 
{
    public static Task<GetTrafficForwardingVPNCredentialsResult> InvokeAsync(GetTrafficForwardingVPNCredentialsArgs args, InvokeOptions? opts = null)
    public static Output<GetTrafficForwardingVPNCredentialsResult> Invoke(GetTrafficForwardingVPNCredentialsInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetTrafficForwardingVPNCredentialsResult> getTrafficForwardingVPNCredentials(GetTrafficForwardingVPNCredentialsArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: zia:index/getTrafficForwardingVPNCredentials:getTrafficForwardingVPNCredentials
  arguments:
    # arguments dictionary

The following arguments are supported:

Fqdn string: (String) Fully Qualified Domain Name. Applicable only to UFQDN or XAUTH (or HOSTED_MOBILE_USERS) auth type.
Id int: Unique identifer of the GRE virtual IP address (VIP)
IpAddress string: Filter based on an IP address range.
Type string: (String) VPN authentication type (i.e., how the VPN credential is sent to the server). It is not modifiable after VpnCredential is created.

Fqdn string: (String) Fully Qualified Domain Name. Applicable only to UFQDN or XAUTH (or HOSTED_MOBILE_USERS) auth type.
Id int: Unique identifer of the GRE virtual IP address (VIP)
IpAddress string: Filter based on an IP address range.
Type string: (String) VPN authentication type (i.e., how the VPN credential is sent to the server). It is not modifiable after VpnCredential is created.

fqdn String: (String) Fully Qualified Domain Name. Applicable only to UFQDN or XAUTH (or HOSTED_MOBILE_USERS) auth type.
id Integer: Unique identifer of the GRE virtual IP address (VIP)
ipAddress String: Filter based on an IP address range.
type String: (String) VPN authentication type (i.e., how the VPN credential is sent to the server). It is not modifiable after VpnCredential is created.

fqdn string: (String) Fully Qualified Domain Name. Applicable only to UFQDN or XAUTH (or HOSTED_MOBILE_USERS) auth type.
id number: Unique identifer of the GRE virtual IP address (VIP)
ipAddress string: Filter based on an IP address range.
type string: (String) VPN authentication type (i.e., how the VPN credential is sent to the server). It is not modifiable after VpnCredential is created.

fqdn str: (String) Fully Qualified Domain Name. Applicable only to UFQDN or XAUTH (or HOSTED_MOBILE_USERS) auth type.
id int: Unique identifer of the GRE virtual IP address (VIP)
ip_address str: Filter based on an IP address range.
type str: (String) VPN authentication type (i.e., how the VPN credential is sent to the server). It is not modifiable after VpnCredential is created.

fqdn String: (String) Fully Qualified Domain Name. Applicable only to UFQDN or XAUTH (or HOSTED_MOBILE_USERS) auth type.
id Number: Unique identifer of the GRE virtual IP address (VIP)
ipAddress String: Filter based on an IP address range.
type String: (String) VPN authentication type (i.e., how the VPN credential is sent to the server). It is not modifiable after VpnCredential is created.

getTrafficForwardingVPNCredentials Result

The following output properties are available:

Comments string: (String) Additional information about this VPN credential.
Id int: (Number) Identifier that uniquely identifies an entity
Locations List<zscaler.PulumiPackage.Zia.Outputs.GetTrafficForwardingVPNCredentialsLocation>: (Set of Object) Location that is associated to this VPN credential. Non-existence means not associated to any location.
ManagedBies List<zscaler.PulumiPackage.Zia.Outputs.GetTrafficForwardingVPNCredentialsManagedBy>: (Set of Object) SD-WAN Partner that manages the location. If a partner does not manage the locaton, this is set to Self.
PreSharedKey string: (String) Pre-shared key. This is a required field for UFQDN and IP auth type.
Type string: (String) VPN authentication type (i.e., how the VPN credential is sent to the server). It is not modifiable after VpnCredential is created.
Fqdn string: (String) Fully Qualified Domain Name. Applicable only to UFQDN or XAUTH (or HOSTED_MOBILE_USERS) auth type.
IpAddress string

Comments string: (String) Additional information about this VPN credential.
Id int: (Number) Identifier that uniquely identifies an entity
Locations []GetTrafficForwardingVPNCredentialsLocation: (Set of Object) Location that is associated to this VPN credential. Non-existence means not associated to any location.
ManagedBies []GetTrafficForwardingVPNCredentialsManagedBy: (Set of Object) SD-WAN Partner that manages the location. If a partner does not manage the locaton, this is set to Self.
PreSharedKey string: (String) Pre-shared key. This is a required field for UFQDN and IP auth type.
Type string: (String) VPN authentication type (i.e., how the VPN credential is sent to the server). It is not modifiable after VpnCredential is created.
Fqdn string: (String) Fully Qualified Domain Name. Applicable only to UFQDN or XAUTH (or HOSTED_MOBILE_USERS) auth type.
IpAddress string

comments String: (String) Additional information about this VPN credential.
id Integer: (Number) Identifier that uniquely identifies an entity
locations List<GetTrafficForwardingVPNCredentialsLocation>: (Set of Object) Location that is associated to this VPN credential. Non-existence means not associated to any location.
managedBies List<GetTrafficForwardingVPNCredentialsManagedBy>: (Set of Object) SD-WAN Partner that manages the location. If a partner does not manage the locaton, this is set to Self.
preSharedKey String: (String) Pre-shared key. This is a required field for UFQDN and IP auth type.
type String: (String) VPN authentication type (i.e., how the VPN credential is sent to the server). It is not modifiable after VpnCredential is created.
fqdn String: (String) Fully Qualified Domain Name. Applicable only to UFQDN or XAUTH (or HOSTED_MOBILE_USERS) auth type.
ipAddress String

comments string: (String) Additional information about this VPN credential.
id number: (Number) Identifier that uniquely identifies an entity
locations GetTrafficForwardingVPNCredentialsLocation[]: (Set of Object) Location that is associated to this VPN credential. Non-existence means not associated to any location.
managedBies GetTrafficForwardingVPNCredentialsManagedBy[]: (Set of Object) SD-WAN Partner that manages the location. If a partner does not manage the locaton, this is set to Self.
preSharedKey string: (String) Pre-shared key. This is a required field for UFQDN and IP auth type.
type string: (String) VPN authentication type (i.e., how the VPN credential is sent to the server). It is not modifiable after VpnCredential is created.
fqdn string: (String) Fully Qualified Domain Name. Applicable only to UFQDN or XAUTH (or HOSTED_MOBILE_USERS) auth type.
ipAddress string

comments str: (String) Additional information about this VPN credential.
id int: (Number) Identifier that uniquely identifies an entity
locations Sequence[GetTrafficForwardingVPNCredentialsLocation]: (Set of Object) Location that is associated to this VPN credential. Non-existence means not associated to any location.
managed_bies Sequence[GetTrafficForwardingVPNCredentialsManagedBy]: (Set of Object) SD-WAN Partner that manages the location. If a partner does not manage the locaton, this is set to Self.
pre_shared_key str: (String) Pre-shared key. This is a required field for UFQDN and IP auth type.
type str: (String) VPN authentication type (i.e., how the VPN credential is sent to the server). It is not modifiable after VpnCredential is created.
fqdn str: (String) Fully Qualified Domain Name. Applicable only to UFQDN or XAUTH (or HOSTED_MOBILE_USERS) auth type.
ip_address str

comments String: (String) Additional information about this VPN credential.
id Number: (Number) Identifier that uniquely identifies an entity
locations List<Property Map>: (Set of Object) Location that is associated to this VPN credential. Non-existence means not associated to any location.
managedBies List<Property Map>: (Set of Object) SD-WAN Partner that manages the location. If a partner does not manage the locaton, this is set to Self.
preSharedKey String: (String) Pre-shared key. This is a required field for UFQDN and IP auth type.
type String: (String) VPN authentication type (i.e., how the VPN credential is sent to the server). It is not modifiable after VpnCredential is created.
fqdn String: (String) Fully Qualified Domain Name. Applicable only to UFQDN or XAUTH (or HOSTED_MOBILE_USERS) auth type.
ipAddress String

Supporting Types

GetTrafficForwardingVPNCredentialsLocation

Extensions Dictionary<string, string>: (Map of String)
Id int: Unique identifer of the GRE virtual IP address (VIP)
Name string: (String) The configured name of the entity

Extensions map[string]string: (Map of String)
Id int: Unique identifer of the GRE virtual IP address (VIP)
Name string: (String) The configured name of the entity

extensions Map<String,String>: (Map of String)
id Integer: Unique identifer of the GRE virtual IP address (VIP)
name String: (String) The configured name of the entity

extensions {[key: string]: string}: (Map of String)
id number: Unique identifer of the GRE virtual IP address (VIP)
name string: (String) The configured name of the entity

extensions Mapping[str, str]: (Map of String)
id int: Unique identifer of the GRE virtual IP address (VIP)
name str: (String) The configured name of the entity

extensions Map<String>: (Map of String)
id Number: Unique identifer of the GRE virtual IP address (VIP)
name String: (String) The configured name of the entity

GetTrafficForwardingVPNCredentialsManagedBy

Extensions Dictionary<string, string>: (Map of String)
Id int: Unique identifer of the GRE virtual IP address (VIP)
Name string: (String) The configured name of the entity

Extensions map[string]string: (Map of String)
Id int: Unique identifer of the GRE virtual IP address (VIP)
Name string: (String) The configured name of the entity

extensions Map<String,String>: (Map of String)
id Integer: Unique identifer of the GRE virtual IP address (VIP)
name String: (String) The configured name of the entity

extensions {[key: string]: string}: (Map of String)
id number: Unique identifer of the GRE virtual IP address (VIP)
name string: (String) The configured name of the entity

extensions Mapping[str, str]: (Map of String)
id int: Unique identifer of the GRE virtual IP address (VIP)
name str: (String) The configured name of the entity

extensions Map<String>: (Map of String)
id Number: Unique identifer of the GRE virtual IP address (VIP)
name String: (String) The configured name of the entity

Package Details

Repository: zia zscaler/pulumi-zia
License: MIT
Notes: This Pulumi package is based on the zia Terraform Provider.

Zscaler Internet Access v0.0.6 published on Wednesday, Apr 10, 2024 by Zscaler

zscaler/pulumi-zia

zia.getTrafficForwardingVPNCredentials

On this page

On this page

Example Usage

Using getTrafficForwardingVPNCredentials

getTrafficForwardingVPNCredentials Result

Supporting Types

GetTrafficForwardingVPNCredentialsLocation

GetTrafficForwardingVPNCredentialsManagedBy

Package Details

On this page

On this page