Scheduling Backup and Restore

This information Applies to TeamHeadquarters version 5.x only.

/NEW:taskname

Creates a new task. Fails if the task name already exists.

/OPEN

Opens an existing task. Fails if the task name doesn't exist.

/RUNAS:username\password

Sets the credentials to use when executing the scheduled request. Use "\" to run as SYSTEM. You must have administrative rights in order to schedule requests to run using the SYSTEM account.

/WD:path

Specifies the working directory for the task.

/COMMENT:"comment"

Provides a comment for the task.

/DELETEWHENCOMPLETE

Deletes the task when execution completes. This is the default behavior.

/RETAIN

Keeps the task when complete. Default behavior is to delete the task when execution has completed.

/START:yyyymmddThh:mm:ss

Specifies the date and time for the task schedule to become active.

/END:yyyymmddThh:mm:ss

Specifies the date and time for the task schedule to become inactive.

/DISABLE

Disables the task to prevent execution.

/ENABLE

Enables the task for execution.

/TERMINATE

Cancels an executing task.

/RUN

Immediately starts a scheduled task.

/MAXRUNTIME:time

Defines the maximum allowable execution time, in milliseconds.

/P:priority

Defines the execution priority of the task.

Values:

   NORMAL (default)

   IDLE

   HIGH

   REALTIME

/INTERVAL:minutes

Defines the time, in minutes, between successive task executions within the time specified by DURATION.

/DURATION:minutes

Defines the time, in minutes, within which the INTERVAL value is used. DURATION value must be greater than the value specified in INTERVAL.

/APP:application

The name of the executable program to run. If the application doesn't reside in the working directory or the system path, the full path to the executable must be provided.

/PARMS:"appparms"

The list of parameters to be passed to the application at execution time. The entire parameter list needs to be in double-quotes ("). The following special characters need to be encoded within the parm list to be handled properly:

Quote (") = "

Greater-than (>) = >

Less-than (<) = &lt;  

/TYPE:0

Runs the task once.

/TYPE:1

Runs the task daily, based on the DAILYINTERVAL parameter.

/DAILYINTERVAL:days

Specifies the number of days between task executions.

/TYPE:2

Runs the task weekly, based on WEEKLYINTERVAL and WEEKLYDAYS parameters.

/WEEKLYINTERVAL:weeks

Specifies the number of weeks between task executions.

/WEEKLYDAYS:days

Specifies the days of the week to run. Multiple values are separated by a comma, and spaces are not allowed. Allowable values are: SUNDAY, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, ALL, WEEKDAYS, WEEKEND  

/TYPE:3

Runs the task monthly, based on MONTHLYDATEDAYS and MONTHLYDATEMONTHS parameters.

/MONTHLYDATEDAYS:dates

Specifies the days of the month to execute. Multiple values are spearated by a comma, and spaces are not allowed. Dates are specified as a number from 1 to 31.  

/MONTHLYDATEMONTHS:months

Specifies which months to execute on. Multiple values are separated by a comma, and spaces are not allowed. Allowable values are: JAN[UARY], FEB[RUARY], MAR[CH], APR[IL], MAY, JUNE, JULY, AUG[UST], SEP[TEMPBER], OCT[OBER], NOV[EMBER], DEC[EMBER], ALL  

/TYPE:4

Runs the task monthly, based on the MONTHLYDOWDAYS, MONTHLYDOWWEEK, and MONTHLYDOWMONTHS parameters.

/MONTHLYDOWDAYS:dates

Specifies the days of the week to run. Multiple values are spearated by a comma, and spaces are not allowed. Allowable values are: SUNDAY, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, ALL, WEEKDAYS, WEEKEND  

/MONTHLYDOWWEEK:weeks

Specifies the relative week to run. Multiple values are spearated by a comma, and spaces are not allowed. Allowable values are: FIRST, SECOND, THIRD, FOURTH, LAST  

/MONTHLYDOWMONTHS:months

Specifies which months to execute on. Multiple values are separated by a comma, and spaces are not allowed. Allowable values are: JAN[UARY], FEB[RUARY], MAR[CH], APR[IL], MAY, JUNE, JULY, AUG[UST], SEP[TEMPBER], OCT[OBER], NOV[EMBER], DEC[EMBER], ALL