zscaler.zpacloud.zpa_private_cloud_group_info module – Retrieves information about a Private Cloud Group.

Note

This module is part of the zscaler.zpacloud collection (version 2.1.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.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_private_cloud_group_info.

New in zscaler.zpacloud 1.0.0

Synopsis

  • This module will allow the retrieval of information about a Private Cloud Group.

  • Private Cloud Groups represent geographic locations where Private Cloud Controllers are deployed.

Requirements

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

Parameters

Parameter

Comments

client_id

string

The client ID for OAuth2 authentication.

Required for OneAPI client authentication when use_legacy_client=false.

client_secret

string

The client secret for OAuth2 authentication.

Used for OneAPI client authentication when use_legacy_client=false and not using private_key.

cloud

string

The ZPA cloud provisioned for your organization.

Used for OneAPI client authentication when use_legacy_client=false.

Choices:

  • "BETA"

  • "GOV"

  • "GOVUS"

  • "PRODUCTION"

  • "QA"

  • "QA2"

  • "PREVIEW"

  • "beta"

  • "production"

customer_id

string

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

Used for OneAPI client authentication when use_legacy_client=false.

id

string

ID of the Private Cloud Group.

microtenant_id

string

The unique identifier of the Microtenant for the ZPA tenant.

name

string

Name of the Private Cloud Group.

private_key

string

The private key for JWT-based OAuth2 authentication.

Used for OneAPI client authentication when use_legacy_client=false and not using client_secret.

provider

dictionary

A dict containing authentication credentials.

client_id

string

The client ID for OAuth2 authentication.

Required for OneAPI client authentication when use_legacy_client=false.

client_secret

string

The client secret for OAuth2 authentication.

Used for OneAPI client authentication when use_legacy_client=false and not using private_key.

cloud

string

The ZPA cloud provisioned for your organization.

Used for OneAPI client authentication when use_legacy_client=false.

Choices:

  • "BETA"

  • "GOV"

  • "GOVUS"

  • "PRODUCTION"

  • "QA"

  • "QA2"

  • "PREVIEW"

  • "beta"

  • "production"

customer_id

string

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

Used for OneAPI client authentication when use_legacy_client=false.

microtenant_id

string

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

Used for OneAPI client authentication when use_legacy_client=false.

private_key

string

The private key for JWT-based OAuth2 authentication.

Used for OneAPI client authentication when use_legacy_client=false and not using client_secret.

use_legacy_client

boolean

Whether to use the legacy Zscaler API client.

When true, uses zpa_client_id/zpa_client_secret/zpa_customer_id/zpa_cloud for authentication.

When false (default), uses client_id/client_secret/private_key with vanity_domain for OAuth2 authentication.

Choices:

  • false ← (default)

  • true

vanity_domain

string

The vanity domain provisioned by Zscaler for OAuth2 flows.

Required for OneAPI client authentication when use_legacy_client=false.

zpa_client_id

string

The ZPA API client ID generated from the ZPA console.

Required for legacy client authentication when use_legacy_client=true.

zpa_client_secret

string

The ZPA API client secret generated from the ZPA console.

Required for legacy client authentication when use_legacy_client=true.

zpa_cloud

string

The ZPA cloud provisioned for your organization.

Required for legacy client authentication when use_legacy_client=true.

Choices:

  • "BETA"

  • "GOV"

  • "GOVUS"

  • "PRODUCTION"

  • "QA"

  • "QA2"

  • "PREVIEW"

  • "beta"

  • "production"

zpa_customer_id

string

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

Required for legacy client authentication when use_legacy_client=true.

zpa_microtenant_id

string

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

Used for legacy client authentication when use_legacy_client=true.

use_legacy_client

boolean

Whether to use the legacy Zscaler API client.

When true, uses zpa_client_id/zpa_client_secret/zpa_customer_id/zpa_cloud for authentication.

When false (default), uses client_id/client_secret/private_key with vanity_domain for OAuth2 authentication.

Choices:

  • false ← (default)

  • true

vanity_domain

string

The vanity domain provisioned by Zscaler for OAuth2 flows.

Required for OneAPI client authentication when use_legacy_client=false.

zpa_client_id

string

The ZPA API client ID generated from the ZPA console.

Required for legacy client authentication when use_legacy_client=true.

zpa_client_secret

string

The ZPA API client secret generated from the ZPA console.

Required for legacy client authentication when use_legacy_client=true.

zpa_cloud

string

The ZPA cloud provisioned for your organization.

Required for legacy client authentication when use_legacy_client=true.

Choices:

  • "BETA"

  • "GOV"

  • "GOVUS"

  • "PRODUCTION"

  • "QA"

  • "QA2"

  • "PREVIEW"

  • "beta"

  • "production"

zpa_customer_id

string

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

Required for legacy client authentication when use_legacy_client=true.

zpa_microtenant_id

string

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

Used for legacy client authentication when use_legacy_client=true.

Notes

Note

  • Check mode is not supported.

Examples

- name: Get Detail Information of All Private Cloud Groups
  zscaler.zpacloud.zpa_private_cloud_group_info:
    provider: "{{ zpa_cloud }}"

- name: Get Details of a Private Cloud Group by Name
  zscaler.zpacloud.zpa_private_cloud_group_info:
    provider: "{{ zpa_cloud }}"
    name: "US East"

- name: Get Details of a Private Cloud Group by ID
  zscaler.zpacloud.zpa_private_cloud_group_info:
    provider: "{{ zpa_cloud }}"
    id: "216196257331291969"

Return Values

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

Key

Description

groups

list / elements=dictionary

A list of dictionaries containing details about the Private Cloud Groups.

Returned: always

city_country

string

City and country of the Private Cloud Group.

Returned: success

Sample: "San Jose, US"

country_code

string

Country code of the Private Cloud Group.

Returned: success

Sample: "US"

description

string

A brief description of the Private Cloud Group.

Returned: success

Sample: "Private Cloud Group for US East region"

enabled

boolean

Indicates whether the Private Cloud Group is enabled.

Returned: success

Sample: true

geo_location_id

string

Geographic location ID for the Private Cloud Group.

Returned: success

Sample: "216199618143191041"

id

string

The unique identifier of the Private Cloud Group.

Returned: success

Sample: "216199618143442000"

is_public

string

Whether the Private Cloud Group is public.

Returned: success

Sample: "true"

latitude

string

Latitude of the Private Cloud Group location.

Returned: success

Sample: "37.3382082"

location

string

Location name of the Private Cloud Group.

Returned: success

Sample: "San Jose, CA, USA"

longitude

string

Longitude of the Private Cloud Group location.

Returned: success

Sample: "-121.8863286"

microtenant_id

string

The unique identifier of the microtenant associated with the group.

Returned: success

Sample: "216199618143191041"

microtenant_name

string

The name of the microtenant associated with the group.

Returned: success

Sample: "Default"

name

string

The name of the Private Cloud Group.

Returned: success

Sample: "US East"

override_version_profile

boolean

Whether the default version profile is overridden.

Returned: success

Sample: false

read_only

boolean

Whether the Private Cloud Group is read-only.

Returned: success

Sample: false

restriction_type

string

Restriction type for the Private Cloud Group.

Returned: success

Sample: "NONE"

site_id

string

Site ID for the Private Cloud Group.

Returned: success

Sample: "216199618143191041"

site_name

string

Site name for the Private Cloud Group.

Returned: success

Sample: "Site-US-East"

upgrade_day

string

Day of the week for software upgrades.

Returned: success

Sample: "SUNDAY"

upgrade_time_in_secs

string

Time of day for software upgrades in seconds.

Returned: success

Sample: "66600"

version_profile_id

string

Version profile ID for the Private Cloud Group.

Returned: success

Sample: "216199618143191041"

zscaler_managed

boolean

Whether the Private Cloud Group is managed by Zscaler.

Returned: success

Sample: false

Authors

  • William Guilherme (@willguibr)