zscaler.ziacloud.zia_location_management_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_management_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.

auth_required

boolean

Filter based on whether the Enforce Authentication setting is enabled or disabled for a location.

Choices:

  • false

  • true

bw_enforced

boolean

Filter based on whether Bandwith Control is being enforced for a location.

Choices:

  • false

  • true

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"

enable_iot

boolean

If set to true, the city field (containing IoT-enabled location IDs, names,

latitudes, and longitudes) and the iotDiscoveryEnabled filter are included in the response. Otherwise, they are not included.

Choices:

  • false

  • true

id

integer

The unique identifier for the location

name

string

The location 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.

ssl_scan_enabled

boolean

This parameter was deprecated and no longer has an effect on SSL policy.

Choices:

  • false

  • true

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.

xff_enabled

boolean

Filter based on whether the Enforce XFF Forwarding setting is enabled or disabled for a location.

Choices:

  • false

  • true

Notes

Note

  • Check mode is not supported.

Examples

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

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

- name: Gather Information Details of ZIA Location with Authentication Enabled
  zscaler.ziacloud.zia_location_management_info:
    provider: '{{ provider }}'
    auth_required: true

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 ZIA locations with detailed configuration settings.

Returned: always

aup_block_internet_until_accepted

boolean

Specifies if Internet access is blocked until the Acceptable Use Policy (AUP) is accepted.

Returned: always

Sample: false

aup_enabled

boolean

Indicates if Acceptable Use Policy (AUP) is enabled for the location.

Returned: always

Sample: false

aup_force_ssl_inspection

boolean

Indicates if SSL inspection is enforced when AUP is enabled.

Returned: always

Sample: false

aup_timeout_in_days

integer

The number of days before the AUP acceptance is timed out.

Returned: always

Sample: 0

auth_required

boolean

Indicates if authentication is required for this location.

Returned: always

Sample: true

caution_enabled

boolean

Indicates if caution is enabled for this location.

Returned: always

Sample: false

child_count

integer

The count of child locations under this location.

Returned: always

Sample: 0

cookies_and_proxy

boolean

Indicates if cookies and proxy are used for this location.

Returned: always

Sample: false

country

string

The country where the location is based.

Returned: always

Sample: "CANADA"

description

string

A description of the location.

Returned: always

Sample: "SJC_Location37"

digest_auth_enabled

boolean

Indicates if digest authentication is enabled for this location.

Returned: always

Sample: false

display_time_unit

string

The unit of time used to display time-related settings.

Returned: always

Sample: "HOUR"

dn_bandwidth

integer

The downstream bandwidth for this location in Mbps.

Returned: always

Sample: 10000

dynamiclocation_groups

list / elements=dictionary

A list of dynamic location groups associated with this location.

Returned: always

id

integer

The ID of the dynamic location group.

Returned: success

Sample: 44772848

name

string

The name of the dynamic location group.

Returned: success

Sample: "Corporate User Traffic Group"

ec_location

boolean

Indicates if this is an EC location.

Returned: always

Sample: false

exclude_from_dynamic_groups

boolean

Indicates if this location is excluded from dynamic groups.

Returned: always

Sample: false

exclude_from_manual_groups

boolean

Indicates if this location is excluded from manual groups.

Returned: always

Sample: false

geo_override

boolean

Indicates if geography override is enabled for this location.

Returned: always

Sample: false

id

string

The ID of the location.

Returned: always

Sample: "108668017"

idle_time_in_minutes

integer

The idle time in minutes before a session is considered inactive.

Returned: always

Sample: 480

ip_addresses

list / elements=string

A list of IP addresses associated with this location.

Returned: always

Sample: ["200.201.200.2"]

ips_control

boolean

Indicates if IPS control is enabled for this location.

Returned: always

Sample: true

name

string

The name of the location.

Returned: always

Sample: "USA-SJC37"

ofw_enabled

boolean

Indicates if OFW (On-the-Fly Whitelisting) is enabled for this location.

Returned: always

Sample: true

profile

string

The profile assigned to this location.

Returned: always

Sample: "CORPORATE"

ssl_scan_enabled

boolean

Indicates if SSL scanning is enabled for this location.

Returned: always

Sample: false

state

string

The state or province of the location.

Returned: always

Sample: "British Columbia"

tz

string

The timezone in which the location operates.

Returned: always

Sample: "CANADA_AMERICA_VANCOUVER"

up_bandwidth

integer

The upstream bandwidth for this location in Mbps.

Returned: always

Sample: 10000

xff_forward_enabled

boolean

Indicates if X-Forwarded-For header forwarding is enabled.

Returned: always

Sample: true

Authors

  • William Guilherme (@willguibr)