Spec-Zone.ru › Ansible

модуль fortinet.fortios.fortios_log_fortianalyzer2_override_setting — Переопределение настроек FortiAnalyzer в FortiOS и FortiGate от Fortinet.

Примечание

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

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

Чтобы установить её, используйте: ansible-galaxy collection install fortinet.fortios. Для использования этого модуля требуются дополнительные компоненты; подробности см. в разделе Требования.

Чтобы использовать его в плейбуке, укажите: fortinet.fortios.fortios_log_fortianalyzer2_override_setting.

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

  • Краткое описание
  • Требования
  • Параметры
  • Примечания
  • Примеры
  • Возвращаемые значения

Краткое описание

  • Этот модуль позволяет настраивать устройство FortiGate или FortiOS (FOS), задавая и изменяя функцию log_fortianalyzer2 и категорию override_setting. В примерах приведены все параметры и значения, которые необходимо адаптировать к источникам данных перед использованием. Проверено на FOS v6.0.0

Требования

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

  • ansible>=2.16

Параметры

Параметр

Комментарии

access_token

строка

Аутентификация на основе токена. Создаётся в графическом интерфейсе FortiGate.

enable_log

логическое значение

Включить или отключить ведение журнала для задачи.

Варианты:

  • false ← (по умолчанию)
  • true

log_fortianalyzer2_override_setting

словарь

Переопределение настроек FortiAnalyzer.

__change_ip

целое число

Скрытый атрибут.

access_config

строка

Включить или отключить доступ FortiAnalyzer к конфигурации и данным.

Варианты:

  • "enable"
  • "disable"

alt_server

строка

Альтернативный FortiAnalyzer.

certificate

строка

Сертификат, используемый для связи с FortiAnalyzer. Источник: certificate.local.name.

certificate_verification

строка

Включить или отключить проверку подлинности FortiAnalyzer с помощью сертификата.

Варианты:

  • "enable"
  • "disable"

conn_timeout

целое число

Тайм-аут подключения к FortiAnalyzer в секундах (для состояния и буфера журналов).

enc_algorithm

строка

Настройка уровня защиты SSL для безопасной связи с FortiAnalyzer.

Варианты:

  • "high-medium"
  • "high"
  • "low"

fallback_to_primary

строка

Включить или отключить возврат этого устройства FortiGate к основному FortiAnalyzer, когда он становится доступен.

Варианты:

  • "enable"
  • "disable"

faz_type

целое число

Скрытый индекс настройки FortiAnalyzer.

hmac_algorithm

строка

Алгоритм хеширования для входа в OFTP.

Варианты:

  • "sha256"
  • "sha1"

interface

строка

Укажите исходящий интерфейс для доступа к серверу. Источник: system.interface.name.

interface_select_method

строка

Укажите способ выбора исходящего интерфейса для доступа к серверу.

Варианты:

  • "auto"
  • "sdwan"
  • "specify"

ips_archive

строка

Включить или отключить архивирование пакетов IPS в журнале.

Варианты:

  • "enable"
  • "disable"

max_log_rate

целое число

Максимальная скорость передачи журналов в FortiAnalyzer, МБ/с (0 = без ограничений).

mgmt_name

строка

Скрытое имя управления FortiAnalyzer.

monitor_failure_retry_period

целое число

Интервал между попытками повторного подключения к FortiAnalyzer в секундах (для состояния и буфера журналов).

monitor_keepalive_period

целое число

Интервал между сигналами поддержания соединения OFTP в секундах (для состояния и буфера журналов).

override

строка

Включить или отключить переопределение настроек FortiAnalyzer либо использовать глобальные настройки.

Варианты:

  • "enable"
  • "disable"

preshared_key

строка

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

priority

строка

Задайте приоритет передачи журналов.

Варианты:

  • "default"
  • "low"

reliable

строка

Включить или отключить надёжное ведение журнала в FortiAnalyzer.

Варианты:

  • "enable"
  • "disable"

serial

список / элементы=словарь

Серийные номера FortiAnalyzer.

name

строка / обязательный

Серийный номер.

server

строка

Удалённый FortiAnalyzer.

server_cert_ca

строка

Обязательный центр сертификации на FortiGate в цепочке сертификатов сервера. Источник: certificate.ca.name vpn.certificate.ca.name.

source_ip

строка

Исходный адрес IPv4 или IPv6, используемый для связи с FortiAnalyzer.

ssl_min_proto_version

строка

Минимальная поддерживаемая версия протокола для соединений SSL/TLS.

Варианты:

  • "default"
  • "SSLv3"
  • "TLSv1"
  • "TLSv1-1"
  • "TLSv1-2"
  • "TLSv1-3"

status

строка

Включить или отключить ведение журнала в FortiAnalyzer.

Варианты:

  • "enable"
  • "disable"

upload_day

строка

День недели (месяца) для отправки журналов.

upload_interval

строка

Периодичность отправки файлов журналов в FortiAnalyzer.

Варианты:

  • "daily"
  • "weekly"
  • "monthly"

upload_option

строка

Включить или отключить запись журналов на жёсткий диск с последующей отправкой в FortiAnalyzer.

Варианты:

  • "store-and-upload"
  • "realtime"
  • "1-minute"
  • "5-minute"

upload_time

строка

Время отправки журналов (чч:мм).

use_management_vdom

строка

Включить или отключить использование IP-адреса управляющего VDOM в качестве исходного IP-адреса для журналов, отправляемых в FortiAnalyzer.

Варианты:

  • "enable"
  • "disable"

vrf_select

целое число

Идентификатор VRF, используемый для подключения к серверу.

member_path

строка

Путь к атрибуту элемента, над которым выполняется операция.

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

Параметр с отметкой member_path можно использовать для выполнения операции над элементом.

member_state

строка

Добавить или удалить элемент по указанному пути атрибута.

Если задан member_state, параметр state игнорируется.

Варианты:

  • "present"
  • "absent"

vdom

строка

Виртуальный домен из числа ранее определённых. VDOM — это виртуальный экземпляр FortiGate, который можно настроить и использовать как отдельное устройство.

По умолчанию: "root"

Примечания

Примечание

  • Устаревшая библиотека fortiosapi объявлена устаревшей; для запуска плейбуков рекомендуется использовать httpapi
  • Модуль поддерживает check_mode.

Примеры

- name: Override FortiAnalyzer settings.
  fortinet.fortios.fortios_log_fortianalyzer2_override_setting:
      vdom: "{{ vdom }}"
      log_fortianalyzer2_override_setting:
          __change_ip: "127"
          access_config: "enable"
          alt_server: "<your_own_value>"
          certificate: "<your_own_value> (source certificate.local.name)"
          certificate_verification: "enable"
          conn_timeout: "10"
          enc_algorithm: "high-medium"
          fallback_to_primary: "enable"
          faz_type: "2147483647"
          hmac_algorithm: "sha256"
          interface: "<your_own_value> (source system.interface.name)"
          interface_select_method: "auto"
          ips_archive: "enable"
          max_log_rate: "0"
          mgmt_name: "<your_own_value>"
          monitor_failure_retry_period: "5"
          monitor_keepalive_period: "5"
          override: "enable"
          preshared_key: "<your_own_value>"
          priority: "default"
          reliable: "enable"
          serial:
              -
                  name: "default_name_25"
          server: "192.168.100.40"
          server_cert_ca: "<your_own_value> (source certificate.ca.name vpn.certificate.ca.name)"
          source_ip: "84.230.14.43"
          ssl_min_proto_version: "default"
          status: "enable"
          upload_day: "<your_own_value>"
          upload_interval: "daily"
          upload_option: "store-and-upload"
          upload_time: "<your_own_value>"
          use_management_vdom: "enable"
          vrf_select: "0"

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

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

Ключ

Описание

build

string

Номер сборки образа FortiGate

Возвращается: всегда

Пример: "1547"

http_method

string

Последний метод, использованный для передачи содержимого в FortiGate

Возвращается: всегда

Пример: "PUT"

http_status

string

Последний результат, возвращённый FortiGate для последней выполненной операции

Возвращается: всегда

Пример: "200"

mkey

string

Главный ключ (идентификатор), использованный при последнем вызове FortiGate

Возвращается: при успешном выполнении

Пример: "id"

name

string

Имя таблицы, использованной для выполнения запроса

Возвращается: всегда

Пример: "urlfilter"

path

string

Путь к таблице, использованной для выполнения запроса

Возвращается: всегда

Пример: "webfilter"

revision

string

Внутренний номер редакции

Возвращается: всегда

Пример: "17.0.2.10658"

serial

string

Серийный номер устройства

Возвращается: всегда

Пример: "FGVMEVYYQT3AB5352"

status

string

Результат операции

Возвращается: всегда

Пример: "success"

vdom

string

Используемый виртуальный домен

Возвращается: всегда

Пример: "root"

version

string

Версия FortiGate

Возвращается: всегда

Пример: "v5.6.3"

Авторы

  • Link Zheng (@chillancezen)
  • Jie Xue (@JieX19)
  • Hongbin Lu (@fgtdev-hblu)
  • Frank Shen (@frankshen01)
  • Miguel Angel Munoz (@mamunozgonzalez)
  • Nicolas Thomas (@thomnico)

Ссылки на коллекцию

  • Отслеживание проблем
  • Главная страница
  • Репозиторий (исходный код)

© 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/fortios/fortios_log_fortianalyzer2_override_setting_module.html

Spec-Zone.ru

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