zscaler.zpacloud.zpa_cloud_browser_isolation_banner_info module – Retrieve CBI Banners.

Note

This module is part of the zscaler.zpacloud collection (version 2.0.0).

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.zpacloud. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: zscaler.zpacloud.zpa_cloud_browser_isolation_banner_info.

New in zscaler.zpacloud 2.0.0

Synopsis

  • This module will allow the retrieval of CBI Banners.

Requirements

The below requirements are needed on the host that executes this module.

Parameters

Parameter

Comments

client_id

string

The client ID for OAuth2 authentication.

Required for OneAPI client authentication when use_legacy_client=false.

client_secret

string

The client secret for OAuth2 authentication.

Used for OneAPI client authentication when use_legacy_client=false and not using private_key.

cloud

string

The ZPA cloud provisioned for your organization.

Used for OneAPI client authentication when use_legacy_client=false.

Choices:

  • "BETA"

  • "GOV"

  • "GOVUS"

  • "PRODUCTION"

  • "QA"

  • "QA2"

  • "PREVIEW"

  • "beta"

  • "production"

customer_id

string

The ZPA tenant ID found in the Administration Company menu in the ZPA console.

Used for OneAPI client authentication when use_legacy_client=false.

id

string

ID of the server group.

microtenant_id

string

The ZPA Microtenant ID found in the Administration Company menu in the ZPA console.

Used for OneAPI client authentication when use_legacy_client=false.

name

string

Name of the server group.

private_key

string

The private key for JWT-based OAuth2 authentication.

Used for OneAPI client authentication when use_legacy_client=false and not using client_secret.

provider

dictionary

A dict containing authentication credentials.

client_id

string

The client ID for OAuth2 authentication.

Required for OneAPI client authentication when use_legacy_client=false.

client_secret

string

The client secret for OAuth2 authentication.

Used for OneAPI client authentication when use_legacy_client=false and not using private_key.

cloud

string

The ZPA cloud provisioned for your organization.

Used for OneAPI client authentication when use_legacy_client=false.

Choices:

  • "BETA"

  • "GOV"

  • "GOVUS"

  • "PRODUCTION"

  • "QA"

  • "QA2"

  • "PREVIEW"

  • "beta"

  • "production"

customer_id

string

The ZPA tenant ID found in the Administration Company menu in the ZPA console.

Used for OneAPI client authentication when use_legacy_client=false.

microtenant_id

string

The ZPA Microtenant ID found in the Administration Company menu in the ZPA console.

Used for OneAPI client authentication when use_legacy_client=false.

private_key

string

The private key for JWT-based OAuth2 authentication.

Used for OneAPI client authentication when use_legacy_client=false and not using client_secret.

use_legacy_client

boolean

Whether to use the legacy Zscaler API client.

When true, uses zpa_client_id/zpa_client_secret/zpa_customer_id/zpa_cloud for authentication.

When false (default), uses client_id/client_secret/private_key with vanity_domain for OAuth2 authentication.

Choices:

  • false ← (default)

  • true

vanity_domain

string

The vanity domain provisioned by Zscaler for OAuth2 flows.

Required for OneAPI client authentication when use_legacy_client=false.

zpa_client_id

string

The ZPA API client ID generated from the ZPA console.

Required for legacy client authentication when use_legacy_client=true.

zpa_client_secret

string

The ZPA API client secret generated from the ZPA console.

Required for legacy client authentication when use_legacy_client=true.

zpa_cloud

string

The ZPA cloud provisioned for your organization.

Required for legacy client authentication when use_legacy_client=true.

Choices:

  • "BETA"

  • "GOV"

  • "GOVUS"

  • "PRODUCTION"

  • "QA"

  • "QA2"

  • "PREVIEW"

  • "beta"

  • "production"

zpa_customer_id

string

The ZPA tenant ID found in the Administration Company menu in the ZPA console.

Required for legacy client authentication when use_legacy_client=true.

zpa_microtenant_id

string

The ZPA Microtenant ID found in the Administration Company menu in the ZPA console.

Used for legacy client authentication when use_legacy_client=true.

use_legacy_client

boolean

Whether to use the legacy Zscaler API client.

When true, uses zpa_client_id/zpa_client_secret/zpa_customer_id/zpa_cloud for authentication.

When false (default), uses client_id/client_secret/private_key with vanity_domain for OAuth2 authentication.

Choices:

  • false ← (default)

  • true

vanity_domain

string

The vanity domain provisioned by Zscaler for OAuth2 flows.

Required for OneAPI client authentication when use_legacy_client=false.

zpa_client_id

string

The ZPA API client ID generated from the ZPA console.

Required for legacy client authentication when use_legacy_client=true.

zpa_client_secret

string

The ZPA API client secret generated from the ZPA console.

Required for legacy client authentication when use_legacy_client=true.

zpa_cloud

string

The ZPA cloud provisioned for your organization.

Required for legacy client authentication when use_legacy_client=true.

Choices:

  • "BETA"

  • "GOV"

  • "GOVUS"

  • "PRODUCTION"

  • "QA"

  • "QA2"

  • "PREVIEW"

  • "beta"

  • "production"

zpa_customer_id

string

The ZPA tenant ID found in the Administration Company menu in the ZPA console.

Required for legacy client authentication when use_legacy_client=true.

zpa_microtenant_id

string

The ZPA Microtenant ID found in the Administration Company menu in the ZPA console.

Used for legacy client authentication when use_legacy_client=true.

Notes

Note

  • Check mode is not supported.

Examples

- name: Gather Information Details of All CBI Banners
  zscaler.zpacloud.zpa_cloud_browser_isolation_banner_info:
    provider: "{{ zpa_cloud }}"

- name: Gather Information Details of an CBI Banner by Name
  zscaler.zpacloud.zpa_cloud_browser_isolation_banner_info:
    provider: "{{ zpa_cloud }}"
    name: Example CBI Banner

- name: Gather Information Details of an CBI Banner  by ID
  zscaler.zpacloud.zpa_cloud_browser_isolation_banner_info:
    provider: "{{ zpa_cloud }}"
    id: "70132442-25f8-44eb-a5bb-caeaac67c201"

Return Values

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

Key

Description

banners

list / elements=dictionary

A list of dictionaries containing details about the specified CBI Banners. If a banner is found by ID or name, only that banner will be returned. If no filters are provided, all available CBI banners will be returned.

Returned: always

banner

boolean

Indicates if the banner is active.

Returned: success

Sample: true

id

string

The unique identifier of the CBI Banner.

Returned: success

Sample: "70132442-25f8-44eb-a5bb-caeaac67c201"

is_default

boolean

Indicates if this is the default system banner.

Returned: success

Sample: false

string

Base64-encoded logo image displayed in the banner.

Returned: success

Sample: "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAYQAAABQCAMAAAAuu/JsAAAD..."

name

string

The name of the CBI Banner.

Returned: success

Sample: "Example CBI Banner"

notification_text

string

Detailed message shown in the banner.

Returned: success

Sample: "The website you were trying to access is now rendered in a fully isolated environment to protect you from malicious content."

notification_title

string

Title of the notification shown in the banner.

Returned: success

Sample: "Heads up, you've been redirected to Browser Isolation!"

persist

boolean

Whether the banner should persist across sessions.

Returned: success

Sample: false

primary_color

string

Primary background color of the banner.

Returned: success

Sample: "#0076BE"

text_color

string

Text color used in the banner.

Returned: success

Sample: "#FFFFFF"

changed

boolean

Indicates if any changes were made.

Returned: always

Sample: false

failed

boolean

Indicates if the operation failed.

Returned: always

Sample: false

Authors

  • William Guilherme (@willguibr)