zscaler.zpacloud.zpa_app_protection_predefined_control_info module – Retrieves App Protection Predefined Control information.

Note

This module is part of the zscaler.zpacloud collection (version 1.4.2).

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.zpacloud. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: zscaler.zpacloud.zpa_app_protection_predefined_control_info.

New in zscaler.zpacloud 1.0.0

Synopsis

  • This module will allow the retrieval of information about an App Protection Predefined Control from the ZPA Cloud.

Requirements

The below requirements are needed on the host that executes this module.

Parameters

Parameter

Comments

client_id

string

The ZPA API client ID generated from the ZPA console.

client_secret

string

The ZPA API client secret generated from the ZPA console.

cloud

string

The ZPA cloud provisioned for your organization.

Choices:

  • "PRODUCTION"

  • "BETA"

  • "QA"

  • "QA2"

  • "GOV"

  • "GOVUS"

  • "PREVIEW"

  • "ZPATWO"

customer_id

string

The ZPA tenant ID found in the Administration Company menu in the ZPA console.

id

string

The unique identifier of the predefined control.

name

string

Name of the App Protection predefined control.

provider

dictionary

A dict object containing authentication details.

client_id

string

The ZPA API client ID generated from the ZPA console.

client_secret

string

The ZPA API client secret generated from the ZPA console.

cloud

string

The ZPA cloud provisioned for your organization.

Choices:

  • "PRODUCTION"

  • "BETA"

  • "QA"

  • "QA2"

  • "GOV"

  • "GOVUS"

  • "PREVIEW"

  • "ZPATWO"

customer_id

string

The ZPA tenant ID found in the Administration Company menu in the ZPA console.

version

string

The predefined control version.

Default: "OWASP_CRS/3.3.0"

Notes

Note

  • Check mode is not supported.

Examples

- name: Get Details of All App Protection Predefined Control
  zscaler.zpacloud.zpa_app_protection_predefined_control_info:
    provider: "{{ zpa_cloud }}"

- name: Get Details of a Specific App Predefined Control by Name
  zscaler.zpacloud.zpa_app_protection_predefined_control_info:
    provider: "{{ zpa_cloud }}"
    name: Example

- name: Get Details of a specific App Predefined Control by ID
  zscaler.zpacloud.zpa_app_protection_predefined_control_info:
    provider: "{{ zpa_cloud }}"
    id: "216196257331282583"

Return Values

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

Key

Description

controls

list / elements=dictionary

A list of dictionaries containing details about the App Protection Predefined Controls.

Returned: always

control_group

string

The group to which the control belongs (e.g., Protocol Issues).

Returned: success

Sample: "Protocol Issues"

default_group

boolean

Indicates if this is a default control group.

Returned: success

Sample: false

predefined_inspection_controls

list / elements=dictionary

A list of predefined inspection controls under the control group.

Returned: success

associated_inspection_profile_names

list / elements=dictionary

A list of associated inspection profile names that use this control.

Returned: success

id

string

The unique identifier of the inspection profile.

Returned: success

Sample: "216199618143270390"

name

string

The name of the inspection profile.

Returned: success

Sample: "BD_SA_Profile1"

control_number

string

The control number.

Returned: success

Sample: "200002"

control_type

string

The type of control (e.g., PREDEFINED).

Returned: success

Sample: "PREDEFINED"

creation_time

string

The timestamp when the control was created.

Returned: success

Sample: "1631459708"

default_action

string

The default action for this control.

Returned: success

Sample: "BLOCK"

description

string

A brief description of the predefined control.

Returned: success

Sample: "Failed to parse request body"

id

string

The unique identifier of the predefined control.

Returned: success

Sample: "72057594037930388"

modified_time

string

The timestamp when the control was last modified.

Returned: success

Sample: "1631459708"

name

string

The name of the predefined control.

Returned: success

Sample: "Failed to parse request body"

paranoia_level

string

The paranoia level associated with the control.

Returned: success

Sample: "1"

protocol_type

string

The protocol type associated with the control.

Returned: success

Sample: "HTTP"

severity

string

The severity level of the control.

Returned: success

Sample: "CRITICAL"

version

string

The version of the control.

Returned: success

Sample: "OWASP_CRS/3.3.0"

Authors

  • William Guilherme (@willguibr)