zscaler.zpacloud.zpa_server_group_info module – Retrieves information about an server group

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

New in zscaler.zpacloud 1.0.0

Synopsis

• This module will allow the retrieval of information about a server group resource.

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
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 server group.
name string	Name of the server group.
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: Get Details of All Server Groups
  zscaler.zpacloud.zpa_server_group_facts:
    provider: "{{ zpa_cloud }}"

- name: Get Details of a Specific Server Group by Name
  zscaler.zpacloud.zpa_server_group_facts:
    provider: "{{ zpa_cloud }}"
    name: Example

- name: Get Details of a Specific Server Group by ID
  zscaler.zpacloud.zpa_server_group_facts:
    provider: "{{ zpa_cloud }}"
    id: "216196257331291969"

Return Values

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

Key	Description
groups list / elements=dictionary	A list of dictionaries containing details about the server groups. Returned: always
app_connector_groups list / elements=dictionary	A list of dictionaries containing details about the associated app connector groups. Returned: success
city_country string	The city and country where the app connector group is located. Returned: success Sample: "San Jose, US"
country_code string	The country code of the app connector group location. Returned: success Sample: "US"
description string	A brief description of the app connector group. Returned: success Sample: "test_zpa_app_connector_group_2n8Cq"
dns_query_type string	The DNS query type used by the app connector group. Returned: success Sample: "IPV4_IPV6"
enabled boolean	Indicates whether the app connector group is enabled. Returned: success Sample: true
id string	The unique identifier of the app connector group. Returned: success Sample: "216199618143441990"
location string	The specific location details of the app connector group. Returned: success Sample: "San Jose, CA, USA"
lss_app_connector_group boolean	Indicates if the app connector group is used for LSS (Log Streaming Service). Returned: success Sample: false
name string	The name of the app connector group. Returned: success Sample: "test_zpa_app_connector_group_2n8Cq"
override_version_profile boolean	Indicates if the version profile override is enabled. Returned: success Sample: true
pra_enabled boolean	Indicates if the app connector group has Private Routing Architecture (PRA) enabled. Returned: success Sample: false
tcp_quick_ack_app boolean	Indicates if TCP Quick ACK is enabled for the application. Returned: success Sample: false
tcp_quick_ack_assistant boolean	Indicates if TCP Quick ACK is enabled for the assistant. Returned: success Sample: false
tcp_quick_ack_read_assistant boolean	Indicates if TCP Quick ACK is enabled for reading assistant. Returned: success Sample: false
use_in_dr_mode boolean	Indicates if the app connector group is used in disaster recovery mode. Returned: success Sample: false
version_profile_id string	The version profile ID associated with the app connector group. Returned: success Sample: "0"
waf_disabled boolean	Indicates if Web Application Firewall (WAF) is disabled. Returned: success Sample: false
config_space string	The configuration space where the server group resides. Returned: success Sample: "DEFAULT"
creation_time string	The timestamp when the server group was created. Returned: success Sample: "1724111999"
description string	A brief description of the server group. Returned: success Sample: "Example200"
dynamic_discovery boolean	Indicates if dynamic discovery is enabled for the server group. Returned: success Sample: true
enabled boolean	Indicates whether the server group is enabled. Returned: success Sample: true
id string	The unique identifier of the server group. Returned: success Sample: "216199618143442001"
ip_anchored boolean	Indicates if the server group is IP anchored. Returned: success Sample: false
microtenant_name string	The name of the microtenant associated with the server group. Returned: success Sample: "Default"
modified_by string	The ID of the user who last modified the server group. Returned: success Sample: "216199618143191041"
modified_time string	The timestamp when the server group was last modified. Returned: success Sample: "1724111999"
name string	The name of the server group. Returned: success Sample: "Example200"

Authors

• William Guilherme (@willguibr)

Collection links

• Issue Tracker
• Repository (Sources)