fortinet.fortimanager.fmgr_wtpprofile_lbs 模块 – 设置各种基于位置的服务
注意
此模块是 fortinet.fortimanager 集合（版本 2.8.2）的一部分。
如果您正在使用 ansible 包，您可能已经安装了此集合。它不包含在 ansible-core 中。要检查是否已安装，请运行 ansible-galaxy collection list。
要安装它，请使用：ansible-galaxy collection install fortinet.fortimanager。
要在 Playbook 中使用它，请指定：fortinet.fortimanager.fmgr_wtpprofile_lbs。
在 fortinet.fortimanager 2.0.0 中新增
概要
此模块能够配置 FortiManager 设备。
示例包括所有参数和值，这些参数和值在使用前需要调整为数据源。
参数
参数 |
注释 |
|---|---|
无需使用用户名和密码即可访问 FortiManager 的令牌。 |
|
请求的 URL 中的参数 (adom)。 |
|
仅当模块模式与 FortiManager API 结构不同时才设置为 True，模块将继续执行而不验证参数。 选项
|
|
启用/禁用任务的日志记录。 选项
|
|
使用 forticloud API 访问令牌验证 Ansible 客户端。 |
|
用于底层 Json RPC 请求的覆盖方法。 选项
|
|
将覆盖失败条件的 rc 代码列表。 |
|
将覆盖成功条件的 rc 代码列表。 |
|
在工作区模式下运行的 FortiManager 要锁定的 adom，该值可以是全局的，也可以是包括 root 的其他值。 |
|
等待其他用户释放工作区锁定的最大时间（以秒为单位）。 默认： |
|
已弃用，请使用“wtp_profile” |
|
请求的 URL 中的参数 (wtp-profile)。 |
|
设置的顶级参数。 |
|
启用/禁用 AeroScout 实时定位服务 选项
|
|
在 Aeroscout AP 消息中使用 BSSID 或主板 MAC 地址作为 AP MAC 地址。 选项
|
|
启用/禁用 MU 复合报告。 选项
|
|
启用/禁用 AeroScout 支持。 选项
|
|
AeroScout 移动单元 |
|
AeroScout MU 模式超时 |
|
AeroScout 服务器的 IP 地址。 |
|
AeroScout 服务器 UDP 监听端口。 |
|
设置 BLE 实时定位服务 选项
|
|
应累积测量的时长（以秒为单位） |
|
（列表）要报告的标签和资产地址组列表。 |
|
要报告的标签和资产 UUID 列表 1 |
|
要报告的标签和资产 UUID 列表 2 |
|
要报告的标签和资产 UUID 列表 3 |
|
要报告的标签和资产 UUID 列表 4 |
|
选择将测量值、广告数据或位置数据报告给云服务器的协议。 选项
|
|
报告累积测量值的时间间隔（以秒为单位） |
|
BLE 实时定位服务的 FQDN |
|
BLE 实时定位服务的路径 |
|
BLE 实时定位服务的端口 |
|
BLE 实时定位服务的访问令牌 |
|
启用/禁用 Ekahua 闪烁模式 选项
|
|
WiFi 帧 MAC 地址或 WiFi 标签。 |
|
Ekahua RTLS 控制器的 IP 地址 |
|
Ekahua RTLS 控制器 |
|
启用/禁用 FortiPresence 以监控 WiFi 客户端的位置和活动，即使它们未连接到此 WiFi 网络... 选项
|
|
启用/禁用 FortiPresence 查找和报告 BLE 设备。 选项
|
|
FortiPresence 报告传输频率 |
|
FortiPresence 服务器 UDP 监听端口 |
|
FortiPresence 项目名称 |
|
启用/禁用 FortiPresence 查找和报告非法 AP。 选项
|
|
(列表) FortiPresence 密钥密码 |
|
FortiPresence 服务器 IP 地址。 |
|
FortiPresence 服务器地址类型 选项
|
|
FortiPresence 服务器的 FQDN。 |
|
启用/禁用 FortiPresence 查找和报告未关联的站点。 选项
|
|
启用/禁用 PoleStar BLE NAO 跟踪实时定位服务 选项
|
|
应累积测量的时长（以秒为单位） |
|
要报告的标签和资产地址组列表。 |
|
要报告的标签和资产 UUID 列表 1 |
|
要报告的标签和资产 UUID 列表 2 |
|
要报告的标签和资产 UUID 列表 3 |
|
要报告的标签和资产 UUID 列表 4 |
|
选择将测量值、广告数据或位置数据报告到 NAO 云的协议。 选项
|
|
报告累积测量值的时间间隔（以秒为单位） |
|
PoleStar Nao Track 服务器的 FQDN |
|
PoleStar Nao Track 服务器的路径 |
|
PoleStar Nao Track 服务器的端口 |
|
PoleStar Nao Track 服务器的访问令牌。 |
|
启用/禁用所有客户端（无论是否关联）的客户端站点定位服务 选项
|
备注
注意
从 2.4.0 版本开始，所有输入参数都使用下划线命名约定 (snake_case) 命名。请将参数（例如“var-name”）更改为“var_name”。旧的参数名称仍然可用，但您将收到弃用警告。您可以通过在 ansible.cfg 中设置 deprecation_warnings=False 来忽略此警告。
此 FortiManager 模块支持在工作区锁定模式下运行，顶层参数 workspace_locking_adom 和 workspace_locking_timeout 可帮助完成此工作。
通常，当返回非零 rc 时，运行一个模块可能会失败。您也可以使用参数 rc_failed 和 rc_succeeded 覆盖失败或成功的条件
示例
- 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>
ble_rtls: <value in [none, polestar, evresys]>
ble_rtls_accumulation_interval: <integer>
ble_rtls_asset_addrgrp_list: <list or string>
ble_rtls_asset_uuid_list1: <string>
ble_rtls_asset_uuid_list2: <string>
ble_rtls_asset_uuid_list3: <string>
ble_rtls_asset_uuid_list4: <string>
ble_rtls_protocol: <value in [WSS]>
ble_rtls_reporting_interval: <integer>
ble_rtls_server_fqdn: <string>
ble_rtls_server_path: <string>
ble_rtls_server_port: <integer>
ble_rtls_server_token: <string>
返回值
通用返回值记录在此处，以下是此模块独有的字段
键 |
描述 |
|---|---|
请求的结果。 返回: 始终 |
|
请求的完整 URL。 返回: 始终 示例: |
|
API 请求的状态。 返回: 始终 示例: |
|
API 响应。 返回: 始终 |
|
API 响应的描述性消息。 返回: 始终 示例: |
|
目标系统的信息。 返回: 始终 |
|
请求的状态。 返回: 始终 示例: |
|
如果在 playbook 中使用的参数不受当前 FortiManager 版本支持，则发出警告。 返回: 复杂 |