zscaler.ziacloud.zia_extranet module – Manages ZIA extranet configurations

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

New in zscaler.ziacloud 1.0.0

Synopsis

  • Adds, updates, or removes extranet configurations for traffic forwarding.

  • Extranets define DNS servers and IP pools for traffic selectors.

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"

description

string

The description of the extranet.

Maximum 10240 characters.

extranet_dns_list

list / elements=dictionary

DNS servers specified for the extranet.

id

integer

The ID for an existing DNS config (update only).

name

string / required

The name of the DNS server.

primary_dns_server

string / required

The IP address of the primary DNS server.

secondary_dns_server

string

The IP address of the secondary DNS server.

use_as_default

boolean

Whether this DNS configuration is the designated default.

Choices:

  • false ← (default)

  • true

extranet_ip_pool_list

list / elements=dictionary

Traffic selector IP pools specified for the extranet.

id

integer

The ID for an existing IP pool (update only).

ip_end

string / required

The ending IP address of the pool.

ip_start

string / required

The starting IP address of the pool.

name

string / required

The name of the IP pool.

use_as_default

boolean

Whether this IP pool is the designated default.

Choices:

  • false ← (default)

  • true

id

integer

The unique identifier for the extranet.

Used to reference an existing extranet for update or delete.

name

string / required

The name of the extranet.

Required for create. Maximum 255 characters.

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"

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

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

Examples

- name: Create an extranet
  zscaler.ziacloud.zia_extranet:
    provider: '{{ provider }}'
    name: "My Extranet"
    description: "Extranet for branch offices"
    extranet_dns_list:
      - name: "DNS Primary"
        primary_dns_server: "8.8.8.8"
        secondary_dns_server: "4.4.2.2"
        use_as_default: true
    extranet_ip_pool_list:
      - name: "Pool 1"
        ip_start: "192.168.200.1"
        ip_end: "192.168.200.100"
        use_as_default: true

- name: Update an extranet by ID
  zscaler.ziacloud.zia_extranet:
    provider: '{{ provider }}'
    id: 12345
    name: "Updated Extranet Name"
    description: "Updated description"

- name: Delete an extranet
  zscaler.ziacloud.zia_extranet:
    provider: '{{ provider }}'
    id: 12345
    state: absent

Return Values

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

Key

Description

data

dictionary

The extranet resource record.

Returned: on success

Authors

  • William Guilherme (@willguibr)