cisco.meraki.meraki_mx_l2_interface 模块 – 配置 MX 二层接口

注意

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

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

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

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

cisco.meraki 2.1.0 中的新增功能

已弃用

在以下版本中移除：

3.0.0 版本

原因：

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

替代方案：

cisco.meraki.networks_appliance_ports

概要

• 允许管理和查看 Meraki MX 二层端口。

参数

参数	注释
access_policy 字符串	策略名称。仅适用于接入端口。 选项 "open" "8021x-radius" "mac-radius" "hybris-radius"
allowed_vlans 字符串	端口上允许的 VLAN ID 的逗号分隔列表，或“all”以允许端口上的所有 VLAN。
auth_key 字符串 / 必需	仪表板提供的身份验证密钥。如果未设置环境变量 MERAKI_KEY，则需要此密钥。
drop_untagged_traffic 布尔值	Trunk 端口可以丢弃所有未标记的流量。如果为真，则不需要 VLAN。 接入端口不能将 dropUntaggedTraffic 设置为 true。 选项 false true
enabled 布尔值	端口的启用状态。 选项 false true
host 字符串	Meraki 仪表板的主机名。 可用于访问区域 Meraki 环境，例如中国。 默认值： "api.meraki.com"
internal_error_retry_time 整数	如果服务器返回内部服务器错误，则重试的秒数。 默认值： 60
net_id 字符串	网络的 ID 号。
net_name 别名：name, network 字符串	网络名称。
number 别名：port, port_id 整数	MX 端口的 ID 号。
org_id 字符串	与网络关联的组织的 ID。
org_name 别名：organization 字符串	组织名称。
output_format 字符串	指示模块响应键是否应为蛇形命名法 (例如 net_id) 或驼峰命名法 (例如 netId)。 选项 "snakecase" ← (默认) "camelcase"
output_level 字符串	设置模块执行期间的调试输出量。 选项 "debug" "normal" ← (默认)
port_type 字符串	端口类型。 选项 "access" "trunk"
rate_limit_retry_time 整数	如果触发速率限制器，则重试的秒数。 默认值： 165
state 字符串	修改或查询端口。 选项 "present" ← (默认) "query"
timeout 整数	HTTP 请求的超时时间。 默认值： 30
use_https 布尔值	如果为 no，则使用 HTTP。否则将使用 HTTPS。 仅对 Meraki 内部开发人员有用。 选项 false true ← (默认)
use_proxy 布尔值	如果为 no，即使在目标主机上定义了环境变量中的代理，它也不会使用代理。 选项 false ← (默认) true
validate_certs 布尔值	是否验证 HTTP 证书。 选项 false true ← (默认)
vlan 整数	端口处于 Trunk 模式时的本机 VLAN。 端口处于 Access 模式时的接入 VLAN。

备注

注意

• 有关 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 layer 2 interface settings
  meraki_mx_l2_interface:
    auth_key: abc123
    org_name: YourOrg
    net_name: YourNet
    state: query
  delegate_to: localhost

- name: Query a single layer 2 interface settings
  meraki_mx_l2_interface:
    auth_key: abc123
    org_name: YourOrg
    net_name: YourNet
    state: query
    number: 2
  delegate_to: localhost

- name: Update interface configuration
  meraki_mx_l2_interface:
    auth_key: abc123
    org_name: YourOrg
    net_name: YourNet
    state: present
    number: 2
    port_type: access
    vlan: 10
  delegate_to: localhost

返回值

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

键	描述
data 复杂类型	有关已创建或已操作对象的的信息。 返回：成功
access_policy 字符串	策略名称。仅适用于接入端口。 返回：成功 示例： "guestUsers"
allowed_vlans 字符串	端口上允许的 VLAN ID 的逗号分隔列表，或“all”以允许端口上的所有 VLAN。 返回：成功 示例： "1,5,10"
drop_untagged_traffic 布尔值	Trunk 端口可以丢弃所有未标记的流量。如果为真，则不需要 VLAN。 接入端口不能将 dropUntaggedTraffic 设置为 true。 返回：成功 示例： true
enabled 布尔值	端口的启用状态。 返回：成功 示例： true
数字 整数	MX 端口的 ID 号。 返回：成功 示例： 4
类型 字符串	端口类型。 返回：成功 示例： "access"
vlan 整数	端口处于 Trunk 模式时的本机 VLAN。 端口处于 Access 模式时的接入 VLAN。 返回：成功 示例： 1

状态

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

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

作者

• Kevin Breit (@kbreit)

集合链接

• 问题追踪器
• 代码库 (源代码)