cisco.meraki.meraki_mr_l7_firewall 模块 – 管理 Meraki 云中的 MR 接入点 7 层防火墙

注意

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

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

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

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

已弃用

在以下版本中删除:

版本 3.0.0

原因:

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

替代方案:

cisco.meraki.networks_appliance_firewall_l7_firewall_rules

概要

• 允许创建、管理和查看在 Meraki MR 接入点上实施的 7 层防火墙。

• 该模块假定完整的防火墙规则列表作为参数传递。

• 如果有人有兴趣让此模块允许操作单个防火墙规则，请针对此模块提交问题。

参数

参数	注释
auth_key string / 必需	仪表板提供的身份验证密钥。如果未设置环境变量 MERAKI_KEY，则为必需。
categories 布尔值	当 True 时，指定应查询应用程序和应用程序类别，而不是防火墙规则。 选项 false true
host 字符串	Meraki 仪表板的主机名。 可用于访问区域性 Meraki 环境，例如中国。 默认值： "api.meraki.com"
internal_error_retry_time 整数	如果服务器返回内部服务器错误，则重试的秒数。 默认值： 60
net_id 字符串	包含接入点的网络的 ID。
net_name 字符串	包含接入点的网络的名称。
number 别名：ssid_number 字符串	要应用防火墙规则的 SSID 的编号。
org_id 字符串	组织的 ID。
org_name 别名：organization 字符串	组织的名称。
output_format 字符串	指示模块响应键应使用蛇形命名法（例如 net_id）还是驼峰命名法（例如 netId）。 选项 "snakecase" ←（默认值） "camelcase"
output_level 字符串	设置模块执行期间的调试输出量。 选项 "debug" "normal" ←（默认值）
rate_limit_retry_time 整数	如果触发速率限制器，则重试的秒数。 默认值： 165
rules list / elements=dictionary	7 层防火墙规则列表。
application 字典	要筛选的应用程序。
id 字符串	由 Meraki 定义的应用程序的 URI。
name 字符串	由 Meraki 定义的要筛选的应用程序的名称。
host 字符串	要筛选的主机的 FQDN。
ip_range 字符串	要将规则应用到的 IP 地址的 CIDR 表示法范围。 可以将端口附加到范围，使用 ":"。
policy 字符串	如果命中规则，则应用的策略。 选项 "deny" ←（默认值）
port 字符串	要筛选的基于 TCP 或 UDP 的端口。
type 字符串	要应用的策略类型。 选项 "application" "application_category" "host" "ip_range" "port"
ssid_name 别名：ssid 字符串	要应用防火墙规则的 SSID 的名称。
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_mr_l7_firewall:
    auth_key: abc123
    org_name: YourOrg
    net_name: YourNet
    state: query
    number: 1
  delegate_to: localhost

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

- name: Set firewall rules
  meraki_mr_l7_firewall:
    auth_key: abc123
    org_name: YourOrg
    net_name: YourNet
    number: 1
    state: present
    rules:
      - 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

返回值

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

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

状态

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

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

作者

• Joshua Coronado (@joshuajcoronado)

合集链接

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