zscaler.ziacloud.zia_dc_exclusions_info module – Gets information about 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_info.

New in zscaler.ziacloud 1.0.0

Synopsis

  • Gets datacenter exclusions configured for traffic forwarding.

  • Retrieves exclusions by datacenter ID or name (partial match).

  • If neither id nor datacenter_id nor name is provided, lists all exclusions.

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

Filter by datacenter ID (dcid).

id

string

Filter by resource id (datacenter ID as string).

name

string

Filter by datacenter name (case-insensitive partial match).

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.

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

Examples

- name: Get all DC exclusions
  zscaler.ziacloud.zia_dc_exclusions_info:
    provider: '{{ provider }}'

- name: Get DC exclusion by datacenter ID
  zscaler.ziacloud.zia_dc_exclusions_info:
    provider: '{{ provider }}'
    datacenter_id: 5313

- name: Get DC exclusions by datacenter name
  zscaler.ziacloud.zia_dc_exclusions_info:
    provider: '{{ provider }}'
    name: "San Jose"

Return Values

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

Key

Description

exclusions

list / elements=dictionary

List of DC exclusion entries.

Returned: always

dc_id

integer

Datacenter ID (dcid) for the exclusion.

Returned: success

dc_name

string

Datacenter name from the dcName reference.

Returned: success

dc_name_id

integer

Datacenter ID from the dcName reference.

Returned: success

description

string

Description of the DC exclusion.

Returned: success

end_time

integer

Unix timestamp when the exclusion window ends.

Returned: success

expired

boolean

Whether the exclusion has expired.

Returned: success

id

string

The exclusion identifier (datacenter ID as string).

Returned: success

start_time

integer

Unix timestamp when the exclusion window starts.

Returned: success

Authors

  • William Guilherme (@willguibr)