Spec-Zone.ru › Ansible

модуль fortinet.fortios.fortios_log_fortianalyzer2_setting — глобальные настройки FortiAnalyzer в Fortinet FortiOS и FortiGate.

Примечание

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

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

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

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

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

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

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

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

Требования

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

  • ansible>=2.16

Параметры

Параметр

Комментарии

access_token

string

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

enable_log

boolean

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

Варианты:

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

log_fortianalyzer2_setting

dictionary

Глобальные настройки FortiAnalyzer.

__change_ip

integer

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

access_config

string

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

Варианты:

  • "enable"
  • "disable"

alt_server

string

Резервный FortiAnalyzer.

certificate

string

Сертификат для связи с FortiAnalyzer. Источник: certificate.local.name.

certificate_verification

string

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

Варианты:

  • "enable"
  • "disable"

conn_timeout

integer

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

enc_algorithm

string

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

Варианты:

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

fallback_to_primary

string

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

Варианты:

  • "enable"
  • "disable"

faz_type

integer

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

hmac_algorithm

string

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

Варианты:

  • "sha256"
  • "sha1"

interface

string

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

interface_select_method

string

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

Варианты:

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

ips_archive

string

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

Варианты:

  • "enable"
  • "disable"

max_log_rate

integer

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

mgmt_name

string

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

monitor_failure_retry_period

integer

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

monitor_keepalive_period

integer

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

preshared_key

string

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

priority

string

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

Варианты:

  • "default"
  • "low"

reliable

string

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

Варианты:

  • "enable"
  • "disable"

serial

list / elements=dictionary

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

name

string / обязательный

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

server

string

Удаленный FortiAnalyzer.

server_cert_ca

string

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

source_ip

string

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

ssl_min_proto_version

string

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

Варианты:

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

status

string

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

Варианты:

  • "enable"
  • "disable"

upload_day

string

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

upload_interval

string

Частота загрузки файлов журналов на FortiAnalyzer.

Варианты:

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

upload_option

string

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

Варианты:

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

upload_time

string

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

vrf_select

integer

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

member_path

string

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

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

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

member_state

string

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

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

Варианты:

  • "present"
  • "absent"

vdom

string

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

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

Примечания

Примечание

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

Примеры

- name: Global FortiAnalyzer settings.
  fortinet.fortios.fortios_log_fortianalyzer2_setting:
      vdom: "{{ vdom }}"
      log_fortianalyzer2_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"
          preshared_key: "<your_own_value>"
          priority: "default"
          reliable: "enable"
          serial:
              -
                  name: "default_name_24"
          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>"
          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_setting_module.html

Spec-Zone.ru

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