zscaler.zpacloud.zpa_app_protection_security_profile_info module – Retrieves App Protection Security Profile 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_security_profile_info.

New in zscaler.zpacloud 1.0.0

Synopsis

  • This module will allow the retrieval of information about an App Protection Profile 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 AppProtection profile.

name

string

Name of the App Protection Security Profile.

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.

Notes

Note

  • Check mode is not supported.

Examples

- name: Get Details of All App Protection profiles
  zscaler.zpacloud.zpa_app_protection_security_profile_facts:
    provider: "{{ zpa_cloud }}"

- name: Get Details of a Specific App Protection profiles by Name
  zscaler.zpacloud.zpa_app_protection_security_profile_facts:
    provider: "{{ zpa_cloud }}"
    name: Example

- name: Get Details of a specific App Protection profiles by ID
  zscaler.zpacloud.zpa_app_protection_security_profile_facts:
    provider: "{{ zpa_cloud }}"
    id: "216196257331282583"

Return Values

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

Key

Description

profiles

list / elements=dictionary

A list of dictionaries containing details about the App Protection Security Profiles.

Returned: always

api_profile

boolean

Indicates if the profile is an API profile.

Returned: success

Sample: false

controls_info

list / elements=dictionary

A list of controls associated with the profile, including type and count.

Returned: success

control_type

string

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

Returned: success

Sample: "PREDEFINED"

count

string

The number of controls of this type.

Returned: success

Sample: "207"

creation_time

string

The timestamp when the profile was created.

Returned: success

Sample: "1699401350"

description

string

A brief description of the App Protection Security Profile.

Returned: success

Sample: "BD_AppProtection_Profile1"

global_control_actions

list / elements=string

A list of global control actions associated with the profile.

Returned: success

Sample: ["PREDEFINED:NONE", "CUSTOM:NONE"]

id

string

The unique identifier of the App Protection Security Profile.

Returned: success

Sample: "216199618143270085"

incarnation_number

string

The incarnation number of the profile, which indicates version or iteration.

Returned: success

Sample: "6"

modified_by

string

The ID of the user who last modified the profile.

Returned: success

Sample: "216199618143191053"

modified_time

string

The timestamp when the profile was last modified.

Returned: success

Sample: "1720243144"

name

string

The name of the App Protection Security Profile.

Returned: success

Sample: "BD_AppProtection_Profile1"

paranoia_level

string

The paranoia level set for the profile, which affects the strictness of security checks.

Returned: success

Sample: "1"

Authors

  • William Guilherme (@willguibr)