zscaler.zpacloud.zpa_segment_group_info module – Retrieves information about a segment 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_segment_group_info.

New in zscaler.zpacloud 1.0.0

Synopsis

  • This module will allow the retrieval of information about a segment 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 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 Detail Information of All Segment Groups
  zscaler.zpacloud.zpa_segment_group_facts:
    provider: "{{ zpa_cloud }}"

- name: Get Details of a Segment Group by Name
  zscaler.zpacloud.zpa_segment_group_facts:
    provider: "{{ zpa_cloud }}"
    name: "Example"

- name: Get Details of a Segment Group by ID
  zscaler.zpacloud.zpa_segment_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 segment groups.

Returned: always

config_space

string

The configuration space where the segment group resides.

Returned: success

Sample: "DEFAULT"

creation_time

string

The timestamp when the segment group was created.

Returned: success

Sample: "1724111641"

description

string

A brief description of the segment group.

Returned: success

Sample: "Example200"

enabled

boolean

Indicates whether the segment group is enabled.

Returned: success

Sample: true

id

string

The unique identifier of the segment group.

Returned: success

Sample: "216199618143442000"

microtenant_name

string

The name of the microtenant associated with the segment group.

Returned: success

Sample: "Default"

modified_by

string

The ID of the user who last modified the segment group.

Returned: success

Sample: "216199618143191041"

modified_time

string

The timestamp when the segment group was last modified.

Returned: success

Sample: "1724111641"

name

string

The name of the segment group.

Returned: success

Sample: "Example200"

policy_migrated

boolean

Indicates if the policy associated with the segment group has been migrated.

Returned: success

Sample: true

tcp_keep_alive_enabled

boolean

Indicates whether TCP keep-alive is enabled for the segment group.

Returned: success

Sample: false

Authors

  • William Guilherme (@willguibr)