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。

要在 Playbook 中使用它，请指定：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 中停止支持驼峰命名输出。请更新您的 Playbook。

• 检查模式从仪表板下载当前配置，然后将更改与此下载进行比较。如果配置存在差异，检查模式将报告已更改，但不会将更改提交到 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

返回值

常见的返回值记录在 此处，以下是此模块独有的字段

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

状态

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

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

作者

• Kevin Breit (@kbreit)

集合链接

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