This operation updates the properties associated with a schedule policy.
Request
Syntax
PUT <webservice>/Task HTTP/1.1 Host: <host name> Accept: application/xml Authtoken: <authentication token> Content-type: application/xml <update_schedule_policy.xml>
where <webservice> is the root path used to route the API requests to the Web Server.
For more information, see Available Web Services for REST API.
Request Headers
Name |
Description |
Host |
The host name of the Web Server or Web Console used in the API request. |
Accept |
The format of the response. Valid values are: application/xml or application/json. |
Authtoken |
The authentication token received after successfully logging on. For details on receiving an authentication token, see Authentication. |
Content-type |
The media type contained in the request body. |
Request Body
Download the update_schedule_policy.xml file required for this request. The following table displays the parameters for the request body.
Parameter |
Description and Parameter Values |
Element |
Parent Element |
|||
taskOperation |
The operation to perform on the schedule policy. The valid value is MODIFY. |
taskInfo |
TMMsg_ModifyTaskReq |
|||
taskName |
The name of the schedule policy. |
task |
taskInfo |
|||
disabled |
taskFlags |
task |
||||
isEdgeDrive |
taskFlags |
task |
||||
policyType |
The type of schedule policy. Valid values are:
|
task |
taskInfo |
|||
taskType |
Valid value is SCHEDULE_POLICY. |
task |
taskInfo |
|||
initiatedFrom |
Valid values are:
|
task |
taskInfo |
|||
description |
A description for the schedule policy. |
task |
taskInfo |
|||
alertName |
The name of the alert to associate with the schedule policy. |
alert |
task |
|||
appGroupName |
The name of the agent group associated with the schedule policy. Most agent groups in the appGroupName parameter represent a group of agents. For example, <appGroupName>APPGRP_BACKEDUP_FILES</appGroupName> is the Files/Protected Files group, and it includes several agents. To select individual agents in the Files/Protected Files group, use the appTypeName parameter. Valid values are:
|
appGroups |
appGroup |
|||
appTypeName |
The name of the agent associated with the schedule policy. To select all of the agents in a group, use the appGroupName parameter. Valid values are:
|
appTypes |
appGroup |
|||
deleted |
The option to remove an agent group association. Valid value is 1. |
flags |
appGroups |
|||
deleted |
The option to remove an agent association. Valid value is 1. |
flags |
appTypes |
|||
associations |
You define the schedule policy entities in the <associations> element. You can use either the entity IDs or the entity names as parameters in the element. To work with multiple associations, add additional <associations> elements, for example: <associations clientName="client001" /> Entities include all of the sub-entities under them unless the entity is specifically exclude by using the exclude parameter. |
taskInfo |
TMMsg_ModifyTaskReq |
|||
clientId |
The system-generated ID assigned to the client. |
associations |
taskInfo |
|||
clientName |
The name of the client. |
associations |
taskInfo |
|||
clientGroupId |
The system-generated ID assigned to the client computer group. |
associations |
taskInfo |
|||
clientGroupName |
The name of the client computer group. |
associations |
taskInfo |
|||
applicationId |
The ID of the application. For a list of application IDs, see the valid values for the appName parameter. |
associations |
taskInfo |
|||
appName |
The name of the application. Valid values for the applicationId and appName parameters:
|
associations |
taskInfo |
|||
backupsetId |
The system-generated ID assigned to the backup set. |
associations |
taskInfo |
|||
backupsetName |
The name of the backup set. |
associations |
taskInfo |
|||
instanceId |
The system-generated ID assigned to the instance. |
associations |
taskInfo |
|||
instanceName |
The name of the instance. |
associations |
taskInfo |
|||
subclientId |
The system-generated ID assigned to the subclient. |
associations |
taskInfo |
|||
subclientName |
The name of the subclient. |
associations |
taskInfo |
|||
storagePolicyName |
The name of the storage policy to add to the auxiliary copy schedule policy. |
associations |
taskInfo |
|||
storagePolicyId |
The system-generated ID assigned to the storage policy. |
associations |
taskInfo |
|||
copyName |
The name of the copy to add to the auxiliary copy schedule policy, for example, Primary. |
associations |
taskInfo |
|||
copyId |
The system-generated ID assigned to the copy. |
associations |
taskInfo |
|||
exclude |
The option to exclude an entity from an association. Valid value is 1. |
flags |
associations |
|||
deleted |
The option to remove an entity association. Valid value is 1. |
flags |
associations |
|||
subTaskName |
The name of the schedule attached to the schedule policy. |
subTask |
subTasks |
|||
subTaskType |
The type of subtask. Valid values are:
|
subTask |
subTasks |
|||
operationType |
The type of schedule policy. Valid values are:
|
subTask |
subTasks |
|||
active_end_date |
The end date of the schedule policy. |
pattern |
subTasks |
|||
active_end_occurence |
The number of times you want to repeat the schedule. |
pattern |
subTasks |
|||
active_end_time |
The end time of the schedule policy. |
pattern |
subTasks |
|||
active_start_date |
The start date of the schedule policy. |
pattern |
subTasks |
|||
active_start_time |
The start time of the schedule policy. |
pattern |
subTasks |
|||
description |
The description of the schedule pattern, for example, Every year on day 10 of January at 12:00 AM starting December 16, 2013 and repeats every 0 hr(s) 0 min(s) until 12:00 AM. |
pattern |
subTasks |
|||
flags |
pattern |
subTasks |
||||
freq_interval |
The meaning of this parameter changes based on the value of the freq_type parameter:
|
pattern |
subTasks |
|||
freq_recurrence_factor |
The meaning of this parameter changes based on the value of the freq_type parameter:
|
pattern |
subTasks |
|||
freq_relative_interval |
The meaning of this parameter changes based on the value of the freq_type parameter:
|
pattern |
subTasks |
|||
freq_restart_interval |
pattern |
subTasks |
||||
freq_subday_interval |
The time interval to repeat the schedule. |
pattern |
subTasks |
|||
freq_type |
Indicates how often the schedule is run. Valid values are:
|
pattern |
subTasks |
|||
name |
pattern |
subTasks |
||||
patternId |
The system-generated ID assigned to the schedule pattern. |
pattern |
subTasks |
|||
exception |
The option to set an exception for a repeating schedule. Multiple exceptions can be added for the repeating schedule: <repeatPattern exception="true" occurrence="1" onDay="1" onDayNumber="0"/> Use the occurrence and the onDay or the onDayNumber parameters to define the exception. Valid values are True/False. |
repeatPattern |
pattern |
|||
occurrence |
The ordinal numbers indicating when the exception to a repeating schedule occurs. Use this parameter with the onDay parameter or the onDayNumber parameter. Valid values are:
|
repeatPattern |
pattern |
|||
onDay |
The day of the week indicating when the exception to a repeating schedule occurs. Use this parameter with the occurrence parameter. Valid values are:
|
repeatPattern |
pattern |
|||
onDayNumber |
The days of the month indicating when the exception to a repeating schedule occurs. Use this parameter with the occurrence parameter. Valid values are the sum of the bit form values assigned to the days of the month. The bit form values are calculated as follows:
|
repeatPattern |
pattern |
|||
calendarName |
The name of the calendar, for example, Standard. |
calendar |
pattern |
|||
TimeZoneName |
The code for the time zone. For a list of valid values, see Time Zone IDs and Names. |
timeZone |
pattern |
|||
description |
The description of the schedule pattern, for example, Every year on day 10 of January at 12:00 AM starting December 16, 2013 and repeats every 0 hr(s) 0 min(s) until 12:00 AM. |
pattern |
subTasks |
|||
backupLevel |
The type of backup to perform. Valid values are:
|
backupOpts |
options |
|||
allowOtherSchedulesToUseMediaSet |
The option to allow jobs that are part of a schedule and that use a specific storage policy to start new media. This option prevents other jobs from writing to the media. Valid values are True/False. |
mediaOpt |
backupOpts |
|||
markMediaFullOnSuccess |
The option to mark the media full two minutes after the completion of the backup operation. Valid values are True/False. |
mediaOpt |
backupOpts |
|||
reserveResourcesBeforeScan |
The option to reserve the media before the scan phase instead of before the operation phase. Valid values are True/False. |
mediaOpt |
backupOpts |
|||
startNewMedia |
The option to start the backup operation on new media. Valid values are True/False. |
mediaOpt |
backupOpts |
|||
numberofDays |
The number of days to keep the job. Use this parameter when the retentionJobType parameter is set to "NO_OF_DAYS." |
mediaOpt |
backupOpts |
|||
retentionJobType |
The option to set job retention. Valid values are:
|
mediaOpt |
backupOpts |
|||
useMostRecentBackupForAuxcopy |
The option to copy the most recent successful full backup for each subclient to selective copies when an Auxiliary Copy job is run. If this option is set to false, the previously selected full backup jobs or manually selected jobs are copied to selective copy when an Auxiliary Copy job is run. Valid values are True/False. |
auxcopyJobOption |
||||
useMaximumStreams |
The option to copy the maximum number of data streams at the same time. Valid values are True/False. |
auxcopyJobOption |
||||
maxNumberOfStreams |
The number of data streams that are copied at the same time. |
auxcopyJobOption |
mediaOpt |
|||
waitForAllParallelCopyResources |
The option to not start the auxiliary copy operation for parallel copies until all resources (MediaAgents and libraries) for the parallel copy are available. Valid values are True/False. |
auxcopyJobOption |
mediaOpt |
|||
useScallableResourceManagement |
The option to enhance the scalability of the auxiliary copy operation and to optimally utilize the CommServe resources. Valid values are True/False. |
auxcopyJobOption |
mediaOpt |
|||
ignoreDataVerificationFailedJobs |
The option to not copy the backup jobs that did not complete the data verification operation with a successful status. Valid values are True/False. |
auxcopyJobOption |
mediaOpt |
|||
createNewIndex |
SAP Oracle: The option to create a new index. Valid values are True/False. |
dataOpt |
backupOpts |
|||
enableIndexCheckPointing |
The option to enable index check pointing. Valid values are True/False. |
dataOpt |
backupOpts |
|||
createBackupCopyImmediately |
The option to create an inline backup copy to start the movement of the snapshot to media immediately after the completion of the IntelliSnap backup job. |
dataOpt |
backupOpts |
|||
followMountPoints |
The option to back up the data in the mount point. Valid values are True/False. |
dataOpt |
backupOpts |
|||
enforceTransactionLogUsage |
The option to use the transaction logs for granular restarts. Valid values are True/False. |
dataOpt |
backupOpts |
|||
skipConsistencyCheck |
The option to skip the consistency check. Valid values are True/False. |
dataOpt |
backupOpts |
|||
collectVMGranularRecoveryMetadataForBkpCopy |
This option collects file and folder metadata to enable recovery of files and folders from the backup copy. Valid values are True/False. |
dataOpt |
backupOpts |
|||
backupQuotas |
The option to back up the user quota information and group quota information registered in the node to monitor and control disk usage. Valid values are True/False. |
nasOptions |
backupOpts |
|||
backupExclusive |
The option to prevent the concurrent execution of multiple backup or restore operations on the same file system. Valid values are True/False. |
nasOptions |
backupOpts |
|||
volumeBasedBackup |
The option to perform a data block level backup of an entire specified volume. Valid values are True/False. |
nasOptions |
backupOpts |
|||
backupOfflineData |
The option to copy the original files (not stub files) during the backup job. This backs up data that is archived. Valid values are True/False. |
nasOptions |
backupOpts |
|||
blockBackup |
The option to back up the files on a Hitachi file server in the order in which they appear on the disk rather than the order they appear in the directory tree. Valid values are True/False. |
nasOptions |
backupOpts |
|||
snapShotType |
The option for the NAS file server to create a snapshot and to perform the backup from the snapshot instead of backing up the live file system. Valid values are:
|
nasOptions |
backupOpts |
|||
readAheadBit0 readAheadBit1 readAheadBit2 readAheadBit3 |
The number of read-ahead processes to use during backup operations of Hitachi NAS (BlueArc) file servers. Valid values are numbers from 1 to 10. |
nasOptions |
backupOpts |
|||
backupFromSnap |
The existing snapshot to back up. On NetApp file servers, the backup will not delete the snapshot. |
nasOptions |
backupOpts |
|||
snapShotExpiration |
The retention period for the snapshot in the backupFromSnap parameter. Set the value for this parameter so that all paths have time to finish but the snapshot is deleted before the next backup of the subclient. If no value is set, the default value is 1 hour. |
nasOptions |
backupOpts |
|||
backupExternalLinks |
The method for handling links to external files that where moved to an external server, such as the cloud, during a backup operation. Valid values are:
|
nasOptions |
backupOpts |
|||
runIncrementalBackup |
The option to run an incremental backup with a synthetic full backup. Use the backupLevel parameter to define the type of backup. Use the incLevel parameter to define the order in which the incremental and synthetic full backups are run. Valid values are True/False. |
backupOpts |
options |
|||
incLevel |
The option to run an incremental backup before or after a synthetic full backup. Use the incLevel parameter with the runIncrementalBackup parameter. Valid values are:
|
backupOpts |
options |
|||
doNotTruncateLog |
The option to not truncate the logs. Valid values are True/False. |
backupOpts |
options |
|||
sybaseSkipFullafterLogBkp |
The option to skip a full backup for new Sybase databases after a log backup. Valid values are True/False. |
backupOpts |
options |
|||
truncateLogsOnSource |
The option to truncate logs on source. Valid values are True/False. |
backupOpts |
options |
|||
notSynthesizeFullFromPrevBackup |
Valid values are True/False. |
backupOpts |
options |
|||
adHocBackup |
Valid values are True/False. |
backupOpts |
options |
|||
subClientBasedAnalytics |
Valid values are True/False. |
contentIndexingOption |
adminOpts |
Response
Parameter |
Description |
Element |
errorCode |
The possible error codes. Valid values are:
|
TMMsg_GenericResp |
errorMessage |
The description of the error code. Not all error codes have an error message. |
TMMsg_GenericResp |
Examples
Sample Request
This request associates the DB2 agent group and the SQL Server agent with the schedule policy.
PUT <webservice>/Task HTTP/1.1
Host: client1.mydomain.com
Accept: application/xml
Authtoken: QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc6
0f4dab8a63347d05cf5552484dafda3bfa4c5db84e580b1cb37bcf8e65b39f7f
8549a443e6f78a2c7be3f31b3d845e24776c835e498e8e883bb40c46bd15af4f
40ca94e823acedcdd4e9659e74b34a07a85c4586cd2ed914b6dce015874783ef7
68fda78183a4208930954a377f66eb56c8b92cexampl4s437a19317ca6ce7f323
3d5a01aca35dbad93468b833f2cf71010809006a937670adce711ca8be46638e8
Content-type: application/xml
<TMMsg_ModifyTaskReq>
<taskInfo>
<taskOperation>MODIFY</taskOperation>
<task>
<policyType>0</policyType>
<taskName>SP009</taskName>
<taskType>SCHEDULE_POLICY</taskType>
</task>
<appGroup>
<appGroups appGroupName="APPGRP_DB2"/>
<appTypes appTypeName="SQL Server"/>
</appGroup>
</taskInfo>
</TMMsg_ModifyTaskReq>
This request removes the DB2 agent group association from the schedule policy.
PUT <webservice>/Task HTTP/1.1
Host: client1.mydomain.com
Accept: application/xml
Authtoken: QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc6
0f4dab8a63347d05cf5552484dafda3bfa4c5db84e580b1cb37bcf8e65b39f7f
8549a443e6f78a2c7be3f31b3d845e24776c835e498e8e883bb40c46bd15af4f
40ca94e823acedcdd4e9659e74b34a07a85c4586cd2ed914b6dce015874783ef7
68fda78183a4208930954a377f66eb56c8b92cexampl4s437a19317ca6ce7f323
3d5a01aca35dbad93468b833f2cf71010809006a937670adce711ca8be46638e8
Content-type: application/xml
<TMMsg_ModifyTaskReq>
<taskInfo>
<taskOperation>MODIFY</taskOperation>
<task>
<policyType>0</policyType>
<taskName>SP009</taskName>
<taskType>SCHEDULE_POLICY</taskType>
</task>
<appGroup>
<appGroups appGroupName="APPGRP_DB2">
<flags deleted="1" />
<appGroups/>
</appGroup>
</taskInfo>
</TMMsg_ModifyTaskReq>
Sample Response
<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
<TMMsg_GenericResp errorMessage="" errorCode="0" />