zscaler.ziacloud.zia_atp_malware_settings_info module – Retrieves the malware protection policy configuration details

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

New in zscaler.ziacloud 2.0.0

Synopsis

  • Retrieves the malware protection policy configuration details

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"

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: Retrieves the malware protection policy configuration details
  zscaler.ziacloud.zia_atp_malware_settings_info:
    provider: '{{ provider }}'

Return Values

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

Key

Description

atp

dictionary

Details of the Advanced Threat Protection (ATP) malware inspection settings.

Returned: always

adware_blocked

boolean

Whether adware is blocked.

Returned: success

Sample: true

adware_capture

boolean

Whether adware is captured for further inspection.

Returned: success

Sample: false

ransomware_blocked

boolean

Whether ransomware is blocked.

Returned: success

Sample: true

ransomware_capture

boolean

Whether ransomware is captured.

Returned: success

Sample: false

remote_access_tool_blocked

boolean

Whether remote access tools are blocked.

Returned: success

Sample: true

remote_access_tool_capture

boolean

Whether remote access tools are captured.

Returned: success

Sample: false

spyware_blocked

boolean

Whether spyware is blocked.

Returned: success

Sample: true

spyware_capture

boolean

Whether spyware is captured.

Returned: success

Sample: false

trojan_blocked

boolean

Whether trojans are blocked.

Returned: success

Sample: true

trojan_capture

boolean

Whether trojans are captured.

Returned: success

Sample: false

unwanted_applications_blocked

boolean

Whether unwanted applications are blocked.

Returned: success

Sample: true

unwanted_applications_capture

boolean

Whether unwanted applications are captured.

Returned: success

Sample: false

virus_blocked

boolean

Whether viruses are blocked.

Returned: success

Sample: true

virus_capture

boolean

Whether viruses are captured.

Returned: success

Sample: false

worm_blocked

boolean

Whether worms are blocked.

Returned: success

Sample: true

worm_capture

boolean

Whether worms are captured.

Returned: success

Sample: false

Authors

  • William Guilherme (@willguibr)