zscaler.ziacloud.zia_dlp_dictionaries module – Adds a new custom DLP dictionary.
Note
This module is part of the zscaler.ziacloud collection (version 2.0.7).
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
.
New in zscaler.ziacloud 1.0.0
Synopsis
Create a new custom DLP dictionary.
Requirements
The below requirements are needed on the host that executes this module.
Zscaler SDK Python can be obtained from PyPI https://pypi.org/project/zscaler-sdk-python/
Parameters
Parameter |
Comments |
---|---|
A string that contains the obfuscated API key. |
|
The list of Bank Identification Number (BIN) values that are included or excluded from the Credit Cards dictionary. BIN values can be specified only for Diners Club, Mastercard, RuPay, and Visa cards. Up to 512 BIN values can be configured in a dictionary. |
|
The client ID for OAuth2 authentication. |
|
The client secret for OAuth2 authentication. |
|
The Zscaler cloud name provisioned for your organization. Choices:
|
|
The DLP confidence threshold Choices:
|
|
The DLP confidence threshold Choices:
|
|
The description of the DLP dictionary |
|
ID of the predefined dictionary (original source dictionary) that is used for cloning. This field is applicable only to cloned dictionaries. Only a limited set of identification-based predefined dictionaries (e.g., Credit Cards, Social Security Numbers, National Identification Numbers, etc.) can be cloned. Up to 4 clones can be created from a predefined dictionary. |
|
The DLP dictionary type. Choices:
|
|
Exact Data Match (EDM) related information for custom DLP dictionaries. |
|
The unique identifier for the EDM mapping. |
|
The EDM template’s primary field. |
|
The unique identifier for the EDM template (or schema). |
|
The EDM secondary field to match on. Choices:
|
|
The EDM template’s secondary fields. |
|
Unique identifier for the DLP dictionary |
|
Exact Data Match (EDM) related information for custom DLP dictionaries. |
|
The IDM template reference. |
|
Identifier that uniquely identifies an entity. |
|
The IDM template match accuracy. Choices:
|
|
Indicates whether to exclude documents that are a 100% match to already-indexed documents from triggering an Indexed Document Match (IDM) Dictionary. Choices:
|
|
A true value denotes that the specified Bank Identification Number (BIN) values are included in the Credit Cards dictionary. A false value denotes that the specified BIN values are excluded from the Credit Cards dictionary. Choices:
|
|
The DLP dictionary’s name |
|
A string that contains the password for the API admin. |
|
List containing the patterns used within a custom DLP dictionary. |
|
The action applied to a DLP dictionary using patterns. Choices:
|
|
DLP dictionary pattern. |
|
List containing the phrases used within a custom DLP dictionary. |
|
The action applied to a DLP dictionary using phrases. Choices:
|
|
DLP dictionary phrase. |
|
This field specifies whether duplicate matches of a phrase from a dictionary must be counted individually or toward the match count or ignored, thereby maintaining a single count for multiple occurrences. Choices:
|
|
The private key for JWT-based OAuth2 authentication. |
|
A dict containing authentication credentials. |
|
Obfuscated API key. |
|
OAuth2 client ID. |
|
OAuth2 client secret. |
|
Zscaler cloud name. Choices:
|
|
Password for the API admin. |
|
Private key for OAuth2 JWT. |
|
Sandbox Cloud environment. |
|
Sandbox API Key. |
|
Whether to use the legacy Zscaler API client. Choices:
|
|
Email ID of the API admin. |
|
Vanity domain for OAuth2. |
|
The DLP dictionary proximity length. |
|
The Sandbox cloud environment for API access. |
|
A string that contains the Sandbox API Key. |
|
Specifies the desired state of the resource. Choices:
|
|
Whether to use the legacy Zscaler API client. Choices:
|
|
A string that contains the email ID of the API admin. |
|
The vanity domain provisioned by Zscaler for OAuth2 flows. |
Notes
Note
Check mode is supported.
Examples
- name: Create/Update/Delete dlp dictionary.
zscaler.ziacloud.zia_dlp_dictionaries:
provider: '{{ provider }}'
name: "Example_Dictionary"
description: "Example_Dictionary"
custom_phrase_match_type: "MATCH_ALL_CUSTOM_PHRASE_PATTERN_DICTIONARY"
dictionary_type: "PATTERNS_AND_PHRASES"
phrases:
- action: "PHRASE_COUNT_TYPE_UNIQUE"
phrase: "YourPhrase"
patterns:
- action: "PATTERN_COUNT_TYPE_ALL"
pattern: "YourPattern"