zscaler.ziacloud.zia_cloud_app_control_rules_info module – Gets the list of cloud application rules by the type of rule..

Note

This module is part of the zscaler.ziacloud collection (version 1.3.1).

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

New in zscaler.ziacloud 1.3.0

Synopsis

  • Gets the list of cloud application rules by the type of rule..

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.

cloud

string

The Zscaler cloud name was provisioned for your organization.

Choices:

  • "zscloud"

  • "zscaler"

  • "zscalerone"

  • "zscalertwo"

  • "zscalerthree"

  • "zscalerbeta"

  • "zscalergov"

  • "zscalerten"

id

string

The universally unique identifier (UUID) for the browser isolation profile.

name

string

Name of the cloud application control rule.

password

string

A string that contains the password for the API admin.

provider

dictionary

A dict object containing connection details. This is optional; credentials can also be provided directly at the top level.

api_key

string

A string that contains the obfuscated API key.

cloud

string

The Zscaler cloud name was provisioned for your organization.

Choices:

  • "zscloud"

  • "zscaler"

  • "zscalerone"

  • "zscalertwo"

  • "zscalerthree"

  • "zscalerbeta"

  • "zscalergov"

  • "zscalerten"

password

string

A string that contains the password for the API admin.

sandbox_token

string

A string that contains the Sandbox API Key.

username

string

A string that contains the email ID of the API admin.

rule_type

string / required

The rule type selected from the available options.

Choices:

  • "SOCIAL_NETWORKING"

  • "STREAMING_MEDIA"

  • "WEBMAIL"

  • "INSTANT_MESSAGING"

  • "BUSINESS_PRODUCTIVITY"

  • "ENTERPRISE_COLLABORATION"

  • "SALES_AND_MARKETING"

  • "SYSTEM_AND_DEVELOPMENT"

  • "CONSUMER"

  • "HOSTING_PROVIDER"

  • "IT_SERVICES"

  • "FILE_SHARE"

  • "DNS_OVER_HTTPS"

  • "HUMAN_RESOURCES"

  • "LEGAL"

  • "HEALTH_CARE"

  • "FINANCE"

  • "CUSTOM_CAPP"

  • "AI_ML"

sandbox_token

string

A string that contains the Sandbox API Key.

username

string

A string that contains the email ID of the API admin.

Notes

Note

  • Check mode is not supported.

Examples

- name: Gather Information Details of a cloud application control rule by Name
  zscaler.ziacloud.zia_cloud_app_control_rules_info:
    provider: '{{ provider }}'
    name: "Webmail Rule-1"
    rule_type: "WEBMAIL"

Return Values

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

Key

Description

rules

list / elements=dictionary

A list of cloud application control rules that match the specified criteria.

Returned: always

Sample: [{"access_control": "READ_WRITE", "actions": ["ALLOW_WEBMAIL_VIEW", "ALLOW_WEBMAIL_ATTACHMENT_SEND"], "applications": ["GOOGLE_WEBMAIL", "YAHOO_WEBMAIL", "WINDOWS_LIVE_HOTMAIL"], "browser_eun_template_id": 0, "cascading_enabled": false, "enforce_time_validity": false, "eun_enabled": false, "eun_template_id": 0, "id": 552617, "name": "Webmail Rule-1", "order": 2, "predefined": false, "rank": 7, "state": "DISABLED", "type": "WEBMAIL"}]

Authors

  • William Guilherme (@willguibr)