Fortinet white logo
Fortinet white logo

CLI Reference

config alertemail setting

config alertemail setting

Configure alert email settings.

config alertemail setting
    Description: Configure alert email settings.
    set FDS-license-expiring-days {integer}
    set FDS-license-expiring-warning [enable|disable]
    set FDS-update-logs [enable|disable]
    set FIPS-CC-errors [enable|disable]
    set FSSO-disconnect-logs [enable|disable]
    set HA-logs [enable|disable]
    set IPS-logs [enable|disable]
    set IPsec-errors-logs [enable|disable]
    set PPP-errors-logs [enable|disable]
    set admin-login-logs [enable|disable]
    set alert-interval {integer}
    set amc-interface-bypass-mode [enable|disable]
    set antivirus-logs [enable|disable]
    set configuration-changes-logs [enable|disable]
    set critical-interval {integer}
    set debug-interval {integer}
    set email-interval {integer}
    set emergency-interval {integer}
    set error-interval {integer}
    set filter-mode [category|threshold]
    set firewall-authentication-failure-logs [enable|disable]
    set fortiguard-log-quota-warning [enable|disable]
    set information-interval {integer}
    set local-disk-usage {integer}
    set log-disk-usage-warning [enable|disable]
    set mailto1 {string}
    set mailto2 {string}
    set mailto3 {string}
    set notification-interval {integer}
    set severity [emergency|alert|...]
    set ssh-logs [enable|disable]
    set sslvpn-authentication-errors-logs [enable|disable]
    set username {string}
    set violation-traffic-logs [enable|disable]
    set warning-interval {integer}
    set webfilter-logs [enable|disable]
end

config alertemail setting

Parameter

Description

Type

Size

Default

FDS-license-expiring-days

Number of days to send alert email prior to FortiGuard license expiration.

integer

Minimum value: 1 Maximum value: 100

15

FDS-license-expiring-warning

Enable/disable FortiGuard license expiration warnings in alert email.

option

-

disable

Option

Description

enable

Enable FortiGuard license expiration warnings in alert email.

disable

Disable FortiGuard license expiration warnings in alert email.

FDS-update-logs

Enable/disable FortiGuard update logs in alert email.

option

-

disable

Option

Description

enable

Enable FortiGuard update logs in alert email.

disable

Disable FortiGuard update logs in alert email.

FIPS-CC-errors

Enable/disable FIPS and Common Criteria error logs in alert email.

option

-

disable

Option

Description

enable

Enable FIPS and Common Criteria error logs in alert email.

disable

Disable FIPS and Common Criteria error logs in alert email.

FSSO-disconnect-logs

Enable/disable logging of FSSO collector agent disconnect.

option

-

disable

Option

Description

enable

Enable logging of FSSO collector agent disconnect.

disable

Disable logging of FSSO collector agent disconnect.

HA-logs

Enable/disable HA logs in alert email.

option

-

disable

Option

Description

enable

Enable HA logs in alert email.

disable

Disable HA logs in alert email.

IPS-logs

Enable/disable IPS logs in alert email.

option

-

disable

Option

Description

enable

Enable IPS logs in alert email.

disable

Disable IPS logs in alert email.

IPsec-errors-logs

Enable/disable IPsec error logs in alert email.

option

-

disable

Option

Description

enable

Enable IPsec error logs in alert email.

disable

Disable IPsec error logs in alert email.

PPP-errors-logs

Enable/disable PPP error logs in alert email.

option

-

disable

Option

Description

enable

Enable PPP error logs in alert email.

disable

Disable PPP error logs in alert email.

admin-login-logs

Enable/disable administrator login/logout logs in alert email.

option

-

disable

Option

Description

enable

Enable administrator login/logout logs in alert email.

disable

Disable administrator login/logout logs in alert email.

alert-interval

Alert alert interval in minutes.

integer

Minimum value: 1 Maximum value: 99999

2

amc-interface-bypass-mode

Enable/disable Fortinet Advanced Mezzanine Card (AMC) interface bypass mode logs in alert email.

option

-

disable

Option

Description

enable

Enable Fortinet Advanced Mezzanine Card (AMC) interface bypass mode logs in alert email.

disable

Disable Fortinet Advanced Mezzanine Card (AMC) interface bypass mode logs in alert email.

antivirus-logs

Enable/disable antivirus logs in alert email.

option

-

disable

Option

Description

enable

Enable antivirus logs in alert email.

disable

Disable antivirus logs in alert email.

configuration-changes-logs

Enable/disable configuration change logs in alert email.

option

-

disable

Option

Description

enable

Enable configuration change logs in alert email.

disable

Disable configuration change logs in alert email.

critical-interval

Critical alert interval in minutes.

integer

Minimum value: 1 Maximum value: 99999

3

debug-interval

Debug alert interval in minutes.

integer

Minimum value: 1 Maximum value: 99999

60

email-interval

Interval between sending alert emails.

integer

Minimum value: 1 Maximum value: 99999

5

emergency-interval

Emergency alert interval in minutes.

integer

Minimum value: 1 Maximum value: 99999

1

error-interval

Error alert interval in minutes.

integer

Minimum value: 1 Maximum value: 99999

5

filter-mode

How to filter log messages that are sent to alert emails.

option

-

category

Option

Description

category

Filter based on category.

threshold

Filter based on severity.

firewall-authentication-failure-logs

Enable/disable firewall authentication failure logs in alert email.

option

-

disable

Option

Description

enable

Enable firewall authentication failure logs in alert email.

disable

Disable firewall authentication failure logs in alert email.

fortiguard-log-quota-warning

Enable/disable FortiCloud log quota warnings in alert email.

option

-

disable

Option

Description

enable

Enable FortiCloud log quota warnings in alert email.

disable

Disable FortiCloud log quota warnings in alert email.

information-interval

Information alert interval in minutes.

integer

Minimum value: 1 Maximum value: 99999

30

local-disk-usage

Disk usage percentage at which to send alert email.

integer

Minimum value: 1 Maximum value: 99

75

log-disk-usage-warning

Enable/disable disk usage warnings in alert email.

option

-

disable

Option

Description

enable

Enable disk usage warnings in alert email.

disable

Disable disk usage warnings in alert email.

mailto1

Email address to send alert email to (usually a system administrator) (max. 63 characters).

string

Maximum length: 63

mailto2

Optional second email address to send alert email to (max. 63 characters).

string

Maximum length: 63

mailto3

Optional third email address to send alert email to (max. 63 characters).

string

Maximum length: 63

notification-interval

Notification alert interval in minutes.

integer

Minimum value: 1 Maximum value: 99999

20

severity

Lowest severity level to log.

option

-

alert

Option

Description

emergency

Emergency level.

alert

Alert level.

critical

Critical level.

error

Error level.

warning

Warning level.

notification

Notification level.

information

Information level.

debug

Debug level.

ssh-logs

Enable/disable SSH logs in alert email.

option

-

disable

Option

Description

enable

Enable SSH logs in alert email.

disable

Disable SSH logs in alert email.

sslvpn-authentication-errors-logs

Enable/disable SSL-VPN authentication error logs in alert email.

option

-

disable

Option

Description

enable

Enable SSL-VPN authentication error logs in alert email.

disable

Disable SSL-VPN authentication error logs in alert email.

username

Name that appears in the From: field of alert emails (max. 63 characters).

string

Maximum length: 63

violation-traffic-logs

Enable/disable violation traffic logs in alert email.

option

-

disable

Option

Description

enable

Enable violation traffic logs in alert email.

disable

Disable violation traffic logs in alert email.

warning-interval

Warning alert interval in minutes.

integer

Minimum value: 1 Maximum value: 99999

10

webfilter-logs

Enable/disable web filter logs in alert email.

option

-

disable

Option

Description

enable

Enable web filter logs in alert email.

disable

Disable web filter logs in alert email.

config alertemail setting

config alertemail setting

Configure alert email settings.

config alertemail setting
    Description: Configure alert email settings.
    set FDS-license-expiring-days {integer}
    set FDS-license-expiring-warning [enable|disable]
    set FDS-update-logs [enable|disable]
    set FIPS-CC-errors [enable|disable]
    set FSSO-disconnect-logs [enable|disable]
    set HA-logs [enable|disable]
    set IPS-logs [enable|disable]
    set IPsec-errors-logs [enable|disable]
    set PPP-errors-logs [enable|disable]
    set admin-login-logs [enable|disable]
    set alert-interval {integer}
    set amc-interface-bypass-mode [enable|disable]
    set antivirus-logs [enable|disable]
    set configuration-changes-logs [enable|disable]
    set critical-interval {integer}
    set debug-interval {integer}
    set email-interval {integer}
    set emergency-interval {integer}
    set error-interval {integer}
    set filter-mode [category|threshold]
    set firewall-authentication-failure-logs [enable|disable]
    set fortiguard-log-quota-warning [enable|disable]
    set information-interval {integer}
    set local-disk-usage {integer}
    set log-disk-usage-warning [enable|disable]
    set mailto1 {string}
    set mailto2 {string}
    set mailto3 {string}
    set notification-interval {integer}
    set severity [emergency|alert|...]
    set ssh-logs [enable|disable]
    set sslvpn-authentication-errors-logs [enable|disable]
    set username {string}
    set violation-traffic-logs [enable|disable]
    set warning-interval {integer}
    set webfilter-logs [enable|disable]
end

config alertemail setting

Parameter

Description

Type

Size

Default

FDS-license-expiring-days

Number of days to send alert email prior to FortiGuard license expiration.

integer

Minimum value: 1 Maximum value: 100

15

FDS-license-expiring-warning

Enable/disable FortiGuard license expiration warnings in alert email.

option

-

disable

Option

Description

enable

Enable FortiGuard license expiration warnings in alert email.

disable

Disable FortiGuard license expiration warnings in alert email.

FDS-update-logs

Enable/disable FortiGuard update logs in alert email.

option

-

disable

Option

Description

enable

Enable FortiGuard update logs in alert email.

disable

Disable FortiGuard update logs in alert email.

FIPS-CC-errors

Enable/disable FIPS and Common Criteria error logs in alert email.

option

-

disable

Option

Description

enable

Enable FIPS and Common Criteria error logs in alert email.

disable

Disable FIPS and Common Criteria error logs in alert email.

FSSO-disconnect-logs

Enable/disable logging of FSSO collector agent disconnect.

option

-

disable

Option

Description

enable

Enable logging of FSSO collector agent disconnect.

disable

Disable logging of FSSO collector agent disconnect.

HA-logs

Enable/disable HA logs in alert email.

option

-

disable

Option

Description

enable

Enable HA logs in alert email.

disable

Disable HA logs in alert email.

IPS-logs

Enable/disable IPS logs in alert email.

option

-

disable

Option

Description

enable

Enable IPS logs in alert email.

disable

Disable IPS logs in alert email.

IPsec-errors-logs

Enable/disable IPsec error logs in alert email.

option

-

disable

Option

Description

enable

Enable IPsec error logs in alert email.

disable

Disable IPsec error logs in alert email.

PPP-errors-logs

Enable/disable PPP error logs in alert email.

option

-

disable

Option

Description

enable

Enable PPP error logs in alert email.

disable

Disable PPP error logs in alert email.

admin-login-logs

Enable/disable administrator login/logout logs in alert email.

option

-

disable

Option

Description

enable

Enable administrator login/logout logs in alert email.

disable

Disable administrator login/logout logs in alert email.

alert-interval

Alert alert interval in minutes.

integer

Minimum value: 1 Maximum value: 99999

2

amc-interface-bypass-mode

Enable/disable Fortinet Advanced Mezzanine Card (AMC) interface bypass mode logs in alert email.

option

-

disable

Option

Description

enable

Enable Fortinet Advanced Mezzanine Card (AMC) interface bypass mode logs in alert email.

disable

Disable Fortinet Advanced Mezzanine Card (AMC) interface bypass mode logs in alert email.

antivirus-logs

Enable/disable antivirus logs in alert email.

option

-

disable

Option

Description

enable

Enable antivirus logs in alert email.

disable

Disable antivirus logs in alert email.

configuration-changes-logs

Enable/disable configuration change logs in alert email.

option

-

disable

Option

Description

enable

Enable configuration change logs in alert email.

disable

Disable configuration change logs in alert email.

critical-interval

Critical alert interval in minutes.

integer

Minimum value: 1 Maximum value: 99999

3

debug-interval

Debug alert interval in minutes.

integer

Minimum value: 1 Maximum value: 99999

60

email-interval

Interval between sending alert emails.

integer

Minimum value: 1 Maximum value: 99999

5

emergency-interval

Emergency alert interval in minutes.

integer

Minimum value: 1 Maximum value: 99999

1

error-interval

Error alert interval in minutes.

integer

Minimum value: 1 Maximum value: 99999

5

filter-mode

How to filter log messages that are sent to alert emails.

option

-

category

Option

Description

category

Filter based on category.

threshold

Filter based on severity.

firewall-authentication-failure-logs

Enable/disable firewall authentication failure logs in alert email.

option

-

disable

Option

Description

enable

Enable firewall authentication failure logs in alert email.

disable

Disable firewall authentication failure logs in alert email.

fortiguard-log-quota-warning

Enable/disable FortiCloud log quota warnings in alert email.

option

-

disable

Option

Description

enable

Enable FortiCloud log quota warnings in alert email.

disable

Disable FortiCloud log quota warnings in alert email.

information-interval

Information alert interval in minutes.

integer

Minimum value: 1 Maximum value: 99999

30

local-disk-usage

Disk usage percentage at which to send alert email.

integer

Minimum value: 1 Maximum value: 99

75

log-disk-usage-warning

Enable/disable disk usage warnings in alert email.

option

-

disable

Option

Description

enable

Enable disk usage warnings in alert email.

disable

Disable disk usage warnings in alert email.

mailto1

Email address to send alert email to (usually a system administrator) (max. 63 characters).

string

Maximum length: 63

mailto2

Optional second email address to send alert email to (max. 63 characters).

string

Maximum length: 63

mailto3

Optional third email address to send alert email to (max. 63 characters).

string

Maximum length: 63

notification-interval

Notification alert interval in minutes.

integer

Minimum value: 1 Maximum value: 99999

20

severity

Lowest severity level to log.

option

-

alert

Option

Description

emergency

Emergency level.

alert

Alert level.

critical

Critical level.

error

Error level.

warning

Warning level.

notification

Notification level.

information

Information level.

debug

Debug level.

ssh-logs

Enable/disable SSH logs in alert email.

option

-

disable

Option

Description

enable

Enable SSH logs in alert email.

disable

Disable SSH logs in alert email.

sslvpn-authentication-errors-logs

Enable/disable SSL-VPN authentication error logs in alert email.

option

-

disable

Option

Description

enable

Enable SSL-VPN authentication error logs in alert email.

disable

Disable SSL-VPN authentication error logs in alert email.

username

Name that appears in the From: field of alert emails (max. 63 characters).

string

Maximum length: 63

violation-traffic-logs

Enable/disable violation traffic logs in alert email.

option

-

disable

Option

Description

enable

Enable violation traffic logs in alert email.

disable

Disable violation traffic logs in alert email.

warning-interval

Warning alert interval in minutes.

integer

Minimum value: 1 Maximum value: 99999

10

webfilter-logs

Enable/disable web filter logs in alert email.

option

-

disable

Option

Description

enable

Enable web filter logs in alert email.

disable

Disable web filter logs in alert email.