Try SpotterConfigure WiFi Automatic Radio Resource Provisioning
| "added in version" 2.1.0 of fortinet.fortimanager"
Authors: Xinwei Du (@dux-fortinet), Xing Li (@lix-fortinet), Jie Xue (@JieX19), Link Zheng (@chillancezen), Frank Shen (@fshen01), Hongbin Lu (@fgtdev-hblu)
preview | supported by community
Install with ansible-galaxy collection install fortinet.fortimanager:==2.4.0
collections:
- name: fortinet.fortimanager
version: 2.4.0This module is able to configure a FortiManager device.
Examples include all parameters and values which need to be adjusted to data sources before usage.
- 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>
adom:
description: The parameter (adom) in requested url.
required: true
type: str
state:
choices:
- present
- absent
description: The directive to create, update or delete an object.
required: true
type: str
rc_failed:
description: The rc codes list with which the conditions to fail will be overriden.
elements: int
type: list
enable_log:
default: false
description: Enable/Disable logging for task.
type: bool
arrpprofile:
description: The top level parameters set.
required: false
suboptions:
comment:
description: Comment.
type: str
darrp-optimize:
description: Deprecated, please rename it to darrp_optimize. Time for running
Dynamic Automatic Radio Resource Provisioning
type: int
darrp-optimize-schedules:
description: (list) Deprecated, please rename it to darrp_optimize_schedules.
type: raw
include-dfs-channel:
choices:
- 'no'
- disable
- 'yes'
- enable
description: Deprecated, please rename it to include_dfs_channel. Enable/disable
use of DFS channel in DARRP channel selection phase 1
type: str
include-weather-channel:
choices:
- 'no'
- disable
- 'yes'
- enable
description: Deprecated, please rename it to include_weather_channel. Enable/disable
use of weather channel in DARRP channel selection ...
type: str
monitor-period:
description: Deprecated, please rename it to monitor_period. Period in seconds
to measure average transmit retries and receive errors
type: int
name:
description: WiFi ARRP profile name.
required: true
type: str
override-darrp-optimize:
choices:
- disable
- enable
description: Deprecated, please rename it to override_darrp_optimize. Enable to
override setting darrp-optimize and darrp-optimize-sche...
type: str
selection-period:
description: Deprecated, please rename it to selection_period. Period in seconds
to measure average channel load, noise floor, spectral...
type: int
threshold-ap:
description: Deprecated, please rename it to threshold_ap. Threshold to reject
channel in DARRP channel selection phase 1 due to surrou...
type: int
threshold-channel-load:
description: Deprecated, please rename it to threshold_channel_load. Threshold
in percentage to reject channel in DARRP channel selecti...
type: int
threshold-noise-floor:
description: Deprecated, please rename it to threshold_noise_floor. Threshold
in dBm to reject channel in DARRP channel selection phase...
type: str
threshold-rx-errors:
description: Deprecated, please rename it to threshold_rx_errors. Threshold in
percentage for receive errors to trigger channel reselec...
type: int
threshold-spectral-rssi:
description: Deprecated, please rename it to threshold_spectral_rssi. Threshold
in dBm to reject channel in DARRP channel selection pha...
type: str
threshold-tx-retries:
description: Deprecated, please rename it to threshold_tx_retries. Threshold in
percentage for transmit retries to trigger channel rese...
type: int
weight-channel-load:
description: Deprecated, please rename it to weight_channel_load. Weight in DARRP
channel score calculation for channel load
type: int
weight-dfs-channel:
description: Deprecated, please rename it to weight_dfs_channel. Weight in DARRP
channel score calculation for DFS channel
type: int
weight-managed-ap:
description: Deprecated, please rename it to weight_managed_ap. Weight in DARRP
channel score calculation for managed APs
type: int
weight-noise-floor:
description: Deprecated, please rename it to weight_noise_floor. Weight in DARRP
channel score calculation for noise floor
type: int
weight-rogue-ap:
description: Deprecated, please rename it to weight_rogue_ap. Weight in DARRP
channel score calculation for rogue APs
type: int
weight-spectral-rssi:
description: Deprecated, please rename it to weight_spectral_rssi. Weight in DARRP
channel score calculation for spectral RSSI
type: int
weight-weather-channel:
description: Deprecated, please rename it to weight_weather_channel. Weight in
DARRP channel score calculation for weather channel
type: int
type: dict
access_token:
description: The token to access FortiManager without using username and password.
type: str
rc_succeeded:
description: The rc codes list with which the conditions to succeed will be overriden.
elements: int
type: list
proposed_method:
choices:
- update
- set
- add
description: The overridden method for the underlying Json RPC request.
type: str
bypass_validation:
default: false
description: Only set to True when module schema diffs with FortiManager API structure,
module continues to execute without validating parameters.
type: bool
workspace_locking_adom:
description: The adom to lock for FortiManager running in workspace mode, the value
can be global and others including root.
type: str
forticloud_access_token:
description: Authenticate Ansible client with forticloud API access token.
type: str
workspace_locking_timeout:
default: 300
description: The maximum time in seconds to wait for other user to release the workspace
lock.
type: int
meta:
contains:
request_url:
description: The full url requested.
returned: always
sample: /sys/login/user
type: str
response_code:
description: The status of api request.
returned: always
sample: 0
type: int
response_data:
description: The api response.
returned: always
type: list
response_message:
description: The descriptive message of the api response.
returned: always
sample: OK.
type: str
system_information:
description: The information of the target system.
returned: always
type: dict
description: The result of the request.
returned: always
type: dict
rc:
description: The status the request.
returned: always
sample: 0
type: int
version_check_warning:
description: Warning if the parameters used in the playbook are not supported by
the current FortiManager version.
returned: complex
type: list