fortinet.fortimanager.fmgr_wtpprofile_lbs модуль — Установка различных сервисов, основанных на местоположении

Примечание

Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.7.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 строка	Токен для доступа к FortiManager без использования имени пользователя и пароля.
adom строка / обязательно	Параметр (adom) в запрошенном URL.
bypass_validation логическое	Устанавливается в значение True только при расхождениях схемы модуля со структурой API FortiManager, модуль продолжит выполнение без проверки параметров. Варианты: `false` ← (по умолчанию) `true`
enable_log логическое	Включить/выключить ведение журнала для задачи. Варианты: `false` ← (по умолчанию) `true`
forticloud_access_token строка	Авторизовать клиент Ansible с помощью токена доступа к API forticloud.
proposed_method строка	Переопределенный метод для базового запроса Json RPC. Варианты: `"update"` `"set"` `"add"`
rc_failed список / элементы=целое	Список rc-кодов, по которым будут переопределены условия ошибки.
rc_succeeded список / элементы=целое	Список rc-кодов, по которым будут переопределены условия успешного выполнения.
workspace_locking_adom строка	Adom для блокировки FortiManager, работающего в режиме рабочей области. Значение может быть глобальным и другими, включая root.
workspace_locking_timeout целое	Максимальное время ожидания в секундах, пока другой пользователь не разблокирует рабочую область. По умолчанию: `300`
wtp-profile строка	Устарело, используйте «wtp_profile»
wtp_profile строка	Параметр (wtp-profile) в запрошенном URL.
wtpprofile_lbs словарь	Набор параметров верхнего уровня.
aeroscout строка	Включить/выключить AeroScout Real Time Location Service Варианты: `"disable"` `"enable"`
aeroscout_ap_mac строка	Устарело, пожалуйста, переименуйте на aeroscout_ap_mac. Используйте BSSID или MAC адрес платы как MAC адрес AP в Aeroscout AP mes… Варианты: `"bssid"` `"board-mac"`
aeroscout_mmu_report строка	Устарело, пожалуйста, переименуйте на aeroscout_mmu_report. Включить/выключить составной отчет MU. Варианты: `"disable"` `"enable"`
aeroscout_mu строка	Устарело, пожалуйста, переименуйте на aeroscout_mu. Включить/выключить поддержку AeroScout. Варианты: `"disable"` `"enable"`
aeroscout_mu_factor целое	Устарело, пожалуйста, переименуйте на aeroscout_mu_factor. Мобильное устройство AeroScout.
aeroscout_mu_timeout целое	Устарело, пожалуйста, переименуйте на aeroscout_mu_timeout. Таймаут режима MU AeroScout
aeroscout_server_ip строка	Устарело, пожалуйста, переименуйте на aeroscout_server_ip. IP адрес сервера AeroScout.
aeroscout_server_port целое	Устарело, пожалуйста, переименуйте на aeroscout_server_port. UDP порт прослушивания сервера AeroScout.

END_OF_DOCUMENT_MARKER

ekahau-blink-mode string	Устарело, переименуйте в ekahau_blink_mode. Включить/выключить режим Ekahua blink Choices: `"disable"` `"enable"`
ekahau-tag string	Устарело, переименуйте в ekahau_tag. MAC-адрес кадра WiFi или тег WiFi.
erc-server-ip string	Устарело, переименуйте в erc_server_ip. IP-адрес контроллера Ekahua RTLS
erc-server-port integer	Устарело, переименуйте в erc_server_port. Контроллер Ekahua RTLS
fortipresence string	Включить/выключить FortiPresence для мониторинга местоположения и активности клиентов WiFi, даже если они не подключаются к этой сети WiFi… Choices: `"disable"` `"enable"` `"enable2"` `"foreign"` `"both"`
fortipresence-ble string	Устарело, переименуйте в fortipresence_ble. Включить/выключить поиск и отчетность FortiPresence для BLE-устройств. Choices: `"disable"` `"enable"`
fortipresence-frequency integer	Устарело, переименуйте в fortipresence_frequency. Частота передачи отчета FortiPresence
fortipresence-port integer	Устарело, переименуйте в fortipresence_port. Порт прослушивания UDP-сервера FortiPresence
fortipresence-project string	Устарело, переименуйте в fortipresence_project. Имя проекта FortiPresence
fortipresence-rogue string	Устарело, переименуйте в fortipresence_rogue. Включить/выключить поиск и отчетность FortiPresence для точек доступа-нарушителей. Choices: `"disable"` `"enable"`
fortipresence-secret any	(list) Устарело, переименуйте в fortipresence_secret. Секретный пароль FortiPresence
fortipresence-server string	Устарело, переименуйте в fortipresence_server. IP-адрес сервера FortiPresence.
fortipresence-server-addr-type string	Устарело, переименуйте в fortipresence_server_addr_type. Тип адреса сервера FortiPresence Choices: `"fqdn"` `"ipv4"`
fortipresence-server-fqdn string	Устарело, переименуйте в fortipresence_server_fqdn. FQDN сервера FortiPresence.
fortipresence-unassoc string	Устарело, переименуйте в fortipresence_unassoc. Включить/выключить поиск и отчетность FortiPresence для неассоциированных станций… Choices: `"disable"` `"enable"`
polestar string	Включить/выключить службу определения местоположения в реальном времени PoleStar BLE NAO Track Choices: `"disable"` `"enable"`
polestar-accumulation-interval integer	Устарело, переименуйте в polestar_accumulation_interval. Время, в течение которого измерения должны накапливаться в секундах
polestar-asset-addrgrp-list string	Устарело, переименуйте в polestar_asset_addrgrp_list. Теги и список addrgrp активов для отчетности.
polestar-asset-uuid-list1 string	Устарело, переименуйте в polestar_asset_uuid_list1. Теги и список UUID активов 1 для отчетности
polestar-asset-uuid-list2 string	Устарело, переименуйте в polestar_asset_uuid_list2. Теги и список UUID активов 2 для отчетности

polestar-asset-uuid-list3 string	Устаревшее, пожалуйста, переименуйте на polestar_asset_uuid_list3. Теги и список идентификаторов UUID активов 3 для отчёта
polestar-asset-uuid-list4 string	Устаревшее, пожалуйста, переименуйте на polestar_asset_uuid_list4. Теги и список идентификаторов UUID активов 4 для отчёта
polestar-protocol string	Устаревшее, пожалуйста, переименуйте на polestar_protocol. Выберите протокол для отчётности о измерениях, данных об рекламных объявлениях или географической информации… Варианты: `"WSS"`
polestar-reporting-interval integer	Устаревшее, пожалуйста, переименуйте на polestar_reporting_interval. Время между отчётностью накопленных измерений в секундах
polestar-server-fqdn string	Устаревшее, пожалуйста, переименуйте на polestar_server_fqdn. FQDN сервера отслеживания PoleStar Nao
polestar-server-path string	Устаревшее, пожалуйста, переименуйте на polestar_server_path. Путь сервера отслеживания PoleStar Nao
polestar-server-port integer	Устаревшее, пожалуйста, переименуйте на polestar_server_port. Порт сервера отслеживания PoleStar Nao
polestar-server-token string	Устаревшее, пожалуйста, переименуйте на polestar_server_token. Токен доступа к серверу отслеживания PoleStar Nao.
station-locate string	Устаревшее, пожалуйста, переименуйте на station_locate. Включить/выключить службы определения местоположения клиентских станций для всех клиентов, независимо от… Варианты: `"disable"` `"enable"`

Примечания

Примечание

Начиная с версии 2.4.0, все входные аргументы имеют название с использованием нижнего подчеркивания (snake_case). Пожалуйста, измените аргументы, такие как "var-name", на "var_name". Старые имена аргументов по-прежнему доступны, но вы получите предупреждения об устаревании. Вы можете проигнорировать это предупреждение, установив deprecation_warnings=False в ansible.cfg.
В этом модуле FortiManager поддерживается режим блокировки рабочей области. Параметры workspace_locking_adom и workspace_locking_timeout помогают в этой задаче.
Обычно выполнение одного модуля может завершиться ошибкой, если возвращён ненулевой код возврата. Вы также можете переопределить условия для завершения ошибкой или успехом с параметрами 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>

Значения возврата

Общие значения возврата документированы здесь, следующие поля уникальны для данного модуля:

Ключ	Описание
meta словарь	Результат запроса. Возвращается: всегда
request_url строка	Полный URL запроса. Возвращается: всегда Пример: `"/sys/login/user"`
response_code целое число	Статус API-запроса. Возвращается: всегда Пример: `0`
response_data список / элементы=строка	Ответ API. Возвращается: всегда
response_message строка	Дескриптивное сообщение ответа API. Возвращается: всегда Пример: `"OK."`
system_information словарь	Информация о целевой системе. Возвращается: всегда
rc целое число	Статус запроса. Возвращается: всегда Пример: `0`
version_check_warning список / элементы=строка	Предупреждение, если параметры, используемые в книге задач, не поддерживаются текущей версией FortiManager. Возвращается: сложный

Авторы

Xinwei Du (@dux-fortinet)
Xing Li (@lix-fortinet)
Jie Xue (@JieX19)
Link Zheng (@chillancezen)
Frank Shen (@fshen01)
Hongbin Lu (@fgtdev-hblu)

Ссылки на сборки

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/fortinet/fortimanager/fmgr_wtpprofile_lbs_module.html