zscaler.ziacloud.zia_cloud_applications_info module – Retrieves a list of Predefined and User Defined Cloud Applications

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

New in zscaler.ziacloud 2.0.0

Synopsis

  • Retrieves a list of Predefined and User Defined Cloud Applications associated with the DLP rules

  • Cloud App Control rules, Advanced Settings, Bandwidth Classes, and File Type Control rules

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.

app_class

string

Filter application by application category.

Choices:

  • "WEB_MAIL"

  • "SOCIAL_NETWORKING"

  • "STREAMING"

  • "P2P"

  • "INSTANT_MESSAGING"

  • "WEB_SEARCH"

  • "GENERAL_BROWSING"

  • "ADMINISTRATION"

  • "ENTERPRISE_COLLABORATION"

  • "BUSINESS_PRODUCTIVITY"

  • "SALES_AND_MARKETING"

  • "SYSTEM_AND_DEVELOPMENT"

  • "CONSUMER"

  • "FILE_SHARE"

  • "HOSTING_PROVIDER"

  • "IT_SERVICES"

  • "DNS_OVER_HTTPS"

  • "HUMAN_RESOURCES"

  • "LEGAL"

  • "HEALTH_CARE"

  • "FINANCE"

  • "CUSTOM_CAPP"

  • "AI_ML"

app_name

string

Cloud application name

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"

group_results

boolean

Show count of applications grouped by application category

Choices:

  • false

  • true

mode

string / required

Type of supported application to be filtered.

Choices:

  • "app_policy"

  • "ssl_policy"

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 a list of all groups
  zscaler.ziacloud.zia_cloud_applications_info:
    provider: '{{ provider }}'
    mode: ssl_policy
    app_class: WEB_MAIL
    group_results: false

Return Values

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

Key

Description

applications

list / elements=dictionary

Retrieves a list of Predefined and User Defined Cloud Applications

Returned: always

app

string

Application enum constant

Returned: success

Sample: "GOOGLE_WEBMAIL"

app_name

string

Cloud application name

Returned: success

Sample: "Gmail"

parent

string

Application category enum constant

Returned: success

Sample: "WEB_MAIL"

parent_name

string

Name of the cloud application category

Returned: success

Sample: "Web Mail"

Authors

  • William Guilherme (@willguibr)