cisco.meraki.networks_appliance_rf_profiles 模块 – 用于 networks _appliance _rfprofiles 的资源模块

注意

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

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

要安装它,请使用:ansible-galaxy collection install cisco.meraki。您需要进一步的要求才能使用此模块,请参阅 要求 了解详细信息。

要在 playbook 中使用它,请指定:cisco.meraki.networks_appliance_rf_profiles

cisco.meraki 2.18.0 中的新功能

概要

  • 管理资源 networks _appliance _rfprofiles 的创建、更新和删除操作。

  • 为此网络创建新的 RF 配置文件。

注意

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

要求

执行此模块的主机需要满足以下要求。

  • meraki >= 2.4.9

  • python >= 3.5

参数

参数

注释

fiveGhzSettings

字典

与 5Ghz 频段相关的设置。

axEnabled

布尔值

确定 5Ghz 频段上的 ax 无线电是否开启或关闭。可以是 true 或 false。如果为 false,我们强烈建议禁用频段转向。默认为 true。

选择

  • false

  • true

minBitrate

整数

设置 5Ghz 频段的最小比特率 (Mbps)。可以是 ‘6’、‘9’、‘12’、‘18’、‘24’、‘36’、‘48’ 或 ‘54’ 之一。默认为 12。

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 ←(默认)

name

字符串

新配置文件的名称。必须是唯一的。创建时必须提供此参数。

networkId

字符串

NetworkId 路径参数。网络 ID。

perSsidSettings

字典

每个 SSID 的无线电设置,按编号。

1

字典

SSID 1 的设置。

bandOperationMode

字符串

在 ‘dual’、‘2.4ghz’、‘5ghz’、‘6ghz’ 或 ‘multi’ 之间选择。

bandSteeringEnabled

布尔值

将客户端引导至 2.4 GHz 和 5 GHz 之间最开放的频段。可以是 true 或 false。

选择

  • false

  • true

2

字典

SSID 2 的设置。

bandOperationMode

字符串

在 ‘dual’、‘2.4ghz’、‘5ghz’、‘6ghz’ 或 ‘multi’ 之间选择。

bandSteeringEnabled

布尔值

将客户端引导至 2.4 GHz 和 5 GHz 之间最开放的频段。可以是 true 或 false。

选择

  • false

  • true

3

字典

SSID 3 的设置。

bandOperationMode

字符串

在 ‘dual’、‘2.4ghz’、‘5ghz’、‘6ghz’ 或 ‘multi’ 之间选择。

bandSteeringEnabled

布尔值

将客户端引导至 2.4 GHz 和 5 GHz 之间最开放的频段。可以是 true 或 false。

选择

  • false

  • true

4

字典

SSID 4 的设置。

bandOperationMode

字符串

在 ‘dual’、‘2.4ghz’、‘5ghz’、‘6ghz’ 或 ‘multi’ 之间选择。

bandSteeringEnabled

布尔值

将客户端引导至 2.4 GHz 和 5 GHz 之间最开放的频段。可以是 true 或 false。

选择

  • false

  • true

twoFourGhzSettings

字典

与 2.4Ghz 频段相关的设置。

axEnabled

布尔值

确定 2.4Ghz 频段上的 ax 无线电是否开启或关闭。可以是 true 或 false。如果为 false,我们强烈建议禁用频段转向。默认为 true。

选择

  • false

  • true

minBitrate

浮点数

设置 2.4Ghz 频段的最小比特率 (Mbps)。可以是 ‘1’、‘2’、‘5.5’、‘6’、‘9’、‘11’、‘12’、‘18’、‘24’、‘36’、‘48’ 或 ‘54’ 之一。默认为 11。

备注

注意

  • 使用的 SDK 方法是 appliance.Appliance.create_network_appliance_rf_profile,

  • 使用的路径是 post /networks/{networkId}/appliance/rfProfiles,

  • 不支持 check_mode

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

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

参见

参见

思科 Meraki 关于 appliance createNetworkApplianceRfProfile 的文档

createNetworkApplianceRfProfile API 的完整参考。

示例

- name: Create
  cisco.meraki.networks_appliance_rf_profiles:
    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:
      axEnabled: true
      minBitrate: 48
    name: MX RF Profile
    networkId: string
    perSsidSettings:
      '1':
        bandOperationMode: dual
        bandSteeringEnabled: true
      '2':
        bandOperationMode: dual
        bandSteeringEnabled: true
      '3':
        bandOperationMode: dual
        bandSteeringEnabled: true
      '4':
        bandOperationMode: dual
        bandSteeringEnabled: true
    twoFourGhzSettings:
      axEnabled: true
      minBitrate: 12.0

返回值

通用返回值已在此处记录 这里,以下是此模块特有的字段

描述

meraki_response

字典

一个字典或列表,其中包含 Cisco Meraki Python SDK 返回的响应

返回: 总是

示例: {"fiveGhzSettings": {"axEnabled": true, "minBitrate": 0}, "id": "string", "name": "string", "networkId": "string", "perSsidSettings": {"1": {"bandOperationMode": "string", "bandSteeringEnabled": true}, "2": {"bandOperationMode": "string", "bandSteeringEnabled": true}, "3": {"bandOperationMode": "string", "bandSteeringEnabled": true}, "4": {"bandOperationMode": "string", "bandSteeringEnabled": true}}, "twoFourGhzSettings": {"axEnabled": true, "minBitrate": 0}}

作者

  • Francisco Munoz (@fmunoz)