fortios_wireless_controller_arrp_profile – Configure WiFi Automatic Radio Resource Provisioning (ARRP) profiles in Fortinet’s FortiOS and FortiGate.

New in version 2.0.0.

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.15

Tips

Using member operation to add an element to an existing object.

FortiOS Version Compatibility

Supported Version Ranges: v6.4.0, v6.4.4 -> 7.4.3

Parameters

  • access_token - Token-based authentication. Generated from GUI of Fortigate. type: str required: false
  • enable_log - Enable/Disable logging for task. type: bool required: false default: False
  • vdom - 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. type: str default: root
  • member_path - Member attribute path to operate on. type: str
  • member_state - Add or delete a member under specified attribute path. type: str choices: present, absent
  • state - Indicates whether to create or remove the object. type: str required: true choices: present, absent
  • wireless_controller_arrp_profile - Configure WiFi Automatic Radio Resource Provisioning (ARRP) profiles. type: dict more...
    • comment - Comment. type: str more...
    • darrp_optimize - Time for running Dynamic Automatic Radio Resource Provisioning (DARRP) optimizations (0 - 86400 sec). type: int more...
    • darrp_optimize_schedules - Firewall schedules for DARRP running time. DARRP will run periodically based on darrp-optimize within the schedules. Separate multiple schedule names with a space. type: list member_path: darrp_optimize_schedules:name more...
      • name - Schedule name. Source firewall.schedule.group.name firewall.schedule.recurring.name firewall.schedule.onetime.name. type: str required: true more...
    • include_dfs_channel - Enable/disable use of DFS channel in DARRP channel selection phase 1 . type: str choices: enable, disable, yes, no more...
    • include_weather_channel - Enable/disable use of weather channel in DARRP channel selection phase 1 . type: str choices: enable, disable, yes, no more...
    • monitor_period - Period in seconds to measure average transmit retries and receive errors . type: int more...
    • name - WiFi ARRP profile name. type: str required: true more...
    • override_darrp_optimize - Enable to override setting darrp-optimize and darrp-optimize-schedules . type: str choices: enable, disable more...
    • selection_period - Period in seconds to measure average channel load, noise floor, spectral RSSI . type: int more...
    • threshold_ap - Threshold to reject channel in DARRP channel selection phase 1 due to surrounding APs (0 - 500). type: int more...
    • threshold_channel_load - Threshold in percentage to reject channel in DARRP channel selection phase 1 due to channel load (0 - 100). 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). type: str more...
    • threshold_rx_errors - Threshold in percentage for receive errors to trigger channel reselection in DARRP monitor stage (0 - 100). 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). type: str more...
    • threshold_tx_retries - Threshold in percentage for transmit retries to trigger channel reselection in DARRP monitor stage (0 - 1000). type: int more...
    • weight_channel_load - Weight in DARRP channel score calculation for channel load (0 - 2000). type: int more...
    • weight_dfs_channel - Weight in DARRP channel score calculation for DFS channel (0 - 2000). type: int more...
    • weight_managed_ap - Weight in DARRP channel score calculation for managed APs (0 - 2000). type: int more...
    • weight_noise_floor - Weight in DARRP channel score calculation for noise floor (0 - 2000). type: int more...
    • weight_rogue_ap - Weight in DARRP channel score calculation for rogue APs (0 - 2000). type: int more...
    • weight_spectral_rssi - Weight in DARRP channel score calculation for spectral RSSI (0 - 2000). type: int more...
    • weight_weather_channel - Weight in DARRP channel score calculation for weather channel (0 - 2000). type: int more...

Notes

Note

  • Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks

Examples

- name: Configure WiFi Automatic Radio Resource Provisioning (ARRP) profiles.
  fortinet.fortios.fortios_wireless_controller_arrp_profile:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      wireless_controller_arrp_profile:
          comment: "Comment."
          darrp_optimize: "86400"
          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: "300"
          name: "default_name_10"
          override_darrp_optimize: "enable"
          selection_period: "3600"
          threshold_ap: "250"
          threshold_channel_load: "60"
          threshold_noise_floor: "<your_own_value>"
          threshold_rx_errors: "50"
          threshold_spectral_rssi: "<your_own_value>"
          threshold_tx_retries: "300"
          weight_channel_load: "20"
          weight_dfs_channel: "500"
          weight_managed_ap: "50"
          weight_noise_floor: "40"
          weight_rogue_ap: "10"
          weight_spectral_rssi: "40"
          weight_weather_channel: "1000"

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:

  • build - Build number of the fortigate image returned: always type: str sample: 1547
  • http_method - Last method used to provision the content into FortiGate returned: always type: str sample: PUT
  • http_status - Last result given by FortiGate on last operation applied returned: always type: str sample: 200
  • mkey - Master key (id) used in the last call to FortiGate returned: success type: str sample: id
  • name - Name of the table used to fulfill the request returned: always type: str sample: urlfilter
  • path - Path of the table used to fulfill the request returned: always type: str sample: webfilter
  • revision - Internal revision number returned: always type: str sample: 17.0.2.10658
  • serial - Serial number of the unit returned: always type: str sample: FGVMEVYYQT3AB5352
  • status - Indication of the operation's result returned: always type: str sample: success
  • vdom - Virtual domain used returned: always type: str sample: root
  • version - Version of the FortiGate returned: always type: str sample: v5.6.3

Status

  • This module is not guaranteed to have a backwards compatible interface.

Authors

  • Link Zheng (@chillancezen)

  • Jie Xue (@JieX19)

  • Hongbin Lu (@fgtdev-hblu)

  • Frank Shen (@frankshen01)

  • Miguel Angel Munoz (@mamunozgonzalez)

  • Nicolas Thomas (@thomnico)

Hint

If you notice any issues in this documentation, you can create a pull request to improve it.