XML Parameters for Oracle Subclient Configuration

The following table describes the supported Oracle subclient parameters.

Parameter Description of Parameter Values Parent Element
appName The name of the application, oracle subClientEntity
clientName The name of the client computer, as displayed in the CommCell Console where the instance is located subClientEntity
instanceName The name of the Oracle instance subClientEntity
subclientName The subclient name subClientEntity
encryptionFlag Enable encryption

Valid values are:

  • ENC_MEDIA_ONLY, enable Media Only (MediaAgent Side) encryption
  • ENC_NETWORK_MEDIA, enable Network and Media (Agent Side) encryption
  • ENC_NETWORK_ONLY, enable Network Only (Agent Encrypts, MediaAgent Decrypts) encryption
  • ENC_NONE, no encryption
commonProperties
description The subclient description commonProperties
enableBackup Option to allow backups. Set this to 'true' commonProperties
networkAgents Number of network agents.

Range: 1-4.

storageDevice
softwareCompression Enable compression on the client or MediaAgent computer.

Valid values are:

  • ON_CLIENT, enable software compression on the client
  • ON_MEDIAAGENT, enable software compression on the MediaAgent
  • USE_STORAGE_POLICY_SETTINGS, use the software compression options defined on the storage policy
  • OFF, disable software compression
storageDevice
throttleNetworkBandwidth Enhance backup performance by reducing network bandwidth overhead.

Range: 2-2147483647.

storageDevice
applicableReadSize The amount of application data backup jobs read for each unit transferred to the MediaAgent. storageDevice
dataBackupStoragePolicy/storagePolicyName The data backup storage policy for the Oracle data backup. dataBackupStoragePolicy
enableDeduplication Enable or disable deduplication

Valid values are:

  • true, enable deduplication
  • false, disable deduplication
deDuplicationOptions
generateSignature Deduplication signature generated on the client or MediaAgent computer.

Valid values are:

  • ON_CLIENT, enable signature generation on the client
  • ON_MEDIA_AGENT, enable signature generation on the MediaAgent
  • OFF, disable the signature generation
deDuplicationOptions
preBackupCommand The script to run before a backup starts. prepostProcess
postBackupCommand The script to run after the backup completes. prepostProcess
runPostBackup Run the post-process script even if the restore job failed

Valid values are:

  • YES, run the script even if the job failed
  • NO, run the script only if the job succeeds
prepostProcess
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
oracleSubclientProperties
data Include datafiles and tablespaces in backups

Valid values are:

  • true, include datafiles and tablespaces
  • false, do not include datafiles and tablespaces
oracleSubclientProperties
backupMode Specifies manner in which 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
oracleSubclientProperties
backupControlFile Back up the control file

Valid values are:

  • true, include the control file
  • false, do not include the control file
oracleSubclientProperties
backupSPFile Back up the SP file.

Valid values are:

  • true, include the SP file
  • false, do not include the SP file
oracleSubclientProperties
protectBackupRecoveryArea Back up the Flash Recovery Area for Oracle 10g database or higher versions.

This is not supported when the validate parameter is 'true'.

Valid values are:

  • true, back up the FRA
  • false, do not back up the FRA
oracleSubclientProperties
tableSpace The tablespace to include in the backup. oracleSubclientProperties
dataFile The datafile to include in the backup. oracleSubclientProperties
dataFilesPerBFS The number of data files bundled in each RMAN backup set.

Range: 1-1000.

oracleSubclientProperties
maxBackupSetSIzeInKB The maximum size in KB for an RMAN backup set.

Range: 1-1072693248.

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

Range: 1-1072693248.

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

Range: 0-1000.

oracleSubclientProperties
oracleTag The character string that is used as the Oracle tag argument associated with Subclient backups. oracleSubclientProperties
lightsOutScript Automatically execute the lights-out script before backing up databases.

This can only be set when the backupMode is 'OFFLINE_DB'.

Valid values are:

  • true, automatically execute the lights-out script
  • false, manually execute the lights-out script
oracleSubclientProperties
warning Issue a message to the physical node for users logged into the database warning them that the database is shut down.

This can only be set when the lightsOutScript is 'true'.

Valid values are:

  • true, issue a message
  • false, do not issue a message
oracleSubclientProperties
delayTimeinMin The number of minutes that you want the system to wait after the warning message is sent to the physical node before attempting to shut down the database.

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

Range: 0-100.

oracleSubclientProperties
sleepTimeinMin The interval in minutes that you want the system to wait, or sleep, between retry 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 'true'.

Range: 0-59.

oracleSubclientProperties
sleepTimeinSec The interval in seconds that you want the system to wait, or sleep, between retry attempts.

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

Range: 0-59.

oracleSubclientProperties
triesNumber The number of times that the system will retry to shut down the database when the Sleep Time (sec) option is activated.

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

Range: 0-59.

oracleSubclientProperties
useSqlConnect 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 'true'.

Valid values are:

  • true, The CommServe database uses the SQL connect command
  • false, the CommServe database does not use the SQL connect command
oracleSubclientProperties
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 'true'.

A valid value is the full path to the pfile.

oracleSubclientProperties
skipReadOnly 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
oracleSubclientProperties
skipOffline Omit offline tablespaces from the backup.

Valid values are:

  • true, omit offline tablespaces from the backup
  • false, include offline tablespaces in the backup
oracleSubclientProperties
skipInaccessible Omit inaccessible tablespaces from the backup.

Valid values are:

  • true, omit inaccessible tablespaces from the backup
  • false, include inaccessible tablespaces in the backup
oracleSubclientProperties
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
oracleSubclientProperties
enableTableBrowse Enable table level restores

This is not supported when the 'validate' parameter is 'true'.

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

Valid values are:

  • true, enable table level restores
  • false, disable table level restores
oracleSubclientProperties
mergeImageCopies Create an image copy of a database, and 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
oracleSubclientProperties
resyncCatalog 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
oracleSubclientProperties
backupArchiveLog Back up the archive redo log

This can be set when the backupMode parameter is '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
oracleSubclientProperties
archiveDelete Delete the archived redo log files after they are backed up.

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

Valid values are:

  • true, delete the archived redo logs
  • false, do not delete the archive redo logs
oracleSubclientProperties
disableSwitchCurrentLog Disable log switching for the current redo log.

Note: This can only be set when the data parameter is 'false' and the selectiveOnlineFull parameter is 'false'.

Valid values are:

  • true, disable log switching for the current redo log
  • false, enable log switching for the current redo log
oracleSubclientProperties
selectArchiveLogDestForBackup Add a location from where the archive logs are backed up.

Valid values are:

  • true, add a location
  • false, do not add a location
oracleSubclientProperties
archiveLogDestForBackupOpType Add or delete a backup location.

Note: This can only be set when the selectArchiveLogDestForBackup parameter is 'true'.

Valid values are:

  • ADD, add a location
  • DELETE, delete the location
oracleSubclientProperties
archiveLogDestForBackup The location from where the archive logs are backed up.

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

A valid value is a directory name (for example, 'e:/u2/logs').

oracleSubclientProperties
selectArchiveLogDestForDelete Add a location from where the archive logs are deleted.

Valid values are:

  • true, add a location
  • false, do not add a location
oracleSubclientProperties
archiveLogDestForDeleteOpType Add or delete a location

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

Valid values are:

  • ADD, add a location
  • DELETE, delete the location
oracleSubclientProperties
archiveLogDestForDelete The location from where the archive logs are deleted.

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

A valid value is a directory name (for example, 'e:/u2/logs').

oracleSubclientProperties
dataThresholdStreams The minimum number of streams to use in order to execute a backup.

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

oracleSubclientProperties
newName The new client name when you rename a subclient. oracleSubclientProperties