Spec-Zone.ru › Ansible

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

Примечание

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

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

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

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

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

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

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

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

Требования

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

  • ansible>=2.16

Параметры

Параметр

Комментарии

access_token

string

Аутентификация на основе токена. Создается в графическом интерфейсе 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.

Варианты:

  • "enable"
  • "disable"

information_interval

integer

Интервал между информационными оповещениями, в минутах.

IPS_logs

string

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

Варианты:

  • "enable"
  • "disable"

IPsec_errors_logs

string

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

Варианты:

  • "enable"
  • "disable"

local_disk_usage

integer

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

log_disk_usage_warning

string

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

Варианты:

  • "enable"
  • "disable"

mailto1

string

Адрес электронной почты для отправки оповещений (обычно адрес системного администратора; не более 63 символов).

mailto2

string

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

mailto3

string

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

notification_interval

integer

Интервал между уведомлениями, в минутах.

PPP_errors_logs

string

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

Варианты:

  • "enable"
  • "disable"

severity

string

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

Варианты:

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

ssh_logs

string

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

Варианты:

  • "enable"
  • "disable"

sslvpn_authentication_errors_logs

string

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

Варианты:

  • "enable"
  • "disable"

username

string

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

violation_traffic_logs

string

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

Варианты:

  • "enable"
  • "disable"

warning_interval

integer

Интервал между предупреждениями, в минутах.

webfilter_logs

string

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

Варианты:

  • "enable"
  • "disable"

enable_log

boolean

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

Варианты:

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

member_path

string

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

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

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

member_state

string

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

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

Варианты:

  • "present"
  • "absent"

vdom

string

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

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

Примечания

Примечание

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

Примеры

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

Spec-Zone.ru

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