cisco.meraki.devices_wireless_radio_settings 模块 – 设备无线射频设置资源模块

注意

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

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

要安装它，请使用： ansible-galaxy collection install cisco.meraki。您需要其他要求才能使用此模块，有关详细信息，请参见 要求。

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

cisco.meraki 2.16.0 中的新增功能

概要

• 管理资源设备无线射频设置的操作更新。

• 更新设备的无线电设置。

注意

此模块具有相应的 操作插件。

要求

在执行此模块的主机上需要以下要求。

• meraki >= 2.4.9

• python >= 3.5

参数

参数	注释
fiveGhzSettings 字典	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’, ‘169’, ‘173’ 或 ‘177’ ，或者为 null 以使用自动信道。
channelWidth 整数	设置 5 GHz 的手动信道宽度。可以是 ‘0’, ‘20’, ‘40’, ‘80’ 或 ‘160’ ，或者为 null 以使用自动信道宽度。
targetPower 整数	设置 5 GHz 的手动目标功率。可以在 ‘8’ 到 ‘30’ 之间，或者为 null 以使用自动功率范围。
meraki_action_batch_retry_wait_time 整数	meraki_action_batch_retry_wait_time (整数)，操作批处理并发错误重试等待时间 默认值： 60
meraki_api_key 字符串 / 必需	meraki_api_key (字符串)，在仪表盘中生成的 API 密钥；也可以设置为环境变量 MERAKI_DASHBOARD_API_KEY
meraki_base_url 字符串	meraki_base_url (字符串)，位于所有端点资源之前 默认值： "https://api.meraki.com/api/v1"
meraki_be_geo_id 字符串	meraki_be_geo_id (字符串)，用于 API 使用跟踪的可选合作伙伴标识符；也可以设置为环境变量 BE_GEO_ID 默认值： ""
meraki_caller 字符串	meraki_caller (字符串)，用于 API 使用跟踪的可选标识符；也可以设置为环境变量 MERAKI_PYTHON_SDK_CALLER 默认值： ""
meraki_certificate_path 字符串	meraki_certificate_path (字符串)，如果位于本地代理之后，则用于 TLS/SSL 证书验证的路径 默认值： ""
meraki_inherit_logging_config 布尔值	meraki_inherit_logging_config (布尔值)，继承您自己的日志记录器实例 选项 false ← (默认) true
meraki_log_file_prefix 字符串	meraki_log_file_prefix (字符串)，日志文件名附加日期和时间戳 默认值： "meraki_api_"
meraki_log_path 字符串	log_path (字符串)，输出日志的路径；如果未指定，则默认为脚本的工作目录 默认值： ""
meraki_maximum_retries 整数	meraki_maximum_retries (整数)，遇到 429 或其他服务器端错误时最多重试这么多次 默认值： 2
meraki_nginx_429_retry_wait_time 整数	meraki_nginx_429_retry_wait_time (整数)，Nginx 429 重试等待时间 默认值： 60
meraki_output_log 布尔值	meraki_output_log (布尔值)，创建输出日志文件？ 选项 false true ← (默认)
meraki_print_console 布尔值	meraki_print_console (布尔值)，将日志输出打印到控制台？ 选项 false true ← (默认)
meraki_requests_proxy 字符串	meraki_requests_proxy (字符串)，如果需要，用于 HTTPS 的代理服务器和端口 默认值： ""
meraki_retry_4xx_error 布尔值	meraki_retry_4xx_error (布尔值)，如果遇到其他 4XX 错误（除了 429）则重试？ 选项 false ← (默认) true
meraki_retry_4xx_error_wait_time 整数	meraki_retry_4xx_error_wait_time (整数)，其他 4XX 错误重试等待时间 默认值： 60
meraki_simulate 布尔值	meraki_simulate (布尔值)，模拟 POST/PUT/DELETE 调用以防止更改？ 选项 false ← (默认) true
meraki_single_request_timeout 整数	meraki_single_request_timeout (整数)，每个 API 调用的最大秒数 默认值： 60
meraki_suppress_logging 布尔值	meraki_suppress_logging (布尔值)，禁用所有日志记录？那么你只能自求多福了！ 选项 false ← (默认) true
meraki_use_iterator_for_get_pages 布尔值	meraki_use_iterator_for_get_pages (布尔值)，list* 方法将返回包含每个对象的迭代器，而不是包含所有项目的完整列表 选项 false ← (默认) true
meraki_wait_on_rate_limit 布尔值	meraki_wait_on_rate_limit (布尔值)，如果遇到 429 速率限制错误则重试？ 选项 false true ← (默认)
rfProfileId 字符串	要分配给设备的射频配置文件的 ID。如果此参数的值为 null，则会将相应的基本射频配置文件（室内或室外）分配给设备。分配射频配置文件将清除设备上所有手动配置的覆盖（信道宽度、信道、功率）。
serial 字符串	串口路径参数。
twoFourGhzSettings 字典	2.4 GHz 的手动无线电设置。
channel 整数	设置 2.4 GHz 的手动信道。可以是 ‘1’, ‘2’, ‘3’, ‘4’, ‘5’, ‘6’, ‘7’, ‘8’, ‘9’, ‘10’, ‘11’, ‘12’, ‘13’ 或 ‘14’ ，或者为 null 以使用自动信道。
targetPower 整数	设置 2.4 GHz 的手动目标功率。可以在 ‘5’ 到 ‘30’ 之间，或者为 null 以使用自动功率范围。

备注

注意

• 使用的 SDK 方法是 wireless.Wireless.update_device_wireless_radio_settings,

• 使用的路径是 put /devices/{serial}/wireless/radio/settings,

• 不支持check_mode

• 该插件在控制节点上运行，不使用任何 Ansible 连接插件，而是使用 Cisco DNAC SDK 中的嵌入式连接管理器。

• 以 dnac_ 开头的参数由 Cisco DNAC Python SDK 用于建立连接。

另请参见

另请参见

Cisco Meraki 文档，关于 wireless updateDeviceWirelessRadioSettings

updateDeviceWirelessRadioSettings API 的完整参考。

示例

- name: Update all
  cisco.meraki.devices_wireless_radio_settings:
    meraki_api_key: "{{meraki_api_key}}"
    meraki_base_url: "{{meraki_base_url}}"
    meraki_single_request_timeout: "{{meraki_single_request_timeout}}"
    meraki_certificate_path: "{{meraki_certificate_path}}"
    meraki_requests_proxy: "{{meraki_requests_proxy}}"
    meraki_wait_on_rate_limit: "{{meraki_wait_on_rate_limit}}"
    meraki_nginx_429_retry_wait_time: "{{meraki_nginx_429_retry_wait_time}}"
    meraki_action_batch_retry_wait_time: "{{meraki_action_batch_retry_wait_time}}"
    meraki_retry_4xx_error: "{{meraki_retry_4xx_error}}"
    meraki_retry_4xx_error_wait_time: "{{meraki_retry_4xx_error_wait_time}}"
    meraki_maximum_retries: "{{meraki_maximum_retries}}"
    meraki_output_log: "{{meraki_output_log}}"
    meraki_log_file_prefix: "{{meraki_log_file_prefix}}"
    meraki_log_path: "{{meraki_log_path}}"
    meraki_print_console: "{{meraki_print_console}}"
    meraki_suppress_logging: "{{meraki_suppress_logging}}"
    meraki_simulate: "{{meraki_simulate}}"
    meraki_be_geo_id: "{{meraki_be_geo_id}}"
    meraki_use_iterator_for_get_pages: "{{meraki_use_iterator_for_get_pages}}"
    meraki_inherit_logging_config: "{{meraki_inherit_logging_config}}"
    state: present
    fiveGhzSettings:
      channel: 149
      channelWidth: 20
      targetPower: 15
    rfProfileId: '1234'
    serial: string
    twoFourGhzSettings:
      channel: 11
      targetPower: 21

返回值

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

键	描述
meraki_response 字典	Cisco Meraki Python SDK 返回的响应字典或列表。 返回：始终 示例：{}

作者

• Francisco Munoz (@fmunoz)

资源链接

• 问题追踪器
• 代码库（源码）