fortinet.fortimanager.fmgr_wtpprofile_lbs module – Set various location based service
Note
This module is part of the fortinet.fortimanager collection (version 2.8.2).
You might already have this collection installed if you are using the ansible package.
It is not included in ansible-core.
To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install fortinet.fortimanager.
To use it in a playbook, specify: fortinet.fortimanager.fmgr_wtpprofile_lbs.
New in fortinet.fortimanager 2.0.0
Synopsis
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.
Parameters
Parameter |
Comments |
|---|---|
The token to access FortiManager without using username and password. |
|
The parameter (adom) in requested url. |
|
Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. Choices:
|
|
Enable/Disable logging for task. Choices:
|
|
Authenticate Ansible client with forticloud API access token. |
|
The overridden method for the underlying Json RPC request. Choices:
|
|
The rc codes list with which the conditions to fail will be overriden. |
|
The rc codes list with which the conditions to succeed will be overriden. |
|
The adom to lock for FortiManager running in workspace mode, the value can be global and others including root. |
|
The maximum time in seconds to wait for other user to release the workspace lock. Default: |
|
Deprecated, please use “wtp_profile” |
|
The parameter (wtp-profile) in requested url. |
|
The top level parameters set. |
|
Enable/disable AeroScout Real Time Location Service Choices:
|
|
Use BSSID or board MAC address as AP MAC address in the Aeroscout AP message. Choices:
|
|
Enable/disable MU compounded report. Choices:
|
|
Enable/disable AeroScout support. Choices:
|
|
AeroScout Mobile Unit |
|
AeroScout MU mode timeout |
|
IP address of AeroScout server. |
|
AeroScout server UDP listening port. |
|
Set BLE Real Time Location Service Choices:
|
|
Time that measurements should be accumulated in seconds |
|
(list) Tags and asset addrgrp list to be reported. |
|
Tags and asset UUID list 1 to be reported |
|
Tags and asset UUID list 2 to be reported |
|
Tags and asset UUID list 3 to be reported |
|
Tags and asset UUID list 4 to be reported |
|
Select the protocol to report Measurements, Advertising Data, or Location Data to Cloud Server. Choices:
|
|
Time between reporting accumulated measurements in seconds |
|
FQDN of BLE Real Time Location Service |
|
Path of BLE Real Time Location Service |
|
Port of BLE Real Time Location Service |
|
Access Token of BLE Real Time Location Service |
|
Enable/disable Ekahua blink mode Choices:
|
|
WiFi frame MAC address or WiFi Tag. |
|
IP address of Ekahua RTLS Controller |
|
Ekahua RTLS Controller |
|
Enable/disable FortiPresence to monitor the location and activity of WiFi clients even if they dont connect to this WiFi n… Choices:
|
|
Enable/disable FortiPresence finding and reporting BLE devices. Choices:
|
|
FortiPresence report transmit frequency |
|
FortiPresence server UDP listening port |
|
FortiPresence project name |
|
Enable/disable FortiPresence finding and reporting rogue APs. Choices:
|
|
(list) FortiPresence secret password |
|
FortiPresence server IP address. |
|
FortiPresence server address type Choices:
|
|
FQDN of FortiPresence server. |
|
Enable/disable FortiPresence finding and reporting unassociated stations. Choices:
|
|
Enable/disable PoleStar BLE NAO Track Real Time Location Service Choices:
|
|
Time that measurements should be accumulated in seconds |
|
Tags and asset addrgrp list to be reported. |
|
Tags and asset UUID list 1 to be reported |
|
Tags and asset UUID list 2 to be reported |
|
Tags and asset UUID list 3 to be reported |
|
Tags and asset UUID list 4 to be reported |
|
Select the protocol to report Measurements, Advertising Data, or Location Data to NAO Cloud. Choices:
|
|
Time between reporting accumulated measurements in seconds |
|
FQDN of PoleStar Nao Track Server |
|
Path of PoleStar Nao Track Server |
|
Port of PoleStar Nao Track Server |
|
Access Token of PoleStar Nao Track Server. |
|
Enable/disable client station locating services for all clients, whether associated or not Choices:
|
Notes
Note
Starting in version 2.4.0, all input arguments are named using the underscore naming convention (snake_case). Please change the arguments such as “var-name” to “var_name”. Old argument names are still available yet you will receive deprecation warnings. You can ignore this warning by setting deprecation_warnings=False in ansible.cfg.
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.
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
- 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: Set various location based service
fortinet.fortimanager.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: <integer>
aeroscout_mu_timeout: <integer>
aeroscout_server_ip: <string>
aeroscout_server_port: <integer>
ekahau_blink_mode: <value in [disable, enable]>
ekahau_tag: <string>
erc_server_ip: <string>
erc_server_port: <integer>
fortipresence: <value in [disable, enable, enable2, ...]>
fortipresence_frequency: <integer>
fortipresence_port: <integer>
fortipresence_project: <string>
fortipresence_rogue: <value in [disable, enable]>
fortipresence_secret: <list or string>
fortipresence_server: <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: <string>
polestar: <value in [disable, enable]>
polestar_accumulation_interval: <integer>
polestar_asset_addrgrp_list: <string>
polestar_asset_uuid_list1: <string>
polestar_asset_uuid_list2: <string>
polestar_asset_uuid_list3: <string>
polestar_asset_uuid_list4: <string>
polestar_protocol: <value in [WSS]>
polestar_reporting_interval: <integer>
polestar_server_fqdn: <string>
polestar_server_path: <string>
polestar_server_port: <integer>
polestar_server_token: <string>
ble_rtls: <value in [none, polestar, evresys]>
ble_rtls_accumulation_interval: <integer>
ble_rtls_asset_addrgrp_list: <list or string>
ble_rtls_asset_uuid_list1: <string>
ble_rtls_asset_uuid_list2: <string>
ble_rtls_asset_uuid_list3: <string>
ble_rtls_asset_uuid_list4: <string>
ble_rtls_protocol: <value in [WSS]>
ble_rtls_reporting_interval: <integer>
ble_rtls_server_fqdn: <string>
ble_rtls_server_path: <string>
ble_rtls_server_port: <integer>
ble_rtls_server_token: <string>
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
The result of the request. Returned: always |
|
The full url requested. Returned: always Sample: |
|
The status of api request. Returned: always Sample: |
|
The api response. Returned: always |
|
The descriptive message of the api response. Returned: always Sample: |
|
The information of the target system. Returned: always |
|
The status the request. Returned: always Sample: |
|
Warning if the parameters used in the playbook are not supported by the current FortiManager version. Returned: complex |