Loading...

REST API - POST Subclient Properties

This operation updates the properties associated with a subclient.

Request

Syntax

Send the request using either the ID or the name and either XML or 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

subclientId

The subclient ID for the subclient. If the subclient ID is not known, use the GET Subclient API to retrieve it.

Yes-for the request by ID

clientName

The client name for the subclient. If the client name is not known, use the GET Subclient API to retrieve it.

Yes-for the request by name

appName

The application name for the subclient. If the application name is not known, use the GET Subclient API to retrieve it.

Yes-for the request by name

backupsetName

The backup set name of the subclient. If the backup set name is not known, use the GET Subclient API to retrieve it.

Yes-for the request by name

subclientName

The subclient name of the subclient. If the subclient name is not known, use the GET Subclient 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 update_subclient_template.xml file required for this request. To work with a virtual machine, download the update_subclient_vm_template.xml or update_subclient_vm_template.json file. The following table displays the parameters for the request body.

Parameter

Description and Parameter Values

Element

Parent Element

appName

The name of the application.

Valid values are:

  • Active Directory
  • DB2
  • DB2 MultiNode
  • DB2 on UNIX
  • Documentum
  • Exchange Database
  • File System
  • Informix Database
  • MySQL
  • NAS
  • Notes Database
  • Oracle
  • Oracle RAC
  • PostgreSQL
  • SAP HANA
  • SAP for MAX DB
  • SAP for Oracle
  • Sharepoint Server
  • SQL Server
  • Sybase Database
  • Virtual Server

 

entity

association

clientName

The name of the client.

entity

association

instanceName

The name of the instance, for example: DefaultInstanceName.

entity

association

backupsetName

The name of the backup set. If the backup set name is not specified, the default backup set is used.

entity

association

subclientName

The name of the subclient.

entity

association

newName

The new name of the subclient.

App_UpdateSubClientPropertiesRequest

 

contentOperationType

The type of operation to perform on the subclient content. The content is defined in the content element. (To work with virtual machines, use the vmContentOperationType element.)

Valid values are:

  • ADD, to add content to the subclient.
  • OVERWRITE, to overwrite content for the subclient.

    Note: For File System agents, when you use OVERWRITE, you must define all of the content parameters you want to keep. For example, to update the subclient content and keep an existing exclusion defined for your content, you must do the following in your XML:

    <contentOperationType>OVERWRITE</contentOperationType>
    ...
    ...
    <content>
    <path>new_path_value</path>
    <excludepath>existing_exclude_value</excludepath>
    </content>

  • DELETE, to delete content from the subclient.

subClientProperties

App_UpdateSubClientPropertiesRequest

vmContentOperationType

The type of operation to perform on the subclient content when the content contains virtual machines. The virtual machines are defined in the children element. (To work with other content, use the contentOperationType element.)

Valid values are:

  • ADD, to add content to the subclient.
  • OVERWRITE, to overwrite content for the subclient.
  • DELETE, to delete content from the subclient.

subClientProperties

App_UpdateSubClientPropertiesRequest

datastoreFreespaceCheck

VMware: The option to set a threshhold for free space on a datastore. If the datastore for a virtual machine under the subclient does not have enough free space for a snapshot of the VM, the backup of that VM is skipped. Checking for freespace before running the backup avoids errors during the backup job.

Valid values are:

  • 0, to disable the free space check
  • 1, to enable the free space check

vsaSubclientProp

subClientProperties

datastoreFreespaceRequired

VMware: The percentage of free space that is required on the hosting datastores for snapshots of virtual machines under the subclient.

Valid values are 10 through 100.

vsaSubclientProp

subClientProperties

collectFileDetailsForSnap

VMware: The option to collect information about files, directories and volumes during IntelliSnap backup operations.

vsaSubclientProp

subClientProperties

collectFileDetails

VMware: The option to collect information about files, directories and volumes during backup operations.

vsaSubclientProp

subClientProperties

quiesceGuestFileSystemAndApplications

Applies To: Hypervisors that support a choice of application or crash consistent backups.

Whether to quiesce the file system and applications on the guest VM.

Valid values are:

  • False, Perform a crash-consistent backup.
  • True, Perform an application-consistent backup.

vsaSubclientProp

subClientProperties

useChangedTrackingOnVM

VMware: The option to use Changed Block Tracking (CBT) for all backups of virtual machines (VMs) under the subclient. CBT optimizes backups by reading only the allocated and modified portions of virtual machine disks.

Valid values are True/False.

vsaSubclientProp

subClientProperties

clientName

The option to set the proxy client for a NAS client. The proxy client is used for scan, backup, and stubbing operations.

Note: This parameter is used to assign the proxy client for OnePass for BlueArc, OnePass for Celerra, and OnePass for NetApp.

turboNASClient

commonProperties

encryptionFlag

The option to set the encryption points during backups.

Valid values are:

  • ENC_MEDIA_ONLY, to encrypt the backup data after transmission and prior to storage on the media.
  • ENC_NETWORK_AND_MEDIA, to encrypt the backup data before transmission. The data is stored encrypted on the media.
  • ENC_NETWORK_ONLY, to encrypt the backup data for transmission and then decrypt the data prior to storage on the media.
  • ENC_NONE, to disable data encryption.

commonProperties

subClientProperties

description

The description of the subclient.

commonProperties

subClientProperties

enableBackup

The option to enable/disable backup.

Valid values are True/False.

commonProperties

subClientProperties

numberOfBackupStreams

The option to set the number of backup streams.

commonProperties

subClientProperties

onDemandSubClient

The option to define the subclient as an on demand subclient.

commonProperties

subClientProperties

allowMultipleDataReaders

The option to allow multiple data reads for a single Windows physical drive or Unix mount point during backups on the subclient.

Valid values are True/False.

commonProperties

subClientProperties

networkAgents

The option to specify the number of processes the subclient uses to transfer data over a network.

Valid values are 1-4 on Windows computers or 1-2 on UNIX computers.

storageDevice

commonProperties

softwareCompression

The option to enable compression on the client or the MediaAgent computer.

Valid values are:

  • ON_CLIENT, to enable software compression on the client.
  • ON_MEDIAAGENT, to enable software compression on the MediaAgent.
  • USE_STORAGE_POLICY_SETTINGS, to use the software compression options defined on the storage policy.
  • OFF, to disable software compression.

storageDevice

commonProperties

throttleNetworkBandwidth

The maximum network bandwidth per network agent (in megabytes per hour).

Valid values are 2-2147483647.

storageDevice

commonProperties

applicableReadSize

The option to specify the amount of application data backup jobs will read for each unit transferred to the MediaAgent.

Valid kilobyte values are 64, 128, 256, 512, 1024, 2048, or 4096.

storageDevice

commonProperties

storagePolicyName

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

dataBackupStoragePolicy

storageDevice

enableDeduplication

The option to enable deduplication on the subclient.

Valid values are True/False.

deDuplicationOptions

storageDevice

generateSignature

A component of deduplication performed on the client or MediaAgent computer.

Valid values are:

  • ON_CLIENT, to enable signature generation on the client.
  • ON_MEDIA_AGENT, to enable signature generation on the MediaAgent.
  • OFF, to disable signature generation.

deDuplicationOptions

storageDevice

snapToTapeProxyToUseSource

The option to enable or disable using the source if the proxy is unreachable.

Valid values are True/False.

snapCopyInfo

commonProperties

isRMANEnableForTapeMovement

The option to enable or disable using RMAN for the backup copy.

snapCopyInfo

commonProperties

isSnapBackupEnabled

The option to enable or disable an IntelliSnap backup.

Valid values are True/False.

snapCopyInfo

commonProperties

snapShotEngineName

The name of the engine used for an IntelliSnap backup.

snapToTapeSelectedEngine

snapCopyInfo

clientName

The name of the client.

snapToTapeProxyToUse

snapCopyInfo

preScanCommand

The path to the pre-process script that runs before the scan phase.

prepostProcess

commonProperties

postScanCommand

The path to the post-process script that runs after the scan phase.

prepostProcess

commonProperties

preBackupCommand

The path to the pre-process script that runs before the backup.

prepostProcess

commonProperties

postBackupCommand

The path to the post-process script that runs after the backup.

prepostProcess

commonProperties

runPostBackup

The option to run a process after the backup completes.

Valid values are Yes/No.

prepostProcess

commonProperties

runAs

The option to specify the user name who has permission to run the pre-process and post-process scripts.

Valid values are:

  • USE_IMPERSONATION, to specify a user with the permission to run the scripts. When using this value, provide the user credentials.
  • USE_LOCAL_SYS_ADMIN, to use the administrator account to run the scripts.

prepostProcess

commonProperties

userName

The name of the user with permission to run the scripts defined in the prepostProcess element. This parameter must be used when the runAs parameter is set to USE_IMPERSONATION.

prepostUserName

prepostProcess

password

The password of the user with permission to run the scripts defined in the prepostProcess element. This parameter must be used when the runAs parameter is set to USE_IMPERSONATION.

prepostUserName

prepostProcess

expandSymbolicLinks

UNIX: The option to expand and back up the data paths in the symbolic links of the subclient content.

Valid values are True/False.

commonProperties

subClientProperties

useGlobalFilters

The option to enable global filters.

Valid values are:

  • ON, to enable global filters for the subclient.
  • USE_CELL_LEVEL_POLICY, to enable global filters if the Use Global Filters on All Subclients option is enabled on the Control Panel (Global Filters) dialog. If the option is disabled, USE_CELL_LEVEL_POLICY will disable global filters for the subclient.
  • OFF, to disable global filters.

fsSubClientProp

subClientProperties

useVSS

The option to enable/disable VSS (Volume Shadow Copy Service) to back up the file system data.

Valid values are True/False.

fsSubClientProp

subClientProperties

vssOptions

The option to use VSS (Volume Shadow Copy Service) for all files or for locked files only.

Valid values are:

  • USE_VSS_FOR_ALL_FILES, to use VSS snap for all files.
  • FOR_LOCKED_FILES_ONLY, to back up locked files.

fsSubClientProp

subClientProperties

useVSSForAllFilesOptions

The options to control what happens if the VSS snap fails because the VSS service is unavailable or it is unable to quiesce a volume. This parameter is available when the vssOptions parameter is set to USE_VSS_FOR_ALL_FILES.

Valid values are:

  • FAIL_THE_JOB, to fail the backup job if the VSS snap fails.
  • CONTINUE_AND_RESET_ACCESS_TIME, to reset the access time of the files when the VSS snap fails.
  • CONTINUE_AND_DO_NOT_RESET_ACCESS_TIME, to not reset the access time of the files when the VSS snap fails.

fsSubClientProp

subClientProperties

useVSSForSystemState

The option to enable/disable VSS (Volume Shadow Copy Service) to back up the system state.

Valid values are True/False.

fsSubClientProp

subClientProperties

backupSystemState

The option to enable/disable backing up the system state. This option should not be enabled in more than one subclient per backup set to avoid system state backup failures.

Valid values are True/False.

fsSubClientProp

subClientProperties

backupSystemStateforFullBkpOnly

The option to backup the system state only during full backups. This parameter is available when the backupSystemState parameter is set to True.

Valid values are True/False.

fsSubClientProp

subClientProperties

backupFilesQualifiedForArchive

The option to backup only the files that meet the archive rules.

Valid values are True/False.

fsSubClientProp

fsSubClientProp

oneTouchSubclient

The option to enable/disable 1-Touch Recovery on Linux file system agents. 1-Touch Recovery can be enabled on only one subclient within a backup set.

Valid values are True/False.

fsSubClientProp

subClientProperties

retentionRule

The option to define the retention period for files deleted by a user. When a synthetic full backup is run at the end of the specified retention period, the deleted files are dropped from the synthetic full backup.

Valid values are:

  • AFTER, to define the number of days to keep the deleted items available in the backup cycle. The number of days is defined in the daysToKeepItems parameter.
  • IMMEDIATELY, to drop the deleted items during the synthetic full backup.
  • NEVER, to never drop the deleted items during the synthetic full backup.

fsSubClientProp

subClientProperties

daysToKeepItems

The number of days to keep the deleted items available in the backup cycle. The number of days is calculated from the date the next incremental backup runs after the file is deleted. This parameter is available when the retentionRule parameter is set to AFTER.

Valid values are 1 - 9999999999.

fsSubClientProp

subClientProperties

keepAtLeastPreviousVersions

The number of previous file versions to retain after synthetic full backup jobs.

Valid values are 0-100.

fsSubClientProp

subClientProperties

deleteArchiveJob

The option to define the retention period for files deleted by an archiving job. When a synthetic full backup is run at the end of the specified retention period, the deleted files are dropped from the synthetic full backup.

Valid values are:

  • AFTER, to define the number of days to keep the deleted items available in the backup cycle. The number of days is defined in the deleteArchiveJobAfterDays parameter.
  • NEVER, to never drop the deleted items during the synthetic full backup.

fsSubClientProp

subClientProperties

deleteArchiveJobAfterDays

The number of days to keep the deleted items available in the backup cycle. The number of days is calculated from the date the next incremental backup runs after the file is deleted. This parameter is available when the deleteArchiveJob parameter is set to AFTER.

Valid values are 0-999.

fsSubClientProp

subClientProperties

userDeletedStubRetention

The option to define the retention period for stubs deleted by a user. When a synthetic full backup is run at the end of the specified retention period, the deleted files are dropped from the synthetic full backup.

Valid values are:

AFTER, to define the number of days to keep the deleted items available in the backup cycle. The number of days is defined in the userDeletedStubRetentionDays parameter.

NEVER, to never drop the deleted items during the synthetic full backup.

fsSubClientProp

subClientProperties

userDeletedStubRetentionDays

The number of days to keep the deleted items available in the backup cycle. The number of days is calculated from the date the next incremental backup runs after the file is deleted. This parameter is available when the userDeletedStubRetention parameter is set to AFTER.

Valid values are 0-999.

fsSubClientProp

subClientProperties

enableOnePass

The option to enable OnePass.

Valid values are True/False.

fsSubClientProp

subClientProperties

enableArchivingWithRules

The option to enable archiving with archive rules. This parameter is available when the enableOnePass parameter is set to True. Parameters under the <diskCleanupRules> element are available when the enableArchivingWithRules parameter is set to True.

Important: Once the enableArchivingWithRules parameter is set to True, the enableOnePass parameter cannot be set to False.

Valid values are True/False.

diskCleanupRules

fsSubClientProp

startCleaningIfLessThan

The option to stop archiving files based on the percentage of available free space on the volume. To ignore this rule, enter 100.

Valid values are 0-100.

diskCleanupRules

fsSubClientProp

stopCleaningIfupto

The option to archive files based on the percentage of available free space on the volume. To ignore this rule, enter 100.

Valid values are 0-100.

diskCleanupRules

fsSubClientProp

fileAccessTimeOlderThan

The option to archive files whose access time is older than the number of days specified. To ignore this rule, enter 0.

Valid values are 0-1000.

diskCleanupRules

fsSubClientProp

fileModifiedTimeOlderThan

The option to archive files whose modified time is older than the number of days specified. To ignore this rule, enter 0.

Valid values are 0-1000.

diskCleanupRules

fsSubClientProp

fileCreatedTimeOlderThan

For Windows file systems only, the option to archive files whose created time is older than the number of days specified. To ignore this rule, enter 0.

Valid values are 0-1000.

diskCleanupRules

fsSubClientProp

fileSizeGreaterThan

The option to archive files whose size is greater than the kilobytes specified. To ignore this rule, enter 0.

Valid values are 0 and greater.

diskCleanupRules

fsSubClientProp

maximumFileSize

The option to archive files whose size is lesser than or equal to the kilobytes specified. To ignore this rule, enter 0.

Valid values are 0 and greater.

diskCleanupRules

fsSubClientProp

archiveReadOnlyFiles

The option to archive the read only files.

Valid values are True/False.

diskCleanupRules

fsSubClientProp

afterArchivingRule

The option to replace the archived file with a stub or to delete the archived file.

Valid values are:

  • REPLACE_FILE_WITH_STUB
  • DELETE_THE_FILE

diskCleanupRules

fsSubClientProp

useNativeSnapshotToPreserveFileAccessTime

For Unix file systems only, the option to use a native snapshot to preserve the file access time.

Valid values are True/False.

diskCleanupRules

fsSubClientProp

catalogAdditional

The option to collect file and system data. The data is used in the Build-Your-Own Reports feature and the File Level Analytics Report.

Valid values are True/False.

fsSubClientProp

subClientProperties

catalogACL

The option to catalog ACLs (Access Control Lists).

Valid values are True/False.

fsSubClientProp

subClientProperties

deletePSTFileOnly

The option to delete the protected PST (personal storage table) files.

Valid values are True/False.

fsSubClientProp

subClientProperties

scanOption

The method used to scan files before performing a backup.

Valid values are:

  • CHANGE_JOURNAL, to use NTFS change journal to determine which files in the subclient are modified
  • OPTIMAL_SCAN, to scan a large number of files and folders for the backup (the system maintains a separate database to track changes in the files)
  • RECURSIVE_SCAN, to scan FAT volumes, UNC paths and volumes with no drive letter

fsSubClientProp

subClientProperties

preserveFileAccessTime

The option to preserve the file access time at the time of backup. This option may increase the time required to complete a backup.

Valid values are True/False.

fsSubClientProp

subClientProperties

checkArchiveBit

The option to reset the archive bit of every file backed up during incremental and differential backups.

Valid values are True/False.

fsSubClientProp

subClientProperties

selectiveOnlineFull

Enable or disable selective online full backups.

Valid values are:

  • true, enable on demand backups for the subclient
  • false, disable on demand backups for the subclient

oracleSubclientProp

subClientProperties

data

Include datafiles and tablespaces in backups.

Valid values are:

  • true, include datafiles and tablespaces
  • false, do not include datafiles and tablespaces

oracleSubclientProp

subClientProperties

backupMode

The option to define how the data file backups for this subclient are conducted.

Valid values are:

  • ONLINE_DB, perform an online backup of the database
  • ONLINE_SUBSET_DB, perform an online subset backup that includes tablespaces and datafiles
  • OFFLINE_DB, perform an offline (cold) backup of the database

oracleSubclientProp

subClientProperties

backupControlFile

Back up the control file.

Valid values are:

  • true, include the control file
  • false, do not include the control file

oracleSubclientProp

subClientProperties

backupSPFile

Back up the SP file.

Valid values are:

  • true, include the SP file
  • false, do not include the SP file

oracleSubclientProp

subClientProperties

protectBackupRecoveryArea

Back up the Flash Recovery Area (FRA) for Oracle 10g database or higher versions.

This is not supported when the validate parameter is set to true.

Valid values are:

  • true, back up the FRA
  • false, do not back up the FRA

oracleSubclientProp

subClientProperties

dataFilesPerBFS

The number of data files bundled in each RMAN backup set.

Valid values are 1-1000.

oracleSubclientProp

subClientProperties

maxBackupSetSizeInKB

The maximum size in kilobytes for the RMAN backup set.

Valid values are 1-1072693248.

oracleSubclientProp

subClientProperties

archiveFilesPerBFS

The number of archive files bundled in each RMAN backup set.

Valid values are 1-1072693248.

oracleSubclientProp

subClientProperties

maxOpenFiles

The maximum number of concurrent open datafiles that RMAN can read from simultaneously during a backup operation.

Valid values are 0-1000.

oracleSubclientProp

subClientProperties

oracleTag

The character string used as the Oracle Tag argument associated with subclient backups.

oracleSubclientProp

subClientProperties

lightsOutScript

The option to automatically execute the lights-out script before backing up databases.

This can only be set when the backupMode parameter is set to OFFLINE_DB.

Valid values are:

  • true, automatically execute the lights-out script
  • false, manually execute the lights-out script

oracleSubclientProp

subClientProperties

warning

The option to issue a message to the physical node for users logged into the database warning them that the database is shutting down.

This can only be set when the lightsOutScript parameter is set to true.

Valid values are:

  • true, issue a message
  • false, do not issue a message

oracleSubclientProp

subClientProperties

delayTimeinMin

The number of minutes the system should wait before attempting to shut down the database after the warning message is sent to the physical node.

This can only be set when the lightsOutScript parameter is set to true.

Valid values are 0-100.

oracleSubclientProp

subClientProperties

sleepTimeinMin

The interval in minutes the system should wait or sleep between attempts to shut down the database and check the status.

Note: This option is only activated when the number of tries limit has been reached for the Sleep Time (sec) option.

This can only be set when the lightsOutScript parameter is set to true.

Valid values are 0-59.

oracleSubclientProp

subClientProperties

sleepTimeinSec

The interval in seconds the system should wait or sleep between retry attempts.

This can only be set when the lightsOutScript parameter is set to true.

Valid values are 0-59.

oracleSubclientProp

subClientProperties

triesNumber

The number of times the system tries to shut down the database when the sleepTimeinSec parameter is set.

This can only be set when the lightsOutScript parameter is set to true.

Valid values are 0-59.

oracleSubclientProp

subClientProperties

useSQLConntect

The CommServe connects to the Oracle database using the SQL command 'Connect <Connect String> as sysdba'.

This can only be set when the lightsOutScript parameter is set to true.

Valid values are:

  • true, the CommServe database uses the SQL connect command
  • false, the CommServe database does not use the SQL connect command

oracleSubclientProp

subClientProperties

startupPFile

The location of the pfile used with the lights-out script option. Select this option to start the database by using the pfile.

This can only be set when the lightsOutScript parameter is set to true.

Valid value is the full path to the pfile.

oracleSubclientProp

subClientProperties

skipReadOnly

The option to omit read-only tablespaces from the backup.

Valid values are:

  • true, omit read-only tablespaces from the backup
  • false, include read-only tablespaces in the backup

oracleSubclientProp

subClientProperties

skipOffline

Omit offline tablespaces from the backup.

Valid values are:

  • true, omit offline tablespaces from the backup
  • false, include offline tablespaces in the backup

oracleSubclientProp

subClientProperties

skipInaccessible

Omit inaccessible tablespaces from the backup.

Valid values are:

  • true, omit inaccessible tablespaces from the backup
  • false, include inaccessible tablespaces in the backup

oracleSubclientProp

subClientProperties

validate

Validate backup jobs for the subclient before they run.

Valid values are:

  • true, validate the backup jobs
  • false, do not validate the backup jobs

oracleSubclientProp

subClientProperties

enableTableBrowse

The option to enable table level restores.

This is not supported when the validate parameter is set to true. This can be set when the backupMode parameter is set to ONLINE_DB or ONLINE_SUBSET_DB.

Valid values are:

  • true, enable table level restores
  • false, disable table level restores

oracleSubclientProp

subClientProperties

mergeIncImageCopies

The option to create an image copy of a database and to regularly create incremental backups of the database and apply them to this image copy.

Valid values are:

  • true, enable merged incremental backups
  • false, disable merged incremental backups

oracleSubclientProp

subClientProperties

resyncCatalog

The option to synchronize the recovery catalog with the contents of the control file.

Valid values are:

  • true, synchronize the recovery catalog with the contents of the control file
  • false, do not synchronize the recovery catalog with the contents of the control file

oracleSubclientProp

subClientProperties

backupArchiveLog

The option to back up the archive redo log.

This can only be set when the backupMode parameter is set to ONLINE_DB or ONLINE_SUBSET_DB.

Valid values are:

  • true, back up the archived redo log
  • false, do not back up the archived redo log

oracleSubclientProp

subClientProperties

archiveDelete

The option to delete the archived redo log files after they are backed up.

This can only be set when the backupMode parameter is set to ONLINE_DB or ONLINE_SUBSET_DB and the backupArchiveLog parameter is set to true.

Valid values are:

  • true, delete the archived redo logs
  • false, do not delete the archive redo logs

oracleSubclientProp

subClientProperties

disableSwitchCurrentLog

The option to disable log switching for the current redo log.

This can only be set when the data parameter is set to false and the selectiveOnlineFull parameter is set to false.

Valid values are:

  • true, disable log switching for the current redo log
  • false, enable log switching for the current redo log

oracleSubclientProp

subClientProperties

selectArchiveLogDestForBackup

The option to add a location from where the archive logs are backed up.

Valid values are:

  • true, add a location
  • false, do not add a location

oracleSubclientProp

subClientProperties

archiveLogDestForBackupOpType

The option to add or delete a backup location.

This can only be set when the selectArchiveLogDestForBackup parameter is set to true.

Valid values are:

  • ADD, add a location
  • DELETE, delete the location

oracleSubclientProp

subClientProperties

archiveLogDestForBackup

The location from where the archive logs are backed up.

This can only be set when the selectArchiveLogDestForBackup parameter is set to true and the archiveLogDestForBackupOpType parameter is set.

Valid value is a directory name, for example, e:/u2/logs.

oracleSubclientProp

subClientProperties

selectArchiveLogDestForDelete

The option to add a location from where the archive logs are deleted.

Valid values are:

  • true, add a location
  • false, do not add a location

oracleSubclientProp

subClientProperties

archiveLogDestForDeleteOpType

The option to add or delete a location.

This can only be set when the selectArchiveLogDestForDelete parameter is set to true.

Valid values are:

  • ADD, add a location
  • DELETE, delete the location

oracleSubclientProp

subClientProperties

archiveLogDestForDelete

The location from where the archive logs are deleted.

This can only be set when the selectArchiveLogDestForDelete parameter is set to true and the archiveLogDestForDeleteOpType is set to true.

Valid value is a directory name, for example, e:/u2/logs.

oracleSubclientProp

subClientProperties

dataThresholdStreams

The minimum number of streams to use to execute a backup.

This can only be used when the storagePolicyName parameter is set.

oracleSubclientProp

subClientProperties

path

The location of the content to back up. This parameter must be used with the contentOperationType parameter.

To add more than one path, add a <content> element for each path:

<content>
<path>datapath1</path>
</content>
<content>
<path>datapath2</path>
</content>
<content>
<path>datapath3</path>
</content>

Note:

  • To specify a wildcard in the content path, add \/\/ (back and forward slashes) at the end of the path to enable the detection of wildcard characters:

    <path>datapath*\/\/</path>

  • If you are using a UNC path to specify the content, use the impersonateUser element to provide the credentials of a user who has the privileges to access the network share (where the content resides).

content

subClientProperties

excludePath

The location of the content to exclude from the backup. This parameter must be used with the contentOperationType parameter.

content

subClientProperties

includePath

The location of the content to back up if the excludePath parameter is used but exceptions exist. This parameter must be used with the contentOperationType parameter.

content

subClientProperties

equalsOrNotEquals

Excludes the virtual machines, the datastore, or the ESX host that does not match the displayName parameter. This parameter must be used with the vmContentOperationType parameter.

Valid value is 1.

children

vmContent

displayName

Name of the virtual machine or datastore depending on the content type defined in the type parameter. This parameter must be used with the vmContentOperationType parameter.

To add more than one virtual machine, add a <children> element for each virtual machine:

<vmContent>
<children equalsOrNotEquals="1" name="" displayName="VM001" type="VMName"/>
<children equalsOrNotEquals="1" name="" displayName="VM002" type="VMName"/>
<children equalsOrNotEquals="1" name="" displayName="VM003" type="VMName"/>
</vmContent>

children

vmContent

type

The type of content to add to the subclient. This parameter must be used with the vmContentOperationType parameter.

Valid values are:

  • VMName, to add a virtual machine to the subclient content.
  • DATASTORE, to add a datastore to the subclient content. This only applies to VMware agents.

    For a complete list of values, see VSA Object Types.

children

vmContent

userName

The user name of the user who has the privileges to access the data on a network share when specifying UNC paths for the subclient content.

impersonateUser

subClientProperties

password

The password of the user who has the privileges to access the data on a network share when specifying UNC paths for the subclient content.

impersonateUser

subClientProperties

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

errorString

The description of the error code. Not all error codes have an error string.

response

Examples

Sample Request

This request adds an exclusion to what is backed up.

POST <webservice>/Subclient/15 HTTP/1.1
Host: client.mydomain.com
Accept: application/xml
Authtoken: QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc6
0f4dab8a63347d05cf5552484dafda3bfa4c5db84e580b1cb37bcf8e65b39f7f
8549a443e6f78a2c7be3f31b3d845e24776c835e498e8e883bb40c46bd15af4f
40ca94e823acedcdd4e9659e74b34a07a85c4586cd2ed914b6dce015874783ef7
68fda78183a4208930954a377f66eb56c8b92cexampl4s437a19317ca6ce7f323
3d5a01aca35dbad93468b833f2cf71010809006a937670adce711ca8be46638e8
Content-type: application/xml

<App_UpdateSubClientPropertiesRequest>
  <subClientProperties>
    <contentOperationType>ADD</contentOperationType>
    <content>
      <excludePath>C:\Log</excludePath>
    </content>
  </subClientProperties>
</App_UpdateSubClientPropertiesRequest>

This request adds virtual machines to a subclient.

POST <webservice>/Subclient/byName(clientName='client001',appName='file system',backupsetName='defaultBackupSet',subclientName='default') HTTP/1.1
Host: client.mydomain.com
Accept: application/xml
Authtoken: QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc6
0f4dab8a63347d05cf5552484dafda3bfa4c5db84e580b1cb37bcf8e65b39f7f
8549a443e6f78a2c7be3f31b3d845e24776c835e498e8e883bb40c46bd15af4f
40ca94e823acedcdd4e9659e74b34a07a85c4586cd2ed914b6dce015874783ef7
68fda78183a4208930954a377f66eb56c8b92cexampl4s437a19317ca6ce7f323
3d5a01aca35dbad93468b833f2cf71010809006a937670adce711ca8be46638e8
Content-type: application/xml

<App_UpdateSubClientPropertiesRequest>
  <association>
    <entity>
      <appName>Virtual Server</appName>
      <instanceName>DefaultInstanceName</instanceName>
      <backupsetName>defaultBackupSet</backupsetName>
      <clientName>client001</clientName>
      <subclientName>subclient001</subclientName>
    </entity>
  </association>
  <subClientProperties>
    <vmContentOperationType>ADD</vmContentOperationType>
    <vmContent>
      <children equalsOrNotEquals="1" name="" displayName="VM001" type="VMName"/>
      <children equalsOrNotEquals="1" name="" displayName="VM002" type="VMName"/>
      <children equalsOrNotEquals="1" name="" displayName="VM003" type="VMName"/>
    </vmContent>
  </subClientProperties>
</App_UpdateSubClientPropertiesRequest>

Sample Response

<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
<App_UpdateSubClientPropertiesResponse>
  <response errorCode="0"/>
</App_UpdateSubClientPropertiesResponse>

Last modified: 8/10/2018 4:18:09 PM