zscaler.ziacloud.zia_dlp_notification_template module – Manage Zscaler Internet Access (ZIA) 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.

New in zscaler.ziacloud 1.0.0

Synopsis

  • This module allows for the management of Zscaler Internet Access (ZIA) Data Loss Prevention (DLP) Notification Templates.

  • It supports the creation, updating, and deletion of DLP Notification Templates.

  • It allows for the customization of the subject line, message body (both plain text and HTML), and various other settings related to DLP notifications.

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.

attach_content

boolean

If set to true, the content that triggered the violation is attached to the DLP notification email.

Choices:

  • false

  • true

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"

html_message

string

The template for the HTML message body that is displayed in the DLP notification email.

id

integer

The unique identifier for the DLP notification template. Required if updating or deleting a template.

name

string / required

The name of the DLP notification template.

password

string

A string that contains the password for the API admin.

plain_text_message

string

The template for the plain text UTF-8 message body that is displayed in the DLP notification email.

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.

state

string

Specifies the desired state of the resource.

Choices:

  • "present" ← (default)

  • "absent"

subject

string

The subject line that is displayed within the DLP notification email.

tls_enabled

boolean

If set to true, enables TLS for the DLP notification template.

Choices:

  • false

  • true

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

Examples

- name: Create a new DLP Notification Template
  zia_dlp_notification_template:
    provider: '{{ provider }}'
    name: "Standard_DLP_Template"
    subject: "DLP Violation Alert"
    attach_content: true
    tls_enabled: true
    plain_text_message: |
      "The attached content triggered a Web DLP rule for your organization..."
    html_message: |
      "<html><body>The attached content triggered a Web DLP rule...</body></html>"

- name: Update an existing DLP Notification Template
  zia_dlp_notification_template:
    provider: '{{ provider }}'
    name: "Updated_DLP_Template"
    subject: "Updated DLP Violation Alert"
    state: "present"

- name: Delete a DLP Notification Template
  zia_dlp_notification_template:
    provider: '{{ provider }}'
    name: Updated_DLP_Template
    state: "absent"

Authors

  • William Guilherme (@willguibr)