sendEventNotification

Use the sendEventNotification command to create and send an event notification using the Notifier Service. How the notification is handled is determined by the currently active subscriptions.

The system automatically generates alerts when one of the following happens:

  • An SLA enforcement policy issues a failure, warning, or compliance alert

  • A condition definition causes the Transaction Monitoring Service to issue a condition alert.

  • A system service throws an exception, causing the system to issue a system alert.

In addition to these cases, an administrator might also want to issue an alert to notify users that the system needs to come down for maintenance or upgrade, or to let users know that some administrative action will regenerate the data used to create reports. The sendEventNotification command is provided to enable this kind of notification. (It would also be possible to send an event notification using the sendToNotifier command, but it would be a lot more work.)

Command Syntax

btmcli sendEventNotification -source source -n name
                   -topic topic [-subtopic subtopic] 
                   -severity SEVERE | WARNING | INFO | CONFIG | FAILURE | SUCCESS 
                   -message message
                   [-attributes name1:value1 [[name2:value2] ...]] 
                   -s sphereUrl -l username:password
Name Long Name Description
-source -- Indicates where the notification was generated. Possible sources include ASLM, ExM, and System. You can specify an arbitrary value.
-n -name The name associated with the event notification. This should provide information as to what the event is about.
-topic -- The event notification's topic. Used to help categorize similar event notifications.
-subtopic -- The event notification's subtopic. Used to help categorize event notifications.
-- -severity Indicates the importance of the situation that caused the notification.
-message -- A textual description of what the event notification means and whether any user action is required.
-- -attributes A list of name:value pairs that will be attached to the event notification and made available to anyone who receives the notification. These attributes typically reference objects related to the notification.
-s -sphereUrl The URL of the sphere.

http://hostname:port/btmcentral/sphere/

This flag is not required if you have set the AP_SPHERE_URL environment variable for your sphere.

-l -userLogin The username and password associated with the sphere, in the format: username:password. This set of credentials must belong to a user in the btmadmin role.

See Security Options in Accessing CLI Commands for information on furnishing login credentials.

You can encrypt passwords using the encryptPassword command.


Example

The following example shows the sendEventNotification command used to notify current subscribers that the system is about to be backed up.

btmcli sendEventNotification -source System -n BackupWarning 
               -topic SysNotifications -severity WARNING
               -message "System backup in 10 minutes. Please save your work."
               -s http://localhost:8080/btmcentral/sphere/
               -l admin:abracadabra