fortinet.fortimanager.fmgr_system_sql_customindex – Список полей индекса SQL.

Примечание

Этот плагин входит в коллекцию fortinet.fortimanager (версия 2.0.1).

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

Для использования в книге задач укажите: fortinet.fortimanager.fmgr_system_sql_customindex.

Новое в версии 2.10: модуля fortinet.fortimanager

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

Обзор

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

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
bypass_validation boolean		Варианты: нет ← да	Устанавливается в значение True только при расхождениях схемы модуля со структурой API FortiManager, модуль продолжает выполнение без проверки параметров
rc_failed список / элементы=строка			список кодов rc, при которых условия будут считаться ошибочными
rc_succeeded список / элементы=строка			список кодов rc, при которых условия будут считаться выполненными
state строка / обязательно		Варианты: present absent	направление для создания, обновления или удаления объекта
system_sql_customindex словарь			параметры верхнего уровня
	case-sensitive строка	Варианты: выключено ← включено	Отключение/Включение чувствительности к регистру индекса. выключено - Создать индекс без учета регистра. включено - Создать индекс с учетом регистра.
	device-type строка	Варианты: FortiGate ← FortiManager FortiClient FortiMail FortiWeb FortiCache FortiSandbox FortiDDoS FortiAuthenticator FortiProxy	Тип устройства. FortiGate - Тип устройства FortiGate. FortiManager - Установка типа устройства на FortiManager FortiClient - Установка типа устройства на FortiClient FortiMail - Тип устройства FortiMail. FortiWeb - Тип устройства FortiWeb. FortiCache - Установка типа устройства на FortiCache FortiSandbox - Установка типа устройства на FortiSandbox FortiDDoS - Установка типа устройства на FortiDDoS FortiAuthenticator - Установка типа устройства на FortiAuthenticator FortiProxy - Установка типа устройства на FortiProxy
	id целое число	Значение по умолчанию: 0	Добавление или редактирование полей индекса логов.
	index-field строка		Имя поля лога для индексации.
	log-type строка	Варианты: 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 - 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
workspace_locking_adom строка			adom для блокировки при работе FortiManager в режиме рабочей области, значение может быть глобальным и другими, включая root
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 index fields.
     fmgr_system_sql_customindex:
        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_customindex:
           case-sensitive: <value in [disable, enable]>
           device-type: <value in [FortiGate, FortiManager, FortiClient, ...]>
           id: <value of integer>
           index-field: <value of string>
           log-type: <value in [none, app-ctrl, attack, ...]>

Значения возврата

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

Ключ	Возвращаемое значение	Описание
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_customindex_module.html