zscaler.zpacloud.zpa_provisioning_key_facts module – Retrieves details about a Provisioning Key.
Note
This module is part of the zscaler.zpacloud collection (version 1.1.0).
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_facts
.
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.
Zscaler SDK Python can be obtained from PyPI https://pypi.org/project/zscaler-sdk-python/
Parameters
Parameter |
Comments |
---|---|
The ZPA API client ID generated from the ZPA console. |
|
The ZPA API client secret generated from the ZPA console. |
|
The ZPA cloud provisioned for your organization. Choices:
|
|
The ZPA tenant ID found in the Administration Company menu in the ZPA console. |
|
ID of the provisioning key. |
|
Specifies the provisioning key type for App Connectors or ZPA Private Service Edges. The supported values are CONNECTOR_GRP and SERVICE_EDGE_GRP. Choices:
|
|
Name of the provisioning key. |
|
A dict object containing authentication details. |
|
The ZPA API client ID generated from the ZPA console. |
|
The ZPA API client secret generated from the ZPA console. |
|
The ZPA cloud provisioned for your organization. Choices:
|
|
The ZPA tenant ID found in the Administration Company menu in the ZPA console. |
Examples
- name: Gather Details of All service_edge Provisioning Keys
zscaler.zpacloud.zpa_provisioning_key_facts:
provider: "{{ zpa_cloud }}"
key_type: "service_edge"
- name: Gather Details of All service_edge Provisioning Keys by Name
zscaler.zpacloud.zpa_provisioning_key_facts:
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_facts:
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"