cisco.meraki.meraki_mr_radio 模块 – 管理 Meraki 无线网络的设备无线电设置

注意

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

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

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

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

已弃用

在以下版本中移除：

3.0.0 版

原因：

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

替代方案：

cisco.meraki.devices_wireless_radio_settings

概要

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

参数

参数	注释
auth_key 字符串 / 必需	仪表板提供的身份验证密钥。如果未设置环境变量 MERAKI_KEY，则需要此密钥。
five_ghz_settings 字典	5 GHz 的手动无线电设置。 默认值： {}
channel 整数	设置 5 GHz 的手动信道。 选项 36 40 44 48 52 56 60 64 100 104 108 112 116 120 124 128 132 136 140 144 149 153 157 161 165
channel_width 字符串	设置 5 GHz 的手动信道。 可以是 '0'、'20'、'40' 或 '80'，或者对于使用自动信道宽度则为 null。 选项 "auto" "20" "40" "80"
target_power 整数	设置 5 GHz 的手动目标功率。 可以是 '8' 到 '30' 之间的数值，或者对于使用自动功率范围则为 null。
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
rf_profile_id 字符串	要分配给设备的 RF 配置文件 ID。 如果此参数的值为 null，则相应的基本 RF 配置文件（室内或室外）将分配给设备。 分配 RF 配置文件将清除设备上所有手动配置的覆盖（信道宽度、信道、功率）。
rf_profile_name 字符串	要分配给设备的 RF 配置文件名称。 类似于 ``rf_profile_id``，但需要 ``net_id``（首选）或 ``net_name``。
serial 字符串	要查询的设备的序列号。
state 字符串	查询或编辑设备上的无线电设置。 选项 "present" ← (默认) "query"
timeout 整数	HTTP 请求的超时时间。 默认值： 30
two_four_ghz_settings 字典	2.4 GHz 的手动无线电设置。 默认值： {}
channel 整数	设置 2.4 GHz 的手动信道。 可以是 '1'、'2'、'3'、'4'、'5'、'6'、'7'、'8'、'9'、'10'、'11'、'12'、'13' 或 '14'，或者对于使用自动信道则为 null。 选项 1 2 3 4 5 6 7 8 9 10 11 12 13 14
target_power 整数	设置 2.4 GHz 的手动目标功率。 可以是 '5' 到 '30' 之间的数值，或者对于使用自动功率范围则为 null。
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 模块的输出键采用蛇形命名法 (snake case)。若要使用驼峰命名法 (camel case)，请将环境变量 ANSIBLE_MERAKI_FORMAT 设置为 camelcase。

• Ansible 的 Meraki 模块将在 Ansible 2.13 中停止支持驼峰命名法 (camel case) 输出。请更新您的 playbook。

• 检查模式会从控制面板下载当前配置，然后将更改与下载的配置进行比较。如果配置存在差异，检查模式将报告更改，但不会将更改提交到 API 进行验证。

示例

- name: Query a device's radio configuration
  meraki_mr_radio:
    auth_key: abc123
    org_name: YourOrg
    net_name: YourNet
    serial: YourSerialNumber
    state: query
  delegate_to: localhost
- name: Configure a device's radios
  meraki_mr_radio:
    auth_key: abc123
    org_name: YourOrg
    net_name: YourNet
    serial: YourSerialNumber
    state: present
    five_ghz_settings:
      channel: 56
      channel_width: 20
      target_power: 10
    two_four_ghz_settings:
      channel: 6
      target_power: 12
    rf_profile_name: Test Profile
  delegate_to: localhost

返回值

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

键	描述
数据 复杂	在特定设备上配置的射频设置。 返回：成功
five_ghz_settings 字典	配置了 5 GHz 的手动无线电设置。 返回：成功
channel 字符串	配置了 5 GHz 的手动信道。 空值表示自动信道。 返回：成功 示例： "56"
channel_width 字符串	配置了 5 GHz 的手动信道。 空值表示自动信道宽度。 返回：成功 示例： "40"
target_power 整数	配置了 5 GHz 的手动目标功率。 空值表示自动功率。 返回：成功 示例： 25
rf_profile_id 字符串	分配给设备的射频配置文件 ID。 空值表示已为设备分配相应的基本射频配置文件（室内或室外）。 返回：成功
serial 字符串	已配置设备的序列号。 返回：成功 示例： "xyz"
two_four_ghz_settings 字典	配置了 2.4 GHz 的手动无线电设置。 返回：成功
channel 字符串	配置了 2.4 GHz 的手动信道。 空值表示自动信道。 返回：成功 示例： "11"
target_power 整数	配置了 2.4 GHz 的手动目标功率。 空值表示自动功率。 返回：成功 示例： 15

状态

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

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

作者

• Tyler Christiansen (@supertylerc)

资源链接

• 问题追踪器
• 代码仓库