zscaler.ziacloud.zia_third_party_proxy_service module – Adds a new object for a third-party proxy service

Note

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

New in zscaler.ziacloud 2.0.0

Synopsis

  • Adds a new object for a third-party proxy service

Requirements

The below requirements are needed on the host that executes this module.

Parameters

Parameter

Comments

address

string

The IP address or the FQDN of the third-party proxy service

api_key

string

A string that contains the obfuscated API key.

base64_encode_xau_header

boolean

Flag indicating whether the added X-Authenticated-User header is Base64 encoded.

Choices:

  • false

  • true

cert

dictionary

The root certificate used by the third-party proxy to perform SSL inspection.

id

integer

A unique identifier for an entity

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:

  • "zscloud"

  • "zscaler"

  • "zscalerone"

  • "zscalertwo"

  • "zscalerthree"

  • "zscalerbeta"

  • "zscalergov"

  • "zscalerten"

  • "beta"

  • "production"

description

string

Additional notes or information

id

integer

The unique identifier for the proxy

insert_xau_header

boolean

Flag indicating whether X-Authenticated-User header is added by the proxy.

Choices:

  • false

  • true

name

string / required

The name of the Proxy

password

string

A string that contains the password for the API admin.

port

integer

The port number on which the third-party proxy service listens to the requests forwarded from Zscaler

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:

  • "zscloud"

  • "zscaler"

  • "zscalerone"

  • "zscalertwo"

  • "zscalerthree"

  • "zscalerbeta"

  • "zscalergov"

  • "zscalerten"

  • "beta"

  • "production"

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"

type

string

Gateway type

Choices:

  • "PROXYCHAIN"

  • "ZIA"

  • "ECSELF"

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.

Examples

- name: Create/Update/Delete proxy.
  zscaler.ziacloud.zia_third_party_proxy_service:
    name: Proxy01Ansible
    description: Proxy01Ansible
    type: PROXYCHAIN
    address: "192.168.1.1"
    port: 5000
    insert_xau_header: true
    base64_encode_xau_header: true

Authors

  • William Guilherme (@willguibr)