fortinet.fortios.fortios_wireless_controller_arrp_profile – Configure WiFi Automatic Radio Resource Provisioning (ARRP) profiles in Fortinet’s FortiOS and FortiGate.
Note
This plugin is part of the fortinet.fortios collection (version 2.1.2).
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.10: 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 | Choices/Defaults | Comments | |
|---|---|---|---|
| access_token
string
|
Token-based authentication. Generated from GUI of Fortigate.
|
||
| enable_log
boolean
|
|
Enable/Disable logging for task.
|
|
| state
string / required
|
|
Indicates whether to create or remove the object.
|
|
| vdom
string
|
Default:
"root"
|
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.
|
|
| wireless_controller_arrp_profile
dictionary
|
Configure WiFi Automatic Radio Resource Provisioning (ARRP) profiles.
|
||
| comment
string
|
Comment.
|
||
| include_dfs_channel
string
|
|
Enable/disable use of DFS channel in DARRP channel selection phase 1 .
|
|
| include_weather_channel
string
|
|
Enable/disable use of weather channel in DARRP channel selection phase 1 .
|
|
| monitor_period
integer
|
Period in seconds to measure average transmit retries and receive errors .
|
||
| name
string / required
|
WiFi ARRP profile name.
|
||
| selection_period
integer
|
Period in seconds to measure average channel load, noise floor, spectral RSSI .
|
||
| threshold_ap
integer
|
Threshold to reject channel in DARRP channel selection phase 1 due to surrounding APs (0 - 500).
|
||
| threshold_channel_load
integer
|
Threshold in percentage to reject channel in DARRP channel selection phase 1 due to channel load (0 - 100).
|
||
| threshold_noise_floor
string
|
Threshold in dBm to reject channel in DARRP channel selection phase 1 due to noise floor (-95 to -20).
|
||
| threshold_rx_errors
integer
|
Threshold in percentage for receive errors to trigger channel reselection in DARRP monitor stage (0 - 100).
|
||
| threshold_spectral_rssi
string
|
Threshold in dBm to reject channel in DARRP channel selection phase 1 due to spectral RSSI (-95 to -20).
|
||
| threshold_tx_retries
integer
|
Threshold in percentage for transmit retries to trigger channel reselection in DARRP monitor stage (0 - 1000).
|
||
| weight_channel_load
integer
|
Weight in DARRP channel score calculation for channel load (0 - 2000).
|
||
| weight_dfs_channel
integer
|
Weight in DARRP channel score calculation for DFS channel (0 - 2000).
|
||
| weight_managed_ap
integer
|
Weight in DARRP channel score calculation for managed APs (0 - 2000).
|
||
| weight_noise_floor
integer
|
Weight in DARRP channel score calculation for noise floor (0 - 2000).
|
||
| weight_rogue_ap
integer
|
Weight in DARRP channel score calculation for rogue APs (0 - 2000).
|
||
| weight_spectral_rssi
integer
|
Weight in DARRP channel score calculation for spectral RSSI (0 - 2000).
|
||
| weight_weather_channel
integer
|
Weight in DARRP channel score calculation for weather channel (0 - 2000).
|
||
Notes
Note
- Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
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."
include_dfs_channel: "yes"
include_weather_channel: "yes"
monitor_period: "6"
name: "default_name_7"
selection_period: "8"
threshold_ap: "9"
threshold_channel_load: "10"
threshold_noise_floor: "<your_own_value>"
threshold_rx_errors: "12"
threshold_spectral_rssi: "<your_own_value>"
threshold_tx_retries: "14"
weight_channel_load: "15"
weight_dfs_channel: "16"
weight_managed_ap: "17"
weight_noise_floor: "18"
weight_rogue_ap: "19"
weight_spectral_rssi: "20"
weight_weather_channel: "21"
Return Values
Common return values are documented here, the following are the fields unique to this module:
| Key | Returned | Description |
|---|---|---|
| build
string
|
always |
Build number of the fortigate image
Sample:
1547
|
| http_method
string
|
always |
Last method used to provision the content into FortiGate
Sample:
PUT
|
| http_status
string
|
always |
Last result given by FortiGate on last operation applied
Sample:
200
|
| mkey
string
|
success |
Master key (id) used in the last call to FortiGate
Sample:
id
|
| name
string
|
always |
Name of the table used to fulfill the request
Sample:
urlfilter
|
| path
string
|
always |
Path of the table used to fulfill the request
Sample:
webfilter
|
| revision
string
|
always |
Internal revision number
Sample:
17.0.2.10658
|
| serial
string
|
always |
Serial number of the unit
Sample:
FGVMEVYYQT3AB5352
|
| status
string
|
always |
Indication of the operation's result
Sample:
success
|
| vdom
string
|
always |
Virtual domain used
Sample:
root
|
| version
string
|
always |
Version of the FortiGate
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)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/fortinet/fortios/fortios_wireless_controller_arrp_profile_module.html