Docs4dev
Docs
ansible / latest / collections / fortinet / fortimanager / fmgr_wtpprofile_lbs_module.html

fortinet.fortimanager.fmgr_wtpprofile_lbs – Set various location based service

Note

This plugin is part of the fortinet.fortimanager collection (version 2.1.3).

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 version 2.10: of fortinet.fortimanager

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 Choices/Defaults Comments
adom
string / required
the parameter (adom) in requested url
bypass_validation
boolean
    Choices:
  • no ←
  • yes
only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters
enable_log
boolean
    Choices:
  • no ←
  • yes
Enable/Disable logging for task
proposed_method
string
    Choices:
  • update
  • set
  • add
The overridden method for the underlying Json RPC request
rc_failed
list / elements=string
the rc codes list with which the conditions to fail will be overriden
rc_succeeded
list / elements=string
the rc codes list with which the conditions to succeed will be overriden
state
string / required
    Choices:
  • present
  • absent
the directive to create, update or delete an object
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
Default:
300
the maximum time in seconds to wait for other user to release the workspace lock
wtp-profile
string / required
the parameter (wtp-profile) in requested url
wtpprofile_lbs
dictionary
the top level parameters set
aeroscout
string
    Choices:
  • disable
  • enable
Enable/disable AeroScout Real Time Location Service (RTLS) support.
aeroscout-ap-mac
string
    Choices:
  • bssid
  • board-mac
Use BSSID or board MAC address as AP MAC address in the Aeroscout AP message.
aeroscout-mmu-report
string
    Choices:
  • disable
  • enable
Enable/disable MU compounded report.
aeroscout-mu
string
    Choices:
  • disable
  • enable
Enable/disable AeroScout support.
aeroscout-mu-factor
integer
AeroScout Mobile Unit (MU) mode dilution factor (default = 20).
aeroscout-mu-timeout
integer
AeroScout MU mode timeout (0 - 65535 sec, default = 5).
aeroscout-server-ip
string
IP address of AeroScout server.
aeroscout-server-port
integer
AeroScout server UDP listening port.
ekahau-blink-mode
string
    Choices:
  • disable
  • enable
Enable/disable Ekahua blink mode (also called AiRISTA Flow Blink Mode) to find the location of devices connected to a wireless...
ekahau-tag
string
WiFi frame MAC address or WiFi Tag.
erc-server-ip
string
IP address of Ekahua RTLS Controller (ERC).
erc-server-port
integer
Ekahua RTLS Controller (ERC) UDP listening port.
fortipresence
string
    Choices:
  • disable
  • enable
  • enable2
  • foreign
  • both
Enable/disable FortiPresence to monitor the location and activity of WiFi clients even if they dont connect to this WiFi netwo...
fortipresence-ble
string
    Choices:
  • disable
  • enable
Enable/disable FortiPresence finding and reporting BLE devices.
fortipresence-frequency
integer
FortiPresence report transmit frequency (5 - 65535 sec, default = 30).
fortipresence-port
integer
FortiPresence server UDP listening port (default = 3000).
fortipresence-project
string
FortiPresence project name (max. 16 characters, default = fortipresence).
fortipresence-rogue
string
    Choices:
  • disable
  • enable
Enable/disable FortiPresence finding and reporting rogue APs.
fortipresence-secret
string
no description
fortipresence-server
string
FortiPresence server IP address.
fortipresence-unassoc
string
    Choices:
  • disable
  • enable
Enable/disable FortiPresence finding and reporting unassociated stations.
station-locate
string
    Choices:
  • disable
  • enable
Enable/disable client station locating services for all clients, whether associated or not (default = disable).

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]>

Return Values

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

Key Returned Description
request_url
string
always
The full url requested

Sample:
/sys/login/user
response_code
integer
always
The status of api request

response_message
string
always
The descriptive message of the api response

Sample:
OK.


Authors

  • Link Zheng (@chillancezen)
  • Jie Xue (@JieX19)
  • Frank Shen (@fshen01)
  • Hongbin Lu (@fgtdev-hblu)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/fortinet/fortimanager/fmgr_wtpprofile_lbs_module.html