Try SpotterSet various location based service
| "added in version" 2.0.0 of fortinet.fortimanager"
Authors: Xinwei Du (@dux-fortinet), Xing Li (@lix-fortinet), Jie Xue (@JieX19), Link Zheng (@chillancezen), Frank Shen (@fshen01), Hongbin Lu (@fgtdev-hblu)
preview | supported by community
Install with ansible-galaxy collection install fortinet.fortimanager:==2.4.0
collections:
- name: fortinet.fortimanager
version: 2.4.0This module is able to configure a FortiManager device.
Examples include all parameters and values which need to be adjusted to data sources before usage.
- 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>
adom:
description: The parameter (adom) in requested url.
required: true
type: str
rc_failed:
description: The rc codes list with which the conditions to fail will be overriden.
elements: int
type: list
enable_log:
default: false
description: Enable/Disable logging for task.
type: bool
wtp-profile:
description: Deprecated, please use "wtp_profile"
type: str
wtp_profile:
description: The parameter (wtp-profile) in requested url.
type: str
access_token:
description: The token to access FortiManager without using username and password.
type: str
rc_succeeded:
description: The rc codes list with which the conditions to succeed will be overriden.
elements: int
type: list
wtpprofile_lbs:
description: The top level parameters set.
required: false
suboptions:
aeroscout:
choices:
- disable
- enable
description: Enable/disable AeroScout Real Time Location Service
type: str
aeroscout-ap-mac:
choices:
- bssid
- board-mac
description: Deprecated, please rename it to aeroscout_ap_mac. Use BSSID or board
MAC address as AP MAC address in the Aeroscout AP mes...
type: str
aeroscout-mmu-report:
choices:
- disable
- enable
description: Deprecated, please rename it to aeroscout_mmu_report. Enable/disable
MU compounded report.
type: str
aeroscout-mu:
choices:
- disable
- enable
description: Deprecated, please rename it to aeroscout_mu. Enable/disable AeroScout
support.
type: str
aeroscout-mu-factor:
description: Deprecated, please rename it to aeroscout_mu_factor. AeroScout Mobile
Unit
type: int
aeroscout-mu-timeout:
description: Deprecated, please rename it to aeroscout_mu_timeout. AeroScout MU
mode timeout
type: int
aeroscout-server-ip:
description: Deprecated, please rename it to aeroscout_server_ip. IP address of
AeroScout server.
type: str
aeroscout-server-port:
description: Deprecated, please rename it to aeroscout_server_port. AeroScout
server UDP listening port.
type: int
ekahau-blink-mode:
choices:
- disable
- enable
description: Deprecated, please rename it to ekahau_blink_mode. Enable/disable
Ekahua blink mode
type: str
ekahau-tag:
description: Deprecated, please rename it to ekahau_tag. WiFi frame MAC address
or WiFi Tag.
type: str
erc-server-ip:
description: Deprecated, please rename it to erc_server_ip. IP address of Ekahua
RTLS Controller
type: str
erc-server-port:
description: Deprecated, please rename it to erc_server_port. Ekahua RTLS Controller
type: int
fortipresence:
choices:
- disable
- enable
- enable2
- foreign
- both
description: Enable/disable FortiPresence to monitor the location and activity
of WiFi clients even if they dont connect to this WiFi n...
type: str
fortipresence-ble:
choices:
- disable
- enable
description: Deprecated, please rename it to fortipresence_ble. Enable/disable
FortiPresence finding and reporting BLE devices.
type: str
fortipresence-frequency:
description: Deprecated, please rename it to fortipresence_frequency. FortiPresence
report transmit frequency
type: int
fortipresence-port:
description: Deprecated, please rename it to fortipresence_port. FortiPresence
server UDP listening port
type: int
fortipresence-project:
description: Deprecated, please rename it to fortipresence_project. FortiPresence
project name
type: str
fortipresence-rogue:
choices:
- disable
- enable
description: Deprecated, please rename it to fortipresence_rogue. Enable/disable
FortiPresence finding and reporting rogue APs.
type: str
fortipresence-secret:
description: (list) Deprecated, please rename it to fortipresence_secret.
type: raw
fortipresence-server:
description: Deprecated, please rename it to fortipresence_server. FortiPresence
server IP address.
type: str
fortipresence-server-addr-type:
choices:
- fqdn
- ipv4
description: Deprecated, please rename it to fortipresence_server_addr_type. FortiPresence
server address type
type: str
fortipresence-server-fqdn:
description: Deprecated, please rename it to fortipresence_server_fqdn. FQDN of
FortiPresence server.
type: str
fortipresence-unassoc:
choices:
- disable
- enable
description: Deprecated, please rename it to fortipresence_unassoc. Enable/disable
FortiPresence finding and reporting unassociated sta...
type: str
polestar:
choices:
- disable
- enable
description: Enable/disable PoleStar BLE NAO Track Real Time Location Service
type: str
polestar-accumulation-interval:
description: Deprecated, please rename it to polestar_accumulation_interval. Time
that measurements should be accumulated in seconds
type: int
polestar-asset-addrgrp-list:
description: Deprecated, please rename it to polestar_asset_addrgrp_list. Tags
and asset addrgrp list to be reported.
type: str
polestar-asset-uuid-list1:
description: Deprecated, please rename it to polestar_asset_uuid_list1. Tags and
asset UUID list 1 to be reported
type: str
polestar-asset-uuid-list2:
description: Deprecated, please rename it to polestar_asset_uuid_list2. Tags and
asset UUID list 2 to be reported
type: str
polestar-asset-uuid-list3:
description: Deprecated, please rename it to polestar_asset_uuid_list3. Tags and
asset UUID list 3 to be reported
type: str
polestar-asset-uuid-list4:
description: Deprecated, please rename it to polestar_asset_uuid_list4. Tags and
asset UUID list 4 to be reported
type: str
polestar-protocol:
choices:
- WSS
description: Deprecated, please rename it to polestar_protocol. Select the protocol
to report Measurements, Advertising Data, or Locati...
type: str
polestar-reporting-interval:
description: Deprecated, please rename it to polestar_reporting_interval. Time
between reporting accumulated measurements in seconds
type: int
polestar-server-fqdn:
description: Deprecated, please rename it to polestar_server_fqdn. FQDN of PoleStar
Nao Track Server
type: str
polestar-server-path:
description: Deprecated, please rename it to polestar_server_path. Path of PoleStar
Nao Track Server
type: str
polestar-server-port:
description: Deprecated, please rename it to polestar_server_port. Port of PoleStar
Nao Track Server
type: int
polestar-server-token:
description: Deprecated, please rename it to polestar_server_token. Access Token
of PoleStar Nao Track Server.
type: str
station-locate:
choices:
- disable
- enable
description: Deprecated, please rename it to station_locate. Enable/disable client
station locating services for all clients, whether a...
type: str
type: dict
proposed_method:
choices:
- update
- set
- add
description: The overridden method for the underlying Json RPC request.
type: str
bypass_validation:
default: false
description: Only set to True when module schema diffs with FortiManager API structure,
module continues to execute without validating parameters.
type: bool
workspace_locking_adom:
description: The adom to lock for FortiManager running in workspace mode, the value
can be global and others including root.
type: str
forticloud_access_token:
description: Authenticate Ansible client with forticloud API access token.
type: str
workspace_locking_timeout:
default: 300
description: The maximum time in seconds to wait for other user to release the workspace
lock.
type: int
meta:
contains:
request_url:
description: The full url requested.
returned: always
sample: /sys/login/user
type: str
response_code:
description: The status of api request.
returned: always
sample: 0
type: int
response_data:
description: The api response.
returned: always
type: list
response_message:
description: The descriptive message of the api response.
returned: always
sample: OK.
type: str
system_information:
description: The information of the target system.
returned: always
type: dict
description: The result of the request.
returned: always
type: dict
rc:
description: The status the request.
returned: always
sample: 0
type: int
version_check_warning:
description: Warning if the parameters used in the playbook are not supported by
the current FortiManager version.
returned: complex
type: list