Модуль fortinet.fortimanager.fmgr_system_sql_customskipidx — список дополнительных полей пропуска индексов SQL.
Примечание
Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.14.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в состав ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install fortinet.fortimanager.
Чтобы использовать коллекцию в плейбуке, укажите: fortinet.fortimanager.fmgr_system_sql_customskipidx.
Добавлено в fortinet.fortimanager 2.1.0
Краткое описание
- Этот модуль позволяет настраивать устройство FortiManager.
- Примеры содержат все параметры и значения, которые необходимо адаптировать к источникам данных перед использованием.
Параметры
Параметр | Комментарии |
|---|---|
access_token string | Токен для доступа к FortiManager без использования имени пользователя и пароля. |
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, переопределяющий условия, при которых выполнение считается успешным. |
state string / обязательный | Указание на создание, обновление или удаление объекта. Варианты:
|
system_sql_customskipidx dictionary | Набор параметров верхнего уровня. |
|
device_type псевдонимы: device-type string |
Тип устройства. FortiGate — задаёт тип устройства FortiGate. FortiManager — задаёт тип устройства FortiManager. FortiClient — задаёт тип устройства FortiClient. FortiMail — задаёт тип устройства FortiMail. FortiWeb — задаёт тип устройства FortiWeb. FortiSandbox — задаёт тип устройства FortiSandbox. FortiProxy — задаёт тип устройства FortiProxy. Варианты:
|
|
id integer / обязательный |
Добавление или изменение полей индекса журнала. |
|
index_field псевдонимы: index-field string |
Поле, которое необходимо добавить в список полей, пропускаемых при индексировании. |
|
log_type псевдонимы: log-type string |
Тип журнала. app-ctrl attack content dlp emailfilter event generic history traffic virus voip webfilter netscan fct-event fct-traffic fct-netscan waf gtp dns ssh ssl file-filter asset Варианты:
|
workspace_locking_adom string | ADOM, блокируемый для FortiManager, работающего в режиме workspace. В качестве значения можно указать global и другие значения, в том числе root. |
workspace_locking_timeout integer | Максимальное время ожидания освобождения блокировки workspace другим пользователем, в секундах. По умолчанию: |
Примечания
Примечание
- Начиная с версии 2.4.0, все входные аргументы именуются в соответствии с соглашением об использовании подчёркиваний (snake_case). Замените аргументы, например “var-name”, на “var_name”. Старые имена аргументов по-прежнему поддерживаются, но вызывают предупреждения об устаревании. Это предупреждение можно отключить, задав deprecation_warnings=False в ansible.cfg.
- Этот модуль FortiManager поддерживает работу в режиме блокировки workspace; параметры верхнего уровня 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: List of aditional SQL skip index fields.
fortinet.fortimanager.fmgr_system_sql_customskipidx:
# workspace_locking_adom: <global or your adom name>
state: present # <value in [present, absent]>
system_sql_customskipidx:
id: 0 # Required variable, integer
# device_type: <value in [FortiGate, FortiManager, FortiClient, ...]>
# index_field: <string>
# log_type: <value in [app-ctrl, attack, content, ...]>
Возвращаемые значения
Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
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_system_sql_customskipidx_module.html
