Alerter CLI Commands

This section list Alerter CLI commands.

The Alerter subsystem transmits messages that have been queued by other components - correlation alerts that have been queued by the Anomaly Detection subsystem, or run-time alerts that have been generated by security policies, for example. The Alerter subsystem can be configured to send messages to both SMTP and SNMP servers. Alerts can also be sent to syslog or custom alerting classes, but no special configuration is required for those two options, beyond starting the Alerter. There are four types of Alerter commands. Use the links in the lists, or browse the commands, which are listed in alphabetical sequence following the lists.

Alerter Start-up and Polling Commands

SMTP Configuration Commands

SNMP Configuration Commands

restart alerter

Restarts the Alerter. You can perform the same function using the store alerter state operational command to stop and then start the alerter:

store alerter state operational off

store alerter state operational on

Syntax

restart alerter

stop alerter

Stops the Alerter.

You can perform the same function using the store alerter state operational command:

store alerter state operational off

Syntax

stop alerter

store alerter poll

Starts (on) or stops (off) the Alerter. The default state at installation time is off. You can also use the restart alerter or stop alerter commands to restart or stop the Alerter subsystem.

Syntax

store alerter state operational <on | off>

Show Command

show alerter state operational

store alerter smtp authentication password

Sets the alerter SMTP authentication password to the specified value. There is no corresponding show command.

Syntax

store alerter smtp authentication <value>

store alerter smtp authentication type

Sets the authentication type required by the SMTP server to the one of the following values:

none: Send without authentication.

auth: Username/password authentication. When used, set the user account and password using the following commands:

store alerter smtp authentication username

store alerter smtp authentication password

Syntax

store alerter smtp authentication type <none | auth>

Show Command

show alerter smtp authentication type

store syslog-trap

Usage: store syslog-trap ON | OFF