zscaler.ziacloud.zia_ip_source_anchoring_zpa_gateway module – Manages ZPA Gateways within Zscaler Internet Access

Note

This module is part of the zscaler.ziacloud collection (version 1.3.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.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_ip_source_anchoring_zpa_gateway.

New in zscaler.ziacloud 1.0.0

Synopsis

  • This module adds or updates a ZPA Gateway within Zscaler Internet Access (ZIA).

  • It allows for the configuration of server groups and application segments for source IP anchoring.

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.

cloud

string

The Zscaler cloud name was provisioned for your organization.

Choices:

  • "zscloud"

  • "zscaler"

  • "zscalerone"

  • "zscalertwo"

  • "zscalerthree"

  • "zscalerbeta"

  • "zscalergov"

  • "zscalerten"

description

string

Additional details about the ZPA gateway.

id

integer

Unique identifier for the ZPA gateway.

name

string / required

Name of the ZPA gateway.

password

string

A string that contains the password for the API admin.

provider

dictionary

A dict object containing connection details. This is optional; credentials can also be provided directly at the top level.

api_key

string

A string that contains the obfuscated API key.

cloud

string

The Zscaler cloud name was provisioned for your organization.

Choices:

  • "zscloud"

  • "zscaler"

  • "zscalerone"

  • "zscalertwo"

  • "zscalerthree"

  • "zscalerbeta"

  • "zscalergov"

  • "zscalerten"

password

string

A string that contains the password for the API admin.

sandbox_token

string

A string that contains the Sandbox API Key.

username

string

A string that contains the email ID of the API admin.

sandbox_token

string

A string that contains the Sandbox API Key.

state

string

Specifies the desired state of the resource.

Choices:

  • "present" ← (default)

  • "absent"

type

string

Type of ZPA gateway. Choose ZPA for Zscaler Internet Access or ECZPA for Zscaler Cloud Connector.

Choices:

  • "ZPA" ← (default)

  • "ECZPA"

username

string

A string that contains the email ID of the API admin.

zpa_server_group

dictionary / required

Server group associated with the ZPA gateway for source IP anchoring.

external_id

string / required

External identifier for the server group, managed outside of ZIA.

name

string / required

Name of the server group.

Notes

Note

  • Check mode is supported.

Examples

- name: Create or update a ZPA Gateway
  zscaler.ziacloud.zia_ip_source_anchoring_zpa_gateway:
    provider: '{{ provider }}'
    name: 'ZPA_GW01'
    description: 'TT#1965432123'
    type: "ZPA"
    zpa_server_group:
      external_id: 216196257331370454
      name: "SRV01"

Authors

  • William Guilherme (@willguibr)