zscaler.ziacloud.zia_location_groups_info module – Gets locations only, not sub-locations.

Note

This module is part of the zscaler.ziacloud collection (version 2.0.3).

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.ziacloud. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: zscaler.ziacloud.zia_location_groups_info.

New in zscaler.ziacloud 1.0.0

Synopsis

  • Gets locations only, not sub-locations.

Requirements

The below requirements are needed on the host that executes this module.

Parameters

Parameter

Comments

api_key

string

A string that contains the obfuscated API key.

client_id

string

The client ID for OAuth2 authentication.

client_secret

string

The client secret for OAuth2 authentication.

cloud

string

The Zscaler cloud name provisioned for your organization.

Choices:

  • "zscloud"

  • "zscaler"

  • "zscalerone"

  • "zscalertwo"

  • "zscalerthree"

  • "zscalerbeta"

  • "zscalergov"

  • "zscalerten"

  • "beta"

  • "production"

comments

string

Additional comments or information about the location group.

group_type

string

The location group’s type (i.e., Static or Dynamic).

Choices:

  • "STATIC"

  • "DYNAMIC"

id

integer

Unique identifier for the location group

last_mod_user

string

The admin who modified the location group last.

location_id

integer

The unique identifier for a location within a location group.

name

string

The location group’s name.

password

string

A string that contains the password for the API admin.

private_key

string

The private key for JWT-based OAuth2 authentication.

provider

dictionary

A dict containing authentication credentials.

api_key

string

Obfuscated API key.

client_id

string

OAuth2 client ID.

client_secret

string

OAuth2 client secret.

cloud

string

Zscaler cloud name.

Choices:

  • "zscloud"

  • "zscaler"

  • "zscalerone"

  • "zscalertwo"

  • "zscalerthree"

  • "zscalerbeta"

  • "zscalergov"

  • "zscalerten"

  • "beta"

  • "production"

password

string

Password for the API admin.

private_key

string

Private key for OAuth2 JWT.

sandbox_cloud

string

Sandbox Cloud environment.

sandbox_token

string

Sandbox API Key.

use_legacy_client

boolean

Whether to use the legacy Zscaler API client.

Choices:

  • false ← (default)

  • true

username

string

Email ID of the API admin.

vanity_domain

string

Vanity domain for OAuth2.

sandbox_cloud

string

The Sandbox cloud environment for API access.

sandbox_token

string

A string that contains the Sandbox API Key.

use_legacy_client

boolean

Whether to use the legacy Zscaler API client.

Choices:

  • false ← (default)

  • true

username

string

A string that contains the email ID of the API admin.

vanity_domain

string

The vanity domain provisioned by Zscaler for OAuth2 flows.

version

integer

The version parameter is for Zscaler internal use only. The version is used by the service for backup operations.

Notes

Note

  • Check mode is not supported.

Examples

- name: Gather Information Details of all ZIA Locations
  zscaler.ziacloud.zia_location_groups_info:
    provider: '{{ provider }}'

- name: Gather Information Details of ZIA Location Group By ID
  zscaler.ziacloud.zia_location_groups_info:
    provider: '{{ provider }}'
    name: "845875645"

- name: Gather Information Details of ZIA Location Group By Name
  zscaler.ziacloud.zia_location_groups_info:
    provider: '{{ provider }}'
    name: "USA-SJC37"

- name: Gather Information Details of ZIA Location Group Type
  zscaler.ziacloud.zia_location_groups_info:
    provider: '{{ provider }}'
    group_type: STATIC

Return Values

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

Key

Description

locations

list / elements=dictionary

A list of location groups managed within the ZIA platform.

Returned: always

comments

string

Additional comments or information about the location group.

Returned: always

Sample: "SDWAN_CAN"

group_type

string

The location group’s type (i.e., Static or Dynamic).

Returned: always

Sample: "DYNAMIC_GROUP"

id

integer

The unique identifier for the location group.

Returned: always

Sample: 64365143

last_mod_time

string

Automatically populated with the current time, after a successful POST or PUT request.

Returned: always

Sample: "1676614490"

locations

list / elements=dictionary

The name of the location group.

Returned: always

Sample: "SDWAN_CAN"

name

string

The name of the location group.

Returned: always

Sample: "SDWAN_CAN"

predefined

boolean

Predefined location group

Returned: always

Sample: false

Authors

  • William Guilherme (@willguibr)