cisco.meraki.meraki_mx_intrusion_prevention 模块 – 管理 Meraki 云中的入侵防护

注意

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

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

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

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

已弃用

在以下版本中移除：

3.0.0 版本

原因：

发布了具有增强功能的更新模块

替代方案：

cisco.meraki.organizations_appliance_security_intrusion 和 cisco.meraki.networks_appliance_security_intrusion

概要

• 允许管理 Meraki MX 网络内的入侵防护规则网络。

参数

参数	注释
allowed_rules 列表 / 元素=字典	与组织允许的规则相关的 ID 列表。
rule_id 字符串	由 Snort 定义的规则 ID。
rule_message 别名：message 字符串 在 cisco.meraki 2.3.0 中添加	规则描述。 这将被 API 覆盖。 以前是 message，该字段已弃用，但仍保留为别名。
auth_key 字符串 / 必需	仪表盘提供的身份验证密钥。如果未设置环境变量 MERAKI_KEY，则需要此密钥。
host 字符串	Meraki 仪表盘的主机名。 可用于访问区域性 Meraki 环境，例如中国。 默认值： "api.meraki.com"
ids_rulesets 字符串	规则集复杂度设置。 选项 "connectivity" "balanced" "security"
internal_error_retry_time 整数	如果服务器返回内部服务器错误，则重试的秒数。 默认值： 60
mode 字符串	入侵防护系统的运行模式。 选项 "detection" "disabled" "prevention"
net_id 字符串	网络的 ID 号。
net_name 别名：name, network 字符串	网络名称。
org_id 字符串	组织的 ID。
org_name 别名：organization 字符串	组织名称。
output_format 字符串	指示模块响应键是否应该是蛇形命名法（例如 net_id）还是驼峰命名法（例如 netId）。 选项 "snakecase" ← (默认) "camelcase"
output_level 字符串	设置模块执行期间的调试输出量。 选项 "debug" "normal" ← (默认)
protected_networks 字典	设置入侵防护的包含/排除网络。
excluded_cidr 列表 / 元素=字符串	要从扫描中排除的网络 IP 范围列表。
included_cidr 列表 / 元素=字符串	要包含在扫描中的网络 IP 范围列表。
use_default 布尔值	是否使用 RFC 5735 中规定的特殊 IPv4 地址。 选项 false true
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 API 的更多信息，请访问 https://dashboard.meraki.com/api_docs。

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

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

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

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

示例

- name: Set whitelist for organization
  meraki_intrusion_prevention:
    auth_key: '{{auth_key}}'
    state: present
    org_id: '{{test_org_id}}'
    allowed_rules:
      - rule_id: "meraki:intrusion/snort/GID/01/SID/5805"
        rule_message: Test rule
  delegate_to: localhost

- name: Query IPS info for organization
  meraki_intrusion_prevention:
    auth_key: '{{auth_key}}'
    state: query
    org_name: '{{test_org_name}}'
  delegate_to: localhost
  register: query_org

- name: Set full ruleset with check mode
  meraki_intrusion_prevention:
    auth_key: '{{auth_key}}'
    state: present
    org_name: '{{test_org_name}}'
    net_name: '{{test_net_name}} - IPS'
    mode: prevention
    ids_rulesets: security
    protected_networks:
      use_default: true
      included_cidr:
        - 192.0.1.0/24
      excluded_cidr:
        - 10.0.1.0/24
  delegate_to: localhost

- name: Clear rules from organization
  meraki_intrusion_prevention:
    auth_key: '{{auth_key}}'
    state: absent
    org_name: '{{test_org_name}}'
    allowed_rules: []
  delegate_to: localhost

返回值

常见的返回值已在 此处 文档中说明，以下是此模块独有的字段

键	描述
data 复杂	有关威胁防护设置的信息。 返回值：成功
idsRulesets 字符串	所选规则集的设置。 返回值：成功，当查询或修改网络时 示例： "balanced"
mode 字符串	启用入侵防御设置。 返回值：成功，当查询或修改网络时 示例： "enabled"
protectedNetworks 复杂	受 IPS 保护的网络。 返回值：成功，当查询或修改网络时
excludedCidr 字符串	要从保护中排除的 CIDR 表示法网络列表。 返回值：成功，当查询或修改网络时 示例： "192.0.1.0/24"
includedCidr 字符串	要保护的 CIDR 表示法网络列表。 返回值：成功，当查询或修改网络时 示例： "192.0.1.0/24"
useDefault 布尔值	是否使用特殊的 IPv4 地址。 返回值：成功，当查询或修改网络时 示例： true
whitelistedRules 复杂	白名单 IPS 规则列表。 返回值：成功，当查询或修改组织时
rule_message 字符串	规则描述。 返回值：成功，当查询或修改组织时 示例： "MALWARE-OTHER Trackware myway speedbar runtime detection - switch engines"
ruleId 字符串	IPS 规则的规则标识符。 返回值：成功，当查询或修改组织时 示例： "meraki:intrusion/snort/GID/01/SID/5805"

状态

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

• 更多信息请参见 已弃用。

作者

• Kevin Breit (@kbreit)

资源链接

• 问题追踪器
• 代码库（源代码）