fmgr_wtpprofile_lbs – Set various location based service (LBS) options.

New in version 2.0.0.

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.
  • Tested with FortiManager v6.x and v7.x.

Requirements

The below requirements are needed on the host that executes this module.

  • ansible>=2.9.0

FortiManager Version Compatibility


6.0.0
True
6.2.0 6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.2.7 6.2.8 6.2.9 6.2.10 6.2.11
True True True True True True True True True True True
6.4.0 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 6.4.6 6.4.7 6.4.8 6.4.9 6.4.10 6.4.11 6.4.12
True True True True True True True True True True True True True
7.0.0 7.0.1 7.0.2 7.0.3 7.0.4 7.0.5 7.0.6 7.0.7 7.0.8
True True True True True True True True True
7.2.0 7.2.1 7.2.2 7.2.3
True True True True
7.4.0
True

Parameters

  • access_token -The token to access FortiManager without using username and password. type: str required: false
  • 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
  • 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
  • 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
  • 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
  • adom - The parameter in requested url type: str required: true
  • wtp-profile - The parameter in requested url type: str required: true
  • wtpprofile_lbs - Set various location based service type: dict
    • aeroscout - Enable/disable AeroScout Real Time Location Service (RTLS) support. type: str choices: [disable, enable] more...
    • aeroscout-ap-mac - Use BSSID or board MAC address as AP MAC address in the Aeroscout AP message. type: str choices: [bssid, board-mac] more...
    • aeroscout-mmu-report - Enable/disable MU compounded report. type: str choices: [disable, enable] more...
    • aeroscout-mu - Enable/disable AeroScout support. type: str choices: [disable, enable] more...
    • aeroscout-mu-factor - AeroScout Mobile Unit (MU) mode dilution factor (default = 20). type: int more...
    • aeroscout-mu-timeout - AeroScout MU mode timeout (0 - 65535 sec, default = 5). type: int more...
    • aeroscout-server-ip - IP address of AeroScout server. type: str more...
    • aeroscout-server-port - AeroScout server UDP listening port. type: int more...
    • ekahau-blink-mode - Enable/disable Ekahua blink mode (also called AiRISTA Flow Blink Mode) to find the location of devices connected to a wireless LAN (default = disable). type: str choices: [disable, enable] more...
    • ekahau-tag - WiFi frame MAC address or WiFi Tag. type: str more...
    • erc-server-ip - IP address of Ekahua RTLS Controller (ERC). type: str more...
    • erc-server-port - Ekahua RTLS Controller (ERC) UDP listening port. type: int more...
    • fortipresence - Enable/disable FortiPresence to monitor the location and activity of WiFi clients even if they dont connect to this WiFi network (default = disable). type: str choices: [disable, enable, enable2, foreign, both] more...
    • fortipresence-frequency - FortiPresence report transmit frequency (5 - 65535 sec, default = 30). type: int more...
    • fortipresence-port - FortiPresence server UDP listening port (default = 3000). type: int more...
    • fortipresence-project - FortiPresence project name (max. type: str more...
    • fortipresence-rogue - Enable/disable FortiPresence finding and reporting rogue APs. type: str choices: [disable, enable] more...
    • fortipresence-secret - No description for the parameter type: str more...
    • fortipresence-server - FortiPresence server IP address. type: str more...
    • fortipresence-unassoc - Enable/disable FortiPresence finding and reporting unassociated stations. type: str choices: [disable, enable] more...
    • station-locate - Enable/disable client station locating services for all clients, whether associated or not (default = disable). type: str choices: [disable, enable] more...
    • fortipresence-ble - Enable/disable FortiPresence finding and reporting BLE devices. type: str choices: [disable, enable] more...
    • fortipresence-server-addr-type - FortiPresence server address type (default = ipv4). type: str choices: [fqdn, ipv4] more...
    • fortipresence-server-fqdn - FQDN of FortiPresence server. type: str 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: Set various location based service
     fmgr_wtpprofile_lbs:
        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>
        wtp-profile: <your own value>
        wtpprofile_lbs:
           aeroscout: <value in [disable, enable]>
           aeroscout-ap-mac: <value in [bssid, board-mac]>
           aeroscout-mmu-report: <value in [disable, enable]>
           aeroscout-mu: <value in [disable, enable]>
           aeroscout-mu-factor: <value of integer>
           aeroscout-mu-timeout: <value of integer>
           aeroscout-server-ip: <value of string>
           aeroscout-server-port: <value of integer>
           ekahau-blink-mode: <value in [disable, enable]>
           ekahau-tag: <value of string>
           erc-server-ip: <value of string>
           erc-server-port: <value of integer>
           fortipresence: <value in [disable, enable, enable2, ...]>
           fortipresence-frequency: <value of integer>
           fortipresence-port: <value of integer>
           fortipresence-project: <value of string>
           fortipresence-rogue: <value in [disable, enable]>
           fortipresence-secret: <value of string>
           fortipresence-server: <value of string>
           fortipresence-unassoc: <value in [disable, enable]>
           station-locate: <value in [disable, enable]>
           fortipresence-ble: <value in [disable, enable]>
           fortipresence-server-addr-type: <value in [fqdn, ipv4]>
           fortipresence-server-fqdn: <value of string>

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:

  • meta - The result of the request.returned: always type: dict
    • 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_data - The data body of the api response. returned: optional type: list or dict
    • response_message - The descriptive message of the api response. returned: always type: str sample: OK
    • system_information - The information of the target system. returned: always type: dict
  • rc - The status the request. returned: always type: int 0
  • version_check_warning - Warning if the parameters used in the playbook are not supported by the current FortiManager version. returned: if at least on parameter mpt supported by the current FortiManager version type: list 0

Status

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

Authors

  • Xinwei Du (@dux-fortinet)
  • Xing Li (@lix-fortinet)
  • Jie Xue (@JieX19)
  • Link Zheng (@chillancezen)
  • Frank Shen (@fshen01)
  • Hongbin Lu (@fgtdev-hblu)

Hint

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