Job - addOneTimeScheduleWithEMailNotificationAndWithApproval

Job - addOneTimeScheduleWithEMailNotificationAndWithApproval

Description :

This command adds a one-time schedule to a job. The job waits until the approval is received and then runs. Depending on the resulting status of the job run, the command issues an email notification. If the approval does not come on time, the schedule is marked as expired and the change ticket is closed by the approval system.

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 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

One-time schedule to be added. The date string must be in the format YYYY-MM-DD HH:MM:SS.

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.

approvalId

Integer

Approval ID to be attached to the job.

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. Email will be sent on success, failure, or cancel.

Script

RECIPIENT="datacenteradmin@anundisclosedcompany.com" 

NOTIFICATION_STATUS=14 

DATE_STRING="2005-01-01 23:35:00" 

JOB_KEY=`blcli SnapshotJob getDBKeyByGroupAndName /snapshots snapconfig` 

JOB_APPROVAL_ID=`blcli Job createApproval 2 2 "My change" 2 3 "" ""` 

JOB_KEY=`blcli Job addOneTimeScheduleWithEMailNotificationAndWithApproval $JOB_KEY "$DATE_STRING" $RECIPIENT $NOTIFICATION_STATUS $JOB_APPROVAL_ID` 

Was this page helpful? Yes No Submitting... Thank you

Comments