Fetch DB2 MultiNode Subclient Properties
Select
SaaS
Customer Managed
This operation returns all properties of a DB2 MultiNode Backupset Subclient.
Path Parameters
- SubclientID integer required
ID of the subclient
Responses
- 200
- 400
- 401
- 404
OK
- application/json
- Schema
- Example (from schema)
- Subclient Properties of a D B2 Multinode Backupset
Schema
subClientProperties object[]
Subclient properties
status integeruseLocalContent booleanuseLocalArchivalRules booleancanChangeEncryptionSetting booleanplanEntity object
Details of plan associated to subclient
planType integerplanName stringplanSubtype integerplanId integercassandraProps objecttaPlanEntity objectsplunkProps objectproxyClient objectdcPlanEntity objectsubClientEntity object
Subclient Specific properties
clientName stringinstanceName stringdisplayName stringbackupsetId integer_type_ integercommCellName stringinstanceId integercsGUID stringsubclientGUID stringsubclientId integerclientId integerappName stringbackupsetName stringapplicationId integersubclientName stringentityInfo object
companyId integercompanyName stringmultiCommcellId integerdfsSubclientProp objectregion objectdb2SubclientProp object
Subclient Properties
db2DeleteLogFilesAfterTime integerskipLogsInBackupImage integerdb2BackupMode integernumberOfBackupStreams integerdb2UseDedupeDevice booleandb2DeleteLogFilesAfter booleandb2BackupLogFiles booleandb2BackupType integerdb2BackupData booleandb2DpfStreams stringcontent object[]
Content of Subclient
db2Content object
db2TableSpace stringdb2DataFile stringcommonProperties object
Common properties for subclients
nextBackupTime integerslaStatus integerisAdAppAwareSubclient booleandisableArchivingTurboRule booleanfirstBackupTime integerlastBackupTime integerindexingBackupSubClient booleanallowVssForSnapbackup booleanisActivityDisabledFromPolicy booleanisETCDSubclient booleanenableBackupAfterDelay booleanrunAs integerslaCategoryDescription stringonBoardCompanyId integersizeOnMedia integerenableBackup booleanencryptionFlag integernumberOfBackupStreams integeridaType integerrunTrueUpJobAfterDays integertotalBackupSize integerdedupeRatio integerisTrueUpOptionEnabled booleanslaCategory integersubClientPropertiesFlag integerlastBackupSize integerallowMultipleDataReaders booleansecurityAssociations object
ownerAssociations objecttagWithCompany object
providerId integerproviderDomainName stringassociatedSnapShotSCId object
_type_ integersnapCopyInfo object
snap info for subclient
IsOracleSposDriverEnabled booleanisRMANEnableForTapeMovement booleanuseProxyForSQLIntegrity objectsybaseUser objectsnapToTapeSelectedEngine object
_type_ integersqlUser objectvmApplicationUser objectsnapToTapeProxyToUse object
_type_ integerquiesceImpersonateUser objectseparateProxyForSnapToTape object
_type_ integersshKey objectconfiguredSybaseInstance object
_type_ integersubclientPolicy object
_type_ integersubclientPolicyName stringimpersonateUserCredentialinfo object
credentialId integercredentialName stringenableBackupAtDateTime object
TimeZoneID integertime integerturboNASClient object
_type_ integerprepostProcess object
runPostScan integerrunPostBackup integerrunPostLog integerprepostUserName objectsecurity object
associatedUserGroups object[]
userGroupId integer_type_ integeruserGroupName stringadvancedPrivacySettings object
isPasskeyFeatureEnabled booleanauthType integerisPrivacyFeatureEnabled booleanpasskeySettings object
enableAuthorizeForRestore booleanexpirationTime object
time integerownerCapabilities objectstorageDevice object
networkAgents integersoftwareCompression integerthrottleNetworkBandwidth integerdataBackupStoragePolicy object
_type_ integerstoragePolicyName stringstoragePolicyId integerdeDuplicationOptions object
enableDeduplication booleangenerateSignature integerlogBackupStoragePolicy object
_type_ integerstoragePolicyName stringstoragePolicyId integerperformanceMode object
perfSPName stringmultiplexingValid booleanenableMultiplexing booleanperfCopyName stringperfClientName stringstreamsOverMux booleanpipelineBufferSize integernumOfPipelineBuffers integermuxFactor integerlookAheadReaderSlots integerperfCRCDetails object[]
crcOverMedia booleanperfMaId integercrcOverNetwork booleanperfMa stringUNCScriptCredentialinfo object
credentialId integercredentialName stringvmBackupValidationSettings object
isAppValidationEnabled booleanbackupValidationThreadCount integersubTaskId integerisCustomAppEnabled booleanrunAsDevTestGroup booleantaskId integeruseSourceVMEsxToMount booleanuncScriptImpersonateUser object
userName stringprepostCredentialinfo object
credentialId integercredentialName stringassociatedPolicy object
subclientPolicyId integerguestCredentialinfo object
credentialId integercredentialName stringanalyticsSubclientProp object
{
"subClientProperties": [
{
"status": 0,
"useLocalContent": true,
"useLocalArchivalRules": true,
"canChangeEncryptionSetting": true,
"planEntity": {
"planType": 0,
"planName": "string",
"planSubtype": 0,
"planId": 0
},
"cassandraProps": {},
"taPlanEntity": {},
"splunkProps": {},
"proxyClient": {},
"dcPlanEntity": {},
"subClientEntity": {
"clientName": "string",
"instanceName": "string",
"displayName": "string",
"backupsetId": 0,
"_type_": 0,
"commCellName": "string",
"instanceId": 0,
"csGUID": "string",
"subclientGUID": "string",
"subclientId": 0,
"clientId": 0,
"appName": "string",
"backupsetName": "string",
"applicationId": 0,
"subclientName": "string",
"entityInfo": {
"companyId": 0,
"companyName": "string",
"multiCommcellId": 0
}
},
"dfsSubclientProp": {},
"region": {},
"db2SubclientProp": {
"db2DeleteLogFilesAfterTime": 0,
"skipLogsInBackupImage": 0,
"db2BackupMode": 0,
"numberOfBackupStreams": 0,
"db2UseDedupeDevice": true,
"db2DeleteLogFilesAfter": true,
"db2BackupLogFiles": true,
"db2BackupType": 0,
"db2BackupData": true,
"db2DpfStreams": "string"
},
"content": [
{
"db2Content": {
"db2TableSpace": "string",
"db2DataFile": "string"
}
}
],
"commonProperties": {
"nextBackupTime": 0,
"slaStatus": 0,
"isAdAppAwareSubclient": true,
"disableArchivingTurboRule": true,
"firstBackupTime": 0,
"lastBackupTime": 0,
"indexingBackupSubClient": true,
"allowVssForSnapbackup": true,
"isActivityDisabledFromPolicy": true,
"isETCDSubclient": true,
"enableBackupAfterDelay": true,
"runAs": 0,
"slaCategoryDescription": "string",
"onBoardCompanyId": 0,
"sizeOnMedia": 0,
"enableBackup": true,
"encryptionFlag": 0,
"numberOfBackupStreams": 0,
"idaType": 0,
"runTrueUpJobAfterDays": 0,
"totalBackupSize": 0,
"dedupeRatio": 0,
"isTrueUpOptionEnabled": true,
"slaCategory": 0,
"subClientPropertiesFlag": 0,
"lastBackupSize": 0,
"allowMultipleDataReaders": true,
"securityAssociations": {
"ownerAssociations": {},
"tagWithCompany": {
"providerId": 0,
"providerDomainName": "string"
}
},
"associatedSnapShotSCId": {
"_type_": 0
},
"snapCopyInfo": {
"IsOracleSposDriverEnabled": true,
"isRMANEnableForTapeMovement": true,
"useProxyForSQLIntegrity": {},
"sybaseUser": {},
"snapToTapeSelectedEngine": {
"_type_": 0
},
"sqlUser": {},
"vmApplicationUser": {},
"snapToTapeProxyToUse": {
"_type_": 0
},
"quiesceImpersonateUser": {},
"separateProxyForSnapToTape": {
"_type_": 0
},
"sshKey": {},
"configuredSybaseInstance": {
"_type_": 0
}
},
"subclientPolicy": {
"_type_": 0,
"subclientPolicyName": "string"
},
"impersonateUserCredentialinfo": {
"credentialId": 0,
"credentialName": "string"
},
"enableBackupAtDateTime": {
"TimeZoneID": 0,
"time": 0
},
"turboNASClient": {
"_type_": 0
},
"prepostProcess": {
"runPostScan": 0,
"runPostBackup": 0,
"runPostLog": 0,
"prepostUserName": {}
},
"security": {
"associatedUserGroups": [
{
"userGroupId": 0,
"_type_": 0,
"userGroupName": "string"
}
],
"advancedPrivacySettings": {
"isPasskeyFeatureEnabled": true,
"authType": 0,
"isPrivacyFeatureEnabled": true,
"passkeySettings": {
"enableAuthorizeForRestore": true,
"expirationTime": {
"time": 0
}
}
},
"ownerCapabilities": {}
},
"storageDevice": {
"networkAgents": 0,
"softwareCompression": 0,
"throttleNetworkBandwidth": 0,
"dataBackupStoragePolicy": {
"_type_": 0,
"storagePolicyName": "string",
"storagePolicyId": 0
},
"deDuplicationOptions": {
"enableDeduplication": true,
"generateSignature": 0
},
"logBackupStoragePolicy": {
"_type_": 0,
"storagePolicyName": "string",
"storagePolicyId": 0
},
"performanceMode": {
"perfSPName": "string",
"multiplexingValid": true,
"enableMultiplexing": true,
"perfCopyName": "string",
"perfClientName": "string",
"streamsOverMux": true,
"pipelineBufferSize": 0,
"numOfPipelineBuffers": 0,
"muxFactor": 0,
"lookAheadReaderSlots": 0,
"perfCRCDetails": [
{
"crcOverMedia": true,
"perfMaId": 0,
"crcOverNetwork": true,
"perfMa": "string"
}
]
}
},
"UNCScriptCredentialinfo": {
"credentialId": 0,
"credentialName": "string"
},
"vmBackupValidationSettings": {
"isAppValidationEnabled": true,
"backupValidationThreadCount": 0,
"subTaskId": 0,
"isCustomAppEnabled": true,
"runAsDevTestGroup": true,
"taskId": 0,
"useSourceVMEsxToMount": true,
"uncScriptImpersonateUser": {
"userName": "string"
}
},
"prepostCredentialinfo": {
"credentialId": 0,
"credentialName": "string"
},
"associatedPolicy": {
"subclientPolicyId": 0
},
"guestCredentialinfo": {
"credentialId": 0,
"credentialName": "string"
}
},
"analyticsSubclientProp": {}
}
]
}
{
"subClientProperties": [
{
"status": 0,
"useLocalContent": false,
"useLocalArchivalRules": true,
"canChangeEncryptionSetting": false,
"planEntity": {
"planType": 2,
"planName": "vikram trad dedup regression",
"planSubtype": 33554437,
"planId": 118
},
"cassandraProps": {},
"taPlanEntity": {},
"splunkProps": {},
"proxyClient": {},
"dcPlanEntity": {},
"subClientEntity": {
"clientName": "vikramdpf",
"instanceName": "dpfinst",
"displayName": "vikramdpf",
"backupsetId": 8937,
"_type_": 7,
"commCellName": "dbcs",
"instanceId": 5419,
"csGUID": "DDCEE9FA-7E8C-4C25-AEE2-D498FFA7445B",
"subclientGUID": "3FA82A18-73E5-4E9E-8F15-079C3D683EDD",
"subclientId": 15974,
"clientId": 1483,
"appName": "DB2 MultiNode",
"backupsetName": "DPFDB",
"applicationId": 103,
"subclientName": "multinode",
"entityInfo": {
"companyId": 0,
"companyName": "Commcell",
"multiCommcellId": 0
}
},
"dfsSubclientProp": {},
"region": {},
"db2SubclientProp": {
"db2DeleteLogFilesAfterTime": 0,
"skipLogsInBackupImage": 1,
"db2BackupMode": 0,
"numberOfBackupStreams": 8,
"db2UseDedupeDevice": true,
"db2DeleteLogFilesAfter": true,
"db2BackupLogFiles": true,
"db2BackupType": 1,
"db2BackupData": true,
"db2DpfStreams": "0,2 1,2 2,2 3,2"
},
"content": [
{
"db2Content": {
"db2TableSpace": "SYSCATSPACE_NODE0000",
"db2DataFile": "/home/dpfinst/dpfinst/NODE0000/DPFDB/T0000000/C0000000.CAT"
}
},
{
"db2Content": {
"db2TableSpace": "TEMPSPACE1_NODE0000",
"db2DataFile": "/home/dpfinst/dpfinst/NODE0000/DPFDB/T0000001/C0000000.TMP"
}
}
],
"commonProperties": {
"nextBackupTime": 0,
"slaStatus": 3,
"isAdAppAwareSubclient": false,
"disableArchivingTurboRule": false,
"firstBackupTime": 0,
"lastBackupTime": 0,
"indexingBackupSubClient": false,
"allowVssForSnapbackup": false,
"isActivityDisabledFromPolicy": false,
"isETCDSubclient": false,
"enableBackupAfterDelay": false,
"runAs": 0,
"slaCategoryDescription": "Recently Installed with No Finished Job",
"onBoardCompanyId": 0,
"sizeOnMedia": 0,
"enableBackup": true,
"encryptionFlag": 2,
"numberOfBackupStreams": 1,
"idaType": 0,
"runTrueUpJobAfterDays": 30,
"totalBackupSize": 0,
"dedupeRatio": 0,
"isTrueUpOptionEnabled": false,
"slaCategory": 10,
"subClientPropertiesFlag": 0,
"lastBackupSize": 0,
"allowMultipleDataReaders": true,
"securityAssociations": {
"ownerAssociations": {},
"tagWithCompany": {
"providerId": 0,
"providerDomainName": "Commcell"
}
},
"associatedSnapShotSCId": {
"_type_": 7
},
"snapCopyInfo": {
"IsOracleSposDriverEnabled": false,
"isRMANEnableForTapeMovement": false,
"useProxyForSQLIntegrity": {},
"sybaseUser": {},
"snapToTapeSelectedEngine": {
"_type_": 110
},
"sqlUser": {},
"vmApplicationUser": {},
"snapToTapeProxyToUse": {
"_type_": 3
},
"quiesceImpersonateUser": {},
"separateProxyForSnapToTape": {
"_type_": 3
},
"sshKey": {},
"configuredSybaseInstance": {
"_type_": 5
}
},
"subclientPolicy": {
"_type_": 65,
"subclientPolicyName": ""
},
"impersonateUserCredentialinfo": {
"credentialId": 0,
"credentialName": ""
},
"enableBackupAtDateTime": {
"TimeZoneID": 0,
"time": 0
},
"turboNASClient": {
"_type_": 3
},
"prepostProcess": {
"runPostScan": 0,
"runPostBackup": 0,
"runPostLog": 0,
"prepostUserName": {}
},
"security": {
"associatedUserGroups": [
{
"userGroupId": 1,
"_type_": 15,
"userGroupName": "master"
}
],
"advancedPrivacySettings": {
"isPasskeyFeatureEnabled": false,
"authType": 1,
"isPrivacyFeatureEnabled": false,
"passkeySettings": {
"enableAuthorizeForRestore": false,
"expirationTime": {
"time": 0
}
}
},
"ownerCapabilities": {}
},
"storageDevice": {
"networkAgents": 2,
"softwareCompression": 2,
"throttleNetworkBandwidth": 0,
"dataBackupStoragePolicy": {
"_type_": 17,
"storagePolicyName": "vikram trad dedup regression",
"storagePolicyId": 291
},
"deDuplicationOptions": {
"enableDeduplication": true,
"generateSignature": 1
},
"logBackupStoragePolicy": {
"_type_": 17,
"storagePolicyName": "vikram trad dedup regression",
"storagePolicyId": 291
},
"performanceMode": {
"perfSPName": "vikram trad dedup regression",
"multiplexingValid": false,
"enableMultiplexing": false,
"perfCopyName": "Primary",
"perfClientName": "vikramdpf",
"streamsOverMux": false,
"pipelineBufferSize": 64,
"numOfPipelineBuffers": 180,
"muxFactor": 0,
"lookAheadReaderSlots": 4,
"perfCRCDetails": [
{
"crcOverMedia": true,
"perfMaId": 1227,
"crcOverNetwork": true,
"perfMa": "vikram-win-man"
}
]
}
},
"UNCScriptCredentialinfo": {
"credentialId": 0,
"credentialName": ""
},
"vmBackupValidationSettings": {
"isAppValidationEnabled": false,
"backupValidationThreadCount": 0,
"subTaskId": 0,
"isCustomAppEnabled": false,
"runAsDevTestGroup": false,
"taskId": 0,
"useSourceVMEsxToMount": false,
"uncScriptImpersonateUser": {
"userName": "0"
}
},
"prepostCredentialinfo": {
"credentialId": 0,
"credentialName": ""
},
"associatedPolicy": {
"subclientPolicyId": 0
},
"guestCredentialinfo": {
"credentialId": 0,
"credentialName": ""
}
},
"analyticsSubclientProp": {}
}
]
}
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
}
Not Found
- application/json
- Schema
- Example (from schema)
- Example 1
Schema
- errorMessage string
- errorCode integer
{
"errorMessage": "string",
"errorCode": 0
}
{
"errorMessage": "Failed to get any subclient for given association. Check if it is valid",
"errorCode": 4
}
Loading...