zscaler.ziacloud.zia_sub_cloud module – Manages ZIA subcloud configurations

Note

This module is part of the zscaler.ziacloud collection (version 2.2.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_sub_cloud.

New in zscaler.ziacloud 1.0.0

Synopsis

  • Updates subcloud excluded data centers based on the specified cloud ID.

  • Subclouds cannot be created or deleted via the API; only exclusions can be updated.

  • Use the info resource zia_sub_cloud_info to look up cloud IDs.

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:

  • "beta"

  • "production"

  • "zscaler"

  • "zscalerbeta"

  • "zscalergov"

  • "zscalerone"

  • "zscalerten"

  • "zscalerthree"

  • "zscalertwo"

  • "zscloud"

  • "zspreview"

cloud_id

integer / required

Unique identifier for the subcloud.

Used as the path parameter for the update API.

exclusions

list / elements=dictionary

Set of data centers excluded from the subcloud.

country

string / required

Country where the excluded data center is located.

datacenter

list / elements=dictionary / required

The excluded datacenter reference.

country

string

Country where the datacenter is located.

id

integer / required

Unique identifier for the datacenter.

name

string

Datacenter name.

end_time

integer

Exclusion end time (Unix timestamp).

end_time_utc

string

Exclusion end time in UTC. Format MM/DD/YYYY HH:MM:SS am/pm.

If set, overrides end_time.

password

string

A string that contains the password for the API admin.

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:

  • "beta"

  • "production"

  • "zscaler"

  • "zscalerbeta"

  • "zscalergov"

  • "zscalerone"

  • "zscalerten"

  • "zscalerthree"

  • "zscalertwo"

  • "zscloud"

  • "zspreview"

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"

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.

  • cloud_id is required to identify the subcloud.

  • state=absent is a no-op; subclouds cannot be deleted via the API.

Examples

- name: Update subcloud exclusions
  zscaler.ziacloud.zia_sub_cloud:
    provider: '{{ provider }}'
    cloud_id: 31649
    exclusions:
      - datacenter:
          - id: 5313
            name: "DC Name"
        country: "United States"
        end_time: 1735689600

- name: Update subcloud with end_time_utc
  zscaler.ziacloud.zia_sub_cloud:
    provider: '{{ provider }}'
    cloud_id: 31649
    exclusions:
      - datacenter:
          - id: 5313
        country: "United States"
        end_time_utc: "01/15/2025 12:00:00 pm"

Return Values

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

Key

Description

data

dictionary

The subcloud resource record.

Returned: on success

Authors

  • William Guilherme (@willguibr)