cisco.meraki.meraki_management_interface 模块 – 配置 Meraki 管理接口

注意

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

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

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

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

cisco.meraki 1.1.0 中的新功能

已弃用

在以下版本中移除:

版本 3.0.0

原因:

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

替代方案:

cisco.meraki.devices_management_interface

概要

• 允许在 Meraki MX、MS 和 MR 设备上配置管理接口。

参数

参数	注释
auth_key 字符串 / 必需	仪表板提供的身份验证密钥。如果未设置环境变量 MERAKI_KEY，则为必需。
host 字符串	Meraki 仪表板的主机名。 可用于访问区域性 Meraki 环境，例如中国。 默认值： "api.meraki.com"
internal_error_retry_time 整数	如果服务器返回内部服务器错误，则重试的秒数。 默认值： 60
net_id 字符串	要绑定或解除绑定配置模板的网络 ID。
net_name 字符串	要绑定或解除绑定配置模板的网络名称。
org_id 字符串	与配置模板关联的组织 ID。
org_name 别名：organization 字符串	包含配置模板的组织的名称。
output_format 字符串	指示模块响应键应该是蛇形命名法 (snake case)（例如，net_id）还是驼峰命名法 (camel case)（例如，netId）。 选项 "snakecase" ← (默认) "camelcase"
output_level 字符串	设置模块执行期间的调试输出量。 选项 "debug" "normal" ← (默认)
rate_limit_retry_time 整数	如果触发速率限制器，则重试的秒数。 默认值： 165
serial 字符串 / 必需	要配置的设备的序列号。
state 字符串	指定应查询、修改还是删除配置模板信息。 选项 "absent" "query" ← (默认) "present"
timeout 整数	HTTP 请求的超时时间。 默认值： 30
use_https 布尔值	如果为 no，则使用 HTTP。否则，将使用 HTTPS。 仅对 Meraki 内部开发人员有用。 选项 false true ← (默认)
use_proxy 布尔值	如果为 no，则不会使用代理，即使在目标主机上的环境变量中定义了代理。 选项 false ← (默认) true
validate_certs 布尔值	是否验证 HTTP 证书。 选项 false true ← (默认)
wan1 别名：mgmt1 字典	管理接口的管理接口详细信息。
static_dns 列表 / 元素=字符串	要使用的 DNS 服务器。 最多允许 2 个地址。
static_gateway_ip 字符串	默认网关的 IP 地址。 仅当 using_static_ip 为 True 时有效。
static_ip 字符串	分配给管理接口的 IP 地址。 仅当 using_static_ip 为 True 时有效。
static_subnet_mask 字符串	静态 IP 地址的子网掩码。 仅当 using_static_ip 为 True 时有效。
using_static_ip 布尔值	配置接口使用静态 IP 或 DHCP。 选项 false true
vlan 整数	用于管理网络的 VLAN 号。
wan_enabled 字符串	说明是否启用了管理接口。 仅对 MX 设备有效。 选项 "disabled" "enabled" "not configured"
wan2 别名：mgmt2 字典	管理接口的管理接口详细信息。
static_dns 列表 / 元素=字符串	要使用的 DNS 服务器。 最多允许 2 个地址。
static_gateway_ip 字符串	默认网关的 IP 地址。 仅当 using_static_ip 为 True 时有效。
static_ip 字符串	分配给管理接口的 IP 地址。 仅当 using_static_ip 为 True 时有效。
static_subnet_mask 字符串	静态 IP 地址的子网掩码。 仅当 using_static_ip 为 True 时有效。
using_static_ip 布尔值	配置接口使用静态 IP 或 DHCP。 选项 false true
vlan 整数	用于管理网络的 VLAN 号。
wan_enabled 字符串	说明是否启用了管理接口。 仅对 MX 设备有效。 选项 "disabled" "enabled" "not configured"

说明

注意

• WAN2 参数仅对 MX 设备有效。

• wan_enabled 不应为非 MX 设备提供。

• 有关 Meraki API 的更多信息，请访问 https://dashboard.meraki.com/api_docs。

• 某些选项可能仅供 Meraki 内部的开发人员使用。

• 从 Ansible 2.9 开始，Meraki 模块将键输出为蛇形命名法 (snake case)。要使用驼峰命名法 (camel case)，请将 ANSIBLE_MERAKI_FORMAT 环境变量设置为 camelcase。

• Ansible 的 Meraki 模块将在 Ansible 2.13 中停止支持驼峰式输出。请更新您的 playbook。

• 检查模式 (Check Mode) 会从仪表板下载当前配置，然后将更改与此下载内容进行比较。如果配置存在差异，检查模式会报告已更改，但不会将更改提交到 API 以进行更改验证。

示例

- name: Set WAN2 as static IP
  meraki_management_interface:
    auth_key: abc123
    state: present
    org_name: YourOrg
    net_id: YourNetId
    serial: AAAA-BBBB-CCCC
    wan2:
      wan_enabled: enabled
      using_static_ip: yes
      static_ip: 192.168.16.195
      static_gateway_ip: 192.168.16.1
      static_subnet_mask: 255.255.255.0
      static_dns:
        - 1.1.1.1
      vlan: 1
  delegate_to: localhost

- name: Query management information
  meraki_management_interface:
    auth_key: abc123
    state: query
    org_name: YourOrg
    net_id: YourNetId
    serial: AAAA-BBBB-CCCC
  delegate_to: localhost

返回值

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

键	描述
数据 复杂	有关查询对象的信息。 返回: 成功
wan1 复杂	WAN1 接口的管理配置 返回: 成功
static_dns 列表 / 元素=字符串	DNS IP 地址列表 返回: 仅当使用静态 IP 分配时 示例: ["1.1.1.1"]
static_gateway_ip 字符串	分配的静态网关 IP 返回: 仅当使用静态 IP 分配时 示例: "192.0.1.1"
static_ip 字符串	分配的静态 IP 返回: 仅当使用静态 IP 分配时 示例: "192.0.1.2"
static_subnet_mask 字符串	分配的静态 IP 子网掩码 返回: 仅当使用静态 IP 分配时 示例: "255.255.255.0"
using_static_ip 布尔值	接口上是否使用静态 IP 分配的布尔值 返回: 成功 示例: true
vlan 整数	管理 VLAN 的 VLAN 标签 ID 返回: 成功 示例: 2
wan_enabled 字符串	接口的启用状态 返回: 成功 示例: "enabled"
wan2 复杂	WAN1 接口的管理配置 返回: 成功
static_dns 列表 / 元素=字符串	DNS IP 地址列表 返回: 仅当使用静态 IP 分配时 示例: ["1.1.1.1"]
static_gateway_ip 字符串	分配的静态网关 IP 返回: 仅当使用静态 IP 分配时 示例: "192.0.1.1"
static_ip 字符串	分配的静态 IP 返回: 仅当使用静态 IP 分配时 示例: "192.0.1.2"
static_subnet_mask 字符串	分配的静态 IP 子网掩码 返回: 仅当使用静态 IP 分配时 示例: "255.255.255.0"
using_static_ip 布尔值	接口上是否使用静态 IP 分配的布尔值 返回: 成功 示例: true
vlan 整数	管理 VLAN 的 VLAN 标签 ID 返回: 成功 示例: 2
wan_enabled 字符串	接口的启用状态 返回: 成功 示例: "enabled"

状态

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

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

作者

• Kevin Breit (@kbreit)

集合链接

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