zscaler.ziacloud.zia_virtual_service_edge_node module – Adds a virtual service edge node.

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

New in zscaler.ziacloud 1.0.0

Synopsis

  • Adds a virtual service edge node.

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"

cluster_name

string

Virtual Service Edge cluster name.

default_gateway

string

The IP address of the default gateway to the internet.

Only IPv4 addresses are supported.

deployment_mode

string

Specifies the deployment mode.

Select either STANDALONE or CLUSTER if you have the VMware ESXi platform.

Otherwise, select only STANDALONE.

Choices:

  • "STANDALONE"

  • "CLUSTER"

establish_support_tunnel_enabled

boolean

A Boolean value that indicates whether or not a support tunnel for Zscaler Support is enabled.

Choices:

  • false

  • true

id

integer

The unique identifier for the Virtual Service Edge node.

Used to reference an existing node for update or delete operations.

in_production

boolean

Represents the Virtual Service Edge instances deployed for production purposes.

Choices:

  • false

  • true

ip_address

string

The Virtual Service Edge cluster IP address.

Only IPv4 addresses are supported.

ip_sec_enabled

boolean

A Boolean value that specifies whether to terminate IPSec traffic from the client at selected Virtual Service Edge instances for the Virtual Service Edge cluster.

Choices:

  • false

  • true

load_balancer_ip_address

string

The IP address of the load balancer.

This field is applicable only when the deployment_mode is set to CLUSTER.

name

string / required

Name of the Virtual Service Edge node.

on_demand_support_tunnel_enabled

boolean

A Boolean value that indicates whether or not the On-Demand Support Tunnel is enabled.

Choices:

  • false

  • true

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.

The status is set to ENABLED by default.

Choices:

  • "ENABLED"

  • "DISABLED"

  • "DISABLED_BY_SERVICE_PROVIDER"

  • "NOT_PROVISIONED_IN_SERVICE_PROVIDER"

  • "IN_TRIAL"

subnet_mask

string

The Virtual Service Edge cluster subnet mask (e.g. 255.255.255.0).

Only IPv4 addresses are supported.

type

string

The Virtual Service Edge cluster type.

For the complete list of supported types refer to the API documentation.

https://help.zscaler.com/zia/service-edges#/virtualZenNodes-post

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.

vzen_sku_type

string

The Virtual Service Edge SKU type.

Choices:

  • "SMALL"

  • "MEDIUM"

  • "LARGE"

Notes

Note

  • Check mode is supported.

Examples

- name: Create a Virtual Service Edge node with basic configuration
  zscaler.ziacloud.zia_virtual_service_edge_node:
    provider: '{{ provider }}'
    name: "VZEN-Example-01"
    status: ENABLED
    ip_address: "10.0.0.100"
    subnet_mask: "255.255.255.0"
    default_gateway: "10.0.0.1"
    type: "SMLB"
    deployment_mode: STANDALONE

- name: Create a Virtual Service Edge node with cluster deployment
  zscaler.ziacloud.zia_virtual_service_edge_node:
    provider: '{{ provider }}'
    status: ENABLED
    ip_address: "10.0.0.100"
    subnet_mask: "255.255.255.0"
    default_gateway: "10.0.0.1"
    type: "VZEN"
    deployment_mode: CLUSTER
    load_balancer_ip_address: "10.0.0.50"
    vzen_sku_type: LARGE
    ip_sec_enabled: false

- name: Update an existing Virtual Service Edge node by ID
  zscaler.ziacloud.zia_virtual_service_edge_node:
    provider: '{{ provider }}'
    id: 123456
    name: "VZEN-Updated"
    status: DISABLED

- name: Delete a Virtual Service Edge node
  zscaler.ziacloud.zia_virtual_service_edge_node:
    provider: '{{ provider }}'
    id: 123456
    state: absent

Return Values

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

Key

Description

data

dictionary

The Virtual Service Edge node resource record.

Returned: on success

default_gateway

string

The default gateway IP address.

Returned: success

id

integer

The unique identifier for the Virtual Service Edge node.

Returned: success

in_production

boolean

Whether the node is deployed for production.

Returned: success

ip_address

string

The Virtual Service Edge cluster IP address.

Returned: success

ip_sec_enabled

boolean

Whether IPSec traffic termination is enabled.

Returned: success

name

string

Name of the Virtual Service Edge node.

Returned: success

status

string

The status of the Virtual Service Edge cluster.

Returned: success

subnet_mask

string

The Virtual Service Edge cluster subnet mask.

Returned: success

type

string

The Virtual Service Edge cluster type.

Returned: success

Authors

  • William Guilherme (@willguibr)