zscaler.ziacloud.zia_dc_exclusions module – Manages ZIA DC (datacenter) exclusions

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

New in zscaler.ziacloud 1.0.0

Synopsis

  • Creates, updates, or deletes datacenter exclusions for traffic forwarding.

  • DC exclusions disable tunnels to specific Zscaler datacenters for a time period.

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"

datacenter_id

integer

Datacenter ID (dcid) to exclude. Required for create. Used with name for update/delete lookup.

description

string

Description of the DC exclusion. Maximum 10240 characters.

end_time

integer

Unix timestamp when the exclusion window ends.

Either end_time or end_time_utc must be set.

end_time_utc

string

Exclusion window end (UTC). Format MM/DD/YYYY HH:MM:SS am/pm.

If set, overrides end_time.

name

string

Datacenter name for lookup when updating or deleting (used if datacenter_id is not set).

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.

start_time

integer

Unix timestamp when the exclusion window starts.

Either start_time or start_time_utc must be set.

start_time_utc

string

Exclusion window start (UTC). Format MM/DD/YYYY HH:MM:SS am/pm.

If set, overrides start_time.

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.

  • Use datacenter_id or name to reference an existing exclusion for update/delete.

Examples

- name: Create a DC exclusion
  zscaler.ziacloud.zia_dc_exclusions:
    provider: '{{ provider }}'
    datacenter_id: 5313
    start_time_utc: "04/29/2025 02:51:00 pm"
    end_time_utc: "05/01/2025 02:00:00 pm"
    description: "Maintenance window"

- name: Update a DC exclusion by datacenter ID
  zscaler.ziacloud.zia_dc_exclusions:
    provider: '{{ provider }}'
    datacenter_id: 5313
    description: "Updated description"
    start_time: 1745941860
    end_time: 1746114660

- name: Delete a DC exclusion
  zscaler.ziacloud.zia_dc_exclusions:
    provider: '{{ provider }}'
    datacenter_id: 5313
    state: absent

Return Values

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

Key

Description

data

dictionary

The DC exclusion resource record.

Returned: on success

Authors

  • William Guilherme (@willguibr)