Try SpotterSet various location based service
| "added in version" 2.0.0 of drmofu.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 drmofu.fortimanager:==2.2.2
collections:
- name: drmofu.fortimanager
version: 2.2.2This module is able to configure a FortiManager device.
Examples include all parameters and values which need to be adjusted to data sources before usage.
- 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]>
fortipresence-server-addr-type: <value in [fqdn, ipv4]>
fortipresence-server-fqdn: <value of 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
required: false
type: list
enable_log:
default: false
description: Enable/Disable logging for task.
required: false
type: bool
wtp-profile:
description: the parameter (wtp-profile) in requested url
required: true
type: str
access_token:
description: The token to access FortiManager without using username and password.
required: false
type: str
rc_succeeded:
description: The rc codes list with which the conditions to succeed will be overriden.
elements: int
required: false
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: Use BSSID or board MAC address as AP MAC address in the Aeroscout
AP message.
type: str
aeroscout-mmu-report:
choices:
- disable
- enable
description: Enable/disable MU compounded report.
type: str
aeroscout-mu:
choices:
- disable
- enable
description: Enable/disable AeroScout support.
type: str
aeroscout-mu-factor:
description: AeroScout Mobile Unit
type: int
aeroscout-mu-timeout:
description: AeroScout MU mode timeout
type: int
aeroscout-server-ip:
description: IP address of AeroScout server.
type: str
aeroscout-server-port:
description: AeroScout server UDP listening port.
type: int
ekahau-blink-mode:
choices:
- disable
- enable
description: Enable/disable Ekahua blink mode
type: str
ekahau-tag:
description: WiFi frame MAC address or WiFi Tag.
type: str
erc-server-ip:
description: IP address of Ekahua RTLS Controller
type: str
erc-server-port:
description: 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 network
type: str
fortipresence-ble:
choices:
- disable
- enable
description: Enable/disable FortiPresence finding and reporting BLE devices.
type: str
fortipresence-frequency:
description: FortiPresence report transmit frequency
type: int
fortipresence-port:
description: FortiPresence server UDP listening port
type: int
fortipresence-project:
description: FortiPresence project name
type: str
fortipresence-rogue:
choices:
- disable
- enable
description: Enable/disable FortiPresence finding and reporting rogue APs.
type: str
fortipresence-secret:
description: description
type: str
fortipresence-server:
description: FortiPresence server IP address.
type: str
fortipresence-server-addr-type:
choices:
- fqdn
- ipv4
description: FortiPresence server address type
type: str
fortipresence-server-fqdn:
description: FQDN of FortiPresence server.
type: str
fortipresence-unassoc:
choices:
- disable
- enable
description: Enable/disable FortiPresence finding and reporting unassociated stations.
type: str
station-locate:
choices:
- disable
- enable
description: Enable/disable client station locating services for all clients,
whether associated or not
type: str
type: dict
proposed_method:
choices:
- update
- set
- add
description: The overridden method for the underlying Json RPC request.
required: false
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.
required: false
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.
required: false
type: str
forticloud_access_token:
description: Authenticate Ansible client with forticloud API access token.
required: false
type: str
workspace_locking_timeout:
default: 300
description: The maximum time in seconds to wait for other user to release the workspace
lock.
required: false
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