zscaler.ziacloud.zia_sandbox_advanced_settings_info module – Gets the custom list of MD5 file hashes

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

New in zscaler.ziacloud 1.0.0

Synopsis

  • Gets the custom list of MD5 file hashes that are blocked by Sandbox.

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"

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: Retrieves the custom list of MD5 file hashes that are blocked by Sandbox.
  zscaler.ziacloud.zia_sandbox_advanced_settings_info:
    provider: '{{ provider }}'

Return Values

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

Key

Description

ansible_module_results

dictionary

A dictionary containing results returned by the Ansible module.

Returned: always

behavioral_analysis

dictionary

Details on behavioral analysis settings related to sandboxing.

Returned: always

file_hashes_to_be_blocked

list / elements=string

List of MD5 file hashes currently configured to be blocked by the sandbox.

Returned: always

Sample: ["0316f6067bc02c23c1975d83c659da21", "35e38d023b253c0cd9bd3e16afc362a7", "72fe869aa394ef0a62bb8324857770dd"]

file_hash_count

dictionary

Information about the count of file hashes that are being blocked and the remaining quota.

Returned: always

blocked_file_hashes_count

integer

The number of file hashes that are currently being blocked.

Returned: always

Sample: 3

remaining_file_hashes

integer

The remaining quota of file hashes that can still be blocked.

Returned: always

Sample: 9997

changed

boolean

A boolean flag that indicates if any changes were made during the execution of the module.

Returned: always

Sample: false

failed

boolean

A boolean flag that indicates if the execution of the module failed.

Returned: always

Sample: false

Authors

  • William Guilherme (@willguibr)