Update DB2 MultiNode Subclient
Select
This operation is used to update the properties of a DB2 MultiNode's Backupset Subclient
Path Parameters
- SubclientID integer required
ID of the subclient
- application/json
Request Body
subClientProperties object
planEntity object
pass this parameters if you want to update plan of a subclient
planName stringName of the plan
planId integerID of the plan
commonProperties object
snapCopyInfo object
isSnapBackupEnabled booleanTrue if snap backup needs to be enabled
snapToTapeSelectedEngine object
pass this object to select snap vendor
snapShotEngineId integerID of the snapshot vendor
snapShotEngineName stringName of the snapshot vendor
snapToTapeProxyToUseSource booleanUse source if access node is unreachable
snapToTapeProxyToUse object
Pass this object if you want to set a proxy for snap backup
clientId integerId of client which should act as proxy
clientName stringName of client that should act as proxy
useSeparateProxyForSnapToTape booleanTrue if a proxy should be used for snap backup copy
backupCopyInterface stringseparateProxyForSnapToTape object
pass this object of seperate proxy to be used for backup copy
clientId integerID of the client
clientName stringName of the client
subClientEntity object
clientName stringinstanceName stringdisplayName stringbackupsetId integer_type_ integercommCellName stringinstanceId integercsGUID stringsubclientGUID stringsubclientId integerclientId integerappName stringbackupsetName stringapplicationId integersubclientName stringentityInfo object
companyId integercompanyName stringmultiCommcellId integerprepostProcess object
pass this object to use pre and post process commands
preBackupCommand stringpath for pre process command
postBackupCommand stringpath for post process command
oracleSubclientProp object
selectiveOnlineFull booleanbackupControlFile booleanbackupSPFile booleanuseRmanForLogBackup booleancontentOperationType integerdb2SubclientProp object required
Update subclient properties using the parameters below
db2BackupData booleanTrue if subclient should backup data
db2BackupMode integer1 for offline database , 0 for online database
db2BackupLogFiles booleanTrue if subclient should backup archived logs
db2DeleteLogFilesAfter booleanTrue to delete log files post log backup from archived location
skipLogsInBackupImage integerTrue if you want to exclude logs in backup image
db2UseDedupeDevice booleannumberOfBackupStreams integerNo.of streams the subclient should use for data backup
db2DpfStreams stringstreams to be used by each node in DB2 MultiNode setup
db2BackupType integer1 if subclient is using online subset
content object[]
pass this object if you want to edit content of subclient
db2Content object
db2TableSpace stringtablespace name
association object
entity object[]
pass this object to update general properties of subclient
clientName stringName of the client
instanceName stringName of the DB2 instance
displayName stringDisplay name of client in commcell
backupsetId integerID of the backupset
_type_ integercommCellName stringinstanceId integerID of the instance
csGUID stringsubclientGUID stringsubclientId integerID of the subclient
clientId integerID of the client
appName stringDB2 MultiNode
backupsetName stringName of the backupset (DB2 database)
applicationId integerPossible values: [
103
]103 for DB2 MultiNode
subclientName stringName of the subclient
entityInfo object
companyId integercompanyName stringmultiCommcellId integer
- 200
- 400
- 401
OK
Bad Request
Unauthorized
- application/json
- Schema
- Example (from schema)
- Example 1
Schema
- errorMessage string
- errorCode integer
{
"errorMessage": "string",
"errorCode": 0
}
{
"errorMessage": "Access denied",
"errorCode": 5
}