zscaler.ziacloud.zia_dlp_engine module – Adds a new custom DLP engine.

Note

This module is part of the zscaler.ziacloud collection (version 1.3.1).

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

New in zscaler.ziacloud 1.0.0

Synopsis

  • Adds a new custom DLP engine.

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.

cloud

string

The Zscaler cloud name was provisioned for your organization.

Choices:

  • "zscloud"

  • "zscaler"

  • "zscalerone"

  • "zscalertwo"

  • "zscalerthree"

  • "zscalerbeta"

  • "zscalergov"

  • "zscalerten"

custom_dlp_engine

boolean

The DLP engine description.

Choices:

  • false

  • true

description

string

The DLP engine description.

engine_expression

string

The logical expression that defines a DLP engine by combining DLP dictionaries using logical operators.

Namely All (AND), Any (OR), Exclude (NOT), and Sum (the total number of content matches).

((D63.S > 1)).

((D38.S > 1) AND (D63.S > 1)).

((D38.S > 1) OR (D63.S > 1)).

(SUM(D63.S, D38.S) > 3).

In the preceding examples, 63 represents the ID of the Credit Cards dictionary ID.

61 is the Financial Statements ID, and 38 is the ABA Bank Routing Numbers dictionary ID.

Each dictionary ID is wrapped around by a prefix (D) and a suffix (.S).

id

integer

The unique identifier for the DLP engine.

name

string / required

The DLP engine name as configured by the admin.

This attribute is required in POST and PUT requests for custom DLP engines.

password

string

A string that contains the password for the API admin.

provider

dictionary

A dict object containing connection details. This is optional; credentials can also be provided directly at the top level.

api_key

string

A string that contains the obfuscated API key.

cloud

string

The Zscaler cloud name was provisioned for your organization.

Choices:

  • "zscloud"

  • "zscaler"

  • "zscalerone"

  • "zscalertwo"

  • "zscalerthree"

  • "zscalerbeta"

  • "zscalergov"

  • "zscalerten"

password

string

A string that contains the password for the API admin.

sandbox_token

string

A string that contains the Sandbox API Key.

username

string

A string that contains the email ID of the API admin.

sandbox_token

string

A string that contains the Sandbox API Key.

state

string

Specifies the desired state of the resource.

Choices:

  • "present" ← (default)

  • "absent"

username

string

A string that contains the email ID of the API admin.

Notes

Note

  • Check mode is supported.

Examples

- name: Create/Update/Delete custom dlp engine.
  zscaler.ziacloud.zia_dlp_engine:
    provider: '{{ provider }}'
    name: "Example"
    description: "Example"
    engine_expression: "((D63.S > 1))"
    custom_dlp_engine: true

Authors

  • William Guilherme (@willguibr)