zscaler.zpacloud.zpa_trusted_networks_info module – Retrieves information about a Trusted Network.

Note

This module is part of the zscaler.zpacloud collection (version 1.4.2).

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.zpacloud. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: zscaler.zpacloud.zpa_trusted_networks_info.

New in zscaler.zpacloud 1.0.0

Synopsis

  • This module will allow the retrieval of information about Trusted Network resource.

Requirements

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

Parameters

Parameter

Comments

client_id

string

The ZPA API client ID generated from the ZPA console.

client_secret

string

The ZPA API client secret generated from the ZPA console.

cloud

string

The ZPA cloud provisioned for your organization.

Choices:

  • "PRODUCTION"

  • "BETA"

  • "QA"

  • "QA2"

  • "GOV"

  • "GOVUS"

  • "PREVIEW"

  • "ZPATWO"

customer_id

string

The ZPA tenant ID found in the Administration Company menu in the ZPA console.

id

string

ID of the trusted network.

name

string

Name of the trusted network.

provider

dictionary

A dict object containing authentication details.

client_id

string

The ZPA API client ID generated from the ZPA console.

client_secret

string

The ZPA API client secret generated from the ZPA console.

cloud

string

The ZPA cloud provisioned for your organization.

Choices:

  • "PRODUCTION"

  • "BETA"

  • "QA"

  • "QA2"

  • "GOV"

  • "GOVUS"

  • "PREVIEW"

  • "ZPATWO"

customer_id

string

The ZPA tenant ID found in the Administration Company menu in the ZPA console.

Notes

Note

  • Check mode is not supported.

Examples

- name: Get Information About All Trusted Networks
  zscaler.zpacloud.zpa_trusted_networks_facts:
    provider: "{{ zpa_cloud }}"

- name: Get information about Trusted Networks by Name
  zscaler.zpacloud.zpa_trusted_networks_facts:
    provider: "{{ zpa_cloud }}"
    name: Corp-Trusted-Networks

- name: Get information about Trusted Networks by ID
  zscaler.zpacloud.zpa_trusted_networks_facts:
    provider: "{{ zpa_cloud }}"
    id: 216196257331282234

Return Values

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

Key

Description

networks

list / elements=dictionary

Details of the Trusted Networks.

Returned: always

creation_time

string

The time when the Trusted Network was created, in epoch format.

Returned: always

Sample: "1698786462"

id

string

The unique identifier of the Trusted Network.

Returned: always

Sample: "216199618143266948"

modified_by

string

The ID of the user who last modified the Trusted Network.

Returned: always

Sample: "72057594037928115"

modified_time

string

The time when the Trusted Network was last modified, in epoch format.

Returned: always

Sample: "1698786462"

name

string

The name of the Trusted Network.

Returned: always

Sample: "BDTrustedNetwork01 (zscalertwo.net)"

network_id

string

The unique network identifier for the Trusted Network.

Returned: always

Sample: "aeba3ac7-d860-4fa4-b4b8-8936ed7bc686"

zscaler_cloud

string

The Zscaler cloud where the Trusted Network is configured.

Returned: always

Sample: "zscalertwo"

Authors

  • William Guilherme (@willguibr)