Job - addWeeklyScheduleWithEMailNotification
Job - addWeeklyScheduleWithEMailNotification
Description :
This command adds a weekly schedule to a job and, depending on the resulting status of the job run, issues an email notification. This command is not supported if the approval is enabled for the job type.
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 weekly schedule to be added to the job definition. It must be in the format YYYY-MM-DD HH:MM:SS. Use the daysOfWeek argument to specify a sum representing the days when the job should execute. Each day of the week has a value, as shown below:
- SUNDAY=1
- MONDAY=2
- TUESDAY=4
- WEDNESDAY=8
- THURSDAY=16
- FRIDAY=32
- SATURDAY=64
Add values representing the days when you want the job to run. For example, if you want the job to run on Monday, Wednesday, and Friday, then daysOfWeek=42. Use the frequency argument to specify an interval in weeks for the job to run (for example, 2 means the job runs every other week).
The recipient argument identifies the receiver of the email that this command generates. 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 | Weekly schedule to be added. The date string must be in the format YYYY-MM-DD HH:MM:SS. |
daysOfWeek | Integer | Days of the week when the job should execute. See above for a more detailed description. |
frequency | Integer | Interval in weeks when the job should run. |
recipient | String | Receiver of the email notification. |
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 weekly job runs to a job. In the example, the job runs every three weeks at 11:35 PM on Sunday, Wednesday, and Friday. An email is sent on success, failure, or cancel.
Script
RECIPIENT="datacenteradmin@anundisclosedcompany.com"
NOTIFICATION_STATUS=14
DATE_STRING="2005-01-01 23:35:00"
DAYS_OF_WEEK=41
FREQUENCY=3
JOB_KEY=`blcli SnapshotJob getDBKeyByGroupAndName /snapshots snapconfig`
JOB_KEY=`blcli Job addWeeklyScheduleWithEMailNotification $JOB_KEY "$DATE_STRING" $DAYS_OF_WEEK $FREQUENCY $RECIPIENT $NOTIFICATION_STATUS`