zscaler.zpacloud.zpa_service_edge_groups_info module – Retrieves information about a Service Edge Group.

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

New in zscaler.zpacloud 1.0.0

Synopsis

  • This module will allow the retrieval of information about a Service Edge Group resource.

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 Service Edge Group.

name

string

Name of the Service Edge 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 information about all Service Edge Groups
  zscaler.zpacloud.zpa_service_edge_groups_info:
    provider: "{{ zpa_cloud }}"

- name: Get information about Service Edge Connector Group by ID
  zscaler.zpacloud.zpa_service_edge_groups_info:
    provider: "{{ zpa_cloud }}"
    id: "198288282"

- name: Get information about Service Edge Connector Group by Name
  zscaler.zpacloud.zpa_service_edge_groups_info:
    provider: "{{ zpa_cloud }}"
    name: "Example"

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 Service Edge Groups.

Returned: always

city_country

string

The city and country where the Service Edge Group is located.

Returned: success

Sample: "San Jose, US"

country_code

string

The country code of the Service Edge Group location.

Returned: success

Sample: "US"

creation_time

string

The timestamp when the Service Edge Group was created.

Returned: success

Sample: "1724112382"

enabled

boolean

Indicates whether the Service Edge Group is enabled.

Returned: success

Sample: true

grace_distance_enabled

boolean

Indicates if grace distance is enabled for the Service Edge Group.

Returned: success

Sample: false

grace_distance_value_unit

string

The unit of measure for the grace distance value.

Returned: success

Sample: "MILES"

id

string

The unique identifier of the Service Edge Group.

Returned: success

Sample: "216199618143442002"

is_public

string

Indicates whether the Service Edge Group is public.

Returned: success

Sample: "FALSE"

latitude

string

The latitude of the Service Edge Group’s location.

Returned: success

Sample: "37.33874"

location

string

The specific location details of the Service Edge Group.

Returned: success

Sample: "San Jose, CA, USA"

longitude

string

The longitude of the Service Edge Group’s location.

Returned: success

Sample: "-121.8852525"

microtenant_name

string

The name of the microtenant associated with the Service Edge Group.

Returned: success

Sample: "Default"

modified_by

string

The ID of the user who last modified the Service Edge Group.

Returned: success

Sample: "216199618143191041"

modified_time

string

The timestamp when the Service Edge Group was last modified.

Returned: success

Sample: "1724112382"

name

string

The name of the Service Edge Group.

Returned: success

Sample: "Example200"

override_version_profile

boolean

Indicates if the version profile override is enabled.

Returned: success

Sample: false

upgrade_day

string

The day of the week scheduled for upgrades.

Returned: success

Sample: "MONDAY"

upgrade_priority

string

The priority assigned for upgrades.

Returned: success

Sample: "WEEK"

upgrade_time_in_secs

string

The time in seconds when the upgrade is scheduled.

Returned: success

Sample: "25200"

use_in_dr_mode

boolean

Indicates if the Service Edge Group is used in disaster recovery mode.

Returned: success

Sample: false

version_profile_id

string

The version profile ID associated with the Service Edge Group.

Returned: success

Sample: "0"

version_profile_name

string

The version profile name associated with the Service Edge Group.

Returned: success

Sample: "Default"

version_profile_visibility_scope

string

The scope of visibility for the version profile.

Returned: success

Sample: "ALL"

Authors

  • William Guilherme (@willguibr)