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 string / 必需	仪表板提供的身份验证密钥。如果未设置环境变量 MERAKI_KEY，则为必需项。
five_ghz_settings dictionary	5 GHz 的手动无线设置。 默认: {}
channel integer	为 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 string	为 5 GHz 设置手动信道。 可以是 ‘0’、‘20’、‘40’ 或 ‘80’，或者使用自动信道宽度的 null。 选择 "auto" "20" "40" "80"
target_power integer	为 5 GHz 设置手动目标功率。 可以是 ‘8’ 到 ‘30’ 之间，或者使用自动功率范围的 null。
host string	Meraki 仪表板的主机名。 可以用于访问区域 Meraki 环境，例如中国。 默认: "api.meraki.com"
internal_error_retry_time integer	如果服务器返回内部服务器错误，则重试的秒数。 默认: 60
net_id string	网络的 ID。
net_name 别名: network string	网络的名称。
org_id string	组织的 ID。
org_name 别名: organization string	组织的名称。
output_format string	指示模块响应键是否应为蛇形命名（例如 net_id）或驼峰命名（例如 netId）。 选择 "snakecase" ← （默认） "camelcase"
output_level string	设置模块执行期间的调试输出量。 选择 "debug" "normal" ← （默认）
rate_limit_retry_time integer	如果触发了速率限制器，则重试的秒数。 默认: 165
rf_profile_id string	要分配给设备的射频配置文件的 ID。 如果此参数的值为 null，则会将相应的基本射频配置文件（室内或室外）分配给设备。 分配射频配置文件将清除设备上所有手动配置的覆盖（信道宽度、信道、功率）。
rf_profile_name string	要分配给设备的射频配置文件的名称。 类似于 ``rf_profile_id``，但需要 ``net_id``（首选）或 ``net_name``。
serial string	要查询的设备的序列号。
state string	查询或编辑设备上的无线设置。 选择 "present" ← （默认） "query"
timeout integer	HTTP 请求的超时时间。 默认: 30
two_four_ghz_settings dictionary	2.4 GHz 的手动无线设置。 默认: {}
channel integer	为 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 integer	为 2.4 GHz 设置手动目标功率。 可以是 ‘5’ 到 ‘30’ 之间，或者使用自动功率范围的 null。
use_https boolean	如果为 no，则将使用 HTTP。否则，将使用 HTTPS。 仅对 Meraki 内部开发人员有用。 选择 false true ← （默认）
use_proxy boolean	如果为 no，则即使目标主机上的环境变量中定义了代理，也不会使用代理。 选择 false ← （默认） true
validate_certs boolean	是否验证 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 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

返回值

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

键	描述
数据 复杂	在特定设备上配置的 RF 设置。 返回： 成功
five_ghz_settings dictionary	为 5 GHz 配置的手动无线电设置。 返回： 成功
channel string	为 5 GHz 配置的手动信道。 Null 表示自动信道。 返回： 成功 示例： "56"
channel_width string	为 5 GHz 配置的手动信道。 Null 表示自动信道宽度。 返回： 成功 示例： "40"
target_power integer	为 5 GHz 配置的手动目标功率。 Null 表示自动功率。 返回： 成功 示例： 25
rf_profile_id string	分配给设备的 RF 配置文件 ID。 Null 表示将适当的基本 RF 配置文件（室内或室外）分配给设备。 返回： 成功
serial string	已配置设备的序列号。 返回： 成功 示例： "xyz"
two_four_ghz_settings dictionary	为 2.4 GHz 配置的手动无线电设置。 返回： 成功
channel string	为 2.4 GHz 配置的手动信道。 Null 表示自动信道。 返回： 成功 示例： "11"
target_power integer	为 2.4 GHz 配置的手动目标功率。 Null 表示自动功率。 返回： 成功 示例： 15

状态

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

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

作者

• Tyler Christiansen (@supertylerc)

集合链接

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