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 |
newName |
The new subclient name |
subClientEntity |
encryptionFlag |
Enable encryption Valid values are:
|
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:
|
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:
|
deDuplicationOptions |
generateSignature |
Deduplication signature generated on the client or MediaAgent computer. Valid values are:
|
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:
|
prepostProcess |
isSnapBackupEnabled |
Enable or disable IntelliSnap Valid values are:
|
snapCopyInfo |
snapShotEngineName |
The engine to use for an IntelliSnap backup. Valid values are in Available Parameters. |
snapCopyInfo |
snapToTapeProxyToUseSource |
Enable or disable using source if proxy is unreachable Valid values are:
|
snapCopyInfo |
snapToTapeProxyToUse |
The client name of the proxy for backup copy operations. |
snapCopyInfo |
isRMANEnableForTapeMovement |
Enable or disable RMAN for the copy to tape operation Valid values are:
|
snapCopyInfo |
backupCopyInterface |
The backup copy interface. Valid values are:
|
snapCopyInfo |
selectiveOnlineFull |
Enable or disable selective online full backups. Valid values are:
|
oracleSubclientProperties |
data |
Include datafiles and tablespaces in backups Valid values are:
|
oracleSubclientProperties |
backupMode |
Specifies manner in which data file backups for this Subclient are conducted. Valid values are:
|
oracleSubclientProperties |
contentOperationType |
This can only be set when the backupMode is 'ONLINE_SUBSET_DB.' Add or delete subclient content. Valid values are:
|
oracleSubclientProperties |
content/oracleContent/tableSpace |
This can only be set when the backupMode is 'ONLINE_SUBSET_DB.' Set this parameter to the tablespace name that you want to add to the subclient. |
oracleSubclientProperties |
content/oracleContent/dataFile |
This can only be set when the backupMode is 'ONLINE_SUBSET_DB.' Set this parameter to the datafile name that you want to add to the subclient. |
oracleSubclientProperties |
backupControlFile |
Back up the control file Valid values are:
|
oracleSubclientProperties |
backupSPFile |
Back up the SP file. Valid values are:
|
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:
|
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 |
sectionSizeInKB |
The size of each data file section (in KB) of an RMAN backup set. |
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:
|
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:
|
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:
|
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:
|
oracleSubclientProperties |
skipOffline |
Omit offline tablespaces from the backup. Valid values are:
|
oracleSubclientProperties |
skipInaccessible |
Omit inaccessible tablespaces from the backup. Valid values are:
|
oracleSubclientProperties |
validate |
Validate backup jobs for the subclient before they run. Valid values are:
|
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:
|
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:
|
oracleSubclientProperties |
resyncCatalog |
Synchronize the recovery catalog with the contents of the control file. Valid values are:
|
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:
|
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' and the archiveDeleteAll parameter is set to 'false'. Valid values are:
|
oracleSubclientProperties |
archiveDeleteAll |
Delete all archived redo log files once 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' and the archiveDelete parameter is set to 'false'. Valid values are:
|
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:
|
oracleSubclientProperties |
useRmanForLogBackup |
Perform a traditional RMAN backup instead of performing a snap backup for a IntelliSnap backup. This can be set when the selectiveOnlineFull parameter is 'false', the data parameter is 'true' and the isSnapBackupEnabled parameter is 'true'. Valid values are:
|
oracleSubclientProperties |
selectArchiveLogDestForBackup |
Add a location from where the archive logs are backed up. Valid values are:
|
oracleSubclientProperties |
archiveLogDestForBackupOpType |
Add or delete a backup location. Note: This can only be set when the selectArchiveLogDestForBackup parameter is 'true'. Valid values are:
|
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:
|
oracleSubclientProperties |
archiveLogDestForDeleteOpType |
Add or delete a location This can only be set when the selectArchiveLogDestForDelete parameter is 'true'. Valid values are:
|
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 |