cisco.meraki.meraki_mx_malware module -- Manage Malware Protection in the Meraki cloud

Note

This module is part of the cisco.meraki collection (version 2.18.2).

To install it, use: ansible-galaxy collection install cisco.meraki.

To use it in a playbook, specify: cisco.meraki.meraki_mx_malware.

DEPRECATED

Removed in:

version 3.0.0

Why:

Updated modules released with increased functionality

Alternative:

cisco.meraki.networks_appliance_security_malware

Synopsis

• Fully configure malware protection in a Meraki environment.

Parameters

Parameter	Comments
allowed_files list / elements=dictionary	List of files to whitelist.
comment string	Human readable information about file.
sha256 aliases: hash string	256-bit hash of file.
allowed_urls list / elements=dictionary	List of URLs to whitelist.
comment string	Human readable information about URL.
url string	URL string to allow.
auth_key string / required	Authentication key provided by the dashboard. Required if environmental variable MERAKI_KEY is not set.
host string	Hostname for Meraki dashboard. Can be used to access regional Meraki environments, such as China. Default: :ansible-option-default:`"api.meraki.com"`
internal_error_retry_time integer	Number of seconds to retry if server returns an internal server error. Default: :ansible-option-default:`60`
mode string	Enabled or disabled state of malware protection. Choices: :ansible-option-choices-entry:`"disabled"` :ansible-option-choices-entry:`"enabled"`
net_id string	ID of network which configuration is applied to.
net_name aliases: network string	Name of network which configuration is applied to.
org_id string	ID of organization.
org_name aliases: organization string	Name of organization.
output_format string	Instructs module whether response keys should be snake case (ex. net_id) or camel case (ex. netId). Choices: :ansible-option-choices-entry-default:`"snakecase"` ← (default) :ansible-option-choices-entry:`"camelcase"`
output_level string	Set amount of debug output during module execution. Choices: :ansible-option-choices-entry:`"debug"` :ansible-option-choices-entry-default:`"normal"` ← (default)
rate_limit_retry_time integer	Number of seconds to retry if rate limiter is triggered. Default: :ansible-option-default:`165`
state string	Specifies whether object should be queried, created/modified, or removed. Choices: :ansible-option-choices-entry:`"absent"` :ansible-option-choices-entry:`"present"` :ansible-option-choices-entry-default:`"query"` ← (default)
timeout integer	Time to timeout for HTTP requests. Default: :ansible-option-default:`30`
use_https boolean	If no, it will use HTTP. Otherwise it will use HTTPS. Only useful for internal Meraki developers. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry-default:`true` ← (default)
use_proxy boolean	If no, it will not use a proxy, even if one is defined in an environment variable on the target hosts. Choices: :ansible-option-choices-entry-default:`false` ← (default) :ansible-option-choices-entry:`true`
validate_certs boolean	Whether to validate HTTP certificates. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry-default:`true` ← (default)

Notes

Note

• Some of the options are likely only used for developers within Meraki.

• More information about the Meraki API can be found at https://dashboard.meraki.com/api_docs.

• Some of the options are likely only used for developers within Meraki.

• As of Ansible 2.9, Meraki modules output keys as snake case. To use camel case, set the ANSIBLE_MERAKI_FORMAT environment variable to camelcase.

• Ansible's Meraki modules will stop supporting camel case output in Ansible 2.13. Please update your playbooks.

• Check Mode downloads the current configuration from the dashboard, then compares changes against this download. Check Mode will report changed if there are differences in the configurations, but does not submit changes to the API for validation of change.

Examples

- name: Enable malware protection
  meraki_malware:
    auth_key: abc123
    state: present
    org_name: YourOrg
    net_name: YourNet
    mode: enabled
  delegate_to: localhost

- name: Set whitelisted url
  meraki_malware:
    auth_key: abc123
    state: present
    org_name: YourOrg
    net_name: YourNet
    mode: enabled
    allowed_urls:
      - url: www.ansible.com
        comment: Ansible
      - url: www.google.com
        comment: Google
  delegate_to: localhost

- name: Set whitelisted file
  meraki_malware:
    auth_key: abc123
    state: present
    org_name: YourOrg
    net_name: YourNet
    mode: enabled
    allowed_files:
      - sha256: e82c5f7d75004727e1f3b94426b9a11c8bc4c312a9170ac9a73abace40aef503
        comment: random zip
  delegate_to: localhost

- name: Get malware settings
  meraki_malware:
    auth_key: abc123
    state: query
    org_name: YourNet
    net_name: YourOrg
  delegate_to: localhost

Return Values

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

Key	Description
data complex	List of administrators. Returned: success
allowed_files complex	List of files which are whitelisted. Returned: success
comment string	Comment about the whitelisted entity Returned: success Sample: :ansible-rv-sample-value:`"TPS report"`
sha256 string	sha256 hash of whitelisted file. Returned: success Sample: :ansible-rv-sample-value:`"e82c5f7d75004727e1f3b94426b9a11c8bc4c312a9170ac9a73abace40aef503"`
allowed_urls complex	List of URLs which are whitelisted. Returned: success
comment string	Comment about the whitelisted entity Returned: success Sample: :ansible-rv-sample-value:`"Corporate HQ"`
url string	URL of whitelisted site. Returned: success Sample: :ansible-rv-sample-value:`"site.com"`
mode string	Mode to enable or disable malware scanning. Returned: success Sample: :ansible-rv-sample-value:`"enabled"`

Status

• This module will be removed in version 3.0.0. [deprecated]

• For more information see DEPRECATED.

Authors

• Kevin Breit (@kbreit)

Collection links

Issue Tracker Repository (Sources)