fortinet.fortimanager.fmgr_system_sql модуль — Настройки SQL.

Примечание

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

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

Чтобы установить её, используйте: ansible-galaxy collection install fortinet.fortimanager.

Чтобы использовать её в книге задач, укажите: fortinet.fortimanager.fmgr_system_sql.

Новый в fortinet.fortimanager 2.0.0

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

Описание

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

Параметры

Параметр	Комментарии
access_token строка	Токен для доступа к FortiManager без использования имени пользователя и пароля.
bypass_validation логическое	Устанавливать в значение True только при расхождениях схемы модуля со структурой API FortiManager, модуль продолжит выполнение без проверки параметров. Варианты: `false` ← (по умолчанию) `true`
enable_log логическое	Включить/выключить ведение журнала для задачи. Варианты: `false` ← (по умолчанию) `true`
forticloud_access_token строка	Авторизовать Ansible-клиент с помощью токена доступа к API forticloud.
proposed_method строка	Переопределённый метод для базового запроса Json RPC. Варианты: `"update"` `"set"` `"add"`
rc_failed список / элементы=целое	Список кодов rc, с которыми будут переопределены условия завершения с ошибкой.
rc_succeeded список / элементы=целое	Список кодов rc, с которыми будут переопределены условия успешного завершения.
system_sql словарь	Настроены верхние параметры.
background_rebuild строка	Устарело, пожалуйста, переименуйте на background_rebuild. Отключить/включить перестроение базы данных SQL в фоновом режиме. disable - Перестроить базу данных SQL не в фоновом режиме. enable - Перестроить базу данных SQL в фоновом режиме. Варианты: `"disable"` `"enable"`
compress_table_min_age целое	Устарело, пожалуйста, переименуйте на compress_table_min_age. Минимальный срок в днях для сжатия таблиц SQL.
custom_index список / элементы=словарь	Устарело, пожалуйста, переименуйте на custom_index. Пользовательский индекс.
case_sensitive строка	Устарело, пожалуйста, переименуйте на case_sensitive. Отключить/включить регистрозависимый индекс. disable - Создать регистронезависимый индекс. enable - Создать регистрозависимый индекс. Варианты: `"disable"` `"enable"`
device_type строка	Устарело, пожалуйста, переименуйте на device_type. Тип устройства. 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 целое	Добавить или отредактировать поля индекса логов.
index_field строка	Устарело, пожалуйста, переименуйте на index_field. Имя поля лога для индексации.
log_type строка	Устарело, пожалуйста, переименуйте на log_type. Тип лога. 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 Варианты: `"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"`
custom_skipidx список / элементы=словарь	Устарело, пожалуйста, переименуйте на custom_skipidx. Пользовательский skipidx.

device-type string	Устарело, переименуйте в device_type. Тип устройства. FortiGate - Установите тип устройства как FortiGate. FortiManager - Установите тип устройства как FortiManager FortiClient - Установите тип устройства как FortiClient. FortiMail - Установите тип устройства как FortiMail. FortiWeb - Установите тип устройства как FortiWeb. FortiSandbox - Установите тип устройства как FortiSandbox FortiProxy - Установите тип устройства как FortiProxy Choices: `"FortiGate"` `"FortiManager"` `"FortiClient"` `"FortiMail"` `"FortiWeb"` `"FortiSandbox"` `"FortiProxy"`
id integer	Добавить или изменить поля индекса журнала.
index-field string	Устарело, переименуйте в index_field. Поле, которое будет добавлено в индекс исключений.
log-type string	Устарело, переименуйте в log_type. Тип журнала. 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 Choices: `"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"`
database-name string	Устарело, переименуйте в database_name. Имя базы данных.
database-type string	Устарело, переименуйте в database_type. Тип базы данных. mysql - База данных MySQL. postgres - Локальная база данных PostgreSQL. Choices: `"mysql"` `"postgres"`
device-count-high string	Устарело, переименуйте в device_count_high. Необходимо установить в enable, если количество зарегистрированных устройств больше 8000. disable - Установите disable, если количество устройств меньше 8000. enable - Установите enable, если количество устройств равно или больше 8000. Choices: `"disable"` `"enable"`
event-table-partition-time integer	Устарело, переименуйте в event_table_partition_time. Максимальный диапазон времени разделения таблиц базы данных SQL в минутах
fct-table-partition-time integer	Устарело, переименуйте в fct_table_partition_time. Максимальный диапазон времени разделения таблиц базы данных SQL в минутах
logtype list / elements=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 Choices: `"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"`
password any	(список) Пароль для входа в удаленную базу данных.
prompt-sql-upgrade string	Устарело, переименуйте в prompt_sql_upgrade. Запрос на преобразование базы данных журналов в базу данных SQL при запуске на графическом интерфейсе. disable - Не запрашивать обновление базы данных журналов до базы данных SQL при запуске на графическом интерфейсе. enable - Запрашивать обновление базы данных журналов до базы данных SQL при запуске на графическом интерфейсе. Choices: `"disable"` `"enable"`
rebuild-event string	Устарело, переименуйте в rebuild_event. Отключить/Включить перестройку событий во время перестройки базы данных SQL. disable - Не перестраивать события во время перестройки базы данных SQL. enable - Перестраивать события во время перестройки базы данных SQL. Choices: `"disable"` `"enable"`
rebuild-event-start-time any	(список) Устарело, переименуйте в rebuild_event_start_time. Дата и время начала перестройки событий

server string	IP-адрес или имя хоста базы данных.
start-time any	(список) Устарело, пожалуйста, переименуйте на start_time. Дата и время начала
status string	Статус базы данных SQL. disable - Отключить базу данных SQL. local - Включить локальную базу данных. Выбоpы: `"disable"` `"local"`
text-search-index string	Устарело, пожалуйста, переименуйте на text_search_index. Отключить/Включить индекс полнотекстового поиска. disable - Не создавать индекс полнотекстового поиска. enable - Создать индекс полнотекстового поиска. Выбоpы: `"disable"` `"enable"`
traffic-table-partition-time integer	Устарело, пожалуйста, переименуйте на traffic_table_partition_time. Максимальное время разбиения таблиц базы данных SQL в минутах
ts-index-field list / elements=dictionary	Устарело, пожалуйста, переименуйте на ts_index_field. Поле индекса TS.
category string	Категория полей индекса полнотекстового поиска.
value string	Поля индекса полнотекстового поиска.
username string	Имя пользователя для входа в удаленную базу данных.
utm-table-partition-time integer	Устарело, пожалуйста, переименуйте на utm_table_partition_time. Максимальное время разбиения таблиц базы данных SQL в минутах
workspace_locking_adom string	ADOM для блокировки при работе FortiManager в режиме рабочего пространства; значение может быть глобальным и др., включая 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

Примеры

- name: Example playbook (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: SQL settings.
      fortinet.fortimanager.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: <integer>
              index_field: <string>
              log_type: <value in [none, app-ctrl, attack, ...]>
          database_name: <string>
          database_type: <value in [mysql, postgres]>
          device_count_high: <value in [disable, enable]>
          event_table_partition_time: <integer>
          fct_table_partition_time: <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
            - file-filter
            - asset
            - protocol
            - siem
            - ztna
            - security
          password: <list or string>
          prompt_sql_upgrade: <value in [disable, enable]>
          rebuild_event: <value in [disable, enable]>
          rebuild_event_start_time: <list or string>
          server: <string>
          start_time: <list or string>
          status: <value in [disable, local]>
          text_search_index: <value in [disable, enable]>
          traffic_table_partition_time: <integer>
          ts_index_field:
            -
              category: <string>
              value: <string>
          username: <string>
          utm_table_partition_time: <integer>
          custom_skipidx:
            -
              device_type: <value in [FortiGate, FortiManager, FortiClient, ...]>
              id: <integer>
              index_field: <string>
              log_type: <value in [app-ctrl, attack, content, ...]>
          compress_table_min_age: <integer>

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

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

Ключ	Описание
meta словарь	Результат запроса. Возвращается: всегда
request_url строка	Полный URL запроса. Возвращается: всегда Пример: `"/sys/login/user"`
response_code целое число	Статус запроса API. Возвращается: всегда Пример: `0`
response_data список / элементы=строка	Ответ API. Возвращается: всегда
response_message строка	Описание ответа API. Возвращается: всегда Пример: `"OK."`
system_information словарь	Информация о целевой системе. Возвращается: всегда
rc целое число	Статус запроса. Возвращается: всегда Пример: `0`
version_check_warning список / элементы=строка	Предупреждение, если параметры, используемые в книге задач, не поддерживаются текущей версией 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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/fortinet/fortimanager/fmgr_system_sql_module.html