cisco.meraki.meraki_mx_l7_firewall 模块 – 在 Meraki 云中管理 MX 设备第 7 层防火墙

注意

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

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

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

要在剧本中使用它，请指定：cisco.meraki.meraki_mx_l7_firewall。

已弃用

在以下版本中移除：

3.0.0 版本

原因：

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

替代方案：

cisco.meraki.networks_appliance_firewall_l7_firewall_rules

摘要

• 允许创建、管理和查看在 Meraki MX 防火墙上实现的第 7 层防火墙。

参数

参数	注释
auth_key 字符串 / 必需	仪表盘提供的身份验证密钥。如果未设置环境变量 MERAKI_KEY，则需要此密钥。
categories 布尔值	当 True 时，指定应查询应用程序和应用程序类别而不是防火墙规则。 选项 false true
host 字符串	Meraki 仪表盘的主机名。 可用于访问区域 Meraki 环境，例如中国。 默认值： "api.meraki.com"
internal_error_retry_time 整数	如果服务器返回内部服务器错误，则重试的秒数。 默认值： 60
net_id 字符串	包含 MX 防火墙的网络的 ID。
net_name 字符串	包含 MX 防火墙的网络的名称。
org_id 字符串	组织的 ID。
org_name 别名：organization 字符串	组织的名称。
output_format 字符串	指示模块响应键是否应为蛇形命名法 (例如 net_id) 或驼峰命名法 (例如 netId)。 选项 "snakecase" ← (默认) "camelcase"
output_level 字符串	设置模块执行期间调试输出的数量。 选项 "debug" "normal" ← (默认)
rate_limit_retry_time 整数	如果触发速率限制器，则重试的秒数。 默认值： 165
rules 列表 / 元素=字典	第 7 层防火墙规则列表。
application 字典	要过滤的应用程序。
id 字符串	Meraki 定义的应用程序的 URI。
name 字符串	Meraki 定义的要过滤的应用程序的名称。
countries 列表 / 元素=字符串	要列入白名单或黑名单的国家/地区列表。 国家/地区采用两位字母的 ISO 3166-1 alpha-2 格式。
host 字符串	要过滤的主机的 FQDN。
ip_range 字符串	要应用规则的 IP 地址的 CIDR 表示法范围。 可以使用 ":" 将端口附加到范围。
policy 字符串	如果命中规则，则应用的策略。 选项 "deny" ← (默认)
port 字符串	要过滤的基于 TCP 或 UDP 的端口。
type 字符串	要应用的策略类型。 选项 "application" "application_category" "blocked_countries" "host" "ip_range" "port" "allowed_countries"
state 字符串	查询或修改防火墙规则。 选项 "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 中停止支持驼峰命名法输出。请更新您的剧本。

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

示例

- name: Query firewall rules
  meraki_mx_l7_firewall:
    auth_key: abc123
    org_name: YourOrg
    net_name: YourNet
    state: query
  delegate_to: localhost

- name: Query applications and application categories
  meraki_mx_l7_firewall:
    auth_key: abc123
    org_name: YourOrg
    net_name: YourNet
    categories: yes
    state: query
  delegate_to: localhost

- name: Set firewall rules
  meraki_mx_l7_firewall:
    auth_key: abc123
    org_name: YourOrg
    net_name: YourNet
    state: present
    rules:
      - type: allowed_countries
        countries:
          - US
          - FR
      - type: blocked_countries
        countries:
          - CN
      - policy: deny
        type: port
        port: 8080
      - type: port
        port: 1234
      - type: host
        host: asdf.com
      - type: application
        application:
          id: meraki:layer7/application/205
      - type: application_category
        application:
          id: meraki:layer7/category/24
  delegate_to: localhost

返回值

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

键	描述
数据 复杂数据	与网络关联的防火墙规则。 返回： 成功
application_categories 列表 / 元素=字符串	应用程序类别和应用程序列表。 返回： 查询应用程序时返回成功
applications 列表 / 元素=字符串	某个类别中的应用程序列表。 返回： 成功
id 字符串	应用程序的URI。 返回： 成功 示例： "Gmail"
name 字符串	应用程序的描述性名称。 返回： 成功 示例： "meraki:layer7/application/4"
id 字符串	应用程序类别的URI。 返回： 成功 示例： "Email"
name 字符串	应用程序类别的描述性名称。 返回： 成功 示例： "layer7/category/1"
rules 列表 / 元素=字符串	防火墙规则的有序列表。 返回： 未查询应用程序时返回成功
allowedCountries 字符串	允许的国家/地区。 返回： 成功 示例： "CA"
applicationCategory 列表 / 元素=字符串	某个类别中的应用程序类别列表。 返回： 成功
id 字符串	应用程序的URI。 返回： 成功 示例： "Gmail"
name 字符串	应用程序的描述性名称。 返回： 成功 示例： "meraki:layer7/application/4"
applications 列表 / 元素=字符串	某个类别中的应用程序列表。 返回： 成功
id 字符串	应用程序的URI。 返回： 成功 示例： "Gmail"
name 字符串	应用程序的描述性名称。 返回： 成功 示例： "meraki:layer7/application/4"
blockedCountries 字符串	列入黑名单的国家/地区。 返回： 成功 示例： "RU"
ipRange 字符串	规则中的IP地址范围。 返回： 成功 示例： "1.1.1.0/23"
policy 字符串	命中规则时要应用的操作。 返回： 成功 示例： "deny"
port 字符串	规则中的端口号。 返回： 成功 示例： "23"
type 字符串	规则类别的类型。 返回： 成功 示例： "applications"

状态

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

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

作者

• Kevin Breit (@kbreit)

资源链接

• 问题追踪器
• 代码仓库