zscaler.ziacloud.zia_dlp_notification_template_info module – Get a list of DLP notification templates.

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

New in zscaler.ziacloud 1.0.0

Synopsis

  • Get a list of DLP notification templates.

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

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.

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: Gets all list of DLP Notification Template
  zscaler.ziacloud.zia_dlp_notification_template_info:
    provider: '{{ provider }}'

- name: Gets a list of DLP Notification Template by name
  zscaler.ziacloud.zia_dlp_notification_template_info:
    provider: '{{ provider }}'
    name: "Standard_Template"

Return Values

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

Key

Description

templates

list / elements=dictionary

A list of DLP notification templates.

Returned: always

attach_content

boolean

Indicates if the content that triggered the DLP rule is attached to the email.

Returned: always

Sample: true

html_message

string

The HTML version of the DLP notification email body, potentially containing template variables and HTML formatting.

Returned: always

Sample: "Detailed DLP notification message in HTML format with placeholders and stylings for various components like user, URL, etc."

id

integer

The unique identifier of the DLP notification template.

Returned: always

Sample: 6523

name

string

The name of the DLP notification template.

Returned: always

Sample: "Standard_Template"

plain_text_message

string

The plain text version of the DLP notification email body, potentially containing template variables.

Returned: always

Sample: "Detailed DLP notification message in plain text format with placeholders for transaction ID, user, URL, etc."

subject

string

The subject line for the DLP notification email, potentially containing template variables.

Returned: always

Sample: "DLP Violation: ${TRANSACTION_ID} ${RULENAME}"

tls_enabled

boolean

Indicates if TLS is enabled for the sending of the notification email.

Returned: always

Sample: true

Authors

  • William Guilherme (@willguibr)