fortios_log_fortianalyzer3_setting – Настройки глобального FortiAnalyzer в Fortinet’s FortiOS и FortiGate

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

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

Описание

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

Требования

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

fortiosapi>=0.9.8

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
host строка			IP-адрес FortiOS или FortiGate.
https логическое значение		Варианты: no yes ←	Указывает, должны ли запросы к FortiGate использовать протокол HTTPS.
log_fortianalyzer3_setting словарь		Значение по умолчанию: null	Настройки глобального FortiAnalyzer.
	__change_ip целое число		Скрытый атрибут.
	certificate строка		Сертификат, используемый для связи с FortiAnalyzer. Источник сертификата certificate.local.name.
	conn_timeout целое число		Таймаут подключения к FortiAnalyzer в секундах (для статуса и буфера логов).
	enc_algorithm строка	Варианты: high-medium high low	Включение/выключение отправки данных логов 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 целое число		Время между OFTP keepalives в секундах (для статуса и буфера логов).
	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 строка		Время загрузки логов (чч:мм).
password строка		Значение по умолчанию: ""	Пароль FortiOS или FortiGate.
ssl_verify логическое значение добавлен в 2.9		Варианты: no yes ←	Обеспечивает проверку сертификата 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"
   ssl_verify: "False"
  tasks:
  - name: Global FortiAnalyzer settings.
    fortios_log_fortianalyzer3_setting:
      host:  "{{ host }}"
      username: "{{ username }}"
      password: "{{ password }}"
      vdom:  "{{ vdom }}"
      https: "False"
      log_fortianalyzer3_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"
        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>"

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

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

Ключ	Возвращаемое значение	Описание
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 строка	всегда	Указание результата операции Пример: успех
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.9/modules/fortios_log_fortianalyzer3_setting_module.html