zscaler.zpacloud.zpa_app_connector_group_info module – Retrieves an app connector group information

Note

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

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

New in zscaler.zpacloud 1.0.0

Synopsis

  • This module will allow the retrieval of information about an app connector group.

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 App Connector Group.

name

string

Name of the App Connector 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: Retrieve All App Connector Groups
  zscaler.zpacloud.zpa_app_connector_group_info:
    provider: "{{ zpa_cloud }}"

- name: Retrieve App Connector Group By Name
  zscaler.zpacloud.zpa_app_connector_group_info:
    provider: "{{ zpa_cloud }}"
    name: 'SJC037_App_Connector_Group'

- name: Retrieve App Connector Group By ID
  zscaler.zpacloud.zpa_app_connector_group_info:
    provider: "{{ zpa_cloud }}"
    name: '123456789'

Return Values

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

Key

Description

groups

list / elements=dictionary

Details of the ZPA App Connector Groups.

Returned: always

city_country

string

The city and country where the App Connector Group is located.

Returned: always

Sample: "San Jose, US"

country_code

string

The country code associated with the App Connector Group’s location.

Returned: always

Sample: "US"

creation_time

string

The creation time of the App Connector Group in epoch format.

Returned: always

Sample: "1724099105"

description

string

The description of the App Connector Group.

Returned: always

Sample: "test_zpa_app_connector_group_2n8Cq"

dns_query_type

string

The type of DNS query the App Connector Group supports.

Returned: always

Sample: "IPV4_IPV6"

enabled

boolean

Indicates whether the App Connector Group is enabled.

Returned: always

Sample: true

id

string

The unique identifier of the App Connector Group.

Returned: always

Sample: "216199618143441990"

latitude

string

The latitude coordinate of the App Connector Group’s location.

Returned: always

Sample: "37.33874"

location

string

The detailed location of the App Connector Group.

Returned: always

Sample: "San Jose, CA, USA"

longitude

string

The longitude coordinate of the App Connector Group’s location.

Returned: always

Sample: "-121.8852525"

lss_app_connector_group

boolean

Indicates if the group is an LSS App Connector Group.

Returned: always

Sample: false

microtenant_name

string

The name of the microtenant associated with the App Connector Group.

Returned: always

Sample: "Default"

modified_by

string

The ID of the user who last modified the App Connector Group.

Returned: always

Sample: "216199618143191053"

modified_time

string

The last modified time of the App Connector Group in epoch format.

Returned: always

Sample: "1724099105"

name

string

The name of the App Connector Group.

Returned: always

Sample: "test_zpa_app_connector_group_2n8Cq"

override_version_profile

boolean

Indicates if the version profile is overridden.

Returned: always

Sample: true

pra_enabled

boolean

Indicates if Proxy Rule Action (PRA) is enabled for the group.

Returned: always

Sample: false

tcp_quick_ack_app

boolean

Indicates if TCP Quick ACK is enabled for applications.

Returned: always

Sample: false

tcp_quick_ack_assistant

boolean

Indicates if TCP Quick ACK is enabled for the assistant.

Returned: always

Sample: false

tcp_quick_ack_read_assistant

boolean

Indicates if TCP Quick ACK is enabled for reading from the assistant.

Returned: always

Sample: false

upgrade_day

string

The scheduled day for upgrades of the App Connector Group.

Returned: always

Sample: "SUNDAY"

upgrade_priority

string

The upgrade priority for the App Connector Group.

Returned: always

Sample: "WEEK"

upgrade_time_in_secs

string

The upgrade time in seconds for the App Connector Group.

Returned: always

Sample: "66600"

use_in_dr_mode

boolean

Indicates if the group is used in Disaster Recovery mode.

Returned: always

Sample: false

version_profile_id

string

The version profile ID associated with the App Connector Group.

Returned: always

Sample: "0"

version_profile_name

string

The name of the version profile associated with the App Connector Group.

Returned: always

Sample: "Default"

version_profile_visibility_scope

string

The visibility scope of the version profile.

Returned: always

Sample: "ALL"

waf_disabled

boolean

Indicates if Web Application Firewall (WAF) is disabled for the group.

Returned: always

Sample: false

Authors

  • William Guilherme (@willguibr)