zscaler.ziacloud.zia_atp_malware_settings module – Updates 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.

New in zscaler.ziacloud 2.0.0

Synopsis

  • Updates the malware protection policy configuration details.

Requirements

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

Parameters

Parameter

Comments

adware_blocked

boolean

Indicates whether malicious files that automatically render advertisements and install adware are allowed or blocked

Choices:

  • false

  • true

adware_capture

boolean

Indicates whether packet capture (PCAP) is enabled or disabled for adware

Choices:

  • false

  • true

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.

ransomware_blocked

boolean

Indicates whether to allow or block malicious programs that can encrypt files and

prevent users from accessing their devices, files, or data until a ransom payment is made.

Choices:

  • false

  • true

ransomware_capture

boolean

Indicates whether packet capture (PCAP) is enabled or disabled for ransomware

Choices:

  • false

  • true

remote_access_tool_blocked

boolean

Indicates whether to allow or block file download from tools that are common from remote access sites

Choices:

  • false

  • true

remote_access_tool_capture

boolean

Indicates whether packet capture (PCAP) is enabled or disabled for remote access tools

Choices:

  • false

  • true

sandbox_cloud

string

The Sandbox cloud environment for API access.

sandbox_token

string

A string that contains the Sandbox API Key.

spyware_blocked

boolean

Indicates whether malicious files that covertly gather information about a user or an organization are allowed or blocked

Choices:

  • false

  • true

spyware_capture

boolean

Indicates whether packet capture (PCAP) is enabled or disabled for spyware

Choices:

  • false

  • true

state

string

Specifies the desired state of the resource.

Choices:

  • "present" ← (default)

trojan_blocked

boolean

Allows or blocks malicious programs such as Trojan viruses that are presented as beneficial or useful

Choices:

  • false

  • true

trojan_capture

boolean

Indicates whether packet capture (PCAP) is enabled or disabled for Trojan viruses

Choices:

  • false

  • true

unwanted_applications_blocked

boolean

Allows or blocks unwanted files that are downloaded alongside intentional programs downloaded by users

Choices:

  • false

  • true

unwanted_applications_capture

boolean

Indicates whether packet capture (PCAP) is enabled or disabled for unwanted applications

Choices:

  • false

  • true

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.

virus_blocked

boolean

Indicates if malicious programs that cause damage to systems and data are allowed or blocked.

This setting applies to any viruses that don’t fit into the more specific malware categories.

Choices:

  • false

  • true

virus_capture

boolean

Indicates whether packet capture (PCAP) is enabled or disabled for viruses

Choices:

  • false

  • true

worm_blocked

boolean

Indicates whether malicious programs that duplicate themselves to spread malicious code to other devices are allowed or blocked

Choices:

  • false

  • true

worm_capture

boolean

Indicates whether packet capture (PCAP) is enabled or disabled for worms

Choices:

  • false

  • true

Notes

Note

  • Check mode is not supported.

Examples

- name: Updates the malware protection policy configuration details
  zscaler.ziacloud.zia_atp_malware_settings:
    provider: '{{ provider }}'
    adware_blocked: true
    adware_capture: false
    ransomware_blocked: true
    ransomware_capture: false
    remote_access_tool_blocked: true
    remote_access_tool_capture: false
    spyware_blocked: true
    spyware_capture: false
    trojan_blocked: true
    trojan_capture: false
    unwanted_applications_blocked: true
    unwanted_applications_capture: false
    virus_blocked: true
    virus_capture: false
    worm_blocked: true
    worm_capture: false

Authors

  • William Guilherme (@willguibr)