Модуль fortinet.fortimanager.fmgr_wtpprofile_lbs — настройка различных служб, основанных на местоположении
Примечание
Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.14.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните команду ansible-galaxy collection list.
Чтобы установить её, используйте: ansible-galaxy collection install fortinet.fortimanager.
Чтобы использовать её в плейбуке, укажите: fortinet.fortimanager.fmgr_wtpprofile_lbs.
Добавлено в fortinet.fortimanager 2.0.0
Краткое описание
- Этот модуль позволяет настраивать устройство FortiManager.
- Примеры содержат все параметры и значения, которые необходимо скорректировать в соответствии с источниками данных перед использованием.
Параметры
Параметр | Комментарии |
|---|---|
access_token string | Токен для доступа к FortiManager без использования имени пользователя и пароля. |
adom string / обязательный | Параметр (adom) в запрашиваемом URL. |
bypass_validation boolean | Устанавливайте значение True только в том случае, если схема модуля отличается от структуры API FortiManager. Модуль продолжит выполнение без проверки параметров. Варианты:
|
enable_log boolean | Включить/отключить ведение журнала для задачи. Варианты:
|
forticloud_access_token string | Аутентификация клиента Ansible с помощью токена доступа к API FortiCloud. |
proposed_method string | Переопределенный метод для базового запроса Json RPC. Варианты:
|
rc_failed list / elements=integer | Список кодов rc, переопределяющий условия сбоя. |
rc_succeeded list / elements=integer | Список кодов rc, переопределяющий условия успешного выполнения. |
revision_note string | Примечание об изменении, которое можно указать при создании или обновлении объекта. |
workspace_locking_adom string | ADOM, который нужно заблокировать в FortiManager, работающем в режиме рабочего пространства. В качестве значения можно указать global и другие ADOM, включая root. |
workspace_locking_timeout integer | Максимальное время ожидания освобождения блокировки рабочего пространства другим пользователем, в секундах. По умолчанию: |
wtp-profile string | Устарело, используйте “wtp_profile” |
wtp_profile string | Параметр (wtp-profile) в запрашиваемом URL. |
wtpprofile_lbs dictionary | Набор параметров верхнего уровня. |
|
aeroscout string |
Включить/отключить службу определения местоположения AeroScout в реальном времени Варианты:
|
|
aeroscout_ap_mac псевдонимы: aeroscout-ap-mac string |
Использовать BSSID или MAC-адрес платы в качестве MAC-адреса точки доступа в сообщении AeroScout AP. Варианты:
|
|
aeroscout_mmu_report псевдонимы: aeroscout-mmu-report string |
Включить/отключить объединенный отчет MU. Варианты:
|
|
aeroscout_mu псевдонимы: aeroscout-mu string |
Включить/отключить поддержку AeroScout. Варианты:
|
|
aeroscout_mu_factor псевдонимы: aeroscout-mu-factor integer |
Мобильное устройство AeroScout |
|
aeroscout_mu_timeout псевдонимы: aeroscout-mu-timeout integer |
Тайм-аут режима MU AeroScout |
|
aeroscout_server_ip псевдонимы: aeroscout-server-ip string |
IP-адрес сервера AeroScout. |
|
aeroscout_server_port псевдонимы: aeroscout-server-port integer |
Порт UDP, на котором сервер AeroScout принимает подключения. |
|
ble_rtls псевдонимы: ble-rtls string |
Настройка службы определения местоположения BLE в реальном времени Варианты:
|
|
ble_rtls_accumulation_interval псевдонимы: ble-rtls-accumulation-interval integer |
Время накопления измерений в секундах |
|
ble_rtls_asset_addrgrp_list псевдонимы: ble-rtls-asset-addrgrp-list any |
(список) Теги и список групп адресов ресурсов для отправки в отчетах. |
|
ble_rtls_asset_uuid_list1 псевдонимы: ble-rtls-asset-uuid-list1 string |
Теги и список UUID ресурсов 1 для отправки в отчетах |
|
ble_rtls_asset_uuid_list2 псевдонимы: ble-rtls-asset-uuid-list2 string |
Теги и список UUID ресурсов 2 для отправки в отчетах |
|
ble_rtls_asset_uuid_list3 псевдонимы: ble-rtls-asset-uuid-list3 string |
Теги и список UUID ресурсов 3 для отправки в отчетах |
|
ble_rtls_asset_uuid_list4 псевдонимы: ble-rtls-asset-uuid-list4 string |
Теги и список UUID ресурсов 4 для отправки в отчетах |
|
ble_rtls_protocol псевдонимы: ble-rtls-protocol string |
Выберите протокол для отправки измерений, рекламных данных или данных о местоположении на облачный сервер. Варианты:
|
|
ble_rtls_reporting_interval псевдонимы: ble-rtls-reporting-interval integer |
Интервал между отправкой накопленных измерений в секундах |
|
ble_rtls_server_fqdn псевдонимы: ble-rtls-server-fqdn string |
Полное доменное имя службы определения местоположения BLE в реальном времени |
|
ble_rtls_server_path псевдонимы: ble-rtls-server-path string |
Путь службы определения местоположения BLE в реальном времени |
|
ble_rtls_server_port псевдонимы: ble-rtls-server-port integer |
Порт службы определения местоположения BLE в реальном времени |
|
ble_rtls_server_token псевдонимы: ble-rtls-server-token string |
Токен доступа к службе определения местоположения BLE в реальном времени |
|
ekahau_blink_mode псевдонимы: ekahau-blink-mode string |
Включить/отключить режим мигания Ekahua Варианты:
|
|
ekahau_tag псевдонимы: ekahau-tag string |
MAC-адрес кадра Wi-Fi или тег Wi-Fi. |
|
erc_server_ip псевдонимы: erc-server-ip string |
IP-адрес контроллера RTLS Ekahua |
|
erc_server_port псевдонимы: erc-server-port integer |
Контроллер RTLS Ekahua |
|
fortipresence string |
Включить/отключить FortiPresence для отслеживания местоположения и активности Wi-Fi-клиентов, даже если они не подключаются к этой сети Wi-Fi… Варианты:
|
|
fortipresence_ble псевдонимы: fortipresence-ble string |
Включить/отключить обнаружение и отправку отчетов об устройствах BLE с помощью FortiPresence. Варианты:
|
|
fortipresence_frequency псевдонимы: fortipresence-frequency integer |
Частота отправки отчетов FortiPresence |
|
fortipresence_port псевдонимы: fortipresence-port integer |
Порт UDP, на котором сервер FortiPresence принимает подключения |
|
fortipresence_project псевдонимы: fortipresence-project string |
Название проекта FortiPresence |
|
fortipresence_rogue псевдонимы: fortipresence-rogue string |
Включить/отключить обнаружение и отправку отчетов о несанкционированных точках доступа с помощью FortiPresence. Варианты:
|
|
fortipresence_secret псевдонимы: fortipresence-secret any |
(список) Секретный пароль FortiPresence |
|
fortipresence_server псевдонимы: fortipresence-server string |
IP-адрес сервера FortiPresence. |
|
fortipresence_server_addr_type псевдонимы: fortipresence-server-addr-type string |
Тип адреса сервера FortiPresence Варианты:
|
|
fortipresence_server_fqdn псевдонимы: fortipresence-server-fqdn string |
Полное доменное имя сервера FortiPresence. |
|
fortipresence_unassoc псевдонимы: fortipresence-unassoc string |
Включить/отключить обнаружение и отправку отчетов о неассоциированных станциях с помощью FortiPresence. Варианты:
|
|
polestar string |
Включить/отключить службу определения местоположения PoleStar BLE NAO Track в реальном времени Варианты:
|
|
polestar_accumulation_interval псевдонимы: polestar-accumulation-interval integer |
Время накопления измерений в секундах |
|
polestar_asset_addrgrp_list псевдонимы: polestar-asset-addrgrp-list string |
Теги и список групп адресов активов, которые необходимо включить в отчет. |
|
polestar_asset_uuid_list1 псевдонимы: polestar-asset-uuid-list1 string |
Теги и список UUID активов 1, которые необходимо включить в отчет |
|
polestar_asset_uuid_list2 псевдонимы: polestar-asset-uuid-list2 string |
Теги и список UUID активов 2, которые необходимо включить в отчет |
|
polestar_asset_uuid_list3 псевдонимы: polestar-asset-uuid-list3 string |
Теги и список UUID активов 3, которые необходимо включить в отчет |
|
polestar_asset_uuid_list4 псевдонимы: polestar-asset-uuid-list4 string |
Теги и список UUID активов 4, которые необходимо включить в отчет |
|
polestar_protocol псевдонимы: polestar-protocol string |
Выберите протокол для передачи измерений, рекламных данных или данных о местоположении в NAO Cloud. Варианты:
|
|
polestar_reporting_interval псевдонимы: polestar-reporting-interval integer |
Интервал в секундах между отправкой накопленных измерений в отчет |
|
polestar_server_fqdn псевдонимы: polestar-server-fqdn string |
FQDN сервера PoleStar Nao Track |
|
polestar_server_path псевдонимы: polestar-server-path string |
Путь к серверу PoleStar Nao Track |
|
polestar_server_port псевдонимы: polestar-server-port integer |
Порт сервера PoleStar Nao Track |
|
polestar_server_token псевдонимы: polestar-server-token string |
Токен доступа к серверу PoleStar Nao Track. |
|
station_locate псевдонимы: station-locate string |
Включение или отключение служб определения местоположения клиентских станций для всех клиентов, независимо от наличия подключения Варианты:
|
Примечания
Примечание
- Начиная с версии 2.4.0 все входные аргументы именуются с использованием соглашения об именовании через подчеркивания (snake_case). Замените аргументы, например «var-name», на «var_name». Старые имена аргументов по-прежнему доступны, однако будут выводиться предупреждения об устаревании. Чтобы игнорировать это предупреждение, задайте deprecation_warnings=False в ansible.cfg.
- Этот модуль FortiManager поддерживает работу в режиме блокировки рабочей области; для этого предназначены параметры верхнего уровня workspace_locking_adom и workspace_locking_timeout.
- Обычно выполнение модуля может завершиться ошибкой, если возвращается ненулевой код rc. Условия завершения с ошибкой или успехом также можно переопределить с помощью параметров rc_failed и rc_succeeded.
Примеры
- name: Example playbook (generated based on argument schema)
hosts: fortimanagers
connection: httpapi
gather_facts: false
tasks:
- name: Set various location based service
fortinet.fortimanager.fmgr_wtpprofile_lbs:
# workspace_locking_adom: <global or your adom name>
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>
Возвращаемые значения
Общие возвращаемые значения описаны здесь; ниже перечислены поля, относящиеся только к этому модулю:
Ключ | Описание |
|---|---|
meta dictionary | Результат запроса. Возвращается: всегда |
|
request_url string |
Полный URL запроса. Возвращается: всегда Пример: |
|
response_code integer |
Статус запроса API. Возвращается: всегда Пример: |
|
response_data list / elements=string |
Ответ API. Возвращается: всегда |
|
response_message string |
Текстовое описание ответа API. Возвращается: всегда Пример: |
|
system_information dictionary |
Информация о целевой системе. Возвращается: всегда |
rc integer | Статус запроса. Возвращается: всегда Пример: |
version_check_warning list / elements=string | Предупреждение о том, что используемые в сценарии параметры не поддерживаются текущей версией FortiManager. Возвращается: в сложных случаях |
Ссылки на коллекцию
© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/fortinet/fortimanager/fmgr_wtpprofile_lbs_module.html