zscaler.ziacloud.zia_device_group_info module – Gets a list of device groups

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

New in zscaler.ziacloud 2.0.0

Synopsis

  • Gets a list of device groups.

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"

id

integer

The unique identifer for the device group.

include_device_info

boolean

Include or exclude device information.

Choices:

  • false

  • true

include_pseudo_groups

boolean

Include or exclude Zscaler Client Connector and Cloud Browser Isolation-related device groups.

Choices:

  • false

  • true

name

string

The device group 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.

Notes

Note

  • Check mode is not supported.

Examples

- name: Gather Information of all Device Group
  zscaler.ziacloud.zia_device_group_info:
    provider: '{{ provider }}'

- name: Gather Information of a Device Group by ID
  zscaler.ziacloud.zia_device_group_info:
    provider: '{{ provider }}'
    id: 1234598

- name: Gather Information of a Device Group by Name
  zscaler.ziacloud.zia_device_group_info:
    provider: '{{ provider }}'
    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

List of device groups.

Returned: always

group_type

string

The device group type.

Returned: always

Sample: "ZCC_OS"

id

integer

The unique identifer for the device group.

Returned: always

Sample: 3254355

name

string

The device group name.

Returned: always

Sample: "Windows"

os_type

string

The operating system (OS).

Returned: always

Sample: "Windows"

predefined

string

Indicates whether this is a predefined device group. If this value is set to true, the group is predefined.

Returned: always

Sample: "True"

Authors

  • William Guilherme (@willguibr)