zscaler.ziacloud.zia_dlp_icap_server_info module – Gets a the list of DLP servers using ICAP.

Note

This module is part of the zscaler.ziacloud collection (version 1.3.1).

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

New in zscaler.ziacloud 1.0.0

Synopsis

  • Gets a the list of DLP servers using ICAP.

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"

id

integer

The unique identifier for a DLP ICAP server.

name

string

The DLP ICAP server name.

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.

username

string

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

Notes

Note

  • Check mode is not supported.

Examples

- name: Gets all list of DLP ICAP Server
  zscaler.ziacloud.zia_dlp_icap_server_info:
    provider: '{{ provider }}'

- name: Gets a list of DLP ICAP Server by name
  zscaler.ziacloud.zia_dlp_icap_server_info:
    provider: '{{ provider }}'
    name: "ZS_ICAP"

Return Values

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

Key

Description

icaps

list / elements=dictionary

List of DLP ICAP servers retrieved from the Zscaler system.

Returned: always

id

integer

Unique identifier for the DLP ICAP server.

Returned: always

Sample: 1493

name

string

Name of the DLP ICAP server.

Returned: always

Sample: "ZS_BD_ICAP_01"

status

string

Operational status of the DLP ICAP server.

Returned: always

Sample: "ENABLED"

url

string

The URL or endpoint of the ICAP server.

Returned: always

Sample: "icaps://192.168.100.1:1344/"

Authors

  • William Guilherme (@willguibr)