fortinet.fortimanager.fmgr_arrpprofile module – Configure WiFi Automatic Radio Resource Provisioning
Note
This module is part of the fortinet.fortimanager collection (version 2.8.0).
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.fortimanager.
To use it in a playbook, specify: fortinet.fortimanager.fmgr_arrpprofile.
New in fortinet.fortimanager 2.1.0
Synopsis
This module is able to configure a FortiManager device.
Examples include all parameters and values which need to be adjusted to data sources before usage.
Parameters
Parameter |
Comments |
|---|---|
The token to access FortiManager without using username and password. |
|
The parameter (adom) in requested url. |
|
The top level parameters set. |
|
Comment. |
|
Time for running Dynamic Automatic Radio Resource Provisioning |
|
(list) Firewall schedules for DARRP running time. |
|
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 |
|
Threshold in percentage to reject channel in DARRP channel selection phase 1 due to channel load |
|
Threshold in dBm to reject channel in DARRP channel selection phase 1 due to noise floor |
|
Threshold in percentage for receive errors to trigger channel reselection in DARRP monitor stage |
|
Threshold in dBm to reject channel in DARRP channel selection phase 1 due to spectral RSSI |
|
Threshold in percentage for transmit retries to trigger channel reselection in DARRP monitor stage |
|
Weight in DARRP channel score calculation for channel load |
|
Weight in DARRP channel score calculation for DFS channel |
|
Weight in DARRP channel score calculation for managed APs |
|
Weight in DARRP channel score calculation for noise floor |
|
Weight in DARRP channel score calculation for rogue APs |
|
Weight in DARRP channel score calculation for spectral RSSI |
|
Weight in DARRP channel score calculation for weather channel |
|
Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. Choices:
|
|
Enable/Disable logging for task. Choices:
|
|
Authenticate Ansible client with forticloud API access token. |
|
The overridden method for the underlying Json RPC request. Choices:
|
|
The rc codes list with which the conditions to fail will be overriden. |
|
The rc codes list with which the conditions to succeed will be overriden. |
|
The directive to create, update or delete an object. Choices:
|
|
The adom to lock for FortiManager running in workspace mode, the value can be global and others including root. |
|
The maximum time in seconds to wait for other user to release the workspace lock. Default: |
Notes
Note
Starting in version 2.4.0, all input arguments are named using the underscore naming convention (snake_case). Please change the arguments such as “var-name” to “var_name”. Old argument names are still available yet you will receive deprecation warnings. You can ignore this warning by setting deprecation_warnings=False in ansible.cfg.
Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace_locking_adom and workspace_locking_timeout help do the work.
To create or update an object, use state present directive.
To delete an object, use state absent directive.
Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc_failed and rc_succeeded
Examples
- 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>
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
The result of the request. Returned: always |
|
The full url requested. Returned: always Sample: |
|
The status of api request. Returned: always Sample: |
|
The api response. Returned: always |
|
The descriptive message of the api response. Returned: always Sample: |
|
The information of the target system. Returned: always |
|
The status the request. Returned: always Sample: |
|
Warning if the parameters used in the playbook are not supported by the current FortiManager version. Returned: complex |