fortinet.fortios.fortios_alertemail_setting module – Configure alert email settings in Fortinet’s FortiOS and FortiGate.
Note
This module is part of the fortinet.fortios collection (version 2.3.6).
You might already have this collection installed if you are using the ansible package.
It is not included in ansible-core.
To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install fortinet.fortios.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: fortinet.fortios.fortios_alertemail_setting.
New in fortinet.fortios 2.0.0
Synopsis
This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify alertemail feature and setting category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
Requirements
The below requirements are needed on the host that executes this module.
ansible>=2.15
Parameters
Parameter |
Comments |
|---|---|
Token-based authentication. Generated from GUI of Fortigate. |
|
Configure alert email settings. |
|
Enable/disable administrator login/logout logs in alert email. Choices:
|
|
Alert alert interval in minutes. |
|
Enable/disable Fortinet Advanced Mezzanine Card (AMC) interface bypass mode logs in alert email. Choices:
|
|
Enable/disable antivirus logs in alert email. Choices:
|
|
Enable/disable configuration change logs in alert email. Choices:
|
|
Critical alert interval in minutes. |
|
Debug alert interval in minutes. |
|
Interval between sending alert emails (1 - 99999 min). |
|
Emergency alert interval in minutes. |
|
Error alert interval in minutes. |
|
Number of days to send alert email prior to FortiGuard license expiration (1 - 100 days). |
|
Enable/disable FortiGuard license expiration warnings in alert email. Choices:
|
|
Enable/disable FortiGuard update logs in alert email. Choices:
|
|
How to filter log messages that are sent to alert emails. Choices:
|
|
Enable/disable FIPS and Common Criteria error logs in alert email. Choices:
|
|
Enable/disable firewall authentication failure logs in alert email. Choices:
|
|
Enable/disable FortiCloud log quota warnings in alert email. Choices:
|
|
Enable/disable logging of FSSO collector agent disconnect. Choices:
|
|
Enable/disable HA logs in alert email. Choices:
|
|
Information alert interval in minutes. |
|
Enable/disable IPS logs in alert email. Choices:
|
|
Enable/disable IPsec error logs in alert email. Choices:
|
|
Disk usage percentage at which to send alert email (1 - 99 percent). |
|
Enable/disable disk usage warnings in alert email. Choices:
|
|
Email address to send alert email to (usually a system administrator) (max. 63 characters). |
|
Optional second email address to send alert email to (max. 63 characters). |
|
Optional third email address to send alert email to (max. 63 characters). |
|
Notification alert interval in minutes. |
|
Enable/disable PPP error logs in alert email. Choices:
|
|
Lowest severity level to log. Choices:
|
|
Enable/disable SSH logs in alert email. Choices:
|
|
Enable/disable SSL-VPN authentication error logs in alert email. Choices:
|
|
Name that appears in the From: field of alert emails (max. 63 characters). |
|
Enable/disable violation traffic logs in alert email. Choices:
|
|
Warning alert interval in minutes. |
|
Enable/disable web filter logs in alert email. Choices:
|
|
Enable/Disable logging for task. Choices:
|
|
Member attribute path to operate on. Delimited by a slash character if there are more than one attribute. Parameter marked with member_path is legitimate for doing member operation. |
|
Add or delete a member under specified attribute path. When member_state is specified, the state option is ignored. Choices:
|
|
Virtual domain, among those defined previously. A vdom is a virtual instance of the FortiGate that can be configured and used as a different unit. Default: |
Notes
Note
Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
- 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"
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
Build number of the fortigate image Returned: always Sample: |
|
Last method used to provision the content into FortiGate Returned: always Sample: |
|
Last result given by FortiGate on last operation applied Returned: always Sample: |
|
Master key (id) used in the last call to FortiGate Returned: success Sample: |
|
Name of the table used to fulfill the request Returned: always Sample: |
|
Path of the table used to fulfill the request Returned: always Sample: |
|
Internal revision number Returned: always Sample: |
|
Serial number of the unit Returned: always Sample: |
|
Indication of the operation’s result Returned: always Sample: |
|
Virtual domain used Returned: always Sample: |
|
Version of the FortiGate Returned: always Sample: |