zscaler.zpacloud.zpa_posture_profile_info module – Retrieves details of a posture profile resource.

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

New in zscaler.zpacloud 1.0.0

Synopsis

  • This module will allow the retrieval of information about a posture profile resource.

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

ID of the posture profile.

name

string

Name of the posture 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 Information About All Posture Profiles
  zscaler.zpacloud.zpa_posture_profile_facts:
    provider: "{{ zpa_cloud }}"

- name: Get Details of a Specific Posture Profile by ID
  zscaler.zpacloud.zpa_posture_profile_facts:
    provider: "{{ zpa_cloud }}"
    id: "216196257331282583"

- name: Get Details of a Specific Posture Profile by Name
  zscaler.zpacloud.zpa_posture_profile_facts:
    provider: "{{ zpa_cloud }}"
    name: CrowdStrike_ZPA_Pre-ZTA

Return Values

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

Key

Description

profiles

list / elements=dictionary

Details of the Posture Profiles.

Returned: always

apply_to_machine_tunnel_enabled

boolean

Indicates if the posture profile applies to machine tunnels.

Returned: always

Sample: false

creation_time

string

The time when the Posture Profile was created, in epoch format.

Returned: always

Sample: "1652337552"

crl_check_enabled

boolean

Indicates if Certificate Revocation List (CRL) check is enabled.

Returned: always

Sample: false

id

string

The unique identifier of the Posture Profile.

Returned: always

Sample: "216199618143191254"

modified_by

string

The ID of the user who last modified the Posture Profile.

Returned: always

Sample: "72057594037928115"

modified_time

string

The time when the Posture Profile was last modified, in epoch format.

Returned: always

Sample: "1652337552"

name

string

The name of the Posture Profile.

Returned: always

Sample: "CrowdStrike_ZPA_Pre-ZTA (zscalertwo.net)"

non_exportable_private_key_enabled

boolean

Indicates if non-exportable private keys are enabled for the profile.

Returned: always

Sample: false

posture_udid

string

The Universal Device Identifier (UDID) associated with the posture profile.

Returned: always

Sample: "e2538bb9-af91-49bc-98ea-e90bbe048203"

zscaler_cloud

string

The Zscaler cloud where the posture profile is applied.

Returned: always

Sample: "zscalertwo"

Authors

  • William Guilherme (@willguibr)