cisco.meraki.meraki_mr_settings 模块 – 管理 Meraki 无线网络的常规设置

注意

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

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

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

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

已弃用

移除版本:

3.0.0 版本

原因:

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

替代方案:

cisco.meraki.networks_wireless_settings

概要

  • 允许配置 Meraki MR 无线网络中的常规设置。

参数

参数

注释

auth_key

字符串 / 必需

仪表板提供的身份验证密钥。如果未设置环境变量 MERAKI_KEY，则为必需项。

host

字符串

Meraki 仪表板的主机名。

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

默认值： "api.meraki.com"

internal_error_retry_time

整数

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

默认值： 60

ipv6_bridge_enabled

布尔值

用于启用或禁用网络中的 IPv6 桥接的开关。

如果启用，SSID 也必须配置为使用桥接模式。

选项

  • false

  • true

led_lights_on

布尔值

用于启用或禁用网络中所有 AP 的 LED 指示灯的开关。

选项

  • false

  • true

location_analytics_enabled

布尔值

用于启用或禁用网络的位置分析的开关。

选项

  • false

  • true

meshing_enabled

布尔值

用于启用或禁用网络中的网状网的开关。

选项

  • false

  • true

net_id

字符串

网络的 ID。

net_name

字符串

网络的名称。

org_id

字符串

组织的 ID。

org_name

别名：organization

字符串

组织的名称。

output_format

字符串

指示模块响应键是否应为蛇形命名法 (ex. net_id) 或驼峰命名法 (ex. netId)。

选项

  • "snakecase" ← (默认)

  • "camelcase"

output_level

字符串

设置模块执行期间的调试输出量。

选项

  • "debug"

  • "normal" ← (默认)

rate_limit_retry_time

整数

如果触发速率限制器，则重试的秒数。

默认值： 165

state

字符串

查询或编辑无线设置。

选项

  • "present" ← (默认)

  • "query"

timeout

整数

HTTP 请求超时的时间。

默认值： 30

upgrade_strategy

字符串

应用于网络的升级策略。

需要 MR 26.8 或更高版本的固件。

选项

  • "minimize_upgrade_time"

  • "minimize_client_downtime"

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 all settings
  meraki_mr_settings:
    auth_key: abc123
    org_name: YourOrg
    net_name: YourNet
    state: query
  delegate_to: localhost
- name: Configure settings
  meraki_mr_settings:
    auth_key: abc123
    org_name: YourOrg
    net_name: YourNet
    state: present
    upgrade_strategy: minimize_upgrade_time
    ipv6_bridge_enabled: false
    led_lights_on: true
    location_analytics_enabled: true
    meshing_enabled: true
  delegate_to: localhost

返回值

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

键

描述

数据

复杂类型

无线设置列表。

返回: 成功

ipv6_bridge_enabled

布尔值

用于启用或禁用网络中的 IPv6 桥接的开关。

如果启用，SSID 也必须配置为使用桥接模式。

返回: 成功

示例: true

led_lights_on

布尔值

用于启用或禁用网络中所有 AP 的 LED 指示灯的开关。

返回: 成功

示例: true

location_analytics_enabled

布尔值

用于启用或禁用网络的位置分析的开关。

返回: 成功

示例: true

meshing_enabled

布尔值

用于启用或禁用网络中的网状网的开关。

返回: 成功

示例: true

upgrade_strategy

字符串

应用于网络的升级策略。

需要 MR 26.8 或更高版本的固件。

返回: 成功

示例: "minimize_upgrade_time"

状态

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

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

作者

  • Kevin Breit (@kbreit)