cisco.meraki.meraki_firewalled_services 模块 – 编辑管理网络服务的防火墙策略

注意

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

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

要安装它,请使用: ansible-galaxy collection install cisco.meraki

要在剧本中使用它,请指定: cisco.meraki.meraki_firewalled_services

已弃用

在以下版本中移除:

3.0.0 版本

原因:

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

替代方案:

cisco.meraki.networks_appliance_firewall_firewalled_services

概要

  • 允许设置 Meraki 网络设备的策略防火墙服务。

参数

参数

注释

access

字符串

要查询或修改的网络服务。

选项

  • "blocked"

  • "restricted"

  • "unrestricted"

allowed_ips

列表 / 元素=字符串

允许访问服务的 IP 地址列表。

仅当 access 设置为 restricted 时使用。

auth_key

字符串 / 必需

仪表盘提供的身份验证密钥。如果未设置环境变量 MERAKI_KEY,则需要此密钥。

host

字符串

Meraki 仪表盘的主机名。

可用于访问区域性 Meraki 环境,例如中国。

默认值: "api.meraki.com"

internal_error_retry_time

整数

如果服务器返回内部服务器错误,则重试的秒数。

默认值: 60

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

service

字符串

要查询或修改的网络服务。

选项

  • "ICMP"

  • "SNMP"

  • "web"

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: Set icmp service to blocked
  meraki_firewalled_services:
    auth_key: '{{ auth_key }}'
    state: present
    org_name: '{{test_org_name}}'
    net_name: IntTestNetworkAppliance
    service: ICMP
    access: blocked
  delegate_to: localhost

- name: Set icmp service to restricted
  meraki_firewalled_services:
    auth_key: abc123
    state: present
    org_name: YourOrg
    net_name: YourNet
    service: web
    access: restricted
    allowed_ips:
      - 192.0.1.1
      - 192.0.1.2
  delegate_to: localhost

- name: Query appliance services
  meraki_firewalled_services:
    auth_key: abc123
    state: query
    org_name: YourOrg
    net_name: YourNet
  delegate_to: localhost

- name: Query services
  meraki_firewalled_services:
    auth_key: abc123
    state: query
    org_name: YourOrg
    net_name: YourNet
    service: ICMP
  delegate_to: localhost

返回值

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

描述

数据

复杂数据

网络服务列表。

返回:信息

access

字符串

分配给服务类型的访问权限。

返回:成功

示例: "unrestricted"

allowed_ips

字符串

允许访问服务的IP地址列表。

返回:成功

示例: "192.0.1.0"

service

字符串

应用策略的服务。

返回:成功

示例: "ICMP"

状态

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

  • 更多信息请参见 已弃用

作者

  • Kevin Breit (@kbreit)