DeployJob - addOneTimeScheduleWithEMailNotification

DeployJob - addOneTimeScheduleWithEMailNotification

Description :

This command adds a one-time schedule to a Deploy Job. If this Deploy Job already had a schedule, this command replaces the old schedule with the schedule you are adding now. If approval is enabled for the job type use the other command which takes in approval ID as an additional input.

Depending on the resulting status of the job run, this command can issue an email notification.

The argument jobKey provides a handle to the job being modified. To find the jobKey, use the 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 argument recipient is the email receiver, and 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 values representing 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 : DBKey

Command Input :

Variable Name

Variable Type



Handle to the job.



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



Receiver of the email.



Sum of all statuses for which you want to issue notification. For more detailed information, see the description above.


The following example shows how to add a schedule for a single Deploy Job run on the 1st of January 2005 day at 11:35 PM. An email will be generated on success, failure, or cancel.




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

JOB_KEY=`blcli DeployJob  [getDBKeyByGroupAndName|DeployJob - getDBKeyByGroupAndName] /deploys deployconfig` 

JOB_KEY=`blcli DeployJob  [addOneTimeScheduleWithEMailNotification|DeployJob - addOneTimeScheduleWithEMailNotification] $JOB_KEY "$DATE_STRING" $RECIPIENT $NOTIFICATION_STATUS` 

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