fortinet.fortimanager.fmgr_wtpprofile_lbs module – Set various location based service

Note

This module is part of the fortinet.fortimanager collection (version 2.4.0).

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
access_token string	The token to access FortiManager without using username and password.
adom string / required	The parameter (adom) in requested url.
bypass_validation boolean	Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. Choices: `false` ← (default) `true`
enable_log boolean	Enable/Disable logging for task. Choices: `false` ← (default) `true`
forticloud_access_token string	Authenticate Ansible client with forticloud API access token.
proposed_method string	The overridden method for the underlying Json RPC request. Choices: `"update"` `"set"` `"add"`
rc_failed list / elements=integer	The rc codes list with which the conditions to fail will be overriden.
rc_succeeded list / elements=integer	The rc codes list with which the conditions to succeed will be overriden.
workspace_locking_adom string	The adom to lock for FortiManager running in workspace mode, the value can be global and others including root.
workspace_locking_timeout integer	The maximum time in seconds to wait for other user to release the workspace lock. Default: `300`
wtp-profile string	Deprecated, please use “wtp_profile”
wtp_profile string	The parameter (wtp-profile) in requested url.
wtpprofile_lbs dictionary	The top level parameters set.
aeroscout string	Enable/disable AeroScout Real Time Location Service Choices: `"disable"` `"enable"`
aeroscout-ap-mac string	Deprecated, please rename it to aeroscout_ap_mac. Use BSSID or board MAC address as AP MAC address in the Aeroscout AP mes… Choices: `"bssid"` `"board-mac"`
aeroscout-mmu-report string	Deprecated, please rename it to aeroscout_mmu_report. Enable/disable MU compounded report. Choices: `"disable"` `"enable"`
aeroscout-mu string	Deprecated, please rename it to aeroscout_mu. Enable/disable AeroScout support. Choices: `"disable"` `"enable"`
aeroscout-mu-factor integer	Deprecated, please rename it to aeroscout_mu_factor. AeroScout Mobile Unit
aeroscout-mu-timeout integer	Deprecated, please rename it to aeroscout_mu_timeout. AeroScout MU mode timeout
aeroscout-server-ip string	Deprecated, please rename it to aeroscout_server_ip. IP address of AeroScout server.
aeroscout-server-port integer	Deprecated, please rename it to aeroscout_server_port. AeroScout server UDP listening port.
ekahau-blink-mode string	Deprecated, please rename it to ekahau_blink_mode. Enable/disable Ekahua blink mode Choices: `"disable"` `"enable"`
ekahau-tag string	Deprecated, please rename it to ekahau_tag. WiFi frame MAC address or WiFi Tag.
erc-server-ip string	Deprecated, please rename it to erc_server_ip. IP address of Ekahua RTLS Controller
erc-server-port integer	Deprecated, please rename it to erc_server_port. Ekahua RTLS Controller
fortipresence string	Enable/disable FortiPresence to monitor the location and activity of WiFi clients even if they dont connect to this WiFi n… Choices: `"disable"` `"enable"` `"enable2"` `"foreign"` `"both"`
fortipresence-ble string	Deprecated, please rename it to fortipresence_ble. Enable/disable FortiPresence finding and reporting BLE devices. Choices: `"disable"` `"enable"`
fortipresence-frequency integer	Deprecated, please rename it to fortipresence_frequency. FortiPresence report transmit frequency
fortipresence-port integer	Deprecated, please rename it to fortipresence_port. FortiPresence server UDP listening port
fortipresence-project string	Deprecated, please rename it to fortipresence_project. FortiPresence project name
fortipresence-rogue string	Deprecated, please rename it to fortipresence_rogue. Enable/disable FortiPresence finding and reporting rogue APs. Choices: `"disable"` `"enable"`
fortipresence-secret any	(list) Deprecated, please rename it to fortipresence_secret.
fortipresence-server string	Deprecated, please rename it to fortipresence_server. FortiPresence server IP address.
fortipresence-server-addr-type string	Deprecated, please rename it to fortipresence_server_addr_type. FortiPresence server address type Choices: `"fqdn"` `"ipv4"`
fortipresence-server-fqdn string	Deprecated, please rename it to fortipresence_server_fqdn. FQDN of FortiPresence server.
fortipresence-unassoc string	Deprecated, please rename it to fortipresence_unassoc. Enable/disable FortiPresence finding and reporting unassociated sta… Choices: `"disable"` `"enable"`
polestar string	Enable/disable PoleStar BLE NAO Track Real Time Location Service Choices: `"disable"` `"enable"`
polestar-accumulation-interval integer	Deprecated, please rename it to polestar_accumulation_interval. Time that measurements should be accumulated in seconds
polestar-asset-addrgrp-list string	Deprecated, please rename it to polestar_asset_addrgrp_list. Tags and asset addrgrp list to be reported.
polestar-asset-uuid-list1 string	Deprecated, please rename it to polestar_asset_uuid_list1. Tags and asset UUID list 1 to be reported
polestar-asset-uuid-list2 string	Deprecated, please rename it to polestar_asset_uuid_list2. Tags and asset UUID list 2 to be reported
polestar-asset-uuid-list3 string	Deprecated, please rename it to polestar_asset_uuid_list3. Tags and asset UUID list 3 to be reported
polestar-asset-uuid-list4 string	Deprecated, please rename it to polestar_asset_uuid_list4. Tags and asset UUID list 4 to be reported
polestar-protocol string	Deprecated, please rename it to polestar_protocol. Select the protocol to report Measurements, Advertising Data, or Locati… Choices: `"WSS"`
polestar-reporting-interval integer	Deprecated, please rename it to polestar_reporting_interval. Time between reporting accumulated measurements in seconds
polestar-server-fqdn string	Deprecated, please rename it to polestar_server_fqdn. FQDN of PoleStar Nao Track Server
polestar-server-path string	Deprecated, please rename it to polestar_server_path. Path of PoleStar Nao Track Server
polestar-server-port integer	Deprecated, please rename it to polestar_server_port. Port of PoleStar Nao Track Server
polestar-server-token string	Deprecated, please rename it to polestar_server_token. Access Token of PoleStar Nao Track Server.
station-locate string	Deprecated, please rename it to station_locate. Enable/disable client station locating services for all clients, whether a… Choices: `"disable"` `"enable"`

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>

Return Values 

Common return values are documented here, the following are the fields unique to this module:

Key	Description
meta dictionary	The result of the request. Returned: always
request_url string	The full url requested. Returned: always Sample: `"/sys/login/user"`
response_code integer	The status of api request. Returned: always Sample: `0`
response_data list / elements=string	The api response. Returned: always
response_message string	The descriptive message of the api response. Returned: always Sample: `"OK."`
system_information dictionary	The information of the target system. Returned: always
rc integer	The status the request. Returned: always Sample: `0`
version_check_warning list / elements=string	Warning if the parameters used in the playbook are not supported by the current FortiManager version. Returned: complex

Authors

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

fortinet.fortimanager.fmgr_wtpprofile_lbs module – Set various location based service

Synopsis

Parameters

Notes

Examples

Return Values