zscaler.ziacloud.zia_third_party_proxy_service_info module – Retrieves a list of all proxies configured for third-party proxy services

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

New in zscaler.ziacloud 2.0.0

Synopsis

  • Retrieves a list of all proxies configured for third-party proxy services

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:

  • "zscloud"

  • "zscaler"

  • "zscalerone"

  • "zscalertwo"

  • "zscalerthree"

  • "zscalerbeta"

  • "zscalergov"

  • "zscalerten"

  • "beta"

  • "production"

id

integer

The unique identifier for the 3rd-party proxy

name

string

The 3rd-party proxy name.

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:

  • "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.

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

Examples

- name: Gets all list of 3rd-party proxy
  zscaler.ziacloud.zia_third_party_proxy_service_info:
    provider: '{{ provider }}'

- name: Gets a list of 3rd-party proxy by name
  zscaler.ziacloud.zia_third_party_proxy_service_info:
    provider: '{{ provider }}'
    name: "example"

Return Values

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

Key

Description

proxies

list / elements=dictionary

A list of third-party proxies fetched based on the given criteria.

Returned: always

address

string

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

Returned: always

Sample: "192.168.100.1"

base64_encode_xau_header

boolean

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

Returned: always

Sample: true

description

string

A description of the third-party proxy.

Returned: always

Sample: "Proxy01test"

id

integer

The unique identifier for the third-party proxy.

Returned: always

Sample: 18206641

insert_xau_header

boolean

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

Returned: always

Sample: true

last_modified_by

dictionary

Last user that modified the proxy

Returned: always

extensions

dictionary

Extension metadata of the user.

Returned: success

Sample: {"id": 19474996, "name": "admin@acme.zsloginbeta.net"}

external_id

boolean

Whether the user has an external identity.

Returned: success

Sample: false

id

integer

ID of the user who modified the proxy.

Returned: success

Sample: 19474996

name

string

Name of the user who modified the proxy.

Returned: success

Sample: "admin@acme.zsloginbeta.net"

last_modified_time

integer

Timestamp of when the proxy was last modified

Returned: always

Sample: 1745861609

name

string

The name of the third-party proxy.

Returned: always

Sample: "Proxy01"

port

integer

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

Returned: always

Sample: 5000

type

string

The proxy type.

Returned: always

Sample: "PROXYCHAIN"

Authors

  • William Guilherme (@willguibr)