fortinet.fortimanager.fmgr_arrpprofile 模块 – 配置 WiFi 自动无线电资源调配

注意

此模块是 fortinet.fortimanager 集合（版本 2.8.2）的一部分。

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

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

要在 playbook 中使用它，请指定：fortinet.fortimanager.fmgr_arrpprofile。

fortinet.fortimanager 2.1.0 中的新增功能

概要

  • 此模块能够配置 FortiManager 设备。

  • 示例包括所有参数和值，在使用前需要根据数据源进行调整。

参数

参数

注释

access_token

字符串

无需使用用户名和密码即可访问 FortiManager 的令牌。

adom

字符串 / 必需

请求 URL 中的参数 (adom)。

arrpprofile

字典

顶层参数集。

comment

字符串

注释。

darrp_optimize

别名：darrp-optimize

整数

运行动态自动无线电资源调配的时间

darrp_optimize_schedules

别名：darrp-optimize-schedules

任何

（列表）用于 DARRP 运行时间的防火墙计划。

include_dfs_channel

别名：include-dfs-channel

字符串

在 DARRP 通道选择阶段 1 中启用/禁用 DFS 通道的使用

选项

  • "no"

  • "disable"

  • "yes"

  • "enable"

include_weather_channel

别名：include-weather-channel

字符串

在 DARRP 通道选择阶段 1 中启用/禁用气象通道的使用

选项

  • "no"

  • "disable"

  • "yes"

  • "enable"

monitor_period

别名：monitor-period

整数

测量平均传输重试和接收错误的秒数

name

字符串 / 必需

WiFi ARRP 配置文件名称。

override_darrp_optimize

别名：override-darrp-optimize

字符串

启用以覆盖设置 darrp-optimize 和 darrp-optimize-schedules

选项

  • "disable"

  • "enable"

selection_period

别名：selection-period

整数

测量平均通道负载、噪声基底、频谱 RSSI 的秒数

threshold_ap

别名：threshold-ap

整数

在 DARRP 通道选择阶段 1 中，由于周围的 AP 而拒绝通道的阈值

threshold_channel_load

别名：threshold-channel-load

整数

在 DARRP 通道选择阶段 1 中，由于通道负载而拒绝通道的百分比阈值

threshold_noise_floor

别名：threshold-noise-floor

字符串

在 DARRP 通道选择阶段 1 中，由于噪声基底而拒绝通道的 dBm 阈值

threshold_rx_errors

别名：threshold-rx-errors

整数

在 DARRP 监视阶段中，触发通道重新选择的接收错误的百分比阈值

threshold_spectral_rssi

别名：threshold-spectral-rssi

字符串

在 DARRP 通道选择阶段 1 中，由于频谱 RSSI 而拒绝通道的 dBm 阈值

threshold_tx_retries

别名：threshold-tx-retries

整数

在 DARRP 监视阶段中，触发通道重新选择的传输重试的百分比阈值

weight_channel_load

别名：weight-channel-load

整数

通道负载在 DARRP 通道评分计算中的权重

weight_dfs_channel

别名：weight-dfs-channel

整数

DFS 通道在 DARRP 通道评分计算中的权重

weight_managed_ap

别名：weight-managed-ap

整数

托管 AP 在 DARRP 通道评分计算中的权重

weight_noise_floor

别名：weight-noise-floor

整数

噪声基底在 DARRP 通道评分计算中的权重

weight_rogue_ap

别名：weight-rogue-ap

整数

恶意 AP 在 DARRP 通道评分计算中的权重

weight_spectral_rssi

别名：weight-spectral-rssi

整数

频谱 RSSI 在 DARRP 通道评分计算中的权重

weight_weather_channel

别名：weight-weather-channel

整数

气象通道在 DARRP 通道评分计算中的权重

bypass_validation

布尔值

仅当模块架构与 FortiManager API 结构不同时才设置为 True，模块将继续执行而不验证参数。

选项

  • false ← （默认）

  • true

enable_log

布尔值

启用/禁用任务日志记录。

选项

  • false ← （默认）

  • true

forticloud_access_token

字符串

使用 forticloud API 访问令牌验证 Ansible 客户端。

proposed_method

字符串

覆盖底层 Json RPC 请求的方法。

选项

  • "update"

  • "set"

  • "add"

rc_failed

列表 / 元素=整数

将覆盖失败条件的 rc 代码列表。

rc_succeeded

列表 / 元素=整数

将覆盖成功条件的 rc 代码列表。

state

字符串 / 必需

创建、更新或删除对象的指令。

选项

  • "present"

  • "absent"

workspace_locking_adom

字符串

在工作区模式下运行的 FortiManager 的锁定 adom，该值可以是全局的，也可以是包括 root 在内的其他值。

workspace_locking_timeout

整数

等待其他用户释放工作区锁定的最长时间（以秒为单位）。

默认值： 300

说明

注意

  • 从 2.4.0 版本开始，所有输入参数都使用下划线命名约定（snake_case）。请将诸如 “var-name” 之类的参数更改为 “var_name”。旧的参数名称仍然可用，但您会收到弃用警告。您可以在 ansible.cfg 中设置 deprecation_warnings=False 来忽略此警告。

  • 此 FortiManager 模块支持在工作区锁定模式下运行，顶层参数 workspace_locking_adom 和 workspace_locking_timeout 用于辅助完成此项工作。

  • 要创建或更新对象，请使用 state present 指令。

  • 要删除对象，请使用 state absent 指令。

  • 通常，当返回非零 rc 时，运行模块会失败。您还可以使用参数 rc_failed 和 rc_succeeded 来覆盖失败或成功的条件。

示例

- name: Example playbook (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Configure WiFi Automatic Radio Resource Provisioning
      fortinet.fortimanager.fmgr_arrpprofile:
        # bypass_validation: false
        workspace_locking_adom: <value in [global, custom adom including root]>
        workspace_locking_timeout: 300
        # rc_succeeded: [0, -2, -3, ...]
        # rc_failed: [-2, -3, ...]
        adom: <your own value>
        state: present # <value in [present, absent]>
        arrpprofile:
          comment: <string>
          darrp_optimize: <integer>
          darrp_optimize_schedules: <list or string>
          include_dfs_channel: <value in [no, disable, yes, ...]>
          include_weather_channel: <value in [no, disable, yes, ...]>
          monitor_period: <integer>
          name: <string>
          override_darrp_optimize: <value in [disable, enable]>
          selection_period: <integer>
          threshold_ap: <integer>
          threshold_channel_load: <integer>
          threshold_noise_floor: <string>
          threshold_rx_errors: <integer>
          threshold_spectral_rssi: <string>
          threshold_tx_retries: <integer>
          weight_channel_load: <integer>
          weight_dfs_channel: <integer>
          weight_managed_ap: <integer>
          weight_noise_floor: <integer>
          weight_rogue_ap: <integer>
          weight_spectral_rssi: <integer>
          weight_weather_channel: <integer>

返回值

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

键

描述

meta

字典

请求的结果。

返回: 始终

request_url

字符串

请求的完整 URL。

返回: 始终

示例: "/sys/login/user"

response_code

整数

API 请求的状态。

返回: 始终

示例: 0

response_data

列表 / 元素=字符串

API 响应。

返回: 始终

response_message

字符串

API 响应的描述性消息。

返回: 始终

示例: "OK."

system_information

字典

目标系统的信息。

返回: 始终

rc

整数

请求的状态。

返回: 始终

示例: 0

version_check_warning

列表 / 元素=字符串

如果 playbook 中使用的参数不受当前 FortiManager 版本支持，则发出警告。

返回: 复杂

作者

  • Xinwei Du (@dux-fortinet)

  • Xing Li (@lix-fortinet)

  • Jie Xue (@JieX19)

  • Link Zheng (@chillancezen)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)