Spec-Zone.ru › Ansible

Модуль fortinet.fortimanager.fmgr_system_sql — параметры SQL.

Примечание

Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.14.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

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, для которых будут переопределены условия успешного выполнения.

system_sql

dictionary

Набор параметров верхнего уровня.

background_rebuild

псевдонимы: background-rebuild

string

Отключить/включить перестроение базы данных SQL в фоновом режиме.

disable — перестраивать базу данных SQL не в фоновом режиме.

enable — перестраивать базу данных SQL в фоновом режиме.

Варианты:

  • "disable"
  • "enable"

compress_table_min_age

псевдонимы: compress-table-min-age

integer

Минимальный возраст таблиц SQL в днях, начиная с которого они сжимаются.

custom_index

псевдонимы: custom-index

list / elements=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"

custom_skipidx

псевдонимы: custom-skipidx

list / elements=dictionary

Пользовательский skipidx.

device_type

псевдонимы: device-type

string

Тип устройства.

FortiGate — установить тип устройства FortiGate.

FortiManager — установить тип устройства FortiManager.

FortiClient — установить тип устройства FortiClient.

FortiMail — установить тип устройства FortiMail.

FortiWeb — установить тип устройства FortiWeb.

FortiSandbox — установить тип устройства FortiSandbox.

FortiProxy — установить тип устройства FortiProxy.

Варианты:

  • "FortiGate"
  • "FortiManager"
  • "FortiClient"
  • "FortiMail"
  • "FortiWeb"
  • "FortiSandbox"
  • "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

Варианты:

  • "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

псевдонимы: database-name

string

Имя базы данных.

database_type

псевдонимы: database-type

string

Тип базы данных.

mysql — база данных MySQL.

postgres — локальная база данных PostgreSQL.

Варианты:

  • "mysql"
  • "postgres"

device_count_high

псевдонимы: device-count-high

string

Необходимо установить значение enable, если количество зарегистрированных устройств превышает 8000.

disable — установить, если количество устройств меньше 8000.

enable — установить, если количество устройств равно или превышает 8000.

Варианты:

  • "disable"
  • "enable"

event_table_partition_time

псевдонимы: event-table-partition-time

integer

Максимальный временной диапазон разбиения таблиц базы данных SQL в минутах.

fct_table_partition_time

псевдонимы: fct-table-partition-time

integer

Максимальный временной диапазон разбиения таблиц базы данных 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

Варианты:

  • "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

(list) Пароль для входа в удаленную базу данных.

prompt_sql_upgrade

псевдонимы: prompt-sql-upgrade

string

Запрашивать преобразование базы данных журналов в базу данных SQL при запуске графического интерфейса.

disable — не запрашивать обновление базы данных журналов до базы данных SQL при запуске графического интерфейса.

enable — запрашивать обновление базы данных журналов до базы данных SQL при запуске графического интерфейса.

Варианты:

  • "disable"
  • "enable"

rebuild_event

псевдонимы: rebuild-event

string

Отключить/включить перестроение событий во время перестроения базы данных SQL.

disable — не перестраивать события во время перестроения базы данных SQL.

enable — перестраивать события во время перестроения базы данных SQL.

Варианты:

  • "disable"
  • "enable"

rebuild_event_start_time

псевдонимы: rebuild-event-start-time

any

(list) Дата и время начала перестроения событий.

server

string

IP-адрес или имя хоста базы данных.

start_time

псевдонимы: start-time

any

(list) Дата и время начала.

status

string

Состояние базы данных SQL.

disable — отключить базу данных SQL.

local — включить локальную базу данных.

Варианты:

  • "disable"
  • "local"

text_search_index

псевдонимы: text-search-index

string

Отключить/включить индекс полнотекстового поиска.

disable — не создавать индекс полнотекстового поиска.

enable — создать индекс полнотекстового поиска.

Варианты:

  • "disable"
  • "enable"

traffic_table_partition_time

псевдонимы: traffic-table-partition-time

integer

Максимальный временной диапазон разбиения таблиц базы данных SQL в минутах.

ts_index_field

псевдонимы: ts-index-field

list / elements=dictionary

Поле индекса ts.

category

string

Категория полей индекса полнотекстового поиска.

value

string

Поля индекса полнотекстового поиска.

username

string

Имя пользователя для входа в удаленную базу данных.

utm_table_partition_time

псевдонимы: utm-table-partition-time

integer

Максимальный временной диапазон разбиения таблиц базы данных SQL в минутах.

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_failed и rc_succeeded.

Примеры

- name: Example playbook (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  gather_facts: false
  tasks:
    - name: SQL settings.
      fortinet.fortimanager.fmgr_system_sql:
        # workspace_locking_adom: <global or your adom name>
        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–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_module.html

Spec-Zone.ru

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