zscaler.ziacloud.zia_dlp_dictionaries_info module – Custom and predefined DLP dictionaries.

Note

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

New in zscaler.ziacloud 1.0.0

Synopsis

  • Gets information on all custom and predefined DLP dictionaries.

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:

  • "zscloud"

  • "zscaler"

  • "zscalerone"

  • "zscalertwo"

  • "zscalerthree"

  • "zscalerbeta"

  • "zscalergov"

  • "zscalerten"

  • "beta"

  • "production"

id

integer

Unique identifier for the DLP dictionary

name

string

Name of the DLP dictionary’s name

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:

  • "zscloud"

  • "zscaler"

  • "zscalerone"

  • "zscalertwo"

  • "zscalerthree"

  • "zscalerbeta"

  • "zscalergov"

  • "zscalerten"

  • "beta"

  • "production"

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: Gather Information Details of all ZIA DLP Dictionaries
  zscaler.ziacloud.zia_dlp_dictionaries_info:
    provider: '{{ provider }}'

- name: Gather Information Details of a ZIA DLP Dictionaries by Name
  zscaler.ziacloud.zia_dlp_dictionaries_info:
    provider: '{{ provider }}'
    name: "Example"

Return Values

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

Key

Description

dictionaries

list / elements=dictionary

Details about the DLP dictionaries retrieved.

Returned: when successful

custom

boolean

Indicates whether the dictionary is custom.

Returned: always

Sample: true

custom_phrase_match_type

string

Describes the phrase match type for the dictionary.

Returned: always

Sample: "MATCH_ANY_CUSTOM_PHRASE_PATTERN_DICTIONARY"

custom_phrase_supported

boolean

Indicates if custom phrases are supported in this dictionary.

Returned: always

Sample: false

description

string

Description of the DLP dictionary.

Returned: always

Sample: "Example_Dictionary"

dictionary_cloning_enabled

boolean

Indicates if cloning of the dictionary is enabled.

Returned: always

Sample: false

dictionary_type

string

Type of the dictionary, indicating whether it contains patterns, phrases, or both.

Returned: always

Sample: "PATTERNS_AND_PHRASES"

id

integer

The unique identifier of the DLP dictionary.

Returned: always

Sample: 1

name

string

The name of the DLP dictionary.

Returned: always

Sample: "Example_Dictionary"

patterns

list / elements=dictionary

List of patterns included in the dictionary.

Returned: always

action

string

The action associated with the pattern.

Returned: always

Sample: "PATTERN_COUNT_TYPE_UNIQUE"

pattern

string

The regex pattern included in the dictionary.

Returned: always

Sample: "test"

phrases

list / elements=dictionary

List of phrases included in the dictionary.

Returned: always

action

string

The action associated with the phrase.

Returned: always

Sample: "PHRASE_COUNT_TYPE_ALL"

phrase

string

The phrase included in the dictionary.

Returned: always

Sample: "test"

Authors

  • William Guilherme (@willguibr)