zscaler.ziacloud.zia_cloud_application_instances_info module – Retrieves the list of cloud application instances

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

New in zscaler.ziacloud 2.0.0

Synopsis

  • Retrieves the list of cloud application instances

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"

instance_id

integer

Cloud application instance ID

instance_name

string

The cloud application instance name

instance_type

string

The cloud application instance type

Choices:

  • "SHAREPOINTONLINE"

  • "ONEDRIVE"

  • "BOXNET"

  • "OKTA"

  • "APPSPACE"

  • "BITBUCKET"

  • "GITHUB"

  • "SLACK"

  • "QUICK_BASE"

  • "ZEPLIN"

  • "SOURCEFORGE"

  • "ZOOM"

  • "WORKDAY"

  • "GDRIVE"

  • "GOOGLE_WEBMAIL"

  • "WINDOWS_LIVE_HOTMAIL"

  • "MSTEAM"

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: Gets all list of cloud application instances
  zscaler.ziacloud.zia_cloud_application_instances_info:
    provider: '{{ provider }}'
    instance_id: 124547686

- name: Gets a list of cloud application instances by instance name
  zscaler.ziacloud.zia_cloud_application_instances_info:
    provider: '{{ provider }}'
    instance_name: "example"

- name: Gets a list of cloud application instances by instance type
  zscaler.ziacloud.zia_cloud_application_instances_info:
    provider: '{{ provider }}'
    instance_type: "example"

Return Values

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

Key

Description

instances

list / elements=dictionary

A list of cloud application instances retrieved based on the filter criteria.

Returned: always

instance_id

integer

The unique identifier of the cloud application instance.

Returned: always

Sample: 1324545

instance_identifiers

list / elements=dictionary

A list of identifiers that define the instance.

Returned: always

identifier_type

string

The type of the identifier.

Returned: success

Sample: "URL"

instance_id

integer

The instance ID associated with the identifier.

Returned: success

Sample: 1324545

instance_identifier

string

The URL, keyword, or IP address that identifies the instance.

Returned: success

Sample: "sharepoint01.sharepoint.com"

instance_identifier_name

string

The friendly name of the identifier.

Returned: success

Sample: "sharepoint01"

modified_at

integer

The timestamp when the identifier was last modified (epoch).

Returned: success

modified_by

dictionary

Information about the user who last modified the identifier.

Returned: success

instance_name

string

The name of the cloud application instance.

Returned: always

Sample: "Instance01_Ansible"

instance_type

string

The type of cloud application instance.

Returned: always

Sample: "SHAREPOINTONLINE"

modified_at

integer

The timestamp when the instance was last modified (epoch).

Returned: always

Sample: 1746507565

modified_by

dictionary

Information about the user who last modified the instance.

Returned: always

extensions

dictionary

Additional metadata about the user.

Returned: success

external_id

boolean

Whether this user has an external identity.

Returned: success

Sample: false

id

integer

ID of the modifying user.

Returned: success

Sample: 19475409

name

string

Name of the modifying user.

Returned: success

Sample: "oauth-user@company.net"

Authors

  • William Guilherme (@willguibr)