fortios_log_fortianalyzer_override_setting – Настройка параметров FortiAnalyzer в Fortinet FortiOS и FortiGate

Новая в версии 2.8.

Обзор
Требования
Параметры
Примечания
Примеры
Возвращаемые значения
Статус

Обзор

Этот модуль позволяет настраивать FortiGate или FortiOS, устанавливая и изменяя функцию log_fortianalyzer и категорию override_setting. Примеры включают все параметры и значения, которые необходимо настроить в источниках данных перед использованием. Тестировано с FOS v6.0.2

Требования

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

fortiosapi>=0.9.8

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
host - / обязательно			IP-адрес FortiOS или FortiGate.
https boolean		Варианты: no yes ←	Указывает, должны ли запросы к FortiGate использовать протокол HTTPS.
log_fortianalyzer_override_setting -		По умолчанию: null	Настройка параметров FortiAnalyzer.
	__change_ip -		Скрытый атрибут.
	certificate -		Сертификат, используемый для связи с FortiAnalyzer. Путь к сертификату.
	conn-timeout -		Таймаут соединения с FortiAnalyzer в секундах (для статуса и буфера логов).
	enc-algorithm -	Варианты: high-medium high low disable	Включить/выключить отправку данных логов FortiAnalyzer с шифрованием SSL.
	faz-type -		Скрытый индекс настройки FortiAnalyzer.
	hmac-algorithm -	Варианты: sha256 sha1	Алгоритм HMAC туннеля IPsec FortiAnalyzer.
	ips-archive -	Варианты: enable disable	Включить/выключить протоколирование архива пакетов IPS.
	mgmt-name -		Скрытое имя управления FortiAnalyzer.
	monitor-failure-retry-period -		Интервал между повторными попытками подключения к FortiAnalyzer в секундах (для статуса и буфера логов).
	monitor-keepalive-period -		Интервал между keepalive запросами OFTP в секундах (для статуса и буфера логов).
	override -	Варианты: enable disable	Включить/выключить переопределение настроек FortiAnalyzer или использовать глобальные настройки.
	reliable -	Варианты: enable disable	Включить/выключить надежное протоколирование в FortiAnalyzer.
	server -		Удаленный FortiAnalyzer.
	source-ip -		Источник IPv4 или IPv6-адреса, используемые для связи с FortiAnalyzer.
	ssl-min-proto-version -	Варианты: default SSLv3 TLSv1 TLSv1-1 TLSv1-2	Минимальная поддерживаемая версия протокола для подключений SSL/TLS (по умолчанию используется системное значение).
	status -	Варианты: enable disable	Включить/выключить протоколирование в FortiAnalyzer.
	upload-day -		День недели (месяца) для загрузки логов.
	upload-interval -	Варианты: daily weekly monthly	Частота загрузки файлов логов в FortiAnalyzer.
	upload-option -	Варианты: store-and-upload realtime 1-minute 5-minute	Включить/выключить протоколирование на жёстком диске и последующую загрузку в FortiAnalyzer.
	upload-time -		Время загрузки логов (чч:мм).
	use-management-vdom -	Варианты: enable disable	Включить/выключить использование IP-адреса управления VDOM в качестве исходного IP-адреса для логов, отправляемых в FortiAnalyzer.
password -		По умолчанию: ""	Пароль FortiOS или FortiGate.
username - / обязательно			Имя пользователя FortiOS или FortiGate.
vdom -		По умолчанию: "root"	Виртуальная область (VDOM), ранее определённая. VDOM — виртуальная инстанция FortiGate, которая может быть настроена и использована как отдельное устройство.

Примечания

Примечание

Требуется библиотека fortiosapi, разработанная Fortinet
Выполняется как local_action в вашем playbook

Примеры

- hosts: localhost
  vars:
   host: "192.168.122.40"
   username: "admin"
   password: ""
   vdom: "root"
  tasks:
  - name: Override FortiAnalyzer settings.
    fortios_log_fortianalyzer_override_setting:
      host:  "{{ host }}"
      username: "{{ username }}"
      password: "{{ password }}"
      vdom:  "{{ vdom }}"
      https: "False"
      log_fortianalyzer_override_setting:
        __change_ip: "3"
        certificate: "<your_own_value> (source certificate.local.name)"
        conn-timeout: "5"
        enc-algorithm: "high-medium"
        faz-type: "7"
        hmac-algorithm: "sha256"
        ips-archive: "enable"
        mgmt-name: "<your_own_value>"
        monitor-failure-retry-period: "11"
        monitor-keepalive-period: "12"
        override: "enable"
        reliable: "enable"
        server: "192.168.100.40"
        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"

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

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

Ключ	Возвращаемое значение	Описание
build строка	всегда	Номер сборки изображения FortiGate Пример: 1547
http_method строка	всегда	Последний метод, используемый для предоставления контента в FortiGate Пример: PUT
http_status строка	всегда	Последний результат, предоставленный FortiGate при последней операции Пример: 200
mkey строка	успех	Главный ключ (id), используемый в последнем вызове FortiGate Пример: id
name строка	всегда	Имя таблицы, используемой для выполнения запроса Пример: urlfilter
path строка	всегда	Путь таблицы, используемой для выполнения запроса Пример: webfilter
revision строка	всегда	Внутренний номер ревизии Пример: 17.0.2.10658
serial строка	всегда	Серийный номер устройства Пример: FGVMEVYYQT3AB5352
status строка	всегда	Указание результата операции Пример: success
vdom строка	всегда	Используемый виртуальный домен Пример: root
version строка	всегда	Версия FortiGate Пример: v5.6.3

Статус

Данный модуль не гарантирует обратную совместимость. [предварительная версия]
Этот модуль поддерживается сообществом Ansible. [community]

Авторы

Miguel Angel Munoz (@mamunozgonzalez)
Nicolas Thomas (@thomnico)

Подсказка

Если вы обнаружите какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.8/modules/fortios_log_fortianalyzer_override_setting_module.html