Spec-Zone.ru › Ansible

fortinet.fortios.fortios_alertemail_setting модуль — Настройка параметров уведомлений по электронной почте в Fortinet FortiOS и FortiGate.

Примечание

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

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

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

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

Новое в fortinet.fortios 2.0.0

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

Обзор

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

Требования

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

  • ansible>=2.15

Параметры

Параметр

Комментарии

access_token

string

Токенная аутентификация. Создается в GUI Fortigate.

alertemail_setting

dictionary

Настройка параметров оповещения по электронной почте.

admin_login_logs

string

Включить/отключить логи входа/выхода администратора в оповещениях по электронной почте.

Варианты:

  • "enable"
  • "disable"

alert_interval

integer

Интервал оповещения в минутах.

amc_interface_bypass_mode

string

Включить/отключить логи режима обхода интерфейса Fortinet Advanced Mezzanine Card (AMC) в оповещениях по электронной почте.

Варианты:

  • "enable"
  • "disable"

antivirus_logs

string

Включить/отключить логи антивируса в оповещениях по электронной почте.

Варианты:

  • "enable"
  • "disable"

configuration_changes_logs

string

Включить/отключить логи изменений конфигурации в оповещениях по электронной почте.

Варианты:

  • "enable"
  • "disable"

critical_interval

integer

Критический интервал оповещения в минутах.

debug_interval

integer

Отладочный интервал оповещения в минутах.

email_interval

integer

Интервал между отправкой оповещений по электронной почте (1 - 99999 мин).

emergency_interval

integer

Аварийный интервал оповещения в минутах.

error_interval

integer

Интервал оповещения об ошибках в минутах.

FDS_license_expiring_days

integer

Количество дней до отправки оповещения по электронной почте до истечения срока действия лицензии FortiGuard (1 - 100 дней).

FDS_license_expiring_warning

string

Включить/отключить предупреждения об истечении срока действия лицензии FortiGuard в оповещениях по электронной почте.

Варианты:

  • "enable"
  • "disable"

FDS_update_logs

string

Включить/отключить логи обновлений FortiGuard в оповещениях по электронной почте.

Варианты:

  • "enable"
  • "disable"

filter_mode

string

Как фильтровать сообщения журналов, которые отправляются в оповещения по электронной почте.

Варианты:

  • "category"
  • "threshold"

FIPS_CC_errors

string

Включить/отключить логи ошибок FIPS и Common Criteria в оповещениях по электронной почте.

Варианты:

  • "enable"
  • "disable"

firewall_authentication_failure_logs

string

Включить/отключить логи сбоев аутентификации брандмауэра в оповещениях по электронной почте.

Варианты:

  • "enable"
  • "disable"

fortiguard_log_quota_warning

string

Включить/отключить предупреждения о квоте журналов FortiCloud в оповещениях по электронной почте.

Варианты:

  • "enable"
  • "disable"

FSSO_disconnect_logs

string

Включить/отключить логи отключения агента коллектора FSSO.

Варианты:

  • "enable"
  • "disable"

HA_logs

string

Включить/выключить журналы HA в электронном письме оповещения.

Choices:

  • "enable"
  • "disable"

information_interval

integer

Интервал оповещения об информации в минутах.

IPS_logs

string

Включить/выключить журналы IPS в электронном письме оповещения.

Choices:

  • "enable"
  • "disable"

IPsec_errors_logs

string

Включить/выключить журналы ошибок IPsec в электронном письме оповещения.

Choices:

  • "enable"
  • "disable"

local_disk_usage

integer

Процент использования диска, при котором отправляется электронное письмо оповещения (1 - 99 процентов).

log_disk_usage_warning

string

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

Choices:

  • "enable"
  • "disable"

mailto1

string

Электронный адрес для отправки уведомлений (обычно системный администратор) (макс. 63 символа).

mailto2

string

Дополнительный второй электронный адрес для отправки уведомлений (макс. 63 символа).

mailto3

string

Дополнительный третий электронный адрес для отправки уведомлений (макс. 63 символа).

notification_interval

integer

Интервал оповещения в минутах.

PPP_errors_logs

string

Включить/выключить журналы ошибок PPP в электронном письме оповещения.

Choices:

  • "enable"
  • "disable"

severity

string

Минимальный уровень серьезности для логирования.

Choices:

  • "emergency"
  • "alert"
  • "critical"
  • "error"
  • "warning"
  • "notification"
  • "information"
  • "debug"

ssh_logs

string

Включить/выключить журналы SSH в электронном письме оповещения.

Choices:

  • "enable"
  • "disable"

sslvpn_authentication_errors_logs

string

Включить/выключить журналы ошибок аутентификации SSL-VPN в электронном письме оповещения.

Choices:

  • "enable"
  • "disable"

username

string

Имя, отображаемое в поле From: электронных писем оповещения (макс. 63 символа).

violation_traffic_logs

string

Включить/выключить журналы трафика нарушений в электронном письме оповещения.

Choices:

  • "enable"
  • "disable"

warning_interval

integer

Интервал предупреждающих оповещений в минутах.

webfilter_logs

string

Включить/выключить журналы веб-фильтра в электронном письме оповещения.

Choices:

  • "enable"
  • "disable"

enable_log

boolean

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

Choices:

  • false ← (default)
  • true

member_path

string

Путь к атрибуту члена для работы.

Разделяется символом слеша, если атрибутов более одного.

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

member_state

string

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

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

Варианты:

  • "present"
  • "absent"

vdom

string

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

Значение по умолчанию: "root"

Примечания

Примечание

  • Устаревшее API fortiosapi было прекращено, httpapi — предпочтительный способ запуска playbook'ов

Примеры

- name: Configure alert email settings.
  fortinet.fortios.fortios_alertemail_setting:
      vdom: "{{ vdom }}"
      alertemail_setting:
          admin_login_logs: "enable"
          alert_interval: "2"
          amc_interface_bypass_mode: "enable"
          antivirus_logs: "enable"
          configuration_changes_logs: "enable"
          critical_interval: "3"
          debug_interval: "60"
          email_interval: "5"
          emergency_interval: "1"
          error_interval: "5"
          FDS_license_expiring_days: "15"
          FDS_license_expiring_warning: "enable"
          FDS_update_logs: "enable"
          filter_mode: "category"
          FIPS_CC_errors: "enable"
          firewall_authentication_failure_logs: "enable"
          fortiguard_log_quota_warning: "enable"
          FSSO_disconnect_logs: "enable"
          HA_logs: "enable"
          information_interval: "30"
          IPS_logs: "enable"
          IPsec_errors_logs: "enable"
          local_disk_usage: "75"
          log_disk_usage_warning: "enable"
          mailto1: "<your_own_value>"
          mailto2: "<your_own_value>"
          mailto3: "<your_own_value>"
          notification_interval: "20"
          PPP_errors_logs: "enable"
          severity: "emergency"
          ssh_logs: "enable"
          sslvpn_authentication_errors_logs: "enable"
          username: "<your_own_value>"
          violation_traffic_logs: "enable"
          warning_interval: "10"
          webfilter_logs: "enable"

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

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

Ключ

Описание

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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/fortinet/fortios/fortios_alertemail_setting_module.html

Spec-Zone.ru

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