Spec-Zone.ru › Ansible 2.11

fortinet.fortimanager.fmgr_system_sql – Настройки SQL.

Примечание

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

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

Для использования в плейбуке укажите: fortinet.fortimanager.fmgr_system_sql.

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

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

Обзор

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

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
bypass_validation
boolean
    Варианты:
  • нет ←
  • да
устанавливается в значение True только при расхождении схемы модуля со структурой API FortiManager, модуль продолжает выполнение без проверки параметров
rc_failed
список / элементы=строка
список кодов rc, с которыми будут переопределены условия для отказа
rc_succeeded
список / элементы=строка
список кодов rc, с которыми будут переопределены условия для успеха
state
строка / обязательно
    Варианты:
  • наличие
  • отсутствует
направление для создания, обновления или удаления объекта
system_sql
словарь
установленные параметры верхнего уровня
background-rebuild
строка
    Варианты:
  • отключить
  • включить ←
Отключить/Включить перестроение базы данных SQL в фоновом режиме.
отключить - Перестроение базы данных SQL не в фоновом режиме.
включить - Перестроение базы данных SQL в фоновом режиме.
custom-index
список / элементы=строка
нет описания
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
database-name
строка
Имя базы данных.
database-type
строка
    Варианты:
  • mysql
  • postgres ←
Тип базы данных.
mysql - База данных MySQL.
postgres - Локальная база данных PostgreSQL.
device-count-high
строка
    Варианты:
  • отключить ←
  • включить
Должно быть установлено в значение включить, если количество зарегистрированных устройств больше 8000.
отключить - Установить в отключить, если количество устройств меньше 8000.
включить - Установить в включить, если количество устройств равно или больше 8000.
event-table-partition-time
целое число
Значение по умолчанию:
0
Максимальный диапазон времени разбиения таблиц базы данных SQL в минутах (0 для неограниченного) для журналов событий.
fct-table-partition-time
целое число
Значение по умолчанию:
240
Максимальный диапазон времени разбиения таблиц базы данных SQL в минутах (0 для неограниченного) для журналов FortiClient.
logtype
список / элементы=строка
    Варианты:
  • 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
нет описания
password
строка
нет описания
prompt-sql-upgrade
строка
    Варианты:
  • отключить
  • включить ←
Запрос на преобразование базы данных журналов в базу данных SQL при запуске на графическом интерфейсе.
отключить - Не запрашивать обновление базы данных журналов до базы данных SQL при запуске на графическом интерфейсе.
включить - Запрашивать обновление базы данных журналов до базы данных SQL при запуске на графическом интерфейсе.
rebuild-event
строка
    Варианты:
  • отключить
  • включить ←
Отключить/Включить перестроение событий во время перестроения базы данных SQL.
отключить - Не перестраивать события во время перестроения базы данных SQL.
включить - Перестроить события во время перестроения базы данных SQL.
rebuild-event-start-time
строка
нет описания
server
строка
IP-адрес или имя хоста базы данных.
start-time
строка
нет описания
status
строка
    Варианты:
  • отключить
  • локальный ←
Статус базы данных SQL.
отключить - Отключить базу данных SQL.
локальный - Включить локальную базу данных.
text-search-index
строка
    Варианты:
  • отключить ←
  • включить
Отключить/Включить индекс полнотекстового поиска.
отключить - Не создавать индекс полнотекстового поиска.
включить - Создать индекс полнотекстового поиска.
traffic-table-partition-time
целое число
Значение по умолчанию:
0
Максимальный диапазон времени разбиения таблиц базы данных SQL в минутах (0 для неограниченного) для журналов трафика.
ts-index-field
список / элементы=строка
нет описания
category
строка
Категория полей индекса полнотекстового поиска.
value
строка
Поля индекса полнотекстового поиска.
username
строка
Имя пользователя для входа в удаленную базу данных.
utm-table-partition-time
целое число
Значение по умолчанию:
0
Максимальный диапазон времени разбиения таблиц базы данных SQL в минутах (0 для неограниченного) для журналов UTM.
workspace_locking_adom
строка
домен, который следует заблокировать для FortiManager, работающего в режиме рабочего пространства, значение может быть глобальным и другими, включая корневой
workspace_locking_timeout
целое число
Значение по умолчанию:
300
максимальное время в секундах ожидания, пока другой пользователь не освободит блокировку рабочего пространства

Примечания

Примечание

  • Работа в режиме блокировки рабочего пространства поддерживается в этом модуле FortiManager, параметры верхнего уровня workspace_locking_adom и workspace_locking_timeout помогают в этой работе.
  • Для создания или обновления объекта используйте направление наличия.
  • Для удаления объекта используйте направление отсутствия.
  • Обычно выполнение одного модуля может завершиться неудачей, если возвращается ненулевой код 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: SQL settings.
     fmgr_system_sql:
        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, ...]
        system_sql:
           background-rebuild: <value in [disable, enable]>
           custom-index:
             -
                 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, ...]>
           database-name: <value of string>
           database-type: <value in [mysql, postgres]>
           device-count-high: <value in [disable, enable]>
           event-table-partition-time: <value of integer>
           fct-table-partition-time: <value of integer>
           logtype:
             - 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
           password: <value of string>
           prompt-sql-upgrade: <value in [disable, enable]>
           rebuild-event: <value in [disable, enable]>
           rebuild-event-start-time: <value of string>
           server: <value of string>
           start-time: <value of string>
           status: <value in [disable, local]>
           text-search-index: <value in [disable, enable]>
           traffic-table-partition-time: <value of integer>
           ts-index-field:
             -
                 category: <value of string>
                 value: <value of string>
           username: <value of string>
           utm-table-partition-time: <value of integer>

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

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

Ключ Возвращаемое значение Описание
request_url
string
всегда
Полный запрашиваемый URL

Пример:
/sys/login/user
response_code
integer
всегда
Статус запроса API

response_message
string
всегда
Дескриптивное сообщение ответа 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_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API