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

Примечание

Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.7.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 строка	Токен для доступа к FortiManager без использования имени пользователя и пароля.
adom строка / обязательно	Параметр (adom) в запрошенном URL.
bleprofile словарь	Набор параметров верхнего уровня.
advertising список / элементы=строка	Тип рекламы. Варианты: `"ibeacon"` `"eddystone-uid"` `"eddystone-url"`
beacon-interval целое число	Устарело, пожалуйста, переименуйте на beacon_interval. Интервал сигнализации
ble-scanning строка	Устарело, пожалуйста, переименуйте на ble_scanning. Включить/выключить Bluetooth Low Energy Варианты: `"disable"` `"enable"`
comment строка	Комментарий.
eddystone-instance строка	Устарело, пожалуйста, переименуйте на eddystone_instance. Идентификатор экземпляра Eddystone.
eddystone-namespace строка	Устарело, пожалуйста, переименуйте на eddystone_namespace. Идентификатор пространства имен Eddystone.
eddystone-url строка	Устарело, пожалуйста, переименуйте на eddystone_url. URL Eddystone.
eddystone-url-encode-hex строка	Устарело, пожалуйста, переименуйте на eddystone_url_encode_hex. Шестнадцатеричная строка закодированного URL Eddystone
ibeacon-uuid строка	Устарело, пожалуйста, переименуйте на ibeacon_uuid. Универсальный уникальный идентификатор
major-id целое число	Устарело, пожалуйста, переименуйте на major_id. Основной идентификатор.
minor-id целое число	Устарело, пожалуйста, переименуйте на minor_id. Вспомогательный идентификатор.
name строка / обязательно	Имя профиля Bluetooth Low Energy.
scan-interval целое число	Устарело, пожалуйста, переименуйте на scan_interval. Интервал сканирования
scan-period целое число	Устарело, пожалуйста, переименуйте на scan_period. Период сканирования
scan-threshold строка	Устарело, пожалуйста, переименуйте на scan_threshold. Минимальный уровень сигнала/порог в дБм, необходимый для того, чтобы AP сообщил о…
scan-time целое число	Устарело, пожалуйста, переименуйте на scan_time. Время сканирования
scan-type строка	Устарело, пожалуйста, переименуйте на scan_type. Тип сканирования Варианты: `"active"` `"passive"`
scan-window целое число	Устарело, пожалуйста, переименуйте на scan_window. Окно сканирования
txpower строка	Уровень мощности передачи Варианты: `"0"` `"1"` `"2"` `"3"` `"4"` `"5"` `"6"` `"7"` `"8"` `"9"` `"10"` `"11"` `"12"`

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, при которых выполнение будет завершено успешно.
state string / обязательно	Директива для создания, обновления или удаления объекта. Варианты: `"present"` `"absent"`
workspace_locking_adom string	Область, которая будет заблокирована при работе модуля в режиме рабочей области, значение может быть глобальным и другими, включая корневой.
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 помогают в этом.
Для создания или обновления объекта используйте директиву state present.
Для удаления объекта используйте директиву state absent.
Обычно, выполнение одного модуля может завершиться ошибкой, если возвращён ненулевой код 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: Configure Bluetooth Low Energy profile.
      fortinet.fortimanager.fmgr_bleprofile:
        # 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>
        state: present # <value in [present, absent]>
        bleprofile:
          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>
          name: <string>
          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 словарь	Результат запроса. Возвращается: всегда
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_bleprofile_module.html