Get Subclient Properties By Name
Select
SaaS
Customer Managed
This operation returns the properties associated with a subclient.
Path Parameters
- clientname string required
Name of the client
- appname string required
Name of the application
- backupsetname string required
Name of the backup set
- subclientname string required
Name of the subclient
Responses
- 200
OK
- application/json
- Schema
- Example (from schema)
- Example 1
Schema
subClientProperties object[]
hcSubclientProp object
impersonateUser object
userName stringproxyClient object
subClientEntity object
clientName stringinstanceName stringbackupsetId integer_type_ integerinstanceId integersubclientId integerclientId integerappName stringbackupsetName stringapplicationId integersubclientName stringdfsSubclientProp object
distributedDataAccessNodes object
fsSubClientProp object
catalogACL booleansyncQueue stringarchiverRetention booleanblockLevelSPOSBackup integerbackupPrivateAuthority booleanenableFolderLevelMultiThread booleanbigFileSize integerbackupAsObjects booleanuseGlobalFilters integerbackupFilesQualifiedForArchive booleansyncAllLibForBackup booleanbackupFileTimeZoneName stringvssOptions integeruseVSSForSystemState booleanolderFileVersionsMode integerblockLevelBackup integerbackupRetentionMode integerdeletePSTFileOnly booleantxtlibSyncCheckPoint stringcustomSubclientContentFlags integersaveAccessPath stringunixCtime booleankeepVersions integerbackupRetention booleanscanOption integerbackupFilesAsExtents booleanbackupSystemState booleanafterDeletionKeepItemsForNDays integersaveWhileActiveOpt stringuseIncremental booleanunixMtime booleanuseVssForAllFilesOptions integerrunTrueUpJobAfterJobsForFS integercatalogAdditional booleanoneTouchSubclient booleanextendRetentionForNDays integercustomSubclientFlag booleanisTrueUpOptionEnabledForFS booleanenableOCSBackupOnSubclient booleanfolderLevelThreadCount integertargetReleaseForBackupData stringretentionPolicy integerbackupSaveFileData booleanactiveWaitTime integerarchiverRetentionMode integerbackupFilesOnOrAfter booleanextentSize integerenableOnePass booleanrunTrueUpJobAfterDaysForFS integeruseVSS booleanisSynthfullRunAfterOnePassEnabledOnSubclient booleanuseSCPFilters booleanextendStoragePolicyRetention booleanbackupSpooledFileData booleanbackupQueueData booleanoneTouchServerDirectory stringkeepOlderVersionsForNDays integeribmiSubclientprop object
SRBootServerDir stringbackupConfiguration object
oneTouchServer object
clientId integer_type_ integerbackupFilesOnOrAfterDate object
_type_ integerdiskCleanupRules object
stubPruningOptions integerafterArchivingRule integerstubRetentionDaysOld integerenableRedundancyForDataBackedup booleanpatternMatch stringrulesToSatisfy integerentityMatch stringocsUserName object
userName stringplanEntity object
content object[]
path stringcommonProperties object
encryptionFlag integernumberOfBackupStreams integernextBackupTime integerisTurboSubclient booleanisKeepItemPastExpiryTime booleanonDemandSubClient booleantotalBackupSize integerlastBackupTime integerindexingBackupSubClient booleandescription stringsubClientPropertiesFlag integerlastBackupSize integeronlyBackupQualifiedArchivingFiles booleanallowVssForSnapbackup booleanenableBackupAfterDelay booleanexpandSymbolicLinks booleanenableAppleDoubleSupport booleanallowMultipleDataReaders booleanindexCycleToEveryBackupJobs integerexcludeFromSLA booleanreadBuffersize integerenableBackup booleansecurityAssociations object
ownerAssociations object
enableBackupAtDateTime object
TimeZoneID integertime integerturboNASClient object
clientId integer_type_ integerassociatedSnapShotSCId object
_type_ integersubclientId integersnapCopyInfo object
snapToTapeProxyToUseSource booleanisSnapBackupEnabled booleanbackupCopyInterface integerIsOracleSposDriverEnabled booleanisRMANEnableForTapeMovement booleanuseProxyForSQLIntegrity object
sybaseUser object
snapToTapeSelectedEngine object
_type_ integersqlUser object
snapToTapeProxyToUse object
clientId integer_type_ integerquiesceImpersonateUser object
separateProxyForSnapToTape object
_type_ integerconfiguredSybaseInstance object
_type_ integerprepostProcess object
runPostScan integerrunPostBackup integerrunPostLog integerprepostUserName object
security object
clientOwners string[]associatedUserGroups object[]
userGroupId integer_type_ integeruserGroupName stringownerCapabilities object
storageDevice object
networkAgents integeroverrideIncrementalDataPath booleanapplicableReadSize integersoftwareCompression integeroverrideDataPath booleanthrottleNetworkBandwidth integerdataBackupStoragePolicy object
_type_ integerstoragePolicyName stringstoragePolicyId integerdeDuplicationOptions object
enableDeduplication booleangenerateSignature integerlogBackupStoragePolicy object
_type_ integerperformanceMode object
perfSPName stringmultiplexingValid booleanenableMultiplexing booleanperfCopyName stringperfClientName stringstreamsOverMux booleanpipelineBufferSize integernumOfPipelineBuffers integermuxFactor integerlookAheadReaderSlots integerperfCRCDetails object[]
crcOverMedia booleanperfMaId integercrcOverNetwork booleanperfMa stringassociatedPolicy object
subclientPolicyId integeranalyticsSubclientProp object
{
"subClientProperties": [
{
"hcSubclientProp": {},
"impersonateUser": {
"userName": "string"
},
"proxyClient": {},
"subClientEntity": {
"clientName": "string",
"instanceName": "string",
"backupsetId": 0,
"_type_": 0,
"instanceId": 0,
"subclientId": 0,
"clientId": 0,
"appName": "string",
"backupsetName": "string",
"applicationId": 0,
"subclientName": "string"
},
"dfsSubclientProp": {
"distributedDataAccessNodes": {}
},
"fsSubClientProp": {
"catalogACL": true,
"syncQueue": "string",
"archiverRetention": true,
"blockLevelSPOSBackup": 0,
"backupPrivateAuthority": true,
"enableFolderLevelMultiThread": true,
"bigFileSize": 0,
"backupAsObjects": true,
"useGlobalFilters": 0,
"backupFilesQualifiedForArchive": true,
"syncAllLibForBackup": true,
"backupFileTimeZoneName": "string",
"vssOptions": 0,
"useVSSForSystemState": true,
"olderFileVersionsMode": 0,
"blockLevelBackup": 0,
"backupRetentionMode": 0,
"deletePSTFileOnly": true,
"txtlibSyncCheckPoint": "string",
"customSubclientContentFlags": 0,
"saveAccessPath": "string",
"unixCtime": true,
"keepVersions": 0,
"backupRetention": true,
"scanOption": 0,
"backupFilesAsExtents": true,
"backupSystemState": true,
"afterDeletionKeepItemsForNDays": 0,
"saveWhileActiveOpt": "string",
"useIncremental": true,
"unixMtime": true,
"useVssForAllFilesOptions": 0,
"runTrueUpJobAfterJobsForFS": 0,
"catalogAdditional": true,
"oneTouchSubclient": true,
"extendRetentionForNDays": 0,
"customSubclientFlag": true,
"isTrueUpOptionEnabledForFS": true,
"enableOCSBackupOnSubclient": true,
"folderLevelThreadCount": 0,
"targetReleaseForBackupData": "string",
"retentionPolicy": 0,
"backupSaveFileData": true,
"activeWaitTime": 0,
"archiverRetentionMode": 0,
"backupFilesOnOrAfter": true,
"extentSize": 0,
"enableOnePass": true,
"runTrueUpJobAfterDaysForFS": 0,
"useVSS": true,
"isSynthfullRunAfterOnePassEnabledOnSubclient": true,
"useSCPFilters": true,
"extendStoragePolicyRetention": true,
"backupSpooledFileData": true,
"backupQueueData": true,
"oneTouchServerDirectory": "string",
"keepOlderVersionsForNDays": 0,
"ibmiSubclientprop": {
"SRBootServerDir": "string"
},
"backupConfiguration": {},
"oneTouchServer": {
"clientId": 0,
"_type_": 0
},
"backupFilesOnOrAfterDate": {
"_type_": 0
},
"diskCleanupRules": {
"stubPruningOptions": 0,
"afterArchivingRule": 0,
"stubRetentionDaysOld": 0,
"enableRedundancyForDataBackedup": true,
"patternMatch": "string",
"rulesToSatisfy": 0,
"entityMatch": "string"
},
"ocsUserName": {
"userName": "string"
}
},
"planEntity": {},
"content": [
{
"path": "string"
}
],
"commonProperties": {
"encryptionFlag": 0,
"numberOfBackupStreams": 0,
"nextBackupTime": 0,
"isTurboSubclient": true,
"isKeepItemPastExpiryTime": true,
"onDemandSubClient": true,
"totalBackupSize": 0,
"lastBackupTime": 0,
"indexingBackupSubClient": true,
"description": "string",
"subClientPropertiesFlag": 0,
"lastBackupSize": 0,
"onlyBackupQualifiedArchivingFiles": true,
"allowVssForSnapbackup": true,
"enableBackupAfterDelay": true,
"expandSymbolicLinks": true,
"enableAppleDoubleSupport": true,
"allowMultipleDataReaders": true,
"indexCycleToEveryBackupJobs": 0,
"excludeFromSLA": true,
"readBuffersize": 0,
"enableBackup": true,
"securityAssociations": {
"ownerAssociations": {}
},
"enableBackupAtDateTime": {
"TimeZoneID": 0,
"time": 0
},
"turboNASClient": {
"clientId": 0,
"_type_": 0
},
"associatedSnapShotSCId": {
"_type_": 0,
"subclientId": 0
},
"snapCopyInfo": {
"snapToTapeProxyToUseSource": true,
"isSnapBackupEnabled": true,
"backupCopyInterface": 0,
"IsOracleSposDriverEnabled": true,
"isRMANEnableForTapeMovement": true,
"useProxyForSQLIntegrity": {},
"sybaseUser": {},
"snapToTapeSelectedEngine": {
"_type_": 0
},
"sqlUser": {},
"snapToTapeProxyToUse": {
"clientId": 0,
"_type_": 0
},
"quiesceImpersonateUser": {},
"separateProxyForSnapToTape": {
"_type_": 0
},
"configuredSybaseInstance": {
"_type_": 0
}
},
"prepostProcess": {
"runPostScan": 0,
"runPostBackup": 0,
"runPostLog": 0,
"prepostUserName": {}
},
"security": {
"clientOwners": [
"string"
],
"associatedUserGroups": [
{
"userGroupId": 0,
"_type_": 0,
"userGroupName": "string"
}
],
"ownerCapabilities": {}
},
"storageDevice": {
"networkAgents": 0,
"overrideIncrementalDataPath": true,
"applicableReadSize": 0,
"softwareCompression": 0,
"overrideDataPath": true,
"throttleNetworkBandwidth": 0,
"dataBackupStoragePolicy": {
"_type_": 0,
"storagePolicyName": "string",
"storagePolicyId": 0
},
"deDuplicationOptions": {
"enableDeduplication": true,
"generateSignature": 0
},
"logBackupStoragePolicy": {
"_type_": 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"
}
]
}
},
"associatedPolicy": {
"subclientPolicyId": 0
}
},
"analyticsSubclientProp": {}
}
]
}
{
"subClientProperties": [
{
"hcSubclientProp": {},
"impersonateUser": {
"userName": ""
},
"proxyClient": {},
"subClientEntity": {
"clientName": "firewalltestcs",
"instanceName": "DefaultInstanceName",
"backupsetId": 3,
"_type_": 7,
"instanceId": 1,
"subclientId": 49,
"clientId": 2,
"appName": "File System",
"backupsetName": "defaultBackupSet",
"applicationId": 33,
"subclientName": "TestFSAPI"
},
"dfsSubclientProp": {
"distributedDataAccessNodes": {}
},
"fsSubClientProp": {
"catalogACL": false,
"syncQueue": "",
"archiverRetention": false,
"blockLevelSPOSBackup": 0,
"backupPrivateAuthority": false,
"enableFolderLevelMultiThread": false,
"bigFileSize": 1024,
"backupAsObjects": false,
"useGlobalFilters": 2,
"backupFilesQualifiedForArchive": false,
"syncAllLibForBackup": false,
"backupFileTimeZoneName": "",
"vssOptions": 2,
"useVSSForSystemState": true,
"olderFileVersionsMode": 1,
"blockLevelBackup": 0,
"backupRetentionMode": 1,
"deletePSTFileOnly": false,
"txtlibSyncCheckPoint": "",
"customSubclientContentFlags": 0,
"saveAccessPath": "*SYSVAL",
"unixCtime": true,
"keepVersions": 0,
"backupRetention": false,
"scanOption": 2,
"backupFilesAsExtents": false,
"backupSystemState": false,
"afterDeletionKeepItemsForNDays": 730,
"saveWhileActiveOpt": "",
"useIncremental": false,
"unixMtime": true,
"useVssForAllFilesOptions": 3,
"runTrueUpJobAfterJobsForFS": 0,
"catalogAdditional": false,
"oneTouchSubclient": false,
"extendRetentionForNDays": -1,
"customSubclientFlag": false,
"isTrueUpOptionEnabledForFS": true,
"enableOCSBackupOnSubclient": false,
"folderLevelThreadCount": 0,
"targetReleaseForBackupData": "",
"retentionPolicy": 0,
"backupSaveFileData": false,
"activeWaitTime": 0,
"archiverRetentionMode": 2,
"backupFilesOnOrAfter": false,
"extentSize": 4,
"enableOnePass": false,
"runTrueUpJobAfterDaysForFS": 30,
"useVSS": true,
"isSynthfullRunAfterOnePassEnabledOnSubclient": false,
"useSCPFilters": false,
"extendStoragePolicyRetention": false,
"backupSpooledFileData": false,
"backupQueueData": false,
"oneTouchServerDirectory": "",
"keepOlderVersionsForNDays": 30,
"ibmiSubclientprop": {
"SRBootServerDir": ""
},
"backupConfiguration": {},
"oneTouchServer": {
"clientId": 0,
"_type_": 3
},
"backupFilesOnOrAfterDate": {
"_type_": 55
},
"diskCleanupRules": {
"stubPruningOptions": 0,
"afterArchivingRule": 1,
"stubRetentionDaysOld": 0,
"enableRedundancyForDataBackedup": true,
"patternMatch": "",
"rulesToSatisfy": 1,
"entityMatch": ""
},
"ocsUserName": {
"userName": ""
}
},
"planEntity": {},
"content": [
{
"path": "C:/csguid.PNG"
},
{
"path": "C:/DEMO_3.pptx"
},
{
"path": "C:/fw10_tppm.doc"
},
{
"path": "C:\\removeGUIDKeyFromClientGroup.sqle"
},
{
"path": "C:\\test.jpg"
},
{
"path": "C:/v11SP4a.xml"
},
{
"path": "C:/wf.txt"
},
{
"path": "C:/WORKQUEUE_TASK.docx"
},
{
"path": "C:\\testimg.jpg"
},
{
"path": "C:/Siesta-Lake-Sunset.jpg"
}
],
"commonProperties": {
"encryptionFlag": 2,
"numberOfBackupStreams": 2,
"nextBackupTime": 0,
"isTurboSubclient": false,
"isKeepItemPastExpiryTime": true,
"onDemandSubClient": false,
"totalBackupSize": 5933719,
"lastBackupTime": 1496122319,
"indexingBackupSubClient": false,
"description": "",
"subClientPropertiesFlag": 0,
"lastBackupSize": 981264,
"onlyBackupQualifiedArchivingFiles": false,
"allowVssForSnapbackup": false,
"enableBackupAfterDelay": false,
"expandSymbolicLinks": false,
"enableAppleDoubleSupport": false,
"allowMultipleDataReaders": false,
"indexCycleToEveryBackupJobs": 0,
"excludeFromSLA": false,
"readBuffersize": 0,
"enableBackup": true,
"securityAssociations": {
"ownerAssociations": {}
},
"enableBackupAtDateTime": {
"TimeZoneID": 0,
"time": 0
},
"turboNASClient": {
"clientId": 0,
"_type_": 3
},
"associatedSnapShotSCId": {
"_type_": 7,
"subclientId": 0
},
"snapCopyInfo": {
"snapToTapeProxyToUseSource": false,
"isSnapBackupEnabled": false,
"backupCopyInterface": 0,
"IsOracleSposDriverEnabled": false,
"isRMANEnableForTapeMovement": false,
"useProxyForSQLIntegrity": {},
"sybaseUser": {},
"snapToTapeSelectedEngine": {
"_type_": 110
},
"sqlUser": {},
"snapToTapeProxyToUse": {
"clientId": 0,
"_type_": 3
},
"quiesceImpersonateUser": {},
"separateProxyForSnapToTape": {
"_type_": 3
},
"configuredSybaseInstance": {
"_type_": 5
}
},
"prepostProcess": {
"runPostScan": 0,
"runPostBackup": 0,
"runPostLog": 0,
"prepostUserName": {}
},
"security": {
"clientOwners": [
"testadmin"
],
"associatedUserGroups": [
{
"userGroupId": 1,
"_type_": 15,
"userGroupName": "master"
},
{
"userGroupId": 3,
"_type_": 15,
"userGroupName": "View All"
}
],
"ownerCapabilities": {}
},
"storageDevice": {
"networkAgents": 2,
"overrideIncrementalDataPath": false,
"applicableReadSize": 0,
"softwareCompression": 2,
"overrideDataPath": false,
"throttleNetworkBandwidth": 0,
"dataBackupStoragePolicy": {
"_type_": 17,
"storagePolicyName": "CSSP",
"storagePolicyId": 3
},
"deDuplicationOptions": {
"enableDeduplication": true,
"generateSignature": 1
},
"logBackupStoragePolicy": {
"_type_": 17
},
"performanceMode": {
"perfSPName": "CSSP",
"multiplexingValid": true,
"enableMultiplexing": false,
"perfCopyName": "Primary",
"perfClientName": "firewalltestcs",
"streamsOverMux": false,
"pipelineBufferSize": 64,
"numOfPipelineBuffers": 30,
"muxFactor": 0,
"lookAheadReaderSlots": 4,
"perfCRCDetails": [
{
"crcOverMedia": true,
"perfMaId": 2,
"crcOverNetwork": true,
"perfMa": "firewalltestcs"
}
]
}
},
"associatedPolicy": {
"subclientPolicyId": 0
}
},
"analyticsSubclientProp": {}
}
]
}
Loading...