Fortinet black logo

CLI Reference

config system alert

config system alert

This command can be used to configure the alert (alert-name) that is referenced in config system alert-policy. However, automation stitches CLI commands are recommended to be used only for debug purposes. To configure the stitches through GUI, refer to the FortiADC Handbook on Automation.

There are two types of alerts:

  • Event alert — These alerts are system predefined, corresponding to the automation trigger types Security Events, HA Failover, and System Events.

  • Metric alert — These alerts are user-defined, corresponding to the automation trigger types for SLB Metrics, System Metrics, and Interface Metrics.

Before you begin:

You must have read-write permission for Security Fabric settings.

Event alert

You can use this command to create an event alert. Automation alert events are predefined, corresponding to the Security Events, HA Failover, and System Events automation triggers.

It is not recommended to configure automation alert events through the CLI.

Automation alert events are system predefined. However, the CLI does not restrict users from defining their own events which could result in invalid configurations or unexpected behavior.

For details on how to configure automation alert events in the GUI, see the FortiADC Handbook on Configure Automation Triggers.

Syntax

config system alert

edit <alert_name>

set alert-source-type event

set priority {high|low|middle}

set event <alert_event_name>

next

end

The <alert_event_name> is defined in config system alert-event.

config system alert-event

edit <alert_event_name>

set alias <string>

set comments <string>

next

end

Metric alert

You can use the following command to create a metric alert. Automation alert metrics are user-defined, corresponding to the SLB Metrics, System Metrics, and Interface Metrics automation triggers.

Syntax

config system alert

edit <alert_name>

set alert-source-type metric

set metric-object-type slb-virtual-server

set metric-object-instance <virtual-server-name>

set duration 600

config alert-metric-expr-member

edit <alert-metric-expr-member_name>

set metric <metric_name>

set metric-comparator {le | eq | ge}

set value <int>

next

end

next

end

Note: Only one metric member is supported.

The <metric_name> is defined in config system alert-metric.

config system alert-metric

edit <metric_name>

set type {if | slb |sys}

set alias <string>

set comments <string>

next

end

Related topics:

config system alert

This command can be used to configure the alert (alert-name) that is referenced in config system alert-policy. However, automation stitches CLI commands are recommended to be used only for debug purposes. To configure the stitches through GUI, refer to the FortiADC Handbook on Automation.

There are two types of alerts:

  • Event alert — These alerts are system predefined, corresponding to the automation trigger types Security Events, HA Failover, and System Events.

  • Metric alert — These alerts are user-defined, corresponding to the automation trigger types for SLB Metrics, System Metrics, and Interface Metrics.

Before you begin:

You must have read-write permission for Security Fabric settings.

Event alert

You can use this command to create an event alert. Automation alert events are predefined, corresponding to the Security Events, HA Failover, and System Events automation triggers.

It is not recommended to configure automation alert events through the CLI.

Automation alert events are system predefined. However, the CLI does not restrict users from defining their own events which could result in invalid configurations or unexpected behavior.

For details on how to configure automation alert events in the GUI, see the FortiADC Handbook on Configure Automation Triggers.

Syntax

config system alert

edit <alert_name>

set alert-source-type event

set priority {high|low|middle}

set event <alert_event_name>

next

end

The <alert_event_name> is defined in config system alert-event.

config system alert-event

edit <alert_event_name>

set alias <string>

set comments <string>

next

end

Metric alert

You can use the following command to create a metric alert. Automation alert metrics are user-defined, corresponding to the SLB Metrics, System Metrics, and Interface Metrics automation triggers.

Syntax

config system alert

edit <alert_name>

set alert-source-type metric

set metric-object-type slb-virtual-server

set metric-object-instance <virtual-server-name>

set duration 600

config alert-metric-expr-member

edit <alert-metric-expr-member_name>

set metric <metric_name>

set metric-comparator {le | eq | ge}

set value <int>

next

end

next

end

Note: Only one metric member is supported.

The <metric_name> is defined in config system alert-metric.

config system alert-metric

edit <metric_name>

set type {if | slb |sys}

set alias <string>

set comments <string>

next

end

Related topics: