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

Примечание

Этот плагин входит в состав коллекции fortinet.fortimanager (версия 2.0.1).

Для его установки используйте: ansible-galaxy collection install fortinet.fortimanager.

Чтобы использовать его в playbook, укажите: fortinet.fortimanager.fmgr_devprof_log_fortianalyzer_setting.

Новое в версии 2.10: модуля fortinet.fortimanager

Обзор
Параметры
Примечания
Примеры
Значения возврата

Обзор

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

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
adom строка / обязательно			параметр (adom) в запрошенном URL
bypass_validation булево		Варианты: нет ← да	устанавливается в True только при расхождениях схемы модуля со структурой API FortiManager; модуль продолжает выполнение без проверки параметров
devprof строка / обязательно			параметр (devprof) в запрошенном URL
devprof_log_fortianalyzer_setting словарь			устанавливаемые параметры верхнего уровня
	certificate строка		Сертификат, используемый для связи с FortiAnalyzer.
	conn-timeout целое число		Тайм-аут подключения к FortiAnalyzer в секундах (для статуса и буфера логов).
	enc-algorithm строка	Варианты: по умолчанию высокий низкий выключено высокий-средний низкий-средний	Включение/выключение отправки данных логов FortiAnalyzer с шифрованием SSL.
	hmac-algorithm строка	Варианты: sha256 sha1	Алгоритм HMAC туннеля IPsec FortiAnalyzer.
	ips-archive строка	Варианты: выключено включено	Включение/выключение записи логов архива пакетов IPS.
	monitor-failure-retry-period целое число		Интервал между повторными попытками подключения к FortiAnalyzer в секундах (для статуса и буфера логов).
	monitor-keepalive-period целое число		Интервал между keepalive OFTP в секундах (для статуса и буфера логов).
	reliable строка	Варианты: выключено включено	Включение/выключение надежной записи логов в FortiAnalyzer.
	ssl-min-proto-version строка	Варианты: по умолчанию TLSv1 TLSv1-1 TLSv1-2 SSLv3	Минимальная поддерживаемая версия протокола для SSL/TLS-соединений (по умолчанию следует глобальному системному параметру).
	upload-day строка		День недели (месяца) для загрузки логов.
	upload-interval строка	Варианты: ежедневно еженедельно ежемесячно	Частота загрузки файлов журналов в FortiAnalyzer.
	upload-option строка	Варианты: хранить и загружать режим реального времени 1 минута 5 минут	Включение/выключение записи логов на жесткий диск, а затем загрузки в FortiAnalyzer.
	upload-time строка		Время загрузки логов (чч:мм).
rc_failed список / элементы=строка			список rc-кодов, при которых выполнение будет остановлено
rc_succeeded список / элементы=строка			список rc-кодов, при которых выполнение будет завершено успешно
state строка / обязательно		Варианты: present absent	направление на создание, обновление или удаление объекта
workspace_locking_adom строка			adom для блокировки в режиме работы FortiManager в режиме рабочей области, значение может быть глобальным и другими, включая root
workspace_locking_timeout целое число		По умолчанию: 300	максимальное время в секундах ожидания освобождения блокировки рабочей области другим пользователем

Примечания

Примечание

Поддержка работы в режиме блокировки рабочей области реализована в этом модуле FortiManager; параметры workspace_locking_adom и workspace_locking_timeout используются для этой задачи.
Для создания или обновления объекта используйте направление state present.
Для удаления объекта используйте направление state absent.
Обычно выполнение одного модуля может завершиться ошибкой при возвращении ненулевого rc. Вы также можете переопределить условия для завершения ошибки или успешного выполнения с помощью параметров rc_failed и rc_succeeded

Примеры

- hosts: fortimanager-inventory
  collections:
    - fortinet.fortimanager
  connection: httpapi
  vars:
     ansible_httpapi_use_ssl: True
     ansible_httpapi_validate_certs: False
     ansible_httpapi_port: 443
  tasks:
   - name: Global FortiAnalyzer settings.
     fmgr_devprof_log_fortianalyzer_setting:
        bypass_validation: False
        workspace_locking_adom: <value in [global, custom adom including root]>
        workspace_locking_timeout: 300
        rc_succeeded: [0, -2, -3, ...]
        rc_failed: [-2, -3, ...]
        adom: <your own value>
        devprof: <your own value>
        devprof_log_fortianalyzer_setting:
           certificate: <value of string>
           conn-timeout: <value of integer>
           enc-algorithm: <value in [default, high, low, ...]>
           hmac-algorithm: <value in [sha256, sha1]>
           ips-archive: <value in [disable, enable]>
           monitor-failure-retry-period: <value of integer>
           monitor-keepalive-period: <value of integer>
           reliable: <value in [disable, enable]>
           ssl-min-proto-version: <value in [default, TLSv1, TLSv1-1, ...]>
           upload-day: <value of string>
           upload-interval: <value in [daily, weekly, monthly]>
           upload-option: <value in [store-and-upload, realtime, 1-minute, ...]>
           upload-time: <value of string>

Значения возврата

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

Ключ	Возвращаемое значение	Описание
request_url строка	всегда	Полный запрошенный URL Пример: /sys/login/user
response_code целое число	всегда	Статус запроса API
response_message строка	всегда	Дескриптивное сообщение ответа API Пример: OK.

Авторы

Link Zheng (@chillancezen)
Jie Xue (@JieX19)
Frank Shen (@fshen01)
Hongbin Lu (@fgtdev-hblu)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/fortinet/fortimanager/fmgr_devprof_log_fortianalyzer_setting_module.html