Job - addOneTimeScheduleWithSNMPNotification
Job - addOneTimeScheduleWithSNMPNotification
Description :
This command adds a one-time schedule to a job and, depending on the resulting status of the job run, issues an SNMP notification. If approval is enabled for the job type, use the addOneTimeScheduleWithSNMPNotificationAndWithApproval command instead.
The argument jobKey is a handle to the job being modified. To find the jobKey for a specific job type, use the SnapshotJob getDBKeyByGroupAndName command.
The dateString argument defines a one-time schedule to be added. It must be in the format YYYY-MM-DD HH:MM:SS.
The recipient argument identifies the SNMP listener. The statusType argument determines the statuses for which you want to issue a notification. The possible statuses each have a value as follows:
- Success=2
- Failure=4
- Cancel=8
For statusType, add the statuses for which you want to issue notifications. For example, if you want to issue notifications when the job status is Failure or Cancel, then statusType=12.
Return type : java.lang.Object
Command Input :
Variable Name | Variable Type | Description |
|---|---|---|
jobKey | com.bladelogic.om.infra.model.base.keys.SJobKey | Handle to the job. |
dateString | String | One-time schedule to be added. The date string must be in the format YYYY-MM-DD HH:MM:SS. |
recipient | String | SNMP listener. |
statusType | Integer | Sum of all statuses for which you want to issue notifications. See above for a more complete description. |
Example
The following example shows how to add a schedule to a job for a single run on the 1st of January 2005 at 11:35 PM. An SNMP trap will be generated on success, failure, or cancel.
Script
RECIPIENT="snmplistener.anundisclosedcompany.com"
NOTIFICATION_STATUS=14
DATE_STRING="2005-01-01 23:35:00"
DAY_OF_MONTH=25
JOB_KEY=`blcli SnapshotJob getDBKeyByGroupAndName /snapshots snapconfig`
JOB_KEY=`blcli Job addOneTimeScheduleWithSNMPNotification $JOB_KEY "$DATE_STRING" $RECIPIENT $NOTIFICATION_STATUS`