fortinet.fortios.fortios_wireless_controller_arrp_profile 模块 – 在 Fortinet 的 FortiOS 和 FortiGate 中配置 WiFi 自动无线资源配置 (ARRP) 配置文件。

注意

此模块是 fortinet.fortios 集合(版本 2.3.8)的一部分。

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

要安装它,请使用:ansible-galaxy collection install fortinet.fortios。您需要其他要求才能使用此模块,请参阅 要求 了解详细信息。

要在 playbook 中使用它,请指定:fortinet.fortios.fortios_wireless_controller_arrp_profile

fortinet.fortios 2.0.0 中的新增功能

概要

  • 此模块能够通过允许用户设置和修改无线控制器功能和 arrp_profile 类别来配置 FortiGate 或 FortiOS (FOS) 设备。示例包括所有参数和值,需要在使用前调整为数据源。已使用 FOS v6.0.0 测试。

要求

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

  • ansible>=2.15

参数

参数

注释

access_token

字符串

基于令牌的身份验证。从 Fortigate 的 GUI 生成。

enable_log

布尔值

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

选择

  • false ←(默认)

  • true

member_path

字符串

要操作的成员属性路径。

如果存在多个属性,则用斜杠字符分隔。

标记有 member_path 的参数对于执行成员操作是合法的。

member_state

字符串

在指定的属性路径下添加或删除成员。

指定 member_state 时,将忽略 state 选项。

选择

  • "present"

  • "absent"

state

字符串 / 必需

指示是否创建或删除对象。

选择

  • "present"

  • "absent"

vdom

字符串

虚拟域,在先前定义的域中。vdom 是 FortiGate 的虚拟实例,可以配置为不同的单元并使用。

默认值: "root"

wireless_controller_arrp_profile

字典

配置 WiFi 自动无线资源配置 (ARRP) 配置文件。

comment

字符串

注释。

darrp_optimize

整数

运行分布式自动无线资源配置 (DARRP) 优化时间(0 - 86400 秒)。

darrp_optimize_schedules

列表 / elements=dictionary

DARRP 运行时间的防火墙计划。DARRP 将在计划内的 darrp-optimize 中定期运行。用空格分隔多个计划名称。

name

字符串 / 必需

计划名称。源 firewall.schedule.group.name firewall.schedule.recurring.name firewall.schedule.onetime.name。

include_dfs_channel

字符串

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

选择

  • "enable"

  • "disable"

  • "yes"

  • "no"

include_weather_channel

字符串

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

选择

  • "enable"

  • "disable"

  • "yes"

  • "no"

monitor_period

整数

以秒为单位测量平均传输重试和接收错误的周期。

name

字符串 / 必需

WiFi ARRP 配置文件名称。

override_darrp_optimize

字符串

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

选择

  • "enable"

  • "disable"

selection_period

整数

以秒为单位测量平均通道负载、噪声层、频谱 RSSI 的周期。

threshold_ap

整数

由于周围的 AP,在 DARRP 通道选择阶段 1 中拒绝通道的阈值 (0 - 500)。

threshold_channel_load

整数

由于通道负载,在 DARRP 通道选择阶段 1 中拒绝通道的百分比阈值 (0 - 100)。

threshold_noise_floor

字符串

由于噪声层,在 DARRP 通道选择阶段 1 中拒绝通道的 dBm 阈值(-95 到 -20)。

threshold_rx_errors

整数

在 DARRP 监视阶段触发通道重新选择的接收错误的百分比阈值 (0 - 100)。

threshold_spectral_rssi

字符串

由于频谱 RSSI,在 DARRP 通道选择阶段 1 中拒绝通道的 dBm 阈值(-95 到 -20)。

threshold_tx_retries

整数

在 DARRP 监视阶段触发通道重新选择的传输重试的百分比阈值 (0 - 1000)。

weight_channel_load

整数

用于通道负载的 DARRP 通道评分计算中的权重 (0 - 2000)。

weight_dfs_channel

整数

用于 DFS 通道的 DARRP 通道评分计算中的权重 (0 - 2000)。

weight_managed_ap

整数

用于托管 AP 的 DARRP 通道评分计算中的权重 (0 - 2000)。

weight_noise_floor

整数

用于噪声层的 DARRP 通道评分计算中的权重 (0 - 2000)。

weight_rogue_ap

整数

用于恶意 AP 的 DARRP 通道评分计算中的权重 (0 - 2000)。

weight_spectral_rssi

整数

用于频谱 RSSI 的 DARRP 通道评分计算中的权重 (0 - 2000)。

weight_weather_channel

整数

用于气象通道的 DARRP 通道评分计算中的权重 (0 - 2000)。

说明

注意

  • 旧版 fortiosapi 已弃用,httpapi 是运行 playbook 的首选方式

  • 该模块支持 check_mode。

示例

- name: Configure WiFi Automatic Radio Resource Provisioning (ARRP) profiles.
  fortinet.fortios.fortios_wireless_controller_arrp_profile:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      wireless_controller_arrp_profile:
          comment: "Comment."
          darrp_optimize: "86400"
          darrp_optimize_schedules:
              -
                  name: "default_name_6 (source firewall.schedule.group.name firewall.schedule.recurring.name firewall.schedule.onetime.name)"
          include_dfs_channel: "enable"
          include_weather_channel: "enable"
          monitor_period: "300"
          name: "default_name_10"
          override_darrp_optimize: "enable"
          selection_period: "3600"
          threshold_ap: "250"
          threshold_channel_load: "60"
          threshold_noise_floor: "<your_own_value>"
          threshold_rx_errors: "50"
          threshold_spectral_rssi: "<your_own_value>"
          threshold_tx_retries: "300"
          weight_channel_load: "20"
          weight_dfs_channel: "500"
          weight_managed_ap: "50"
          weight_noise_floor: "40"
          weight_rogue_ap: "10"
          weight_spectral_rssi: "40"
          weight_weather_channel: "1000"

返回值

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

描述

build

字符串

fortigate 映像的版本号

返回:始终

示例: "1547"

http_method

字符串

用于将内容配置到 FortiGate 的最后一种方法

返回:始终

示例: "PUT"

http_status

字符串

FortiGate 在上次操作后给出的最后结果

返回:始终

示例: "200"

mkey

字符串

上次调用 FortiGate 时使用的主密钥(ID)

返回: 成功

示例: "id"

name

字符串

用于满足请求的表的名称

返回:始终

示例: "urlfilter"

path

字符串

用于满足请求的表的路径

返回:始终

示例: "webfilter"

revision

字符串

内部修订号

返回:始终

示例: "17.0.2.10658"

serial

字符串

设备的序列号

返回:始终

示例: "FGVMEVYYQT3AB5352"

status

字符串

操作结果的指示

返回:始终

示例: "success"

vdom

字符串

使用的虚拟域

返回:始终

示例: "root"

version

字符串

FortiGate 的版本

返回:始终

示例: "v5.6.3"

作者

  • Link Zheng (@chillancezen)

  • Jie Xue (@JieX19)

  • Hongbin Lu (@fgtdev-hblu)

  • Frank Shen (@frankshen01)

  • Miguel Angel Munoz (@mamunozgonzalez)

  • Nicolas Thomas (@thomnico)