fortinet.fortios.fortios_alertemail_setting 模块 – 配置 Fortinet 的 FortiOS 和 FortiGate 中的告警邮件设置。

注意

此模块是 fortinet.fortios 集合 (版本 2.3.8) 的一部分。

如果您使用的是 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) 设备。示例包括所有参数，使用前需要将值调整到数据源。已在 FOS v6.0.0 上测试。

要求

执行此模块的主机需要以下要求。

• ansible>=2.15

参数

参数	注释
access_token 字符串	基于令牌的身份验证。从 FortiGate 的 GUI 生成。
alertemail_setting 字典	配置告警邮件设置。
admin_login_logs 字符串	启用/禁用告警邮件中的管理员登录/注销日志。 选项 "enable" "disable"
alert_interval 整数	告警间隔（分钟）。
amc_interface_bypass_mode 字符串	启用/禁用告警邮件中的 Fortinet 高级中间件卡 (AMC) 接口旁路模式日志。 选项 "enable" "disable"
antivirus_logs 字符串	启用/禁用告警邮件中的反病毒日志。 选项 "enable" "disable"
configuration_changes_logs 字符串	启用/禁用告警邮件中的配置更改日志。 选项 "enable" "disable"
critical_interval 整数	严重告警间隔（分钟）。
debug_interval 整数	调试告警间隔（分钟）。
email_interval 整数	发送告警邮件的时间间隔 (1 - 99999 分钟)。
emergency_interval 整数	紧急告警间隔（分钟）。
error_interval 整数	错误告警间隔（分钟）。
FDS_license_expiring_days 整数	在 FortiGuard 许可证过期前发送告警邮件的天数 (1 - 100 天)。
FDS_license_expiring_warning 字符串	启用/禁用告警邮件中的 FortiGuard 许可证过期警告。 选项 "enable" "disable"
FDS_update_logs 字符串	启用/禁用告警邮件中的 FortiGuard 更新日志。 选项 "enable" "disable"
filter_mode 字符串	如何过滤发送到告警邮件的日志消息。 选项 "category" "threshold"
FIPS_CC_errors 字符串	启用/禁用告警邮件中的 FIPS 和通用标准错误日志。 选项 "enable" "disable"
firewall_authentication_failure_logs 字符串	启用/禁用告警邮件中的防火墙身份验证失败日志。 选项 "enable" "disable"
fortiguard_log_quota_warning 字符串	启用/禁用告警邮件中的 FortiCloud 日志配额警告。 选项 "enable" "disable"
FSSO_disconnect_logs 字符串	启用/禁用 FSSO 收集器代理断开连接的日志记录。 选项 "enable" "disable"
HA_logs 字符串	启用/禁用告警邮件中的 HA 日志。 选项 "enable" "disable"
information_interval 整数	信息告警间隔（分钟）。
IPS_logs 字符串	启用/禁用告警邮件中的 IPS 日志。 选项 "enable" "disable"
IPsec_errors_logs 字符串	启用/禁用告警邮件中的 IPsec 错误日志。 选项 "enable" "disable"
local_disk_usage 整数	发送告警邮件的磁盘使用率百分比 (1 - 99%)。
log_disk_usage_warning 字符串	启用/禁用告警邮件中的磁盘使用率警告。 选项 "enable" "disable"
mailto1 字符串	发送告警邮件到的电子邮件地址（通常是系统管理员）（最多 63 个字符）。
mailto2 字符串	可选的第二个发送告警邮件到的电子邮件地址（最多 63 个字符）。
mailto3 字符串	可选的第三个发送告警邮件到的电子邮件地址（最多 63 个字符）。
notification_interval 整数	通知告警间隔（分钟）。
PPP_errors_logs 字符串	启用/禁用告警邮件中的 PPP 错误日志。 选项 "enable" "disable"
severity 字符串	要记录的最低严重性级别。 选项 "emergency" "alert" "critical" "error" "warning" "notification" "information" "debug"
ssh_logs 字符串	启用/禁用告警邮件中的 SSH 日志。 选项 "enable" "disable"
sslvpn_authentication_errors_logs 字符串	启用/禁用告警邮件中的 SSL-VPN 身份验证错误日志。 选项 "enable" "disable"
username 字符串	显示在告警邮件的“发件人”字段中的名称（最多 63 个字符）。
violation_traffic_logs 字符串	启用/禁用告警邮件中的违规流量日志。 选项 "enable" "disable"
warning_interval 整数	警告告警间隔（分钟）。
webfilter_logs 字符串	启用/禁用告警邮件中的 Web 过滤器日志。 选项 "enable" "disable"
enable_log 布尔值	启用/禁用任务的日志记录。 选项 false ← (默认) true
member_path 字符串	要操作的成员属性路径。 如果有多个属性，则用斜杠字符分隔。 标有 member_path 的参数对于执行成员操作是合法的。
member_state 字符串	在指定的属性路径下添加或删除成员。 指定 member_state 时，将忽略 state 选项。 选项 "present" "absent"
vdom 字符串	虚拟域，在以前定义的虚拟域中。vdom 是 FortiGate 的虚拟实例，可以将其配置并用作不同的单元。 默认值： "root"

注释

注意

• 旧版 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 字符串	FortiGate镜像的版本号 返回值：始终 示例： "1547"
http_method 字符串	上次用于将内容置备到 FortiGate 的方法 返回值：始终 示例： "PUT"
http_status 字符串	FortiGate 在上次应用的操作中给出的最后结果 返回值：始终 示例： "200"
mkey 字符串	上次调用 FortiGate 时使用的主密钥 (ID) 返回值：成功 示例： "id"
name 字符串	用于完成请求的表的名称 返回值：始终 示例： "urlfilter"
path 字符串	用于完成请求的表的路径 返回值：始终 示例： "webfilter"
revision 字符串	内部修订号 返回值：始终 示例： "17.0.2.10658"
serial 字符串	设备的序列号 返回值：始终 示例： "FGVMEVYYQT3AB5352"
status 字符串	操作结果的指示 返回值：始终 示例： "success"
vdom 字符串	使用的虚拟域 返回值：始终 示例： "root"
version 字符串	FortiGate 的版本 返回值：始终 示例： "v5.6.3"

作者

• 郑链 (@chillancezen)

• 薛杰 (@JieX19)

• 陆洪滨 (@fgtdev-hblu)

• 沈峰 (@frankshen01)

• Miguel Angel Munoz (@mamunozgonzalez)

• Nicolas Thomas (@thomnico)

集合链接

• 问题追踪器
• 主页
• 代码库 (源代码)