zscaler.zpacloud.zpa_lss_client_types_facts module – Retrieves Log Streaming Service (LSS) Client Types information from ZPA Cloud.

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

New in zscaler.zpacloud 1.0.0

Synopsis

  • This module queries ZPA Cloud to retrieve information about different Log Streaming Service (LSS) Client Types.

  • The retrieved data can be used in conjunction with the source_log_type parameter for configuring LSS Resources.

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.

client_type

string

Specifies a specific type of LSS client for which information is to be retrieved.

If not specified, the module retrieves information for all available LSS client types.

Choices:

  • "zpn_client_type_exporter"

  • "zpn_client_type_machine_tunnel"

  • "zpn_client_type_ip_anchoring"

  • "zpn_client_type_edge_connector"

  • "zpn_client_type_zapp"

  • "zpn_client_type_slogger"

  • "zpn_client_type_zapp_partner"

  • "zpn_client_type_branch_connector"

  • "zpn_client_type_zia_inspection"

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.

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.

Examples

- name: Retrieve information about all LSS Client Types
  zscaler.zpacloud.zpa_lss_client_types_facts:
    provider: "{{ zpa_cloud }}"

- name: Retrieve information about a specific LSS Client Type (e.g., 'zpn_client_type_exporter')
  zscaler.zpacloud.zpa_lss_client_types_facts:
    provider: "{{ zpa_cloud }}"
    name: zpn_client_type_exporter

Authors

  • William Guilherme (@willguibr)