Name space : Job

The Job name space contains commands for modifying jobs created in the individual job name spaces (for example, SnapshotJob, , AuditJob, , or DeployJob, ). Using these commands, you can modify includes, add and remove schedules, and add and remove servers and groups.

When working with the Jobs name space, be aware of the following:

• Most job editing commands use a jobKey as a handle to the job to be edited.
• When a job is edited, the value of the jobKey changes. Its value should be replaced with the value returned by the editing command.

Command Name : accept

Name space : Job

Command Type : API

Release command : false

Description :

Return type : void

Command Input :

Command Name : accept

Name space : Job

Command Type : API

Release command : false

Description :

Return type : void

Command Input :

Command Name : add

Name space : Job

Command Type : API

Release command : false

Description :

Return type : Boolean

Command Input :

Command Name : add

Name space : Job

Command Type : API

Release command : false

Description :

Adds a component to the job.

Return type : Boolean

Command Input :

Command Name : add

Name space : Job

Command Type : API

Release command : false

Description :

Adds a component group to this job.

Return type : Boolean

Command Input :

Command Name : add

Name space : Job

Command Type : API

Release command : false

Description :

Return type : Boolean

Command Input :

Command Name : add

Name space : Job

Command Type : API

Release command : false

Description :

Return type : Boolean

Command Input :

Command Name : add

Name space : Job

Command Type : API

Release command : false

Description :

Adds a server group to this job.

Return type : Boolean

Command Input :

Command Name : add

Name space : Job

Command Type : API

Release command : false

Description :

Return type : Boolean

Command Input :

Command Name : add

Name space : Job

Command Type : API

Release command : false

Description :

Adds a master device to the job.

Return type : Boolean

Command Input :

Command Name : add

Name space : Job

Command Type : API

Release command : false

Description :

Adds a master snapshot to the job.

Return type : Boolean

Command Input :

Command Name : add

Name space : Job

Command Type : API

Release command : false

Description :

Return type : Boolean

Command Input :

Command Name : add

Name space : Job

Command Type : API

Release command : false

Description :

Return type : Boolean

Command Input :

Command Name : add

Name space : Job

Command Type : API

Release command : false

Description :

Return type : Boolean

Command Input :

Command Name : add

Name space : Job

Command Type : API

Release command : false

Description :

Adds a template to a job.

Return type : Boolean

Command Input :

Command Name : add

Name space : Job

Command Type : API

Release command : false

Description :

Adds a template group to the job.

Return type : Boolean

Command Input :

Command Name : add

Name space : Job

Command Type : API

Release command : false

Description :

Return type : Boolean

Command Input :

Command Name : addApprovalRequestToSchedule

Name space : Job

Command Type : Load

Release command : false

Description :

Adds approval to a given schedule

Return type : void

Command Input :

Invoked commands in order :

Command Name : addApprovalRequestToSchedule-api

Name space : Job

Command Type : API

Release command : false

Description :

Adds approval to a given schedule

Return type : void

Command Input :

Command Name : addDailySchedule

Do not modify, published by technical writer

Name space : Job

Command Type : Complex

Release command : true

Author :

Description :

This command adds a daily schedule to a job. This command is not supported when 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 daily schedule to be added to the job definition. It must be in the format YYYY-MM-DD HH:MM:SS.

This command does not send a job notification. To add a schedule that includes notifications, see the Job addDailyScheduleWithSNMPNotification or Job addDailyScheduleWithEMailNotification commands.

Return type : java.lang.Object

Command Input :

Example

The following example shows how to add a daily run at 11:35 PM to a job:

Script

Invoked commands in order :

Command Name : addDailyScheduleWithEMailNotification

Do not modify, published by technical writer

Name space : Job

Command Type : Complex

Release command : true

Author :

Description :

This command adds a daily 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 daily 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 :

Example

The following example shows how to add a daily run at 11:35 PM to a job. Email will be sent on success, failure, or cancel.

Script

Invoked commands in order :

Command Name : addDailyScheduleWithEMailNotificationAndPriority

Do not modify, published by technical writer

Name space : Job

Command Type : Complex

Release command : true

Author :

Description :

This command adds a daily schedule with specified priority to a job and, depending on the resulting status of the job run, issues an email notification. This command is not supported if 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 daily 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.

Set priorityString to one of the following priorities:

• CRITICAL
• HIGH
• NORMAL
• LOW
• LOWEST

Return type : java.lang.Object

Command Input :

Example

The following example shows how to add a daily run at 11:35 PM to a job. Email will be sent on success, failure, or cancel.

Script

Invoked commands in order :

Command Name : addDailyScheduleWithPriority

Do not modify, published by technical writer

Name space : Job

Command Type : Complex

Release command : true

Author :

Description :

This command adds a daily schedule to a job. This command is not supported when 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 daily schedule to be added to the job definition. It must be in the format YYYY-MM-DD HH:MM:SS. The priorityString argument sets the priority of the schedule.

Set priorityString to one of the following priorities:

• CRITICAL
• HIGH
• NORMAL
• LOW
• LOWEST

This command does not send a job notification. To add a schedule that includes notifications, see the Job addDailyScheduleWithSNMPNotificationAndPriority or Job addDailyScheduleWithEMailNotificationAndPriority commands.

Return type : java.lang.Object

Command Input :

Example

The following example shows how to add a HIGH priority daily run at 11:35 PM to a job:

Script

Invoked commands in order :

Command Name : addDailyScheduleWithSNMPNotification

Do not modify, published by technical writer

Name space : Job

Command Type : Complex

Release command : true

Author :

Description :

This command adds a daily schedule to a job and, depending on the resulting status of the job run, issues an SNMP notification.This command is not supported if 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 daily 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 :

Example

The following example shows how to add a daily run at 11:35 PM to a job. An SNMP trap will be generated on success, failure, or cancel.

Script

Invoked commands in order :

Command Name : addDailyScheduleWithSNMPNotificationAndPriority

Do not modify, published by technical writer

Name space : Job

Command Type : Complex

Release command : true

Author :

Description :

This command adds a daily schedule with specified priority to a job and, depending on the resulting status of the job run, issues an SNMP notification.This command is not supported if 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 daily 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.

Set priorityString to one of the following priorities:

• CRITICAL
• HIGH
• NORMAL
• LOW
• LOWEST

Return type : java.lang.Object

Command Input :

Example

The following example shows how to add a daily run at 11:35 PM to a job with HIGH Priority. An SNMP trap will be generated on success, failure, or cancel.

Script

Invoked commands in order :

Command Name : addDailyScheduleWithTimeZone

Do not modify, published by technical writer

Name space : Job

Command Type : Complex

Release command : true

Author :

Description :

This command adds a daily schedule to a job in a time zone. This command is not supported when 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 daily schedule to be added to the job definition. It must be in the format YYYY-MM-DD HH:MM:SS.

For a list of valid Time Zone ids, use the Schedule listValidTimeZones command.

Return type : java.lang.Object

Command Input :

Example

The following example shows how to add a daily run at 11:35 PM to a job in the UTC time zone:

Script

Invoked commands in order :

Command Name : addDepotObjectKey

Name space : Job

Command Type : API

Release command : false

Description :

Return type : Boolean

Command Input :

Command Name : addDepotObjectKey

Name space : Job

Command Type : API

Release command : false

Description :

Return type : Boolean

Command Input :

Command Name : addDepotObjectKeys

Name space : Job

Command Type : API

Release command : false

Description :

Return type : Boolean

Command Input :

Command Name : addDepotSoftwarePart

Name space : Job

Command Type : API

Release command : false

Description :

Return type : void

Command Input :

Command Name : addDepotSoftwarePartAll

Name space : Job

Command Type : API

Release command : false

Description :

Return type : void

Command Input :

Command Name : addDeviceList

Name space : Job

Command Type : API

Release command : false

Description :

Adds the list of devices to the job. The list should contain Integer items.

Return type : void

Command Input :

Command Name : addIntervalSchedule

Do not modify, published by technical writer

Name space : Job

Command Type : Complex

Release command : true

Author :

Description :

This command adds an interval schedule to a job. 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.

This command takes 5 arguments: DBKey of a job, a date/time formatted string indicating the start time of the first occurrence of the job, the interval in days, in hours and in minutes.

This command does not send a job notification. To add a schedule that includes notifications, see the Job addIntervalScheduleWithSNMPNotification or Job addIntervalScheduleWithEMailNotification commands.

Return type : java.lang.Object

Command Input :

Example

The following example shows how to add an interval schedule every 1 day 10 hours and 12 minutes to a job, starting at 2005-01-01 23:35:00:

Script

Invoked commands in order :

Command Name : addIntervalScheduleWithEMailNotification

Do not modify, published by technical writer

Name space : Job

Command Type : Complex

Release command : true

Author :

Description :

This command adds an interval 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 start time for the schedule to be added. It must be in the format YYYY-MM-DD HH:MM:SS.

The days, hours, and mins arguments let you specify the interval in days, in hours and in minutes.

The recipient argument identifies the receiver of the email that this command generates. The statusType argument indicates the statuses for which you want to issue a notification. The possible statuses have the following values:

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

Example

The following example shows how to add an interval schedule to a job, starting at 11:35 PM. Email will be sent on success, failure, or cancel.

Script

Invoked commands in order :

Command Name : addIntervalScheduleWithSNMPNotification

Do not modify, published by technical writer

Name space : Job

Command Type : Complex

Release command : true

Author :

Description :

This command adds an interval schedule to a job and, depending on the resulting status of the job run, issues an SNMP notification. This command is not supported if 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 start time for the schedule to be added. It must be in the format YYYY-MM-DD HH:MM:SS.

The days, hours, and mins arguments let you specify the interval in days, in hours and in minutes.

The recipient argument identifies the SNMP listener. The statusType argument determines the statuses for which you want to issue a notification. The possible statuses have the following values:

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

Example

The following example shows how to add an interval schedule to a job, starting at 11:35 PM. An SNMP trap will be generated on success, failure, or cancel.

Script

Invoked commands in order :

Command Name : addIntervalScheduleWithTimeZone

Do not modify, published by technical writer

Name space : Job

Command Type : Complex

Release command : true

Author :

Description :

This command adds an interval schedule in a time zone to a job. This command is not supported when 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.

This command takes 6 arguments: DBKey of a job, a date/time formatted string indicating the start time of the first occurrence of the job, the interval in days, in hours and in minutes and time zone.

For a list of valid Time Zone ids, use the Schedule listValidTimeZones command.

Return type : java.lang.Object

Command Input :

Example

The following example shows how to add an interval schedule every 1 day 10 hours and 12 minutes to a job with time zone, starting at 2005-01-01 23:35:00:

Script

Invoked commands in order :

Command Name : addMonthlySchedule

Do not modify, published by technical writer

Name space : Job

Command Type : Complex

Release command : true

Author :

Description :

This command adds a monthly schedule to a job. 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 monthly schedule to be added to the job definition. It must be in the format YYYY-MM-DD HH:MM:SS. Use the dayOfMonth argument to specify the day when the job executes.

This command does not send a job notification. To add a schedule that includes notifications, see the Job addMonthlyScheduleWithSNMPNotification or Job addMonthlyScheduleWithEMailNotification commands.

Return type : java.lang.Object

Command Input :

Example

The following example shows how to add a monthly run to a job. The job runs at 11:35 PM on the 25th day of the month.

Script

Invoked commands in order :

Command Name : addMonthlySchedule

Do not modify, published by technical writer

Name space : Job

Command Type : Complex

Release command : true

Author :

Description :

This command adds a monthly schedule to a job with support for all schedule choices (specific day of a particular week of every month, particular day of every month or last day of every month). 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.

There are three types of monthly schedules that are supported. The command requires specifying one of the types listed below to add appropriate schedule to the job.

• Specific day of every month=0
• Specific day of a week of every month=1
• Last day of every month=2

The dateString argument defines a monthly schedule to be added to the job definition. It must be in the format YYYY-MM-DD HH:MM:SS.

Use the dayOfWeekOrMonth argument to specify the day when the job executes. For last day of month schedule (scheduleType=2) this argument gets ignored and you may specify -1 as its value. For specific day of month schedule (scheduleType=0), this specifies actual calendar day (1-31) and for specific day of a week schedule (scheduleType=1) it provides the actual day of the week based on the following scheme.

• SUNDAY=1
• MONDAY=2
• TUESDAY=4
• WEDNESDAY=8
• THURSDAY=16
• FRIDAY=32
• SATURDAY=64

Use the weekOfMonth argument for specific day of a week schedule (scheduleType=1), to select the week in which the job will execute. Set value to -1 to execute the job in last week of every month. Please note any value entered gets ignored for all other type of schedules (scheduleType=0 or scheduleType=2).

This command does not send a job notification. To add a schedule that includes notifications, see the Job addMonthlyScheduleWithSNMPNotification or Job addMonthlyScheduleWithEMailNotification commands.

Return type : java.lang.Object

Command Input :

Example

The following example shows how to add a monthly run to a job. The job runs at 11:35 PM on the second Tuesday of every month.

Script

Invoked commands in order :

Command Name : addMonthlyScheduleWithEMailNotification

Do not modify, published by technical writer

Name space : Job

Command Type : Complex

Release command : true

Author :

Description :

This command adds a monthly schedule to a job and, depending on the resulting status of the job run, issues an email notification. Monthly schedule with email notification is not supported if 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 monthly schedule to be added. It must be in the format YYYY-MM-DD HH:MM:SS. Use the DayOfMonth argument to specify the day when the job executes.

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 :

Example

The following example shows how to add a monthly run to a job. The job runs at 11:35 PM on the 25th day of the month. Email will be sent on success, failure, or cancel.

Script

Invoked commands in order :

Command Name : addMonthlyScheduleWithEMailNotification

Do not modify, published by technical writer

Name space : Job

Command Type : Complex

Release command : true

Author :

Description :

This command adds a monthly schedule to a job with support for all schedule choices (specific day of a particular week of every month, particular day of every month or last day of every month) and, depending on the resulting status of the job run, issues an email notification. Monthly schedule with email notification is not supported if 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.

There are three types of monthly schedules that are supported. The command requires specifying one of the types listed below to add appropriate schedule to the job.

• Specific day of every month=0
• Specific day of a week of every month=1
• Last day of every month=2

The dateString argument defines a monthly schedule to be added to the job definition. It must be in the format YYYY-MM-DD HH:MM:SS.

Use the dayOfWeekOrMonth argument to specify the day when the job executes. For last day of month schedule (scheduleType=2) this argument gets ignored and you may specify -1 as its value. For specific day of month schedule (scheduleType=0), this specifies actual calendar day (1-31) and for specific day of a week schedule (scheduleType=1) it provides the actual day of the week based on the following scheme.

• SUNDAY=1
• MONDAY=2
• TUESDAY=4
• WEDNESDAY=8
• THURSDAY=16
• FRIDAY=32
• SATURDAY=64

Use the weekOfMonth argument for specific day of a week schedule (scheduleType=1), to select the week in which the job will execute. Set value to -1 to execute the job in last week of every month. Please note any value entered gets ignored for all other type of schedules (scheduleType=0 or scheduleType=2).

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 :

Example

The following example shows how to add a monthly run to a job. The job runs at 11:35 PM on the second Tuesday of every month. Email will be sent on success, failure, or cancel.

Script

Invoked commands in order :

Command Name : addMonthlyScheduleWithEMailNotificationAndPriority

Do not modify, published by technical writer

Name space : Job

Command Type : Complex

Release command : true

Author :

Description :

This command adds a monthly schedule with specified priority to a job and, depending on the resulting status of the job run, issues an email notification. Monthly schedule with email notification is not supported if 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 monthly schedule to be added. It must be in the format YYYY-MM-DD HH:MM:SS. Use the DayOfMonth argument to specify the day when the job executes.

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.

Set priorityString to one of the following priorities:

• CRITICAL
• HIGH
• NORMAL
• LOW
• LOWEST

Return type : java.lang.Object

Command Input :

Example

The following example shows how to add a monthly run with high priority to a job. The job runs at 11:35 PM on the 25th day of the month. Email will be sent on success, failure, or cancel.

Script

Invoked commands in order :

Command Name : addMonthlyScheduleWithEMailNotificationAndPriority

Do not modify, published by technical writer

Name space : Job

Command Type : Complex

Release command : true

Author :

Description :

This command adds a monthly schedule with specified priority to a job with support for all schedule choices (specific day of a particular week of every month, particular day of every month or last day of every month) and, depending on the resulting status of the job run, issues an email notification. Monthly schedule with email notification is not supported if 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.

There are three types of monthly schedules that are supported. The command requires specifying one of the types listed below to add appropriate schedule to the job.

• Specific day of every month=0
• Specific day of a week of every month=1
• Last day of every month=2

The dateString argument defines a monthly schedule to be added to the job definition. It must be in the format YYYY-MM-DD HH:MM:SS.

Use the dayOfWeekOrMonth argument to specify the day when the job executes. For last day of month schedule (scheduleType=2) this argument gets ignored and you may specify -1 as its value. For specific day of month schedule (scheduleType=0), this specifies actual calendar day (1-31) and for specific day of a week schedule (scheduleType=1) it provides the actual day of the week based on the following scheme.

• SUNDAY=1
• MONDAY=2
• TUESDAY=4
• WEDNESDAY=8
• THURSDAY=16
• FRIDAY=32
• SATURDAY=64

Use the weekOfMonth argument for specific day of a week schedule (scheduleType=1), to select the week in which the job will execute. Set value to -1 to execute the job in last week of every month. Please note any value entered gets ignored for all other type of schedules (scheduleType=0 or scheduleType=2).

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.

Set priorityString to one of the following priorities:

• CRITICAL
• HIGH
• NORMAL
• LOW
• LOWEST

Return type : java.lang.Object

Command Input :

Example

The following example shows how to add a monthly run with high priority to a job. The job runs at 11:35 PM on the second Tuesday of every month. Email will be sent on success, failure, or cancel.

Script

Invoked commands in order :

Command Name : addMonthlyScheduleWithPriority

Do not modify, published by technical writer

Name space : Job

Command Type : Complex

Release command : true

Author :

Description :

This command adds a monthly schedule with specified priority to a job. This command is not supported if 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 monthly schedule to be added to the job definition. It must be in the format YYYY-MM-DD HH:MM:SS. Use the dayOfMonth argument to specify the day when the job executes.

This command does not send a job notification. To add a schedule that includes notifications, see the Job addMonthlyScheduleWithSNMPNotificationAndPriority or Job addMonthlyScheduleWithEMailNotificationAndPriority commands.

Set priorityString to one of the following priorities:

• CRITICAL
• HIGH
• NORMAL
• LOW
• LOWEST

Return type : java.lang.Object

Command Input :

Example

The following example shows how to add a monthly run with high priority to a job. The job runs at 11:35 PM on the 25th day of the month.

Script

Invoked commands in order :

Command Name : addMonthlyScheduleWithPriority

Do not modify, published by technical writer

Name space : Job

Command Type : Complex

Release command : true

Author :

Description :

This command adds a monthly schedule to a job with support for all schedule choices (specific day of a particular week of every month, particular day of every month or last day of every month) and with specified priority to a job. This command is not supported if 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.

There are three types of monthly schedules that are supported. The command requires specifying one of the types listed below to add appropriate schedule to the job.

• Specific day of every month=0
• Specific day of a week of every month=1
• Last day of every month=2

The dateString argument defines a monthly schedule to be added to the job definition. It must be in the format YYYY-MM-DD HH:MM:SS.

Use the dayOfWeekOrMonth argument to specify the day when the job executes. For last day of month schedule (scheduleType=2) this argument gets ignored and you may specify -1 as its value. For specific day of month schedule (scheduleType=0), this specifies actual calendar day (1-31) and for specific day of a week schedule (scheduleType=1) it provides the actual day of the week based on the following scheme.

• SUNDAY=1
• MONDAY=2
• TUESDAY=4
• WEDNESDAY=8
• THURSDAY=16
• FRIDAY=32
• SATURDAY=64

Use the weekOfMonth argument for specific day of a week schedule (scheduleType=1), to select the week in which the job will execute. Set value to -1 to execute the job in last week of every month. Please note any value entered gets ignored for all other type of schedules (scheduleType=0 or scheduleType=2).

This command does not send a job notification. To add a schedule that includes notifications, see the Job addMonthlyScheduleWithSNMPNotificationAndPriority or Job addMonthlyScheduleWithEMailNotificationAndPriority commands.

Set priorityString to one of the following priorities:

• CRITICAL
• HIGH
• NORMAL
• LOW
• LOWEST

Return type : java.lang.Object

Command Input :

Example

The following example shows how to add a monthly run with high priority to a job. The job runs at 11:35 PM on second Tuesday every month.

Script

Invoked commands in order :

Command Name : addMonthlyScheduleWithSNMPNotification

Do not modify, published by technical writer

Name space : Job

Command Type : Complex

Release command : true

Author :

Description :

This command adds a monthly schedule to a job and, depending on the resulting status of the job run, issues an SNMP notification. Monthly schedule with SNMP notification is not supported if 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 monthly schedule to be added. It must be in the format YYYY-MM-DD HH:MM:SS. Use the DayOfMonth argument to specify the day when the job executes.

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 :

Example

The following example shows how to add a monthly run to a job. The job runs at 11:35 PM on the 25th day of the month. An SNMP trap will be generated on success, failure, or cancel.

Script

Invoked commands in order :

Command Name : addMonthlyScheduleWithSNMPNotification

Do not modify, published by technical writer

Name space : Job

Command Type : Complex

Release command : true

Author :

Description :

This command adds a monthly schedule to a job with support for all schedule choices (specific day of a particular week of every month, particular day of every month or last day of every month) and, depending on the resulting status of the job run, issues an SNMP notification. Monthly schedule with SNMP notification is not supported if 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.

There are three types of monthly schedules that are supported. The command requires specifying one of the types listed below to add appropriate schedule to the job.

• Specific day of every month=0
• Specific day of a week of every month=1
• Last day of every month=2

The dateString argument defines a monthly schedule to be added to the job definition. It must be in the format YYYY-MM-DD HH:MM:SS.

Use the dayOfWeekOrMonth argument to specify the day when the job executes. For last day of month schedule (scheduleType=2) this argument gets ignored and you may specify -1 as its value. For specific day of month schedule (scheduleType=0), this specifies actual calendar day (1-31) and for specific day of a week schedule (scheduleType=1) it provides the actual day of the week based on the following scheme.

• SUNDAY=1
• MONDAY=2
• TUESDAY=4
• WEDNESDAY=8
• THURSDAY=16
• FRIDAY=32
• SATURDAY=64

Use the weekOfMonth argument for specific day of a week schedule (scheduleType=1), to select the week in which the job will execute. Set value to -1 to execute the job in last week of every month. Please note any value entered gets ignored for all other type of schedules (scheduleType=0 or scheduleType=2).

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 :

Example

The following example shows how to add a monthly run to a job. The job runs at 11:35 PM on second Tuesday of every month. An SNMP trap will be generated on success, failure, or cancel.

Script

Invoked commands in order :

Command Name : addMonthlyScheduleWithSNMPNotificationAndPriority

Do not modify, published by technical writer

Name space : Job

Command Type : Complex

Release command : true

Author :

Description :

This command adds a monthly schedule with specified priority to a job and, depending on the resulting status of the job run, issues an SNMP notification. Monthly schedule with SNMP notification is not supported if 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 monthly schedule to be added. It must be in the format YYYY-MM-DD HH:MM:SS. Use the DayOfMonth argument to specify the day when the job executes.

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.

Set priorityString to one of the following priorities:

• CRITICAL
• HIGH
• NORMAL
• LOW
• LOWEST

Return type : java.lang.Object

Command Input :

Example

The following example shows how to add a monthly run with high priority to a job. The job runs at 11:35 PM on the 25th day of the month. An SNMP trap will be generated on success, failure, or cancel.

Script

Invoked commands in order :

Command Name : addMonthlyScheduleWithSNMPNotificationAndPriority

Do not modify, published by technical writer

Name space : Job

Command Type : Complex

Release command : true

Author :

Description :

This command adds a monthly schedule with specified priority to a job with support for all schedule choices (specific day of a particular week of every month, particular day of every month or last day of every month) and, depending on the resulting status of the job run, issues an SNMP notification. Monthly schedule with SNMP notification is not supported if 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.

There are three types of monthly schedules that are supported. The command requires specifying one of the types listed below to add appropriate schedule to the job.

• Specific day of every month=0
• Specific day of a week of every month=1
• Last day of every month=2

The dateString argument defines a monthly schedule to be added to the job definition. It must be in the format YYYY-MM-DD HH:MM:SS.

Use the dayOfWeekOrMonth argument to specify the day when the job executes. For last day of month schedule (scheduleType=2) this argument gets ignored and you may specify -1 as its value. For specific day of month schedule (scheduleType=0), this specifies actual calendar day (1-31) and for specific day of a week schedule (scheduleType=1) it provides the actual day of the week based on the following scheme.

• SUNDAY=1
• MONDAY=2
• TUESDAY=4
• WEDNESDAY=8
• THURSDAY=16
• FRIDAY=32
• SATURDAY=64

Use the weekOfMonth argument for specific day of a week schedule (scheduleType=1), to select the week in which the job will execute. Set value to -1 to execute the job in last week of every month. Please note any value entered gets ignored for all other type of schedules (scheduleType=0 or scheduleType=2).

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.

Set priorityString to one of the following priorities:

• CRITICAL
• HIGH
• NORMAL
• LOW
• LOWEST

Return type : java.lang.Object

Command Input :

Example

The following example shows how to add a monthly run with high priority to a job. The job runs at 11:35 PM on second Tuesday of every month. An SNMP trap will be generated on success, failure, or cancel.

Script

Invoked commands in order :

Command Name : addMonthlyScheduleWithTimeZone

Do not modify, published by technical writer

Name space : Job

Command Type : Complex

Release command : true

Author :

Description :

This command adds a monthly schedule to a job for a specific time zone. 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 monthly schedule to be added to the job definition. It must be in the format YYYY-MM-DD HH:MM:SS. Use the dayOfMonth argument to specify the day when the job executes.

For a list of valid Time Zone ids, use the Schedule listValidTimeZones command.

Return type : java.lang.Object

Command Input :

Example

The following example shows how to add a monthly run to a job. The job runs at 11:35 PM on the 25th day of the month in UTC.

Script

Invoked commands in order :

Command Name : addNotificationList

Name space : Job

Command Type : API

Release command : false

Description :

Return type : Boolean

Command Input :

Command Name : addOneTimeSchedule

Do not modify, published by technical writer

Name space : Job

Command Type : Complex

Release command : true

Author :

Description :

This command adds a one-time schedule to a job.If approval is enabled for the job type, use the addOneTimeScheduleWithApproval 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 to the job definition. It must be in the format YYYY-MM-DD HH:MM:SS.

This command does not send a job notification. To add a schedule that includes notifications, see the Job addOneTimeScheduleWithSNMPNotification or Job addOneTimeScheduleWithEMailNotification commands.

Return type : java.lang.Object

Command Input :

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.

Script

Invoked commands in order :

Command Name : addOneTimeScheduleWithApproval

Do not modify, published by technical writer

Name space : Job

Command Type : Complex

Release command : true

Author :

Description :

This command adds a one-time schedule to a job. The job waits until the approval is received and then runs. If the approval does not come on time, the schedule is marked as expired and the approval system closes the change ticket.

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 to the job definition. It must be in the format YYYY-MM-DD HH:MM:SS.

This command does not send a job notification. To add a schedule that includes notifications, see the Job addOneTimeScheduleWithSNMPNotificationAndWithApproval or Job addOneTimeScheduleWithEMailNotificationAndWithApproval commands.

Return type : java.lang.Object

Command Input :

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.

Script

Invoked commands in order :

Command Name : addOneTimeScheduleWithEMailNotification

Do not modify, published by technical writer

Name space : Job

Command Type : Complex

Release command : true

Author :

Description :

This command adds a one-time schedule to a job and, depending on the resulting status of the job run, issues an email notification. If approval is enabled for the job type, use the addOneTimeScheduleWithEMailNotificationAndWithApproval 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 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 :

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

Invoked commands in order :

Command Name : addOneTimeScheduleWithEMailNotificationAndPriority

Do not modify, published by technical writer

Name space : Job

Command Type : Complex

Release command : true

Author :

Description :

This command adds a one-time schedule to a job with specified priority and, depending on the resulting status of the job run, issues an email notification. If approval is enabled for the job type, use the addOneTimeScheduleWithEMailNotificationAndWithApproval 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 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.

Set priorityString to one of the following priorities:

• CRITICAL
• HIGH
• NORMAL
• LOW
• LOWEST

Return type : java.lang.Object

Command Input :

Example

The following example shows how to add a schedule with high priority 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

Invoked commands in order :

Command Name : addOneTimeScheduleWithEMailNotificationAndWithApproval

Do not modify, published by technical writer

Name space : Job

Command Type : Complex

Release command : true

Author :

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 :

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

Invoked commands in order :

Command Name : addOneTimeScheduleWithPriority

Do not modify, published by technical writer

Name space : Job

Command Type : Complex

Release command : true

Author :

Description :

This command adds a one-time schedule with specified priority to a job. If approval is enabled for the job type, use the addOneTimeScheduleWithApproval 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 to the job definition. It must be in the format YYYY-MM-DD HH:MM:SS.

Set priorityString to one of the following priorities:

• CRITICAL
• HIGH
• NORMAL
• LOW
• LOWEST

This command does not send a job notification. To add a schedule that includes notifications, see the Job addOneTimeScheduleWithSNMPNotificationAndPriority or Job addOneTimeScheduleWithEMailNotificationAndPriority commands.

Return type : java.lang.Object

Command Input :

Example

The following example shows how to add a schedule with high priority to a job for a single run on the 1st of January 2005 at 11:35 PM.

Script

Invoked commands in order :

Command Name : addOneTimeScheduleWithSNMPNotification

Do not modify, published by technical writer

Name space : Job

Command Type : Complex

Release command : true

Author :

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 :

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

Invoked commands in order :

Command Name : addOneTimeScheduleWithSNMPNotificationAndPriority

Do not modify, published by technical writer

Name space : Job

Command Type : Complex

Release command : true

Author :

Description :

This command adds a one-time schedule with specified priority 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.

Set priorityString to one of the following priorities:

• CRITICAL
• HIGH
• NORMAL
• LOW
• LOWEST

Return type : java.lang.Object

Command Input :

Example

The following example shows how to add a schedule with high priority 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

Invoked commands in order :

Command Name : addOneTimeScheduleWithSNMPNotificationAndWithApproval

Do not modify, published by technical writer

Name space : Job

Command Type : Complex

Release command : true

Author :

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

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

Invoked commands in order :