zscaler.zpacloud.zpa_provisioning_key_info module – Retrieves details about a Provisioning Key.

Note

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

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

New in zscaler.zpacloud 1.0.0

Synopsis

  • This module will allow the retrieval of information abouta Provisioning Key by association type (CONNECTOR_GRP or SERVICE_EDGE_GRP).

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 provisioning key.

key_type

string / required

Specifies the provisioning key type for App Connectors or ZPA Private Service Edges.

The supported values are CONNECTOR_GRP and SERVICE_EDGE_GRP.

Choices:

  • "connector"

  • "service_edge"

name

string

Name of the provisioning key.

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 service_edge Provisioning Keys
  zscaler.zpacloud.zpa_provisioning_key_info:
    provider: "{{ zpa_cloud }}"
    key_type: "service_edge"

- name: Gather Details of All service_edge Provisioning Keys by Name
  zscaler.zpacloud.zpa_provisioning_key_info:
    provider: "{{ zpa_cloud }}"
    name: "Example Service Edge Group"
    key_type: "service_edge"

- name: Gather Details of All connector Provisioning Keys
  zscaler.zpacloud.zpa_provisioning_key_info:
    provider: "{{ zpa_cloud }}"
    key_type: "connector"

- name: Gather Details of All connector Provisioning Keys by Name
  zscaler.zpacloud.zpa_provisioning_key_facts:
    provider: "{{ zpa_cloud }}"
    name: "Example Service Edge Group"
    key_type: "connector"

Return Values

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

Key

Description

changed

boolean

Indicates if any changes were made.

Returned: always

Sample: false

failed

boolean

Indicates if the operation failed.

Returned: always

Sample: false

provisioning_keys

list / elements=dictionary

Details of the provisioning keys that match the criteria.

Returned: always

creation_time

string

The time when the provisioning key was created, in epoch format.

Returned: success

Sample: "1724115868"

enabled

boolean

Indicates if the provisioning key is enabled.

Returned: success

Sample: true

enrollment_cert_id

string

The ID of the associated enrollment certificate.

Returned: success

Sample: "16560"

enrollment_cert_name

string

The name of the associated enrollment certificate.

Returned: success

Sample: "Connector"

id

string

The unique identifier of the provisioning key.

Returned: success

Sample: "38108"

max_usage

string

The maximum number of times the provisioning key can be used.

Returned: success

Sample: "10"

modified_by

string

The ID of the user who last modified the provisioning key.

Returned: success

Sample: "216199618143191041"

modified_time

string

The time when the provisioning key was last modified, in epoch format.

Returned: success

Sample: "1724115868"

name

string

The name of the provisioning key.

Returned: success

Sample: "Provisioning_Key01"

provisioning_key

string

The actual provisioning key value.

Returned: success

Sample: "3|api.private.zscaler.com|Befsgew"

usage_count

string

The number of times the provisioning key has been used.

Returned: success

Sample: "0"

zcomponent_id

string

The ID of the associated component (App Connector Group or Service Edge Group).

Returned: success

Sample: "216199618143441990"

zcomponent_name

string

The name of the associated component (App Connector Group or Service Edge Group).

Returned: success

Sample: "test_zpa_app_connector_group_2n8Cq"

Authors

  • William Guilherme (@willguibr)