cisco.meraki.meraki_mr_rf_profile 模块 – 管理 Meraki 无线网络的射频配置文件

注意

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

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

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

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

已弃用

在以下版本中移除:

版本 3.0.0

原因:

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

替代方案:

cisco.meraki.networks_wireless_rf_profiles

概要

• 允许在 Meraki MR 无线网络中配置射频 (RF) 配置文件。

参数

参数	注释
ap_band_settings 字典	如果 selectionType 设置为“ap”，将启用的设置。
band_steering_enabled 布尔值	将客户端引导到最开放的频段。 选项 false true
mode 别名: band_operation_mode 字符串	设置 AP 将支持的射频频段。 选项 "2.4ghz" "5ghz" "dual"
auth_key 字符串 / 必需	仪表板提供的身份验证密钥。如果未设置环境变量 MERAKI_KEY，则为必需项。
band_selection_type 字符串	设置是按接入点还是 SSID 分配频段选择。 此参数在创建时是必需的。 选项 "ssid" "ap"
client_balancing_enabled 布尔值	将客户端引导到最佳可用接入点。 选项 false true
five_ghz_settings 字典	与 5Ghz 频段相关的设置。
channel_width 字符串	设置 5Ghz 频段的信道宽度 (MHz)。 选项 "auto" "20" "40" "80"
max_power 整数	设置 5Ghz 频段的最大功率 (dBm)。 可以是 8 到 30 之间的整数。
min_bitrate 整数	设置 5Ghz 频段的最小比特率 (Mbps)。 选项 6 9 12 18 24 36 48 54
min_power 整数	设置 5Ghz 频段的最小功率 (dBm)。 可以是 8 到 30 之间的整数。
rxsop 整数	RX-SOP 级别控制无线电的灵敏度。 强烈建议仅在咨询无线专家后使用 RX-SOP。 RX-SOP 可配置在 -65 到 -95 (dBm) 的范围内。
valid_auto_channels 列表 / elements=integer	设置 5Ghz 频段的有效自动信道。 选项 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
host 字符串	Meraki 仪表板的主机名。 可用于访问区域 Meraki 环境，例如中国。 默认: "api.meraki.com"
internal_error_retry_time 整数	如果服务器返回内部服务器错误，则重试的秒数。 默认: 60
min_bitrate_type 字符串	最小比特率的类型。 选项 "band" "ssid"
name 字符串	新配置文件的唯一名称。 此参数在创建时是必需的。
net_id 字符串	网络 ID。
net_name 字符串	网络名称。
org_id 字符串	组织 ID。
org_name 别名: organization 字符串	组织名称。
output_format 字符串	指示模块响应键是否应为蛇形命名法（例如 net_id）或驼峰式命名法（例如 netId）。 选项 "snakecase" ← (默认) "camelcase"
output_level 字符串	设置模块执行期间的调试输出量。 选项 "debug" "normal" ← (默认)
profile_id 别名: id 字符串	现有射频配置文件的唯一标识符。
rate_limit_retry_time 整数	如果触发速率限制器，则重试的秒数。 默认: 165
state 字符串	查询、编辑或删除无线射频配置文件设置。 选项 "present" ← (默认) "query" "absent"
timeout 整数	HTTP 请求的超时时间。 默认: 30
two_four_ghz_settings 字典	与 2.4Ghz 频段相关的设置
ax_enabled 布尔值	确定 2.4Ghz 频段上的 ax 无线电是否开启。 选项 false true
max_power 整数	设置 2.4Ghz 频段的最大功率 (dBm)。 可以是 5 到 30 之间的整数。
min_bitrate 浮点数	设置 2.4Ghz 频段的最小比特率 (Mbps)。 选项 1.0 2.0 5.5 6.0 9.0 11.0 12.0 18.0 24.0 36.0 48.0 54.0
min_power 整数	设置 2.4Ghz 频段的最小功率 (dBm)。 可以是 5 到 30 之间的整数。
rxsop 整数	RX-SOP 级别控制无线电的灵敏度。 强烈建议仅在咨询无线专家后使用 RX-SOP。 RX-SOP 可配置在 -65 到 -95 (dBm) 的范围内。
valid_auto_channels 列表 / elements=integer	设置 2.4Ghz 频段的有效自动信道。 选项 1 6 11
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: Create RF profile in check mode
  meraki_mr_rf_profile:
    auth_key: abc123
    org_name: YourOrg
    net_name: YourNet
    state: present
    name: Test Profile
    band_selection_type: ap
    client_balancing_enabled: True
    ap_band_settings:
        mode: dual
        band_steering_enabled: true
    five_ghz_settings:
      max_power: 10
      min_bitrate: 12
      min_power: 8
      rxsop: -65
      channel_width: 20
      valid_auto_channels:
        - 36
        - 40
        - 44
    two_four_ghz_settings:
      max_power: 10
      min_bitrate: 12
      min_power: 8
      rxsop: -65
      ax_enabled: false
      valid_auto_channels:
        - 1
  delegate_to: localhost

- name: Query all RF profiles
  meraki_mr_rf_profile:
    auth_key: abc123
    org_name: YourOrg
    net_name: YourNet
    state: query
  delegate_to: localhost

- name: Query one RF profile by ID
  meraki_mr_rf_profile:
    auth_key: abc123
    org_name: YourOrg
    net_name: YourNet
    state: query
    profile_id: '{{ profile_id }}'
  delegate_to: localhost

- name: Update profile
  meraki_mr_rf_profile:
    auth_key: abc123
    org_name: YourOrg
    net_name: YourNet
    state: present
    profile_id: 12345
    band_selection_type: ap
    client_balancing_enabled: True
    ap_band_settings:
        mode: dual
        band_steering_enabled: true
    five_ghz_settings:
      max_power: 10
      min_bitrate: 12
      min_power: 8
      rxsop: -65
      channel_width: 20
      valid_auto_channels:
        - 36
        - 44
    two_four_ghz_settings:
      max_power: 10
      min_bitrate: 12
      min_power: 8
      rxsop: -75
      ax_enabled: false
      valid_auto_channels:
        - 1
  delegate_to: localhost

- name: Delete RF profile
  meraki_mr_rf_profile:
    auth_key: abc123
    org_name: YourOrg
    net_name: YourNet
    state: absent
    profile_id: 12345
  delegate_to: localhost

返回值

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

键	描述
data 复杂	无线射频配置文件设置列表。 已返回： 成功
ap_band_settings 复杂	如果 selectionType 设置为“ap”，将启用的设置。 已返回： 成功
band_steering_enabled 布尔值	将客户端引导到最开放的频段。 已返回： 成功 示例： true
mode 字符串	设置 AP 将支持的射频频段。 已返回： 成功 示例： "dual"
band_selection_type 字符串	设置是按接入点还是 SSID 分配频段选择。 此参数在创建时是必需的。 已返回： 成功 示例： "ap"
client_balancing_enabled 布尔值	将客户端引导到最佳可用接入点。 已返回： 成功 示例： true
five_ghz_settings 复杂	与 5Ghz 频段相关的设置。 已返回： 成功
channel_width 字符串	设置 5Ghz 频段的信道宽度 (MHz)。 已返回： 成功 示例： "auto"
max_power 整数	设置 5Ghz 频段的最大功率 (dBm)。 可以是 8 到 30 之间的整数。 已返回： 成功 示例： 12
min_bitrate 整数	设置 5Ghz 频段的最小比特率 (Mbps)。 已返回： 成功 示例： 6
min_power 整数	设置 5Ghz 频段的最小功率 (dBm)。 可以是 8 到 30 之间的整数。 已返回： 成功 示例： 12
rxsop 整数	RX-SOP 级别控制无线电的灵敏度。 已返回： 成功 示例： -70
valid_auto_channels list / elements=string	设置 5Ghz 频段的有效自动信道。 已返回： 成功
id 字符串	现有射频配置文件的唯一标识符。 已返回： 成功 示例： "12345"
min_bitrate_type 字符串	最小比特率的类型。 已返回： 成功 示例： "ssid"
name 字符串	新配置文件的唯一名称。 此参数在创建时是必需的。 已返回： 成功 示例： "Guest RF profile"
two_four_ghz_settings 复杂	与 2.4Ghz 频段相关的设置 已返回： 成功
ax_enabled 布尔值	确定 2.4Ghz 频段上的 ax 无线电是否开启。 已返回： 成功 示例： true
max_power 整数	设置 2.4Ghz 频段的最大功率 (dBm)。 已返回： 成功 示例： 12
min_bitrate 浮点数	设置 2.4Ghz 频段的最小比特率 (Mbps)。 已返回： 成功 示例： 5.5
min_power 整数	设置 2.4Ghz 频段的最小功率 (dBm)。 已返回： 成功 示例： 12
rxsop 整数	RX-SOP 级别控制无线电的灵敏度。 已返回： 成功 示例： -70
valid_auto_channels list / elements=string	设置 2.4Ghz 频段的有效自动信道。 已返回： 成功 示例： ["6"]

状态

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

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

作者

• Kevin Breit (@kbreit)

集合链接

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