zscaler.ziacloud.zia_dlp_engine_info module – Get a list of DLP engines.

Note

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

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

New in zscaler.ziacloud 1.0.0

Synopsis

  • Get a list of DLP engines.

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"

id

integer

The unique identifier for the DLP engine.

name

string

The DLP engine name as configured by the admin.

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.

username

string

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

Notes

Note

  • Check mode is not supported.

Examples

- name: Gets all list of DLP Engines
  zscaler.ziacloud.zia_dlp_engine_info:
    provider: '{{ provider }}'

- name: Gets a list of DLP Engines by name
  zscaler.ziacloud.zia_dlp_engine_info:
    provider: '{{ provider }}'
    name: "PCI"

Return Values

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

Key

Description

data

dictionary

Details about the DLP engine retrieved.

Returned: when successful

custom_dlp_engine

boolean

Indicates whether the engine is a custom DLP engine.

Returned: always

Sample: false

description

string

Description of what the DLP engine is used for.

Returned: always

Sample: "Detect PCI violations"

engine_expression

string

The logical expression defining the DLP engine rules.

Returned: always

Sample: "(D63.S > 5 AND D62.S > 5)"

id

integer

The unique identifier of the DLP engine.

Returned: always

Sample: 61

predefined_engine_name

string

The name of the predefined engine, if this is not a custom engine.

Returned: always

Sample: "PCI"

Authors

  • William Guilherme (@willguibr)