zscaler.ziacloud.zia_browser_control_policy_info module – Gets the Browser Control policy settings

Note

This module is part of the zscaler.ziacloud collection (version 2.2.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_browser_control_policy_info.

New in zscaler.ziacloud 1.0.0

Synopsis

  • Retrieves the Browser Control policy settings for the organization.

  • Browser Control is a singleton resource; there is one policy per organization.

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:

  • "beta"

  • "production"

  • "zscaler"

  • "zscalerbeta"

  • "zscalergov"

  • "zscalerone"

  • "zscalerten"

  • "zscalerthree"

  • "zscalertwo"

  • "zscloud"

  • "zspreview"

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:

  • "beta"

  • "production"

  • "zscaler"

  • "zscalerbeta"

  • "zscalergov"

  • "zscalerone"

  • "zscalerten"

  • "zscalerthree"

  • "zscalertwo"

  • "zscloud"

  • "zspreview"

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: Get Browser Control policy settings
  zscaler.ziacloud.zia_browser_control_policy_info:
    provider: '{{ provider }}'

Return Values

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

Key

Description

policy

dictionary

The Browser Control policy settings.

Returned: always

allow_all_browsers

boolean

If true, allows all browsers and their versions access to the internet.

Returned: always

blocked_chrome_versions

list / elements=string

Versions of Google Chrome browser that need to be blocked. If not set, all allowed.

Returned: always

blocked_firefox_versions

list / elements=string

Versions of Mozilla Firefox browser that need to be blocked. If not set, all allowed.

Returned: always

blocked_internet_explorer_versions

list / elements=string

Versions of Microsoft browser that need to be blocked. If not set, all allowed.

Returned: always

blocked_opera_versions

list / elements=string

Versions of Opera browser that need to be blocked. If not set, all allowed.

Returned: always

blocked_safari_versions

list / elements=string

Versions of Apple Safari browser that need to be blocked. If not set, all allowed.

Returned: always

bypass_all_browsers

boolean

If true, all browsers are bypassed for warnings.

Returned: always

bypass_applications

list / elements=string

List of applications that need to be bypassed for warnings.

Has effect only if enable_warnings is true. If not set, all vulnerable applications are warned.

Returned: always

bypass_plugins

list / elements=string

List of plugins that need to be bypassed for warnings.

Has effect only if enable_warnings is true. If not set, all vulnerable plugins are warned.

Returned: always

enable_smart_browser_isolation

boolean

If true, Smart Browser Isolation is enabled.

Returned: always

enable_warnings

boolean

If true, warnings are enabled.

Returned: always

plugin_check_frequency

string

Specifies how frequently the service checks browsers and relevant applications to warn users regarding outdated or vulnerable browsers, plugins, and applications.

If not set, the warnings are disabled.

Returned: always

Sample: "DAILY"

smart_isolation_groups

list / elements=dictionary

List of groups for which the Smart Isolation rule is applied.

Returned: when available

smart_isolation_profile

dictionary

The browser isolation profile details.

Returned: when available

default_profile

boolean

Indicates whether this is a default browser isolation profile.

Returned: success

id

string

The UUID for the browser isolation profile.

Returned: success

name

string

Name of the browser isolation profile.

Returned: success

url

string

The browser isolation profile URL.

Returned: success

smart_isolation_profile_id

integer

The isolation profile ID.

Returned: when available

smart_isolation_users

list / elements=dictionary

List of users for which the Smart Isolation rule is applied.

Returned: when available

Authors

  • William Guilherme (@willguibr)