drmofu.fortimanager.fmgr_arrpprofile (2.2.2) — module

Install collection

Install with ansible-galaxy collection install drmofu.fortimanager:==2.2.2

Add to requirements.yml

  collections:
    - name: drmofu.fortimanager
      version: 2.2.2

Description

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.

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

 - 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: Configure WiFi Automatic Radio Resource Provisioning
      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>

Inputs

    
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
    required: false
    type: list

enable_log:
    default: false
    description: Enable/Disable logging for task.
    required: false
    type: bool

arrpprofile:
    description: the top level parameters set
    required: false
    suboptions:
      comment:
        description: Comment.
        type: str
      darrp-optimize:
        description: Time for running Dynamic Automatic Radio Resource Provisioning
        type: int
      darrp-optimize-schedules:
        description: description
        type: str
      include-dfs-channel:
        choices:
        - 'no'
        - disable
        - 'yes'
        - enable
        description: Enable/disable use of DFS channel in DARRP channel selection phase
          1
        type: str
      include-weather-channel:
        choices:
        - 'no'
        - disable
        - 'yes'
        - enable
        description: Enable/disable use of weather channel in DARRP channel selection
          phase 1
        type: str
      monitor-period:
        description: Period in seconds to measure average transmit retries and receive
          errors
        type: int
      name:
        description: WiFi ARRP profile name.
        type: str
      override-darrp-optimize:
        choices:
        - disable
        - enable
        description: Enable to override setting darrp-optimize and darrp-optimize-schedules
        type: str
      selection-period:
        description: Period in seconds to measure average channel load, noise floor, spectral
          RSSI
        type: int
      threshold-ap:
        description: Threshold to reject channel in DARRP channel selection phase 1 due
          to surrounding APs
        type: int
      threshold-channel-load:
        description: Threshold in percentage to reject channel in DARRP channel selection
          phase 1 due to channel load
        type: int
      threshold-noise-floor:
        description: Threshold in dBm to reject channel in DARRP channel selection phase
          1 due to noise floor
        type: str
      threshold-rx-errors:
        description: Threshold in percentage for receive errors to trigger channel reselection
          in DARRP monitor stage
        type: int
      threshold-spectral-rssi:
        description: Threshold in dBm to reject channel in DARRP channel selection phase
          1 due to spectral RSSI
        type: str
      threshold-tx-retries:
        description: Threshold in percentage for transmit retries to trigger channel reselection
          in DARRP monitor stage
        type: int
      weight-channel-load:
        description: Weight in DARRP channel score calculation for channel load
        type: int
      weight-dfs-channel:
        description: Weight in DARRP channel score calculation for DFS channel
        type: int
      weight-managed-ap:
        description: Weight in DARRP channel score calculation for managed APs
        type: int
      weight-noise-floor:
        description: Weight in DARRP channel score calculation for noise floor
        type: int
      weight-rogue-ap:
        description: Weight in DARRP channel score calculation for rogue APs
        type: int
      weight-spectral-rssi:
        description: Weight in DARRP channel score calculation for spectral RSSI
        type: int
      weight-weather-channel:
        description: 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.
    required: false
    type: str

rc_succeeded:
    description: The rc codes list with which the conditions to succeed will be overriden.
    elements: int
    required: false
    type: list

proposed_method:
    choices:
    - update
    - set
    - add
    description: The overridden method for the underlying Json RPC request.
    required: false
    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.
    required: false
    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.
    required: false
    type: str

forticloud_access_token:
    description: Authenticate Ansible client with forticloud API access token.
    required: false
    type: str

workspace_locking_timeout:
    default: 300
    description: The maximum time in seconds to wait for other user to release the workspace
      lock.
    required: false
    type: int

Outputs

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