zscaler.zpacloud.zpa_private_cloud_group module – Create 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.

New in zscaler.zpacloud 1.0.0

Synopsis

  • This module will create/update/delete a Private Cloud Group resource.

  • 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

city_country

string

City and country of the Private Cloud Group. Format: <City>, <Country Code> (e.g., Sydney, AU)

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"

country_code

string

Country code of the Private Cloud Group (ISO standard)

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.

description

string

Description of the Private Cloud Group

enabled

boolean

Whether this Private Cloud Group is enabled or not

Choices:

  • false

  • true

id

string

The unique identifier of the Private Cloud Group

is_public

string

Whether the Private Cloud Group is public

latitude

string

Latitude of the Private Cloud Group location. Integer or decimal with values in the range of -90 to 90

location

string

Location name of the Private Cloud Group

longitude

string

Longitude of the Private Cloud Group location. Integer or decimal with values in the range of -180 to 180

microtenant_id

string

The unique identifier of the Microtenant for the ZPA tenant

name

string / required

Name of the Private Cloud Group

override_version_profile

boolean

Whether the default version profile of the Private Cloud Group is applied or overridden

Choices:

  • false

  • true

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.

site_id

string

Site ID for the Private Cloud Group

state

string

Specifies the desired state of the resource.

Choices:

  • "present" ← (default)

  • "absent"

upgrade_day

string

Private Cloud Controllers in this group will attempt to update during this specified day

Choices:

  • "SUNDAY"

  • "MONDAY"

  • "TUESDAY"

  • "WEDNESDAY"

  • "THURSDAY"

  • "FRIDAY"

  • "SATURDAY"

upgrade_time_in_secs

string

Private Cloud Controllers will attempt to update during this specified time.

Integer in seconds (i.e., -66600). Must be >= 0 and < 86400, in 15 minute intervals.

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.

version_profile_id

string

ID of the version profile for the Private Cloud Group

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

Examples

- name: Create/Update/Delete a Private Cloud Group
  zscaler.zpacloud.zpa_private_cloud_group:
    provider: "{{ zpa_cloud }}"
    name: US East Private Cloud
    description: Private Cloud Group for US East region
    enabled: true
    city_country: "San Jose, US"
    country_code: "US"
    latitude: "37.3382082"
    longitude: "-121.8863286"
    location: "San Jose, CA, USA"
    upgrade_day: "SUNDAY"

Authors

  • William Guilherme (@willguibr)