zscaler.ziacloud.zia_vzen_cluster module – Manages 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.

New in zscaler.ziacloud 1.0.0

Synopsis

  • Adds, updates, or removes Virtual Service Edge (VZEN) clusters.

  • Clusters group Virtual Service Edge instances for traffic forwarding.

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"

default_gateway

string

The IP address of the default gateway to the internet.

id

integer

System-generated Virtual Service Edge cluster ID.

Used to reference an existing cluster for update or delete.

ip_address

string

The Virtual Service Edge cluster IP address.

ip_sec_enabled

boolean

Whether to terminate IPSec traffic at selected Virtual Service Edge instances.

Choices:

  • false

  • true

name

string / required

Name of the Virtual Service Edge cluster.

Required for create.

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.

state

string

Specifies the desired state of the resource.

Choices:

  • "present" ← (default)

  • "absent"

status

string

Specifies the status of the Virtual Service Edge cluster.

Default is ENABLED.

Choices:

  • "ENABLED"

  • "DISABLED"

  • "DISABLED_BY_SERVICE_PROVIDER"

  • "NOT_PROVISIONED_IN_SERVICE_PROVIDER"

subnet_mask

string

The Virtual Service Edge cluster subnet mask.

type

string

The Virtual Service Edge cluster type.

Choices:

  • "ANY"

  • "NONE"

  • "SME"

  • "SMSM"

  • "SMCA"

  • "SMUI"

  • "SMCDS"

  • "SMDNSD"

  • "SMAA"

  • "SMTP"

  • "SMQTN"

  • "VIP"

  • "UIZ"

  • "UIAE"

  • "SITEREVIEW"

  • "PAC"

  • "S_RELAY"

  • "M_RELAY"

  • "H_MON"

  • "SMIKE"

  • "NSS"

  • "SMEZA"

  • "SMLB"

  • "SMFCCLT"

  • "SMBA"

  • "SMBAC"

  • "SMESXI"

  • "SMBAUI"

  • "VZEN"

  • "ZSCMCLT"

  • "SMDLP"

  • "ZSQUERY"

  • "ADP"

  • "SMCDSDLP"

  • "SMSCIM"

  • "ZSAPI"

  • "ZSCMCDSSCLT"

  • "LOCAL_MTS"

  • "SVPN"

  • "SMCASB"

  • "SMFALCONUI"

  • "MOBILEAPP_REG"

  • "SMRESTSVR"

  • "FALCONCA"

  • "MOBILEAPP_NF"

  • "ZIRSVR"

  • "SMEDGEUI"

  • "ALERTEVAL"

  • "ALERTNOTIF"

  • "SMPARTNERUI"

  • "CQM"

  • "DATAKEEPER"

  • "SMBAM"

  • "ZWACLT"

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.

virtual_zen_node_ids

list / elements=integer

List of Virtual Service Edge node IDs to include in the cluster.

Notes

Note

  • Check mode is supported.

  • Use id or name to reference an existing cluster for update/delete.

Examples

- name: Create a VZEN cluster
  zscaler.ziacloud.zia_vzen_cluster:
    provider: '{{ provider }}'
    name: "VZEN-Cluster-01"
    status: ENABLED
    ip_address: "192.168.100.100"
    subnet_mask: "255.255.255.0"
    default_gateway: "192.168.100.1"
    ip_sec_enabled: true
    virtual_zen_node_ids:
      - 123456
      - 123457

- name: Update a VZEN cluster by ID
  zscaler.ziacloud.zia_vzen_cluster:
    provider: '{{ provider }}'
    id: 1254654
    name: "VZEN-Cluster-Updated"
    status: DISABLED

- name: Delete a VZEN cluster
  zscaler.ziacloud.zia_vzen_cluster:
    provider: '{{ provider }}'
    id: 1254654
    state: absent

Return Values

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

Key

Description

data

dictionary

The VZEN cluster resource record.

Returned: on success

Authors

  • William Guilherme (@willguibr)