zscaler.ziacloud.zia_dlp_web_rules_info module – Gets a list of DLP policy rules, excluding SaaS Security API DLP policy rules

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

New in zscaler.ziacloud 1.0.0

Synopsis

  • Gets a list of DLP policy rules, excluding SaaS Security API DLP policy rules

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

Unique identifier for the DLP Web rule

name

string

Name of the DLP Web rule

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: Gather Information Details of all ZIA DLP Web Rule
  zscaler.ziacloud.zia_dlp_web_rules_info:
    provider: '{{ provider }}'

- name: Gather Information Details of a ZIA DLP Web Rule by Name
  zscaler.ziacloud.zia_dlp_web_rules_info:
    provider: '{{ provider }}'
    name: "Example"

Return Values

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

Key

Description

dlp_web_rules

list / elements=dictionary

Details about the DLP web rules retrieved.

Returned: when successful

access_control

string

The access control setting for the rule.

Returned: always

Sample: "READ_WRITE"

action

string

Action to be taken when the rule conditions are met.

Returned: always

Sample: "ALLOW"

departments

list / elements=dictionary

List of departments to which the rule is applicable.

Returned: always

id

integer

The unique identifier of the department.

Returned: always

name

string

The name of the department.

Returned: always

Sample: "A000"

description

string

Description of the DLP web rule.

Returned: always

Sample: "Sample_DLP_Rule1"

groups

list / elements=dictionary

List of user groups to which the rule applies.

Returned: always

id

integer

The unique identifier of the user group.

Returned: always

name

string

The name of the user group.

Returned: always

Sample: "A000"

icap_server

dictionary

Details about the ICAP server used for the rule.

Returned: always

id

integer

The unique identifier of the ICAP server.

Returned: always

Sample: 1494

name

string

The name of the ICAP server.

Returned: always

Sample: "ZS_BD_INC_RECEIVER_01"

id

integer

The unique identifier of the DLP web rule.

Returned: always

Sample: 1203349

name

string

The name of the DLP web rule.

Returned: always

Sample: "Sample_DLP_Rule1"

protocols

list / elements=string

List of protocols to which the rule applies.

Returned: always

Sample: ["FTP_RULE", "HTTPS_RULE", "HTTP_RULE"]

severity

string

Severity level of the rule.

Returned: always

Sample: "RULE_SEVERITY_HIGH"

state

string

The current state of the rule (e.g., enabled or disabled).

Returned: always

Sample: "ENABLED"

Authors

  • William Guilherme (@willguibr)