fortinet.fortios.fortios_wireless_controller_arrp_profile module – Configure WiFi Automatic Radio Resource Provisioning (ARRP) profiles in Fortinet’s FortiOS and FortiGate.
Note
This module is part of the fortinet.fortios collection (version 2.1.6).
You might already have this collection installed if you are using the ansible package.
It is not included in ansible-core.
To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install fortinet.fortios.
To use it in a playbook, specify: fortinet.fortios.fortios_wireless_controller_arrp_profile.
New in version 2.0.0: of fortinet.fortios
Synopsis
This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify wireless_controller feature and arrp_profile category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
Requirements
The below requirements are needed on the host that executes this module.
ansible>=2.9.0
Parameters
Parameter |
Comments |
|---|---|
Token-based authentication. Generated from GUI of Fortigate. |
|
Enable/Disable logging for task. Choices:
|
|
Member attribute path to operate on. Delimited by a slash character if there are more than one attribute. Parameter marked with member_path is legitimate for doing member operation. |
|
Add or delete a member under specified attribute path. When member_state is specified, the state option is ignored. Choices:
|
|
Indicates whether to create or remove the object. Choices:
|
|
Virtual domain, among those defined previously. A vdom is a virtual instance of the FortiGate that can be configured and used as a different unit. Default: “root” |
|
Configure WiFi Automatic Radio Resource Provisioning (ARRP) profiles. |
|
Comment. |
|
Time for running Dynamic Automatic Radio Resource Provisioning (DARRP) optimizations (0 - 86400 sec). |
|
Firewall schedules for DARRP running time. DARRP will run periodically based on darrp-optimize within the schedules. Separate multiple schedule names with a space. |
|
Schedule name. Source firewall.schedule.group.name firewall.schedule.recurring.name firewall.schedule.onetime.name. |
|
Enable/disable use of DFS channel in DARRP channel selection phase 1 . Choices:
|
|
Enable/disable use of weather channel in DARRP channel selection phase 1 . Choices:
|
|
Period in seconds to measure average transmit retries and receive errors . |
|
WiFi ARRP profile name. |
|
Enable to override setting darrp-optimize and darrp-optimize-schedules . Choices:
|
|
Period in seconds to measure average channel load, noise floor, spectral RSSI . |
|
Threshold to reject channel in DARRP channel selection phase 1 due to surrounding APs (0 - 500). |
|
Threshold in percentage to reject channel in DARRP channel selection phase 1 due to channel load (0 - 100). |
|
Threshold in dBm to reject channel in DARRP channel selection phase 1 due to noise floor (-95 to -20). |
|
Threshold in percentage for receive errors to trigger channel reselection in DARRP monitor stage (0 - 100). |
|
Threshold in dBm to reject channel in DARRP channel selection phase 1 due to spectral RSSI (-95 to -20). |
|
Threshold in percentage for transmit retries to trigger channel reselection in DARRP monitor stage (0 - 1000). |
|
Weight in DARRP channel score calculation for channel load (0 - 2000). |
|
Weight in DARRP channel score calculation for DFS channel (0 - 2000). |
|
Weight in DARRP channel score calculation for managed APs (0 - 2000). |
|
Weight in DARRP channel score calculation for noise floor (0 - 2000). |
|
Weight in DARRP channel score calculation for rogue APs (0 - 2000). |
|
Weight in DARRP channel score calculation for spectral RSSI (0 - 2000). |
|
Weight in DARRP channel score calculation for weather channel (0 - 2000). |
Examples
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure WiFi Automatic Radio Resource Provisioning (ARRP) profiles.
fortios_wireless_controller_arrp_profile:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
wireless_controller_arrp_profile:
comment: "Comment."
darrp_optimize: "4"
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: "9"
name: "default_name_10"
override_darrp_optimize: "enable"
selection_period: "12"
threshold_ap: "13"
threshold_channel_load: "14"
threshold_noise_floor: "<your_own_value>"
threshold_rx_errors: "16"
threshold_spectral_rssi: "<your_own_value>"
threshold_tx_retries: "18"
weight_channel_load: "19"
weight_dfs_channel: "20"
weight_managed_ap: "21"
weight_noise_floor: "22"
weight_rogue_ap: "23"
weight_spectral_rssi: "24"
weight_weather_channel: "25"
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
Build number of the fortigate image Returned: always Sample: “1547” |
|
Last method used to provision the content into FortiGate Returned: always Sample: “PUT” |
|
Last result given by FortiGate on last operation applied Returned: always Sample: “200” |
|
Master key (id) used in the last call to FortiGate Returned: success Sample: “id” |
|
Name of the table used to fulfill the request Returned: always Sample: “urlfilter” |
|
Path of the table used to fulfill the request Returned: always Sample: “webfilter” |
|
Internal revision number Returned: always Sample: “17.0.2.10658” |
|
Serial number of the unit Returned: always Sample: “FGVMEVYYQT3AB5352” |
|
Indication of the operation’s result Returned: always Sample: “success” |
|
Virtual domain used Returned: always Sample: “root” |
|
Version of the FortiGate Returned: always Sample: “v5.6.3” |
Authors
Link Zheng (@chillancezen)
Jie Xue (@JieX19)
Hongbin Lu (@fgtdev-hblu)
Frank Shen (@frankshen01)
Miguel Angel Munoz (@mamunozgonzalez)
Nicolas Thomas (@thomnico)