Модуль fortinet.fortimanager.fmgr_system_sql_customindex — список полей индекса SQL.

Примечание

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

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

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

Чтобы использовать модуль в плейбуке, укажите: fortinet.fortimanager.fmgr_system_sql_customindex.

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

Обзор
Параметры
Примечания
Примеры
Возвращаемые значения

Обзор

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

Параметры

Параметр	Комментарии
access_token string	Токен для доступа к FortiManager без использования имени пользователя и пароля.
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"`
system_sql_customindex dictionary	Набор параметров верхнего уровня.
case_sensitive псевдонимы: case-sensitive string	Отключить или включить индекс с учётом регистра. disable — создать индекс без учёта регистра. enable — создать индекс с учётом регистра. Варианты: `"disable"` `"enable"`
device_type псевдонимы: device-type string	Тип устройства. FortiGate — тип устройства FortiGate. FortiManager — установить тип устройства FortiManager. FortiClient — установить тип устройства FortiClient. FortiMail — тип устройства FortiMail. FortiWeb — тип устройства FortiWeb. FortiCache — установить тип устройства FortiCache. FortiSandbox — установить тип устройства FortiSandbox. FortiDDoS — установить тип устройства FortiDDoS. FortiAuthenticator — установить тип устройства FortiAuthenticator. FortiProxy — установить тип устройства FortiProxy. Варианты: `"FortiGate"` `"FortiManager"` `"FortiClient"` `"FortiMail"` `"FortiWeb"` `"FortiCache"` `"FortiSandbox"` `"FortiDDoS"` `"FortiAuthenticator"` `"FortiProxy"`
id integer / обязательный	Добавить или изменить поля индекса журналов.
index_field псевдонимы: index-field string	Имя поля журнала, которое необходимо индексировать.
log_type псевдонимы: log-type string	Тип журнала. none — нет 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 Варианты: `"none"` `"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"` `"protocol"` `"siem"` `"ztna"` `"security"`
workspace_locking_adom string	ADOM, который необходимо заблокировать для FortiManager, работающего в режиме рабочей области. Значением может быть global или другой ADOM, включая 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
  hosts: fortimanagers
  gather_facts: false
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: List of SQL index fields.
      fortinet.fortimanager.fmgr_system_sql_customindex:
        bypass_validation: false
        state: present
        system_sql_customindex:
          case_sensitive: disable
          device_type: FortiGate # <value in [FortiGate, FortiManager, FortiClient, ...]>
          id: 1
          index_field: srcip
          log_type: attack # <value in [none, app-ctrl, attack, ...]>

- name: Gathering fortimanager facts
  hosts: fortimanagers
  gather_facts: false
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Retrieve all the SQL index fields
      fortinet.fortimanager.fmgr_fact:
        facts:
          selector: "system_sql_customindex"
          params:
            custom_index: "your_value"

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

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

Ключ	Описание
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_system_sql_customindex_module.html