Defining notification content

The following sections describe the options on the Content tab of the Edit Notification dialog box.

Email actions

This section describes the options for both the AWS Email Host and the Email actions.

Common email fields applies to both the AWS Email Host and the Email actions.
SMTP fields applies to the Email action only.
Amazon SES fields applies to the AWS Email Host action only.

Common email fields

The fields in the following table are present in all email actions.

Field	Description
Body Content Type	The email message format, HTML or plain text.
Message (Subject) Format	The Subject line of the email message. The default value includes content variables. Best practice: Include the event severity variable (`${evt/severity}`) in this field.
Body Format	The body of the email message. The default value includes content variables. Best practice: To facilitate debugging, include variables for the name of the notification (`${notification/name}`) and the name of the trigger that matched the event (`${trigger/name}`) in this field.
Clear Message (Subject) Format	The Subject line of the clearing email message. The default value includes content variables. Best practice: Include the clearing event severity variable (`${clearEvt/severity}`) in this field.
Body Format	The body of the clearing email message. The default value includes content variables. Best practice: To facilitate debugging, include variables for the name of the notification (`${notification/name}`) and the name of the trigger that matched the clearing event (`${trigger/name}`) in this field.
Skip fails in TALES evaluation ?	Mark this check box to ensure that the email message is sent even if the TALES expressions included in the message do not resolve.
From Address for Emails	The email address to use in the From line of the email message.

SMTP fields

The fields in the following table are present only for the Email action.

Note

When the SMTP fields are empty, Zenoss Cloud uses its default SMTP server to send email. Provide values only to use an alternate SMTP server.

Field	Description
SMTP Host	The hostname or IP of an SMTP server host to use instead of the default Zenoss Cloud SMTP host.
SMTP Port (usually 25)	The port on which an SMTP server is listening for email to send.
Use TLS?	Mark this check box to encrypt emails.
SMTP Username (blank for none)	The username of an account on the non-default SMTP server.
SMTP Password (blank for none)	The password of the account on the non-default SMTP server.

Amazon SES fields

The fields in the following table are present only for the AWS Email Host action.

Note

Both the sender and the recipients of emails sent through this action must be verified SES users in the target AWS region.

Field	Description
AWS Account Name	The name of an authorized Amazon SES account.
AWS Region	The AWS region to use.
AWS Access Key	The ID of the authorized account's AWS access key.
AWS Secret Key	The secret key of the authorized account's AWS access key.

Command actions

Tip

Use the Command action sparingly. Frequent use can degrade the performance of the event processing service.

Field	Description
Command Timeout (seconds)	The amount of time to wait for the command to return an exit value.
Command	The shell command to run on a remote host, through an SSH connection. This field supports content variables. The connection information and the name of the target host must be present in the properties of the triggering event, and the host must accept incoming SSH connections.
Clear Command	The shell command to run on a remote host, through an SSH connection, when a clearing event is received. This field supports content variables. The connection information and the name of the target host must be present in the properties of the clearing event, and the host must accept incoming SSH connections.
Environment variables	Environment variables to pass to the shell that performs the command, if any. This field supports content variables.

Page actions

Field Description

Message (Subject) Format

The Subject line of the message. The default value includes content variables.

Best practice: Include the event severity variable (${evt/severity}) in this field.

Clear Message (Subject) Format

The Subject line of the clearing email message. The default value includes content variables.

Best practice: Include the clearing event severity variable (${clearEvt/severity}) in this field.

Syslog actions

Use the Syslog action to forward event information to a receiving syslog system.

Field	Description
Syslog Host	The hostname or IP address of a `syslog` server host in your environment.
Syslog Port (usually 514)	The port on which the `syslog` server is listening.
Protocol	The network protocol to use, UDP or TCP.
Syslog Facility	The `syslog` facility code to include in the message.

SNMP Trap actions

Use these actions to forward event information to an SNMP network management station (NMS). The OIDs that are used in the SNMP traps that Collection Zone sends are defined in the Zenoss MIB.

SNMP Trap (v1/v2c) and SNMP Trap w/Impact

When the action is SNMP Trap w/Impact, additional OIDs are included.

Field	Description
SNMP Trap Destination	The hostname or IP address of an SNMP NMS in your environment.
SNMP Community	The SNMP trap community string to include.
SNMP Version	The SNMP version to use. SNMPv1 (`v1`) and SNMPv2 ( `v2c`, the default) are supported.
SNMP Port	The port on which the NMS in your environment is listening for traps. The default is 162.

SNMP Trap (v3)

Field	Description
SNMP Trap Destination	The hostname or IP address of an SNMP NMS in your environment.
SNMP Port (usually 162)	The port on which the NMS in your environment is listening for traps. The default is 162.
Security Engine ID	The identifier of the authoritative SNMP engine.
Context Engine ID	The identifier of the entity hosting the information.
Context Name	The name of a specific context.
Authentication Protocol	The authentication protocol to use. Valid values are `none`, `SHA1`, and `MD5`.
Security Name	The name of the user when generating notifications.
Security Passphrase	The security passphrase, if any.
Privacy Protocol	The privacy protocol to use. Valid values are `none` and `AES128`.
Privacy Passphrase	The privacy passphrase, if any.

WinCommand actions

Field

Description

Windows CMD Command

The standard CMD or PowerShell command to run on a remote host. This field supports content variables.

The connection information and the name of the target host must be present in the properties of the triggering event, and the host must accept incoming connections.

Clear Windows CMD Command

The standard CMD or PowerShell command to run on a remote host when a clearing event is received. This field supports content variables.

The connection information and the name of the target host must be present in the properties of the clearing event, and the host must accept incoming connections.