cisco.meraki.meraki_ms_access_list 模块 – 管理 Meraki 云中 Meraki 交换机的访问列表

注意

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

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

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

要在 playbook 中使用它,请指定: cisco.meraki.meraki_ms_access_list

cisco.meraki 0.1.0 中的新增功能

已弃用

在以下版本中移除:

3.0.0 版本

原因:

更新的模块发布,功能增强

替代方案:

cisco.meraki.networks_switch_access_control_lists

概要

  • 配置和查询有关 Meraki 云中 Meraki 交换机上的访问列表的信息。

参数

参数

注释

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

rules

列表 / elements=字典

访问控制规则的列表。

comment

字符串

规则的描述。

dst_cidr

字符串

要匹配的目标 IP 地址的 CIDR 表示法。

dst_port

字符串

要匹配的目标端口的端口号。

可以是端口号或 'any'。

ip_version

字符串

要匹配的 IP 数据包的类型。

选项

  • "any"

  • "ipv4"

  • "ipv6"

policy

字符串

对匹配的流量采取的操作。

选项

  • "allow"

  • "deny"

protocol

字符串

要匹配的协议类型。

选项

  • "any"

  • "tcp"

  • "udp"

src_cidr

字符串

要匹配的目标 IP 地址的 CIDR 表示法。

src_port

字符串

要匹配的源端口的端口号。

可以是端口号或 'any'。

vlan

字符串

传入流量 VLAN。

可以是 1-4095 之间的任何端口,或 'any'。

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 内部的开发人员使用。

  • 有关 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 access list
  meraki_switch_access_list:
    auth_key: abc123
    state: present
    org_name: YourOrg
    net_name: YourNet
    rules:
      - comment: Fake rule
        policy: allow
        ip_version: ipv4
        protocol: udp
        src_cidr: 192.0.1.0/24
        src_port: "4242"
        dst_cidr: 1.2.3.4/32
        dst_port: "80"
        vlan: "100"
  delegate_to: localhost

- name: Query access lists
  meraki_switch_access_list:
    auth_key: abc123
    state: query
    org_name: YourOrg
    net_name: YourNet
  delegate_to: localhost

返回值

通用返回值记录在 此处,以下是此模块独有的字段

描述

数据

复杂

管理员列表。

返回: 成功

rules

列表 / 元素=字符串

访问控制规则的列表。

返回: 成功

comment

字符串

规则的描述。

返回: 成功

示例: "用户规则"

dst_cidr

字符串

要匹配的目标 IP 地址的 CIDR 表示法。

返回: 成功

示例: "1.2.3.4/32"

dst_port

字符串

要匹配的目标端口的端口号。

返回: 成功

示例: "80"

ip_version

字符串

要匹配的 IP 数据包的类型。

返回: 成功

示例: "ipv4"

policy

字符串

对匹配的流量采取的操作。

返回: 成功

示例: "允许"

protocol

字符串

要匹配的协议类型。

返回: 成功

示例: "udp"

src_cidr

字符串

要匹配的目标 IP 地址的 CIDR 表示法。

返回: 成功

示例: "192.0.1.0/24"

src_port

字符串

要匹配的源端口的端口号。

返回: 成功

示例: "1234"

vlan

字符串

传入流量 VLAN。

返回: 成功

示例: "100"

状态

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

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

作者

  • Kevin Breit (@kbreit)