Loading...

REST API - POST Schedule Policy

This operation creates a schedule policy.

Request

Syntax

POST <webservice>/Task HTTP/1.1
Host: <host name>
Accept: application/xml
Authtoken: <authentication token>
Content-type: application/xml

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

taskName

The name of the schedule policy.

task

taskInfo

disabled

 

taskFlags

task

isEdgeDrive

 

taskFlags

task

policyType

The type of schedule policy.

Valid values are:

  • 0, for data protection
  • 1, for auxiliary copy
  • 3, for backup copy
  • 6, for content indexing

task

taskInfo

taskType

Valid value is SCHEDULE_POLICY.

task

taskInfo

initiatedFrom

Valid values are:

  • GUI
  • COMMANDLINE

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:

 

  • APPGRP_ARCHIVE_DOCS, Archived Documents
  • APPGRP_ARCHIVED_FILES, Archived Files
  • APPGRP_ARCHIVED_MAILS, Archived Mail
  • APPGRP_BACKEDUP_DOCS, Protected Documents
  • APPGRP_BACKEDUP_FILES, Protected Files
  • APPGRP_BACKEDUP_MAILS, Protected Mail
  • APPGRP_CLOUDAPPS, Cloud Apps
  • APPGRP_DB2, DB2
  • APPGRP_DBS, all databases
  • APPGRP_DISTRIBUTEDAPPS, Big Data Apps
  • APPGRP_DOCUMENTUM, Documentum
  • APPGRP_INFORMIX, Informix
  • APPGRP_JOURNALED_MAILS, Journaled Mail
  • APPGRP_MySql, MySQL
  • APPGRP_NotesDb, Notes DB
  • APPGRP_NotesDb_Transaction_Log, Notes DB (Transaction Log Subclients)
  • APPGRP_NotesDoc, Notes Document
  • APPGRP_NotesDocDataMigrator, Domino Mailbox Archiver
  • APPGRP_ORACLE, Oracle
  • APPGRP_POSTGRES, PostgreSQL
  • APPGRP_SAP_FOR_ORACLE, SAP for Oracle
  • APPGRP_SAP_HANA, SAP HANA
  • APPGRP_SQL_POLICY, SQL Server
  • APPGRP_Sybase, Sybase
  • APPGRP_XchangeDB, Exchange DB
  • PACKAGEGRP_EXCHANGE, all archived files
  • PACKAGEGRP_WIN, All protected files

 

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:

 

  • Active Directory
  • AIX File System
  • Big Data Apps
  • Cloud Apps
  • DB2
  • DB2 MultiNode
  • DB2 on Unix
  • Documentum
  • Domino Mailbox Archiver
  • DPM
  • Exchange Compliance Archiver
  • Exchange Database
  • Exchange Mailbox
  • Exchange Mailbox (Classic)
  • Exchange Mailbox Archiver
  • Exchange PF Archiver
  • Exchange Public Folder
  • File Share Archiver
  • FreeBSD
  • GroupWise DB
  • HP-UX Files System
  • Image Level
  • Image Level On Unix
  • Image Level ProxyHost
  • Image Level ProxyHost on Unix
  • Informix Database
  • Linux File System
  • MAC FileSystem
  • MS SharePoint Archiver
  • MySQL
  • NAS
  • Netware File Archiver
  • Netware File System
  • Notes Database
  • Notes Document
  • Novell Directory Services
  • Object Link
  • Object Store
  • OES File System on Linux
  • Oracle
  • Oracle RAC
  • Other External Agent
  • PostgreSQL
  • Proxy Client File System
  • ProxyHost on Unix
  • SAP for Oracle
  • SAP HANA
  • SharePoint Server
  • Solaris 64bit File System
  • Solaris File System
  • SQL Server
  • Sybase Database
  • Unix File Archiver
  • Unix Tru64 64-bit File System
  • Virtual Server
  • Window File System
  • Windows File Archiver

 

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" />
<associations clientGroupId="2" />

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:

 

  • 41, Active Directory
  • 21, AIX File System
  • 64, Big Data Apps
  • 134, Cloud Apps
  • 37, DB2
  • 103, DB2 MultiNode
  • 62, DB2 on Unix
  • 128, Documentum
  • 90, Domino Mailbox Archiver
  • 91, DPM
  • 67, Exchange Compliance Archiver
  • 53, Exchange Database
  • 45, Exchange Mailbox
  • 54, Exchange Mailbox (Classic)
  • 56, Exchange Mailbox Archiver
  • 82, Exchange PF Archiver
  • 35, Exchange Public Folder
  • 73, File Share Archiver
  • 33, File System
  • 74, FreeBSD
  • 71, GroupWise DB
  • 17, HP-UX Files System
  • 65, Image Level
  • 75, Image Level On Unix
  • 76, Image Level ProxyHost
  • 87, Image Level ProxyHost on Unix
  • 3, Informix Database
  • 29, Linux File System
  • 89, MS SharePoint Archiver
  • 104, MySQL
  • 13, NAS
  • 83, Netware File Archiver
  • 12, Netware File System
  • 10, Novell Directory Services
  • 124, Object Link
  • 131, Object Store
  • 86, OES File System on Linux
  • 22, Oracle
  • 80, Oracle RAC
  • 130, Other External Agent
  • 125, PostgreSQL
  • 38, Proxy Client File System
  • 87, ProxyHost on Unix
  • 61, SAP for Oracle
  • 135, SAP HANA
  • 78, SharePoint Server
  • 20, Solaris 64bit File System
  • 19, Solaris File System
  • 81, SQL Server
  • 5, Sybase Database
  • 66, Unix File Archiver
  • 36, Unix Tru64 64-bit File System
  • 106, Virtual Server
  • 58, Windows File Archiver

 

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

subTaskName

The name of the schedule attached to the schedule policy.

subTask

subTasks

subTaskType

The type of subtask.

Valid values are:

  • ADMIN, for policies that are not data protection policies
  • BACKUP, for data protection schedule policies

subTask

subTasks

operationType

The type of schedule policy.

Valid values are:

  • 0, for data protection
  • 1, for auxiliary copy
  • 3, for backup copy
  • 6, for content indexing

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:

  • If freq_type equals 1 (one time) or 1024 (automatic schedule), freq_interval is not used and is set to 0.
  • If freq_type equals 4 (daily), freq_interval is the number of days the schedule should repeat. For example, the parameters to run a schedule daily every 17 days are freq_type="4" and freq_interval="17".
  • If freq_type equals 8 (weekly), freq_interval is the sum of the bit form values assigned to the days of the week. The bit form values are:
    • Sunday = 1
    • Monday = 2
    • Tuesday = 4
    • Wednesday = 8
    • Thursday = 16
    • Friday = 32
    • Saturday = 64

    For example, the parameters to run a schedule weekly on Monday and Saturday are freq_type="8" and freq_interval="66" and the parameters to run a schedule weekly on Sunday, Monday, Tuesday, Wednesday, and Thursday are freq_type="8" and freq_interval="31".

  • If freq_type equals 16 (monthly), freq_interval is the day of the month the schedule runs. For example, the parameters to run a schedule monthly on the thirteenth of every month are freq_type="16" and freq_interval="13".
  • If freq_type equals 32 (monthly relative), freq_interval is the day of the week the schedule runs. Valid values are:
    • 1, for Sunday
    • 2, for Monday
    • 3, for Tuesday
    • 4, for Wednesday
    • 5, for Thursday
    • 6, for Friday
    • 7, for Saturday
    • 8, for any day
    • 9, for a weekday
    • 10, for a weekend day
  • If freq_type equals 64 (yearly) or 128 (yearly relative), freq_interval is the day of the month the schedule runs.

pattern

subTasks

freq_recurrence_factor

The meaning of this parameter changes based on the value of the freq_type parameter:

  • If freq_type equals 64 (yearly) or 128 (yearly relative), freq_recurrence_factor is the month the schedule runs. For example, the parameters to run a yearly schedule every July are freq_type="64" and freq_recurrence_factor="7".
  • If freq_type equals 4 (daily), 8 (weekly), 16 (monthly) or 32 (monthly relative), freq_recurrence_factor is set to 1 (one time).
  • If freq_type equals 1 (one time) or 1024 (automatic schedule), freq_recurrence_factor is set to 0.

pattern

subTasks

freq_relative_interval

The meaning of this parameter changes based on the value of the freq_type parameter:

  • If freq_type equals 32 (monthly relative) or 128 (yearly relative), freq_relative_interval is the ordinal numbers indicating when the schedule runs. Use with the freq_interval parameter. Valid values are:
    • 1, if the exception occurs on the first n
    • 2, if the exception occurs on the second n
    • 3, if the exception occurs on the third n
    • 4, if the exception occurs on the fourth n
    • 5, if the exception occurs on the last n
  • If freq_type equals any other value, freq_recurrence_factor is set to 0.

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:

  • 1, One time
  • 4, Daily
  • 8, Weekly
  • 16, Monthly
  • 32, Monthly relative
  • 64, Yearly
  • 128, Yearly relative
  • 1024, Automatic schedule

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"/>
<repeatPattern exception="true" occurrence="0" onDay="0" onDayNumber="268435460"/>

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:

  • 0, if the exception occurs on specific days of the month
  • 1, if the exception occurs on the first n
  • 2, if the exception occurs on the second n
  • 4, if the exception occurs on the third n
  • 8, if the exception occurs on the fourth n
  • 16, if the exception occurs on the last n

    For example, if a repeating schedule skips the fourth Friday of the month, then the parameter is occurrence="8". If a repeating schedule skips the last Friday of the month, then the parameter is occurrence="16".

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:

  • 0, to use the onDayNumber parameter
  • 1, for Sunday
  • 2, for Monday
  • 4, for Tuesday
  • 8, for Wednesday
  • 16, for Thursday
  • 32, for Friday
  • 64, for Saturday
  • 128, for any day
  • 256, for a weekday
  • 512, for a weekend day

    For example, if a repeating schedule skips the fourth Friday of the month, then the parameters are occurrence="8" and onDay="32". If a repeating schedule skips the last weekday of the month, then the parameters are occurrence="16" and onDay="256".

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:

  • first day = 1
  • second to thirty-first day = 2(n-1) where n is the day of the month

    For example, if a repeating schedule skips the first day and thirty-first day of the month, then the parameter is onDayNumber="1073741825" using the formula 1+2(31-1). If a repeating schedule skips the third day and twenty-ninth day of the month, then the parameter is onDayNumber="268435460" using the formula 2(3-1)+2(29-1).

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:

  • FULL
  • INCREMENTAL
  • DIFFERENTIAL
  • SYNTHETIC_FULL

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:

  • INFINITE, to retain this job indefinitely
  • NO_OF_DAYS, to prune the job after the number of days specified in the numberofDays parameter
  • STORAGE_POLICY_DEFAULT, to apply the retention rules of the associated storage policy

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:

  • SNAP
  • SYNC
  • YES
  • NO

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:

  • 1, links to external files are ignored and not included in the backup.
  • 2, metadata for links to external files are included in the backup. Contents of the links to external files are not backed up.
  • 3, metadata and content for links to external files are included in the backup. This is the default behavior if no option is selected.

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:

  • BEFORE_SYNTH
  • AFTER_SYNTH

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

Response Parameters

Parameter

Description

Element

taskId

The system-generated ID assigned to the schedule policy.

TMMsg_CreateTaskResp

Examples

Sample Request

POST <webservice>/Task HTTP/1.1
Host: client.mydomain.com
Accept: application/json
Authtoken: QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc6
0f4dab8a63347d05cf5552484dafda3bfa4c5db84e580b1cb37bcf8e65b39f7f
8549a443e6f78a2c7be3f31b3d845e24776c835e498e8e883bb40c46bd15af4f
40ca94e823acedcdd4e9659e74b34a07a85c4586cd2ed914b6dce015874783ef7
68fda78183a4208930954a377f66eb56c8b92cexampl4s437a19317ca6ce7f323
3d5a01aca35dbad93468b833f2cf71010809006a937670adce711ca8be46638e8
Content-type: application/xml

<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
<TMMsg_CreateTaskReq>
  <taskInfo>
    <task>
      <taskName>SP009</taskName>
      <policyType>0</policyType>
      <taskType>SCHEDULE_POLICY</taskType>
      <description>schedule policy to protect archived and protected files</description>
    </task>
    <appGroup>
      <appGroups>
        <appGroupName>PACKAGEGRP_WIN</appGroupName>
      </appGroups>
      <appGroups>
        <appGroupName>PACKAGEGRP_EXCHANGE</appGroupName>
      </appGroups>
    </appGroup>
    <associations>
      <clientName>winter</clientName>
    </associations>
    <subTasks>
      <subTask>
        <subTaskName>Sunday afternoons</subTaskName>
        <subTaskType>BACKUP</subTaskType>
        <operationType>BACKUP</operationType>
      </subTask>
      <pattern>
        <freq_type>Weekly</freq_type>
        <daysToRun>
          <Sunday>true</Sunday>
        </daysToRun>
        <freq_interval>1</freq_interval>
        <freq_recurrence_factor>1</freq_recurrence_factor>
        <active_start_date>2017-07-17 20:00:00</active_start_date>
        <active_start_time>14:00:00</active_start_time>
        <active_end_time>00:00:00</active_end_time>
        <timeZone>
          <TimeZoneName>(UTC-05:00) Eastern Time (US &amp; Canada)</TimeZoneName>
        </timeZone>
        <calendar>
          <calendarName>Standard</calendarName>
        </calendar>
      </pattern>
      <options>
        <backupOpts>
          <backupLevel>INCREMENTAL</backupLevel>
        </backupOpts>
      </options>
    </subTasks>
  </taskInfo>
</TMMsg_CreateTaskReq>

Sample Response

<TMMsg_CreateTaskResp taskId="64" />

Last modified: 9/11/2020 7:40:38 PM