REST API - POST Backup Set Properties

This operation updates the properties associated with a backup set.

Request

Syntax

Send the request using either the ID or the name and either XML or JSON:

 
POST <webservice>/Backupset/{backupsetId} HTTP/1.1
 Host: <host name>
 Accept: application/xml
 Authtoken: <authentication token>
 Content-type: application/xml|json
 <update_backupset_template.xml>
 <update_backupset_template.json>

Name

 
POST <webservice>/Backupset/byName(clientName='{clientName}',appName='{appName}',backupsetName='{backupsetName}')
Host: <host name>
Accept: application/xml
Authtoken: <authentication token>
Content-type: application/xml|json
<update_backupset_template.xml>
 <update_backupset_template.json>

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 Parameters

Name	Description	Required
backupsetId	The backup set ID for the backup set. If the backup set ID is not known, use the GET Backup Set API to retrieve it.	Yes-for the request by ID
clientName	The client name for the backup set. If the client name is not known, use the GET Client API to retrieve it.	Yes-for the request by name
appName	The application name for the backup set. If the application name is not known, use the GET Backup Set API to retrieve it.	Yes-for the request by name
backupsetName	The backup set name of the backup set. If the backup set name is not known, use the GET Backup Set API to retrieve it.	Yes-for the request by name

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 XML or JSON file required for this request: update_backupset_template.xml or update_backupset_template.json. The following table displays the parameters for the request body.

Name

Description

Elements

Parent Element

appName

The name of the application.

Valid values are:

DB2
DB2 on UNIX
Exchange Database
File System
MySQL
NAS
Notes Database

Oracle
Oracle RAC
PostgreSQL
SAP for MAX DB
SAP for Oracle
SQL Server
Sybase Database
Virtual Server

backupSetEntity

backupsetProperties

backupsetName

The name of the backup set.

backupSetEntity

backupsetProperties

clientName

The name of the client.

backupSetEntity

backupsetProperties

instanceName

The name of the instance, for example: DefaultInstanceName.

backupSetEntity

backupsetProperties

userGroupName

The name of the user group associated with the backup set.

associatedUserGroups

backupsetSecurity

clientOwners

The name of the client owners.

backupsetSecurity

backupsetProperties

ownerCapabilities

The capabilities of the client computer owners associated with the backup set.

backupsetSecurity

backupsetProperties

associatedsubclientPolicy

commonBackupSet

backupsetProperties

associatedsubclientPolicyName

The name of the subclient policy associated with the backup set.

commonBackupSet

backupsetProperties

cDRFSDMBackupset

Valid values are True/False.

commonBackupSet

backupsetProperties

dataMigratorILMCLASS

Valid values are True/False.

commonBackupSet

backupsetProperties

decompressData

The option to decompress data that is in a compressed format on the backup media.

Valid values are True/False.

commonBackupSet

backupsetProperties

isDedupBackupset

The option to set the backup set as the deduplication backup set.

Valid values are True/False.

commonBackupSet

backupsetProperties

isDefaultBackupSet

The option to set the backup set as the default backup set.

Valid values are True/False.

commonBackupSet

backupsetProperties

isDeleted

The option to delete the backup set.

Valid values are True/False.

commonBackupSet

backupsetProperties

isFanInBackupSet

The option to support fan-in.

Valid values are True/False.

commonBackupSet

backupsetProperties

isHidden

The option to set the backup set storage policy as hidden.

Valid values are True/False.

commonBackupSet

backupsetProperties

isMining

The option to use the backup set for IntelliSnap mining.

Valid values are True/False.

commonBackupSet

backupsetProperties

isMyBackupSet

The option to use the backup set for my backup set.

Valid values are True/False.

commonBackupSet

backupsetProperties

isNasTurboBackupSet

The option to use the backup set for a NAS turbo restore.

Valid values are True/False.

commonBackupSet

backupsetProperties

isUSeDCForBackup

The option to use data classification for file system backups.

Valid values are True/False.

commonBackupSet

backupsetProperties

isWildCardContentBackupSet

The option for the backup set to support wildcards.

Valid values are True/False.

commonBackupSet

backupsetProperties

newBackupSetName

The new name of the backup set if the name should be updated.

commonBackupSet

backupsetProperties

onDemandBackupset

The option to set the backup set as an on demand backup set.

Valid values are True/False.

commonBackupSet

backupsetProperties

siloCopyId

The system-generated ID assigned to the silo copy.

commonBackupSet

backupsetProperties

userDescription

The description of the backup set.

commonBackupSet

backupsetProperties

fLRrepSetId

fsBackupSet

backupsetProperties

flrRepSetName

fsBackupSet

backupsetProperties

netAppImageBackup

Valid values are True/False.

fsBackupSet

backupsetProperties

pre70SystemStateArchiveFilesExist

Valid values are True/False.

fsBackupSet

backupsetProperties

preserveFileAccessTimes

The option to prevent the file access time from being changed as a result of running data protection operations.

Valid values are True/False.

fsBackupSet

backupsetProperties

useArchiveBit

The option to check whether files are considered modified and therefore backed up based on either the state of the archive bit or the file modification time.

Valid values are True/False.

fsBackupSet

backupsetProperties

useChangeJournal

The option to backup all of the new or changed data since the last incremental or full backup, ignoring any differential backups performed prior to the current backup.

Valid values are True/False.

fsBackupSet

backupsetProperties

useDCserviceForScan

The option to maintain a separate database to track changes in the files. Use this option when scanning a large number of files and folders for the backup.

Valid values are True/False.

fsBackupSet

backupsetProperties

Response

Response Parameters

Parameter

Description

Element

errorCode

The possible error codes.

Valid values are:

0, successful completion.
2, a failure.
a specific error code.

response

Examples

Sample Request

This request uses the ID.

POST <webservice>/Backupset/9 HTTP/1.1
 Host: client.mydomain.com
 Accept: application/xml
 Authtoken: QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc6
 0f4dab8a63347d05cf5552484dafda3bfa4c5db84e580b1cb37bcf8e65b39f7f
 8549a443e6f78a2c7be3f31b3d845e24776c835e498e8e883bb40c46bd15af4f
 40ca94e823acedcdd4e9659e74b34a07a85c4586cd2ed914b6dce015874783ef7
 68fda78183a4208930954a377f66eb56c8b92cexampl4s437a19317ca6ce7f323
 3d5a01aca35dbad93468b833f2cf71010809006a937670adce711ca8be46638e8
 Content-type: application/xml
 <App_SetBackupsetPropertiesRequest>
   <association>
     <entity>
       <appName>File System</appName> 
       <clientName>client001</clientName>
       <instanceName>DefaultInstanceName</instanceName>
       <backupsetName>Back_44</backupsetName>
     </entity>
   </association>
   <backupsetProperties>
     <commonBackupSet>
       <newBackupSetName>Back_55</newBackupSetName>
     </commonBackupSet>
   </backupsetProperties>
 </App_SetBackupsetPropertiesRequest>

This request uses the name.

POST <webservice>/Backupset/byName(clientName='client001',appName='File System',backupsetName='Back_44') HTTP/1.1
 Host: client.mydomain.com
 Accept: application/xml
 Authtoken: QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc6
 0f4dab8a63347d05cf5552484dafda3bfa4c5db84e580b1cb37bcf8e65b39f7f
 8549a443e6f78a2c7be3f31b3d845e24776c835e498e8e883bb40c46bd15af4f
 40ca94e823acedcdd4e9659e74b34a07a85c4586cd2ed914b6dce015874783ef7
 68fda78183a4208930954a377f66eb56c8b92cexampl4s437a19317ca6ce7f323
 3d5a01aca35dbad93468b833f2cf71010809006a937670adce711ca8be46638e8
 Content-type: application/xml
 <App_SetBackupsetPropertiesRequest>
   <association>
     <entity>
       <appName>File System</appName> 
       <clientName>client001</clientName>
       <instanceName>DefaultInstanceName</instanceName>
       <backupsetName>Back_44</backupsetName>
     </entity>
   </association>
   <backupsetProperties>
     <commonBackupSet>
       <newBackupSetName>Back_55</newBackupSetName>
     </commonBackupSet>
   </backupsetProperties>
 </App_SetBackupsetPropertiesRequest>

Sample Response

<App_SetBackupsetPropertiesResponse>
   <response errorCode="0"/>
 </App_SetBackupsetPropertiesResponse>