zscaler.ziacloud.zia_traffic_forwarding_vpn_credentials module – Adds VPN credentials that can be associated to locations.

Note

This module is part of the zscaler.ziacloud collection (version 2.0.3).

It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install zscaler.ziacloud. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: zscaler.ziacloud.zia_traffic_forwarding_vpn_credentials.

New in zscaler.ziacloud 1.0.0

Synopsis

  • Adds VPN credentials that can be associated to locations.

Requirements

The below requirements are needed on the host that executes this module.

Parameters

Parameter

Comments

api_key

string

A string that contains the obfuscated API key.

client_id

string

The client ID for OAuth2 authentication.

client_secret

string

The client secret for OAuth2 authentication.

cloud

string

The Zscaler cloud name provisioned for your organization.

Choices:

  • "zscloud"

  • "zscaler"

  • "zscalerone"

  • "zscalertwo"

  • "zscalerthree"

  • "zscalerbeta"

  • "zscalergov"

  • "zscalerten"

  • "beta"

  • "production"

comments

string

Additional information about this VPN credential.

disabled

boolean

Enable or disable the VPN credential

Choices:

  • false

  • true

fqdn

string

Fully Qualified Domain Name. Applicable only to UFQDN or XAUTH (or HOSTED_MOBILE_USERS) auth type.

id

integer

VPN credential id

ip_address

string

Static IP address for VPN that is self-provisioned or provisioned by Zscaler.

This is a required field for IP auth type and is not applicable to other auth types.

password

string

A string that contains the password for the API admin.

pre_shared_key

string

This is a required field for UFQDN and IP auth type.

private_key

string

The private key for JWT-based OAuth2 authentication.

provider

dictionary

A dict containing authentication credentials.

api_key

string

Obfuscated API key.

client_id

string

OAuth2 client ID.

client_secret

string

OAuth2 client secret.

cloud

string

Zscaler cloud name.

Choices:

  • "zscloud"

  • "zscaler"

  • "zscalerone"

  • "zscalertwo"

  • "zscalerthree"

  • "zscalerbeta"

  • "zscalergov"

  • "zscalerten"

  • "beta"

  • "production"

password

string

Password for the API admin.

private_key

string

Private key for OAuth2 JWT.

sandbox_cloud

string

Sandbox Cloud environment.

sandbox_token

string

Sandbox API Key.

use_legacy_client

boolean

Whether to use the legacy Zscaler API client.

Choices:

  • false ← (default)

  • true

username

string

Email ID of the API admin.

vanity_domain

string

Vanity domain for OAuth2.

sandbox_cloud

string

The Sandbox cloud environment for API access.

sandbox_token

string

A string that contains the Sandbox API Key.

state

string

Specifies the desired state of the resource.

Choices:

  • "present" ← (default)

  • "absent"

type

string / required

VPN authentication type (i.e., how the VPN credential is sent to the server).

It is not modifiable after VpnCredential is created.

Choices:

  • "IP"

  • "UFQDN"

update_psk

boolean

Must be set to True to update pre-shared key

Choices:

  • false ← (default)

  • true

use_legacy_client

boolean

Whether to use the legacy Zscaler API client.

Choices:

  • false ← (default)

  • true

username

string

A string that contains the email ID of the API admin.

vanity_domain

string

The vanity domain provisioned by Zscaler for OAuth2 flows.

Notes

Note

  • Check mode is supported.

Examples

- name: Create/Update/Delete VPN Credentials Type IP.
  zscaler.ziacloud.zia_traffic_forwarding_vpn_credentials:
    provider: '{{ provider }}'
    type: "IP"
    ip_address: "1.1.1.1"
    comments: "Created via Ansible"
    pre_shared_key: ""

- name: Create/Update/Delete VPN Credentials Type UFQDN.
  zscaler.ziacloud.zia_traffic_forwarding_vpn_credentials:
    provider: '{{ provider }}'
    type: "UFQDN"
    ip_address: "sjc-1-37@acme.com"
    comments: "Created via Ansible"
    pre_shared_key: ""

Authors

  • William Guilherme (@willguibr)