модуль fortinet.fortimanager.fmgr_bleprofile — настройка профиля Bluetooth Low Energy.

Примечание

Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.14.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install fortinet.fortimanager.

Чтобы использовать коллекцию в плейбуке, укажите: fortinet.fortimanager.fmgr_bleprofile.

Добавлено в fortinet.fortimanager 2.0.0

Краткое описание
Параметры
Примечания
Примеры
Возвращаемые значения

Краткое описание

Этот модуль позволяет настраивать устройство FortiManager.
Примеры включают все параметры и значения, которые необходимо адаптировать к источникам данных перед использованием.

Параметры

Параметр	Комментарии
access_token string	Токен для доступа к FortiManager без использования имени пользователя и пароля.
adom string / обязательный	Параметр (adom) в запрашиваемом URL.
bleprofile dictionary	Параметры верхнего уровня.
advertising list / elements=string	Тип рекламного объявления. Варианты: `"ibeacon"` `"eddystone-uid"` `"eddystone-url"`
beacon_interval псевдонимы: beacon-interval integer	Интервал маяка
ble_scanning псевдонимы: ble-scanning string	Включение/отключение Bluetooth Low Energy Варианты: `"disable"` `"enable"`
comment string	Комментарий.
eddystone_instance псевдонимы: eddystone-instance string	Идентификатор экземпляра Eddystone.
eddystone_namespace псевдонимы: eddystone-namespace string	Идентификатор пространства имен Eddystone.
eddystone_url псевдонимы: eddystone-url string	URL Eddystone.
eddystone_url_encode_hex псевдонимы: eddystone-url-encode-hex string	Шестнадцатеричная строка закодированного URL Eddystone
ibeacon_uuid псевдонимы: ibeacon-uuid string	Универсальный уникальный идентификатор
major_id псевдонимы: major-id integer	Основной идентификатор.
minor_id псевдонимы: minor-id integer	Дополнительный идентификатор.
name string / обязательный	Имя профиля Bluetooth Low Energy.
scan_interval псевдонимы: scan-interval integer	Интервал сканирования
scan_period псевдонимы: scan-period integer	Период сканирования
scan_threshold псевдонимы: scan-threshold string	Минимальный уровень/порог сигнала в дБм, необходимый для того, чтобы точка доступа сообщила об обнаруженном BLE-устройстве
scan_time псевдонимы: scan-time integer	Время сканирования
scan_type псевдонимы: scan-type string	Тип сканирования Варианты: `"active"` `"passive"`
scan_window псевдонимы: scan-window integer	Окно сканирования
txpower string	Уровень мощности передачи Варианты: `"0"` `"1"` `"2"` `"3"` `"4"` `"5"` `"6"` `"7"` `"8"` `"9"` `"10"` `"11"` `"12"` `"13"` `"14"` `"15"` `"16"` `"17"`
bypass_validation boolean	Устанавливайте значение True только в том случае, если схема модуля отличается от структуры API FortiManager. Модуль продолжит выполнение без проверки параметров. Варианты: `false` ← (по умолчанию) `true`
enable_log boolean	Включить/отключить ведение журнала для задачи. Варианты: `false` ← (по умолчанию) `true`
forticloud_access_token string	Аутентификация клиента Ansible с помощью токена доступа к API forticloud.
proposed_method string	Переопределяемый метод для базового запроса Json RPC. Варианты: `"update"` `"set"` `"add"`
rc_failed list / elements=integer	Список кодов rc, с помощью которого переопределяются условия неудачного выполнения.
rc_succeeded list / elements=integer	Список кодов rc, с помощью которого переопределяются условия успешного выполнения.
revision_note string	Примечание об изменении, которое можно указать при создании или обновлении объекта.
state string / обязательный	Указание создать, обновить или удалить объект. Варианты: `"present"` `"absent"`
workspace_locking_adom string	ADOM, который необходимо заблокировать в FortiManager, работающем в режиме рабочего пространства. Значением может быть global или другие варианты, включая root.
workspace_locking_timeout integer	Максимальное время ожидания в секундах, пока другой пользователь снимет блокировку рабочего пространства. По умолчанию: `300`

Примечания

Примечание

Начиная с версии 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.
Чтобы создать или обновить объект, используйте директиву state present.
Чтобы удалить объект, используйте директиву state absent.

Примеры

- name: Example playbook (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  gather_facts: false
  tasks:
    - name: Configure Bluetooth Low Energy profile.
      fortinet.fortimanager.fmgr_bleprofile:
        # workspace_locking_adom: <global or your adom name>
        adom: <your own value>
        state: present # <value in [present, absent]>
        bleprofile:
          name: "your value" # Required variable, string
          # advertising: ["ibeacon", "eddystone-uid", "eddystone-url"]
          # beacon_interval: <integer>
          # ble_scanning: <value in [disable, enable]>
          # comment: <string>
          # eddystone_instance: <string>
          # eddystone_namespace: <string>
          # eddystone_url: <string>
          # eddystone_url_encode_hex: <string>
          # ibeacon_uuid: <string>
          # major_id: <integer>
          # minor_id: <integer>
          # txpower: <value in [0, 1, 2, ...]>
          # scan_interval: <integer>
          # scan_period: <integer>
          # scan_threshold: <string>
          # scan_time: <integer>
          # scan_type: <value in [active, passive]>
          # scan_window: <integer>

Возвращаемые значения

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

Ключ	Описание
meta dictionary	Результат запроса. Возвращается: всегда
request_url string	Полный запрашиваемый URL. Возвращается: всегда Пример: `"/sys/login/user"`
response_code integer	Статус запроса API. Возвращается: всегда Пример: `0`
response_data list / elements=string	Ответ API. Возвращается: всегда
response_message string	Текстовое описание ответа API. Возвращается: всегда Пример: `"OK."`
system_information dictionary	Информация о целевой системе. Возвращается: всегда
rc integer	Статус запроса. Возвращается: всегда Пример: `0`
version_check_warning list / elements=string	Предупреждение о том, что используемые в плейбуке параметры не поддерживаются текущей версией 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–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/fortinet/fortimanager/fmgr_bleprofile_module.html