Fetch Oracle subclient properties
This operation is used to fetch subclient properties
Path Parameters
- subclientId integer required
Subclient Id of the subclient whose properties need to be read
Responses
- 200
- 401
- 404
OK
- application/json
- Schema
- Example (from schema)
- Example 1
Schema
subClientProperties object[]
status integeruseLocalContent booleanuseLocalArchivalRules booleancanChangeEncryptionSetting booleanplanEntity objectcassandraProps objectsplunkProps objectproxyClient objectdcPlanEntity objectsubClientEntity object
Subclient General Properties
clientName stringinstanceName stringdisplayName stringbackupsetId integer_type_ integercommCellName stringinstanceId integercsGUID stringsubclientGUID stringsubclientId integerclientId integerappName stringbackupsetName stringapplicationId integersubclientName stringentityInfo object
companyId integercompanyName stringmultiCommcellId integerdfsSubclientProp objectoracleSubclientProp object
Subclient Oracle properties
imageCopyDir stringoracleTag stringdata booleanarchiveDelete booleanskipOffline booleanuseSQLConntect booleandbSubclientType integermergeIncImageCopies booleanskipReadOnly booleanwarning booleanarchiveDeleteAll booleantriesNumber integerselectArchiveLogDestForDelete booleanstartupPFile stringcheckLogical booleansleepTimeinMin integerbackupArchiveLogOption integerprotectBackupRecoveryArea booleansleepTimeinSec integerdelayTimeinMin integerlightsOutScript booleanlogThresholdStreams integerselectArchiveLogDestForBackup booleanmaxOpenFiles integermaxBackupSetSizeInKB integerbackupSPFile booleansnapImageCopy booleanbackupControlFile booleanskipInaccessible booleanbackupMode integerdisableSwitchCurrentLog booleanbackupArchiveLog booleanresyncCatalog booleanvalidate booleanuseRmanForLogBackup booleandataFilesPerBFS integerenableTableBrowse booleandataThresholdStreams integerarchiveFilesPerBFS integersectionSizeInKB integerdgInfo object
isDataGuardClient booleanlogPolicy integerdataPolicy integerarchiveOptions object
databaseName objecthistoryConnectUserAccount objectclient objectregion objectcommonProperties object
Subclient Advanced Options
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 integersecurityAssociations object
ownerAssociations objecttagWithCompany object
providerId integerproviderDomainName stringassociatedSnapShotSCId object
_type_ integersnapCopyInfo object
backupCopyInterface integerIsOracleSposDriverEnabled 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_ integerdeDuplicationOptions object
enableDeduplication booleangenerateSignature integerlogBackupStoragePolicy object
_type_ integerstoragePolicyName stringstoragePolicyId integerperformanceMode object
perfSPName stringperfCopyName stringperfClientName stringpipelineBufferSize 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 stringlastBackupJobInfo object
jobID integerfailureReasonIds stringcommCellID integerDefault value:
2
failureReasonMessageEnglish stringstatus integerDefault value:
1
startTime object
time integerendTime object
time integeranalyticsSubclientProp object
{
"subClientProperties": [
{
"status": 0,
"useLocalContent": true,
"useLocalArchivalRules": true,
"canChangeEncryptionSetting": true,
"planEntity": {},
"cassandraProps": {},
"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": {},
"oracleSubclientProp": {
"imageCopyDir": "string",
"oracleTag": "string",
"data": true,
"archiveDelete": true,
"skipOffline": true,
"useSQLConntect": true,
"dbSubclientType": 0,
"mergeIncImageCopies": true,
"skipReadOnly": true,
"warning": true,
"archiveDeleteAll": true,
"triesNumber": 0,
"selectArchiveLogDestForDelete": true,
"startupPFile": "string",
"checkLogical": true,
"sleepTimeinMin": 0,
"backupArchiveLogOption": 0,
"protectBackupRecoveryArea": true,
"sleepTimeinSec": 0,
"delayTimeinMin": 0,
"lightsOutScript": true,
"logThresholdStreams": 0,
"selectArchiveLogDestForBackup": true,
"maxOpenFiles": 0,
"maxBackupSetSizeInKB": 0,
"backupSPFile": true,
"snapImageCopy": true,
"backupControlFile": true,
"skipInaccessible": true,
"backupMode": 0,
"disableSwitchCurrentLog": true,
"backupArchiveLog": true,
"resyncCatalog": true,
"validate": true,
"useRmanForLogBackup": true,
"dataFilesPerBFS": 0,
"enableTableBrowse": true,
"dataThresholdStreams": 0,
"archiveFilesPerBFS": 0,
"sectionSizeInKB": 0,
"dgInfo": {
"isDataGuardClient": true,
"logPolicy": 0,
"dataPolicy": 0
},
"archiveOptions": {
"databaseName": {},
"historyConnectUserAccount": {},
"client": {}
}
},
"region": {},
"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,
"securityAssociations": {
"ownerAssociations": {},
"tagWithCompany": {
"providerId": 0,
"providerDomainName": "string"
}
},
"associatedSnapShotSCId": {
"_type_": 0
},
"snapCopyInfo": {
"backupCopyInterface": 0,
"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
},
"deDuplicationOptions": {
"enableDeduplication": true,
"generateSignature": 0
},
"logBackupStoragePolicy": {
"_type_": 0,
"storagePolicyName": "string",
"storagePolicyId": 0
},
"performanceMode": {
"perfSPName": "string",
"perfCopyName": "string",
"perfClientName": "string",
"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"
},
"lastBackupJobInfo": {
"jobID": 0,
"failureReasonIds": "string",
"commCellID": 2,
"failureReasonMessageEnglish": "string",
"status": 1,
"startTime": {
"time": 0
},
"endTime": {
"time": 0
}
}
},
"analyticsSubclientProp": {}
}
]
}
{
"subClientProperties": [
{
"status": 64,
"useLocalContent": false,
"useLocalArchivalRules": true,
"canChangeEncryptionSetting": true,
"planEntity": {},
"cassandraProps": {},
"splunkProps": {},
"proxyClient": {},
"dcPlanEntity": {},
"subClientEntity": {
"clientName": "oraserv1",
"instanceName": "ora1",
"displayName": "oraserv1",
"backupsetId": 4982,
"_type_": 7,
"commCellName": "CS1",
"instanceId": 4226,
"csGUID": "DDCEE9FA-7E8C-4C25-AEE2-D498FFA7445B",
"subclientGUID": "BCFF4EB5-C9CD-44E6-B3D1-B5B72077676B",
"subclientId": 8852,
"clientId": 1129,
"appName": "Oracle",
"backupsetName": "default",
"applicationId": 22,
"subclientName": "(command line)",
"entityInfo": {
"companyId": 0,
"companyName": "Commcell",
"multiCommcellId": 0
}
},
"dfsSubclientProp": {},
"oracleSubclientProp": {
"imageCopyDir": "",
"oracleTag": "",
"data": true,
"archiveDelete": true,
"skipOffline": false,
"useSQLConntect": false,
"dbSubclientType": 0,
"mergeIncImageCopies": false,
"skipReadOnly": false,
"warning": false,
"archiveDeleteAll": false,
"triesNumber": 3,
"selectArchiveLogDestForDelete": false,
"startupPFile": "",
"checkLogical": false,
"sleepTimeinMin": 1,
"backupArchiveLogOption": 0,
"protectBackupRecoveryArea": false,
"sleepTimeinSec": 10,
"delayTimeinMin": 2,
"lightsOutScript": false,
"logThresholdStreams": 1,
"selectArchiveLogDestForBackup": false,
"maxOpenFiles": 8,
"maxBackupSetSizeInKB": 0,
"backupSPFile": false,
"snapImageCopy": false,
"backupControlFile": true,
"skipInaccessible": false,
"backupMode": 0,
"disableSwitchCurrentLog": false,
"backupArchiveLog": true,
"resyncCatalog": false,
"validate": false,
"useRmanForLogBackup": false,
"dataFilesPerBFS": 32,
"enableTableBrowse": false,
"dataThresholdStreams": 1,
"archiveFilesPerBFS": 32,
"sectionSizeInKB": 0,
"dgInfo": {
"isDataGuardClient": false,
"logPolicy": 0,
"dataPolicy": 0
},
"archiveOptions": {
"databaseName": {},
"historyConnectUserAccount": {},
"client": {}
}
},
"region": {},
"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,
"securityAssociations": {
"ownerAssociations": {},
"tagWithCompany": {
"providerId": 0,
"providerDomainName": "Commcell"
}
},
"associatedSnapShotSCId": {
"_type_": 7
},
"snapCopyInfo": {
"backupCopyInterface": 1,
"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": -1,
"dataBackupStoragePolicy": {
"_type_": 17
},
"deDuplicationOptions": {
"enableDeduplication": true,
"generateSignature": 1
},
"logBackupStoragePolicy": {
"_type_": 17,
"storagePolicyName": "demoplan",
"storagePolicyId": 88
},
"performanceMode": {
"perfSPName": "CV_DEFAULT",
"perfCopyName": "DUMMY",
"perfClientName": "oraserv1",
"pipelineBufferSize": 64,
"numOfPipelineBuffers": 180,
"muxFactor": 0,
"lookAheadReaderSlots": 4,
"perfCRCDetails": [
{
"crcOverMedia": false,
"perfMaId": 1,
"crcOverNetwork": false,
"perfMa": "NO CLIENT"
}
]
}
},
"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": {}
}
]
}
Unauthorized
- application/json
- Schema
- Example (from schema)
- Example
Schema
- errorMessage string
- errorCode integer
{
"errorMessage": "string",
"errorCode": 0
}
{
"errorMessage": "Access Denied",
"errorCode": 5
}
Not found
- application/json
- Schema
- Example (from schema)
- Example
Schema
- errorMessage string
- errorCode integer
{
"errorMessage": "string",
"errorCode": 0
}
{
"errorMessage": "No client/instance is specified",
"errorCode": 4
}
Loading...