zscaler.ziacloud.zia_vzen_cluster_info module – Gets information about Virtual Service Edge clusters

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

New in zscaler.ziacloud 1.0.0

Synopsis

  • Gets Virtual Service Edge (VZEN) cluster configurations.

  • Retrieves a specific cluster by ID or name.

  • If neither id nor name is provided, lists all clusters.

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"

id

integer

System-generated Virtual Service Edge cluster ID.

name

string

Name of the Virtual Service Edge cluster.

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 all Virtual Service Edge clusters
  zscaler.ziacloud.zia_vzen_cluster_info:
    provider: '{{ provider }}'

- name: Get a VZEN cluster by ID
  zscaler.ziacloud.zia_vzen_cluster_info:
    provider: '{{ provider }}'
    id: 1254654

- name: Get a VZEN cluster by name
  zscaler.ziacloud.zia_vzen_cluster_info:
    provider: '{{ provider }}'
    name: "VZEN-Cluster-01"

Return Values

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

Key

Description

clusters

list / elements=dictionary

A list of Virtual Service Edge clusters fetched based on the given criteria.

Returned: always

default_gateway

string

The IP address of the default gateway.

Returned: when available

id

integer

System-generated Virtual Service Edge cluster ID.

Returned: always

ip_address

string

The cluster IP address.

Returned: when available

ip_sec_enabled

boolean

Whether IPSec traffic is terminated at selected instances.

Returned: when available

name

string

Name of the Virtual Service Edge cluster.

Returned: always

status

string

Status of the cluster (e.g., ENABLED, DISABLED).

Returned: when available

subnet_mask

string

The cluster subnet mask.

Returned: when available

type

string

The Virtual Service Edge cluster type.

Returned: when available

virtual_zen_nodes

list / elements=string

Virtual Service Edge instances in the cluster.

Returned: when available

Authors

  • William Guilherme (@willguibr)