zscaler.ziacloud.zia_traffic_forwarding_vpn_credentials_info module – Gets VPN credentials that can be associated to locations

Note

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

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_info.

New in zscaler.ziacloud 1.0.0

Synopsis

  • Gets 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.

cloud

string

The Zscaler cloud name was provisioned for your organization.

Choices:

  • "zscloud"

  • "zscaler"

  • "zscalerone"

  • "zscalertwo"

  • "zscalerthree"

  • "zscalerbeta"

  • "zscalergov"

  • "zscalerten"

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

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.

provider

dictionary

A dict object containing connection details. This is optional; credentials can also be provided directly at the top level.

api_key

string

A string that contains the obfuscated API key.

cloud

string

The Zscaler cloud name was provisioned for your organization.

Choices:

  • "zscloud"

  • "zscaler"

  • "zscalerone"

  • "zscalertwo"

  • "zscalerthree"

  • "zscalerbeta"

  • "zscalergov"

  • "zscalerten"

password

string

A string that contains the password for the API admin.

sandbox_token

string

A string that contains the Sandbox API Key.

username

string

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

sandbox_token

string

A string that contains the Sandbox API Key.

username

string

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

Notes

Note

  • Check mode is not supported.

Examples

- name: Retrieve Details of All ZPN Credentials.
  zscaler.ziacloud.zia_traffic_forwarding_vpn_credentials_info:
    provider: '{{ provider }}'

- name: Retrieve Details of Specific ZPN Credentials By fqdn.
  zscaler.ziacloud.zia_traffic_forwarding_vpn_credentials_info:
    provider: '{{ provider }}'
    fqdn: "sjc-1-37@acme.com"

- name: Retrieve Details of Specific ZPN Credentials By IP Address.
  zscaler.ziacloud.zia_traffic_forwarding_vpn_credentials_info:
    provider: '{{ provider }}'
    ip_address: '1.1.1.1'

- name: Retrieve Details of Specific ZPN Credentials By ID.
  zscaler.ziacloud.zia_traffic_forwarding_vpn_credentials_info:
    provider: '{{ provider }}'
    id: 222

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

credentials

list / elements=dictionary

A list of VPN credentials retrieved based on the given criteria.

Returned: always

comments

string

Any additional comments or metadata associated with the VPN credential.

Returned: always

Sample: "San Jose VPN Credential 37"

fqdn

string

The Fully Qualified Domain Name associated with the VPN credential.

Returned: when type is ‘UFQDN’

Sample: "sjc-1-37@acme.com"

id

integer

The unique identifier for the VPN credential.

Returned: always

Sample: 108667023

ip_address

string

The IP address associated with the VPN credential.

Returned: when type is ‘IP’

Sample: "1.1.1.1"

type

string

The type of VPN credential, which could be ‘UFQDN’ or ‘IP’.

Returned: always

Sample: "UFQDN"

Authors

  • William Guilherme (@willguibr)