zscaler.ziacloud.zia_devices_info module – Gets a list of devices

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

New in zscaler.ziacloud 2.0.0

Synopsis

  • Gets a list of devices

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"

device_group_id

integer

The unique identifier for the device group

id

integer

The unique identifier for the device

include_all

boolean

Used to include or exclude Cloud Browser Isolation devices

Choices:

  • false

  • true

model

string

The device models

name

string

The device name

os_type

string

The operating system (OS)

Choices:

  • "ANY"

  • "OTHER_OS"

  • "IOS"

  • "ANDROID_OS"

  • "WINDOWS_OS"

  • "MAC_OS"

  • "LINUX"

os_version

string

The device’s operating system version

owner

string

The device owners

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.

search_all

string

Used to match against all device attribute information

use_legacy_client

boolean

Whether to use the legacy Zscaler API client.

Choices:

  • false ← (default)

  • true

user_ids

list / elements=integer

Used to list devices for specific users

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 Devices
  zscaler.ziacloud.zia_devices_info:
    provider: '{{ provider }}'

- name: Gather Information of a Device by ID
  zscaler.ziacloud.zia_devices_info:
    provider: '{{ provider }}'
    id: 79215323

- name: Gather Information of a Device by Name
  zscaler.ziacloud.zia_devices_info:
    provider: '{{ provider }}'
    name: ManufactoringDevice

Return Values

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

Key

Description

devices

list / elements=dictionary

List of devices

Returned: always

id

integer

The unique identifier for the device

Returned: always

Sample: 79215323

include_all

boolean

Used to include or exclude Cloud Browser Isolation devices

Returned: always

Sample: false

model

string

The device models

Returned: always

Sample: "VMware Virtual Platform"

name

string

The device name

Returned: always

Sample: "Sample_IP_Destination_Group"

os_type

string

The operating system (OS)

Returned: always

Sample: "WINDOWS_OS"

os_version

string

The device’s operating system version

Returned: always

Sample: "Microsoft Windows 10 Pro;64 bit;amd64"

owner

string

The device owners

Returned: always

Sample: "John Doe"

search_all

string

Used to match against all device attribute information

Returned: always

Sample: "[]"

user_ids

list / elements=string

Used to list devices for specific users

Returned: always

Sample: []

Authors

  • William Guilherme (@willguibr)