fmgr_wtpprofile_lbs – Set various location based service (LBS) options.
Added in version 2.0.0.
Warning
Starting in version 3.0.0, all input arguments will be named using the underscore naming convention (snake_case).
Argument name before 3.0.0:
var-name,var name,var.nameNew argument name starting in 3.0.0:
var_name
FortiManager Ansible v2.4+ supports both previous argument name and new underscore name. You will receive deprecation warnings if you keep using the previous argument name. You can ignore the warning by setting deprecation_warnings=False in ansible.cfg.
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.15.0
FortiManager Version Compatibility
Supported Version Ranges: v6.0.0 -> latest
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 (Alias name: 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 (Alias name: aeroscout-mmu-report) Enable/disable mu compounded report. type: str choices: [disable, enable] more...
- aeroscout_mu (Alias name: aeroscout-mu) Enable/disable aeroscout support. type: str choices: [disable, enable] more...
- aeroscout_mu_factor (Alias name: aeroscout-mu-factor) Aeroscout mobile unit (mu) mode dilution factor (default = 20). type: int more...
- aeroscout_mu_timeout (Alias name: aeroscout-mu-timeout) Aeroscout mu mode timeout (0 - 65535 sec, default = 5). type: int more...
- aeroscout_server_ip (Alias name: aeroscout-server-ip) Ip address of aeroscout server. type: str more...
- aeroscout_server_port (Alias name: aeroscout-server-port) Aeroscout server udp listening port. type: int more...
- ekahau_blink_mode (Alias name: 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 (Alias name: ekahau-tag) Wifi frame mac address or wifi tag. type: str more...
- erc_server_ip (Alias name: erc-server-ip) Ip address of ekahua rtls controller (erc). type: str more...
- erc_server_port (Alias name: 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 (Alias name: fortipresence-frequency) Fortipresence report transmit frequency (5 - 65535 sec, default = 30). type: int more...
- fortipresence_port (Alias name: fortipresence-port) Fortipresence server udp listening port (default = 3000). type: int more...
- fortipresence_project (Alias name: fortipresence-project) Fortipresence project name (max. type: str more...
- fortipresence_rogue (Alias name: fortipresence-rogue) Enable/disable fortipresence finding and reporting rogue aps. type: str choices: [disable, enable] more...
- fortipresence_secret (Alias name: fortipresence-secret) type: list more...
- fortipresence_server (Alias name: fortipresence-server) Fortipresence server ip address. type: str more...
- fortipresence_unassoc (Alias name: fortipresence-unassoc) Enable/disable fortipresence finding and reporting unassociated stations. type: str choices: [disable, enable] more...
- station_locate (Alias name: 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 (Alias name: fortipresence-ble) Enable/disable fortipresence finding and reporting ble devices. type: str choices: [disable, enable] more...
- fortipresence_server_addr_type (Alias name: fortipresence-server-addr-type) Fortipresence server address type (default = ipv4). type: str choices: [fqdn, ipv4] more...
- fortipresence_server_fqdn (Alias name: fortipresence-server-fqdn) Fqdn of fortipresence server. type: str more...
- polestar Enable/disable polestar ble nao track real time location service (rtls) support (default = disable). type: str choices: [disable, enable] more...
- polestar_accumulation_interval (Alias name: polestar-accumulation-interval) Time that measurements should be accumulated in seconds (default = 2). type: int more...
- polestar_asset_addrgrp_list (Alias name: polestar-asset-addrgrp-list) Tags and asset addrgrp list to be reported. type: str more...
- polestar_asset_uuid_list1 (Alias name: polestar-asset-uuid-list1) Tags and asset uuid list 1 to be reported (string in the format of xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx). type: str more...
- polestar_asset_uuid_list2 (Alias name: polestar-asset-uuid-list2) Tags and asset uuid list 2 to be reported (string in the format of xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx). type: str more...
- polestar_asset_uuid_list3 (Alias name: polestar-asset-uuid-list3) Tags and asset uuid list 3 to be reported (string in the format of xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx). type: str more...
- polestar_asset_uuid_list4 (Alias name: polestar-asset-uuid-list4) Tags and asset uuid list 4 to be reported (string in the format of xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx). type: str more...
- polestar_protocol (Alias name: polestar-protocol) Select the protocol to report measurements, advertising data, or location data to nao cloud. type: str choices: [WSS] more...
- polestar_reporting_interval (Alias name: polestar-reporting-interval) Time between reporting accumulated measurements in seconds (default = 2). type: int more...
- polestar_server_fqdn (Alias name: polestar-server-fqdn) Fqdn of polestar nao track server (default = ws. type: str more...
- polestar_server_path (Alias name: polestar-server-path) Path of polestar nao track server (default = /v1/token/
/pst-v2). type: str more... - polestar_server_port (Alias name: polestar-server-port) Port of polestar nao track server (default = 443). type: int more...
- polestar_server_token (Alias name: polestar-server-token) Access token of polestar nao track 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
- 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: 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 sample: 0
- version_check_warning - Warning if the parameters used in the playbook are not supported by the current FortiManager version. returned: if at least one parameter not supported by the current FortiManager version type: list
Status
This module is not guaranteed to have a backwards compatible interface.