fmgr_arrpprofile – Configure WiFi Automatic Radio Resource Provisioning (ARRP) profiles.¶
New in version 2.10.
Synopsis¶
- This module is able to configure a FortiManager device.
- Examples include all parameters and values need to be adjusted to data sources before usage.
Requirements¶
The below requirements are needed on the host that executes this module.
- ansible>=2.9.0
Parameters¶
- enable_log - Enable/Disable logging for task type: bool required: false default: False
- forticloud_access_token - Access token of forticloud managed API users, this option is available with FortiManager later than 6.4.0 type: str required: false
- proposed_method - The overridden method for the underlying Json RPC request type: str required: false choices: set, update, add
- bypass_validation - Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters type: bool required: false default: False
- workspace_locking_adom - Acquire the workspace lock if FortiManager is running in workspace mode type: str required: false choices: global, custom adom including root
- workspace_locking_timeout - The maximum time in seconds to wait for other users to release workspace lock type: integer required: false default: 300
- rc_succeeded - The rc codes list with which the conditions to succeed will be overriden type: list required: false
- rc_failed - The rc codes list with which the conditions to fail will be overriden type: list required: false
- state - The directive to create, update or delete an object type: str required: true choices: present, absent
- adom - The parameter in requested url type: str required: true
- arrpprofile - no description type: dict
- comment - Comment. type: str more...
- darrp-optimize - Time for running Dynamic Automatic Radio Resource Provisioning (DARRP) optimizations (0 - 86400 sec, default = 86400, 0 = disable). type: int more...
- darrp-optimize-schedules - No description for the parameter type: str more...
- include-dfs-channel - Enable/disable use of DFS channel in DARRP channel selection phase 1 (default = disable). type: str choices: [no, disable, yes, enable] more...
- include-weather-channel - Enable/disable use of weather channel in DARRP channel selection phase 1 (default = disable). type: str choices: [no, disable, yes, enable] more...
- monitor-period - Period in seconds to measure average transmit retries and receive errors (default = 300). type: int more...
- name - WiFi ARRP profile name. type: str more...
- override-darrp-optimize - Enable to override setting darrp-optimize and darrp-optimize-schedules (default = disable). type: str choices: [disable, enable] more...
- selection-period - Period in seconds to measure average channel load, noise floor, spectral RSSI (default = 3600). type: int more...
- threshold-ap - Threshold to reject channel in DARRP channel selection phase 1 due to surrounding APs (0 - 500, default = 250). type: int more...
- threshold-channel-load - Threshold in percentage to reject channel in DARRP channel selection phase 1 due to channel load (0 - 100, default = 60). type: int more...
- threshold-noise-floor - Threshold in dBm to reject channel in DARRP channel selection phase 1 due to noise floor (-95 to -20, default = -85). type: str more...
- threshold-rx-errors - Threshold in percentage for receive errors to trigger channel reselection in DARRP monitor stage (0 - 100, default = 50). type: int more...
- threshold-spectral-rssi - Threshold in dBm to reject channel in DARRP channel selection phase 1 due to spectral RSSI (-95 to -20, default = -65). type: str more...
- threshold-tx-retries - Threshold in percentage for transmit retries to trigger channel reselection in DARRP monitor stage (0 - 1000, default = 300). type: int more...
- weight-channel-load - Weight in DARRP channel score calculation for channel load (0 - 2000, default = 20). type: int more...
- weight-dfs-channel - Weight in DARRP channel score calculation for DFS channel (0 - 2000, default = 500). type: int more...
- weight-managed-ap - Weight in DARRP channel score calculation for managed APs (0 - 2000, default = 50). type: int more...
- weight-noise-floor - Weight in DARRP channel score calculation for noise floor (0 - 2000, default = 40). type: int more...
- weight-rogue-ap - Weight in DARRP channel score calculation for rogue APs (0 - 2000, default = 10). type: int more...
- weight-spectral-rssi - Weight in DARRP channel score calculation for spectral RSSI (0 - 2000, default = 40). type: int more...
- weight-weather-channel - Weight in DARRP channel score calculation for weather channel (0 - 2000, default = 1000). type: int more...
Notes¶
Note
- 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¶
- hosts: fortimanager-inventory
collections:
- fortinet.fortimanager
connection: httpapi
vars:
ansible_httpapi_use_ssl: True
ansible_httpapi_validate_certs: False
ansible_httpapi_port: 443
tasks:
- name: no description
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: <value in [present, absent]>
arrpprofile:
comment: <value of string>
darrp-optimize: <value of integer>
darrp-optimize-schedules: <value of string>
include-dfs-channel: <value in [no, disable, yes, ...]>
include-weather-channel: <value in [no, disable, yes, ...]>
monitor-period: <value of integer>
name: <value of string>
override-darrp-optimize: <value in [disable, enable]>
selection-period: <value of integer>
threshold-ap: <value of integer>
threshold-channel-load: <value of integer>
threshold-noise-floor: <value of string>
threshold-rx-errors: <value of integer>
threshold-spectral-rssi: <value of string>
threshold-tx-retries: <value of integer>
weight-channel-load: <value of integer>
weight-dfs-channel: <value of integer>
weight-managed-ap: <value of integer>
weight-noise-floor: <value of integer>
weight-rogue-ap: <value of integer>
weight-spectral-rssi: <value of integer>
weight-weather-channel: <value of integer>
Return Values¶
Common return values are documented: https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values, the following are the fields unique to this module:
- request_url - The full url requested returned: always type: str sample: /sys/login/user
- response_code - The status of api request returned: always type: int sample: 0
- response_message - The descriptive message of the api response returned: always type: str sample: OK
- response_data - The data body of the api response returned: optional type: list or dict