zscaler.zpacloud.zpa_customer_version_profile_info module – Retrieves visible version profiles.

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

New in zscaler.zpacloud 1.0.0

Synopsis

  • This module will allow the retrieval visible version profiles to be associated with app connector groups.

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 version profile.

name

string

The name of the version 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: Gather Details of All Visible Version Profiles
  zscaler.zpacloud.zpa_customer_version_profile_info:
    provider: "{{ zpa_cloud }}"

- name: Gather Details of a Specific Visible Version Profiles by Name
  zscaler.zpacloud.zpa_customer_version_profile_info:
    provider: "{{ zpa_cloud }}"
    name: crm.acme.com

- name: Gather Details of a Specific Visible Version Profiles by ID
  zscaler.zpacloud.zpa_customer_version_profile_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

profiles

list / elements=dictionary

List of version profiles based on the search criteria or all available profiles if no criteria are provided.

Returned: always

creation_time

string

The Unix timestamp when the profile was created.

Returned: always

customer_id

string

The unique identifier for the customer to whom the profile belongs.

Returned: always

id

string

The unique identifier for the profile.

Returned: always

modified_by

string

The unique identifier of the user who last modified the profile.

Returned: always

modified_time

string

The Unix timestamp when the profile was last modified.

Returned: always

name

string

The name of the profile.

Returned: always

upgrade_priority

string

The priority of upgrades for this profile, which can be ‘WEEK’, ‘DAY’, or other intervals.

Returned: always

visibility_scope

string

The scope of visibility for the profile, such as ‘ALL’, ‘NONE’, or other specific scopes.

Returned: always

Authors

  • William Guilherme (@willguibr)