cisco.meraki.meraki_mx_malware 模块 – 管理 Meraki 云中的恶意软件防护

注意

此模块是 cisco.meraki 集合（版本 2.18.3）的一部分。

如果您使用的是 ansible 包，您可能已经安装了此集合。它不包含在 ansible-core 中。要检查是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用：ansible-galaxy collection install cisco.meraki。

要在 playbook 中使用它，请指定：cisco.meraki.meraki_mx_malware。

已弃用

在以下版本中移除:

版本 3.0.0

原因:

已发布功能增强的更新模块

替代方案:

cisco.meraki.networks_appliance_security_malware

概要

• 在 Meraki 环境中完全配置恶意软件防护。

参数

参数	注释
allowed_files 列表 / 元素=字典	要列入白名单的文件列表。
comment 字符串	有关文件的可读信息。
sha256 别名: hash 字符串	文件的 256 位哈希值。
allowed_urls 列表 / 元素=字典	要列入白名单的 URL 列表。
comment 字符串	有关 URL 的可读信息。
url 字符串	要允许的 URL 字符串。
auth_key 字符串 / 必需	仪表板提供的身份验证密钥。如果未设置环境变量 MERAKI_KEY，则为必需项。
host 字符串	Meraki 仪表板的主机名。 可用于访问区域 Meraki 环境，例如中国。 默认值： "api.meraki.com"
internal_error_retry_time 整数	如果服务器返回内部服务器错误，则重试的秒数。 默认值： 60
mode 字符串	恶意软件防护的启用或禁用状态。 选择 "disabled" "enabled"
net_id 字符串	应用配置的网络 ID。
net_name 别名: network 字符串	应用配置的网络名称。
org_id 字符串	组织 ID。
org_name 别名: organization 字符串	组织名称。
output_format 字符串	指示模块响应键应使用蛇形命名法（例如，net_id）还是驼峰命名法（例如，netId）。 选择 "snakecase" ←（默认） "camelcase"
output_level 字符串	设置模块执行期间的调试输出量。 选择 "debug" "normal" ←（默认）
rate_limit_retry_time 整数	如果触发速率限制器，则重试的秒数。 默认值： 165
state 字符串	指定是否应查询、创建/修改或删除对象。 选择 "absent" "present" "query" ←（默认）
timeout 整数	HTTP 请求的超时时间。 默认值： 30
use_https 布尔值	如果为 no，则将使用 HTTP。否则，将使用 HTTPS。 仅对 Meraki 内部开发人员有用。 选择 false true ←（默认）
use_proxy 布尔值	如果为 no，即使在目标主机上的环境变量中定义了代理，也不会使用代理。 选择 false ←（默认） true
validate_certs 布尔值	是否验证 HTTP 证书。 选择 false true ←（默认）

备注

注意

• 某些选项可能仅供 Meraki 内部的开发人员使用。

• 有关 Meraki API 的更多信息，请访问 https://dashboard.meraki.com/api_docs。

• 某些选项可能仅供 Meraki 内部的开发人员使用。

• 从 Ansible 2.9 开始，Meraki 模块将键输出为蛇形命名法。要使用驼峰命名法，请将 ANSIBLE_MERAKI_FORMAT 环境变量设置为 camelcase。

• Ansible 的 Meraki 模块将在 Ansible 2.13 中停止支持驼峰命名法输出。请更新您的 playbook。

• 检查模式从仪表板下载当前配置，然后将更改与此下载进行比较。如果配置存在差异，检查模式将报告已更改，但不会将更改提交到 API 以进行更改验证。

示例

- 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

返回值

通用返回值记录在此处，以下是此模块特有的字段

键	描述
数据 复杂	管理员列表。 返回：成功
allowed_files 复杂	列入白名单的文件列表。 返回：成功
comment 字符串	有关列入白名单实体的注释 返回：成功 示例： "TPS 报告"
sha256 字符串	列入白名单的文件的 sha256 哈希值。 返回：成功 示例： "e82c5f7d75004727e1f3b94426b9a11c8bc4c312a9170ac9a73abace40aef503"
allowed_urls 复杂	列入白名单的 URL 列表。 返回：成功
comment 字符串	有关列入白名单实体的注释 返回：成功 示例: "Corporate HQ"
url 字符串	白名单站点的 URL。 返回：成功 示例: "site.com"
mode 字符串	启用或禁用恶意软件扫描的模式。 返回：成功 示例: "enabled"

状态

• 此模块将在 3.0.0 版本中移除。[已弃用]

• 有关更多信息，请参阅 已弃用。

作者

• Kevin Breit (@kbreit)

集合链接

• 问题跟踪器
• 存储库（源代码）