fortinet.fortimanager.fmgr_system_sql_tsindexfield – Список полей индекса текстового поиска SQL.
Примечание
Этот плагин входит в коллекцию fortinet.fortimanager (версия 2.0.1).
Для его установки используйте: ansible-galaxy collection install fortinet.fortimanager.
Для использования в книге задач укажите: fortinet.fortimanager.fmgr_system_sql_tsindexfield.
Новое в версии 2.10: модуля fortinet.fortimanager
Обзор
- Этот модуль позволяет настроить устройство FortiManager.
- Примеры включают все параметры и значения, которые необходимо скорректировать в источниках данных перед использованием.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| bypass_validation boolean |
| устанавливается в True только при расхождении схемы модуля со структурой API FortiManager, модуль продолжает выполняться без проверки параметров | |
| rc_failed список / элементы=строка | список кодов rc, при которых условия выполнения будут нарушены | ||
| rc_succeeded список / элементы=строка | список кодов rc, при которых условия выполнения будут соблюдены | ||
| state строка / обязательный |
| директива для создания, обновления или удаления объекта | |
| system_sql_tsindexfield словарь | параметры верхнего уровня | ||
| category строка | Категория полей индекса текстового поиска. | ||
| value строка | Поля индекса текстового поиска. | ||
| workspace_locking_adom строка | область ADOM для блокировки FortiManager в режиме рабочего пространства; значение может быть глобальным или другим, включая корень | ||
| workspace_locking_timeout целое число | Значение по умолчанию: 300 | максимальное время в секундах ожидания освобождения блокировки рабочего пространства другим пользователем | |
Примечания
Примечание
- В этом модуле FortiManager поддерживается режим блокировки рабочего пространства; параметры верхнего уровня workspace_locking_adom и workspace_locking_timeout помогают в этой работе.
- Для создания или обновления объекта используйте директиву state present.
- Для удаления объекта используйте директиву state absent.
- Обычно выполнение одного модуля может завершиться ошибкой при возврате ненулевого значения rc. Также можно переопределить условия для ошибок или успешного выполнения с помощью параметров rc_failed и rc_succeeded
Примеры
- hosts: fortimanager-inventory
collections:
- fortinet.fortimanager
connection: httpapi
vars:
ansible_httpapi_use_ssl: True
ansible_httpapi_validate_certs: False
ansible_httpapi_port: 443
tasks:
- name: List of SQL text search index fields.
fmgr_system_sql_tsindexfield:
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, ...]
state: <value in [present, absent]>
system_sql_tsindexfield:
category: <value of string>
value: <value of string>
Возвращаемые значения
Общие возвращаемые значения документированы здесь. Ниже перечислены поля, уникальные для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| request_url строка | всегда | Полный запрашиваемый URL Пример: /sys/login/user |
| response_code целое число | всегда | Статус запроса API |
| response_message строка | всегда | Дескриптивное сообщение ответа API Пример: OK. |
Авторы
- Link Zheng (@chillancezen)
- Jie Xue (@JieX19)
- Frank Shen (@fshen01)
- Hongbin Lu (@fgtdev-hblu)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/fortinet/fortimanager/fmgr_system_sql_tsindexfield_module.html
