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

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

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.

Notes

Note

  • Check mode is not supported.

Examples

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

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

Return Values

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

Key

Description

data

dictionary

A dictionary mapping of Log Streaming Service (LSS) Client Types and their respective identifiers.

Returned: always

branch_connector

string

Identifier for the Branch Connector client type.

Returned: success

Sample: "zpn_client_type_branch_connector"

client_connector

string

Identifier for the Client Connector client type (Zscaler App).

Returned: success

Sample: "zpn_client_type_zapp"

client_connector_partner

string

Identifier for the Client Connector Partner client type.

Returned: success

Sample: "zpn_client_type_zapp_partner"

cloud_connector

string

Identifier for the Cloud Connector client type (Edge Connector).

Returned: success

Sample: "zpn_client_type_edge_connector"

machine_tunnel

string

Identifier for the Machine Tunnel client type.

Returned: success

Sample: "zpn_client_type_machine_tunnel"

web_browser

string

Identifier for the Web Browser client type.

Returned: success

Sample: "zpn_client_type_exporter"

zia_inspection

string

Identifier for the ZIA Inspection client type.

Returned: success

Sample: "zpn_client_type_zia_inspection"

zia_service_edge

string

Identifier for the ZIA Service Edge client type.

Returned: success

Sample: "zpn_client_type_ip_anchoring"

zpa_lss

string

Identifier for the ZPA Log Streaming Service (LSS) client type.

Returned: success

Sample: "zpn_client_type_slogger"

zsdk_pre_login_tunnel

string

Identifier for the Zscaler SDK Pre-Login Tunnel client type.

Returned: success

Sample: "zpn_client_type_simple_zsdk"

zsdk_zero_trust_tunnel

string

Identifier for the Zscaler SDK Zero Trust Tunnel client type.

Returned: success

Sample: "zpn_client_type_zsdk"

Authors

  • William Guilherme (@willguibr)