fortinet.fortios.fortios_alertemail_setting – Настройка параметров оповещений по электронной почте в FortiOS и FortiGate Fortinet.
Примечание
Этот модуль входит в коллекцию fortinet.fortios (версия 1.1.8).
Для его установки используйте: ansible-galaxy collection install fortinet.fortios.
Для использования в playbook укажите: fortinet.fortios.fortios_alertemail_setting.
Новое в версии 2.9: модуля fortinet.fortios
Обзор
- Этот модуль позволяет настраивать устройства FortiGate или FortiOS (FOS), позволяя пользователю устанавливать и изменять функцию alertemail и категорию настроек. Примеры включают все параметры и значения, которые необходимо настроить в источниках данных перед использованием. Тестировалось на FOS v6.0.0.
Требования
Ниже перечислены требования к хосту, на котором будет выполняться этот модуль.
- ansible>=2.9.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| access_token строка | Аутентификация на основе токена. Сгенерирован из графического интерфейса Fortigate. | ||
| alertemail_setting словарь | Настройка параметров оповещений по электронной почте. | ||
| admin_login_logs строка |
| Включение/выключение регистрации входа/выхода администратора в оповещения по электронной почте. | |
| alert_interval целое число | Интервал оповещения в минутах. | ||
| amc_interface_bypass_mode строка |
| Включение/выключение режима обхода интерфейса карты Fortinet Advanced Mezzanine Card (AMC) в оповещениях по электронной почте. | |
| antivirus_logs строка |
| Включение/выключение логов антивируса в оповещениях по электронной почте. | |
| configuration_changes_logs строка |
| Включение/выключение логов изменений конфигурации в оповещениях по электронной почте. | |
| critical_interval целое число | Интервал критического оповещения в минутах. | ||
| debug_interval целое число | Интервал отладки оповещения в минутах. | ||
| email_interval целое число | Интервал между отправкой электронных писем об оповещениях (от 1 до 99999 минут). | ||
| emergency_interval целое число | Интервал экстренного оповещения в минутах. | ||
| error_interval целое число | Интервал оповещения об ошибках в минутах. | ||
| FDS_license_expiring_days целое число | Количество дней, за которое отправляется электронное письмо об истечении срока действия лицензии FortiGuard (от 1 до 100 дней). | ||
| FDS_license_expiring_warning строка |
| Включение/выключение предупреждений об истечении срока действия лицензии FortiGuard в оповещениях по электронной почте. | |
| FDS_update_logs строка |
| Включение/выключение логов обновлений FortiGuard в оповещениях по электронной почте. | |
| filter_mode строка |
| Как фильтровать сообщения журналов, которые отправляются по электронной почте об оповещениях. | |
| FIPS_CC_errors строка |
| Включение/выключение логов ошибок FIPS и Common Criteria в оповещениях по электронной почте. | |
| firewall_authentication_failure_logs строка |
| Включение/выключение логов отказа аутентификации брандмауэра в оповещениях по электронной почте. | |
| fortiguard_log_quota_warning строка |
| Включение/выключение предупреждений о квоте журнала FortiCloud в оповещениях по электронной почте. | |
| FSSO_disconnect_logs строка |
| Включение/выключение регистрации отключения агента сборщика FSSO. | |
| HA_logs строка |
| Включение/выключение логов HA в оповещениях по электронной почте. | |
| information_interval целое число | Интервал информационных оповещений в минутах. | ||
| IPS_logs строка |
| Включение/выключение логов IPS в оповещениях по электронной почте. | |
| IPsec_errors_logs строка |
| Включение/выключение логов ошибок IPsec в оповещениях по электронной почте. | |
| local_disk_usage целое число | Процент использования диска, при котором отправляется электронное письмо об оповещении (от 1 до 99 процентов). | ||
| log_disk_usage_warning строка |
| Включение/выключение предупреждений об использовании диска в оповещениях по электронной почте. | |
| mailto1 строка | Адрес электронной почты для отправки оповещений (обычно системному администратору) (макс. 64 символа). | ||
| mailto2 строка | Дополнительный второй адрес электронной почты для отправки оповещений (макс. 64 символа). | ||
| mailto3 строка | Дополнительный третий адрес электронной почты для отправки оповещений (макс. 64 символа). | ||
| notification_interval целое число | Интервал оповещения в минутах. | ||
| PPP_errors_logs строка |
| Включение/выключение логов ошибок PPP в оповещениях по электронной почте. | |
| severity строка |
| Минимальный уровень серьезности для регистрации. | |
| ssh_logs строка |
| Включение/выключение логов SSH в оповещениях по электронной почте. | |
| sslvpn_authentication_errors_logs строка |
| Включение/выключение логов ошибок аутентификации SSL-VPN в оповещениях по электронной почте. | |
| username строка | Имя, отображаемое в поле От кого: электронных писем об оповещениях (макс. 36 символов). | ||
| violation_traffic_logs строка |
| Включение/выключение логов нарушений трафика в оповещениях по электронной почте. | |
| warning_interval целое число | Интервал предупредительного оповещения в минутах. | ||
| webfilter_logs строка |
| Включение/выключение логов веб-фильтра в оповещениях по электронной почте. | |
| vdom строка | По умолчанию: "root" | Виртуальная область, среди ранее определённых. VDOM — виртуальный экземпляр FortiGate, который может быть настроен и использован как отдельное устройство. | |
Примечания
Примечание
- Устаревший fortiosapi устарел, httpapi является предпочтительным способом выполнения playbooks
Примеры
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure alert email settings.
fortios_alertemail_setting:
vdom: "{{ vdom }}"
alertemail_setting:
admin_login_logs: "enable"
alert_interval: "4"
amc_interface_bypass_mode: "enable"
antivirus_logs: "enable"
configuration_changes_logs: "enable"
critical_interval: "8"
debug_interval: "9"
email_interval: "10"
emergency_interval: "11"
error_interval: "12"
FDS_license_expiring_days: "13"
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: "22"
IPS_logs: "enable"
IPsec_errors_logs: "enable"
local_disk_usage: "25"
log_disk_usage_warning: "enable"
mailto1: "<your_own_value>"
mailto2: "<your_own_value>"
mailto3: "<your_own_value>"
notification_interval: "30"
PPP_errors_logs: "enable"
severity: "emergency"
ssh_logs: "enable"
sslvpn_authentication_errors_logs: "enable"
username: "<your_own_value>"
violation_traffic_logs: "enable"
warning_interval: "37"
webfilter_logs: "enable"
Значения возврата
Общие значения возврата документированы здесь, следующие — поля, уникальные для данного модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| build string | всегда | Номер сборки образа FortiGate Пример: 1547 |
| http_method string | всегда | Последний метод, используемый для предоставления содержимого в FortiGate Пример: PUT |
| http_status string | всегда | Последний результат, предоставленный FortiGate после последней операции Пример: 200 |
| mkey string | успех | Главный ключ (id), используемый в последнем вызове 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–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/fortinet/fortios/fortios_alertemail_setting_module.html