The following table describes the supported SAP for Oracle subclient parameters.
Parameter |
Description of Parameter Values |
---|---|
appName |
Specifies the name of the application. In this case it would be 'Oracle RAC'. |
clientName |
Specifies the name of the client as displayed in the CommCell Browser (e.g., RacPseudoclient1). |
instanceName |
Specifies the name of the Oracle instance (e.g., racdb). |
subclientName |
Specifies the name of the Subclient (e.g. subclient1). |
encryptionFlag |
Specifies whether to enable encryption. Valid values are:
|
description |
Specifies the Subclient description. |
enableBackup |
Option to allow backup. Set this to 'true'. |
networkAgents |
Number of Network Agents (e.g., 2). Valid vales are 1-4. |
softwareCompression |
Specifies whether to enable compression on the Client or MediaAgent computer. Valid values are:
|
throttleNetworkBandwidth |
Enhancing backup performance by reducing network bandwidth overhead. Valid values are 0/1. |
applicableReadSize |
Specifies the amount of application data backup jobs will read for each unit transferred to the MediaAgent. |
dataBackupStoragePolicy/storagePolicyName |
Specifies the data backup storage policy. |
enableDeduplication |
Specifies whether to enable or disable deduplication. Valid values are true/false. |
generateSignature |
A component of deduplication performed on the client or MediaAgent computer. Valid values are:
|
isSnapBackupEnabled |
Specifies whether to enable or disable IntelliSnap. Valid values are true/false. |
snapShotEngineName |
Specifies the Snapshot Engine Name. |
snapToTapeProxyToUse/clientName |
Specifies the proxy server used for IntelliSnap backups. |
snapToTapeProxyToUseSource |
Specifies whether to use the source machine when the proxy is not available. Valid values are true/false. |
isRMANEnableForTapeMovement |
Specifies the RMAN for movement to media operations. Valid values are true/false. |
preBackupCommand |
Specifies the script to run before a backup starts. |
postBackupCommand |
Specifies the script to run after the backup completes. |
runPostBackup |
Specifies whether this process will execute for all attempts to run the phase. Valid values are YES/NO. |
selectiveOnlineFull |
Specifies whether selective online full backups will be performed for this Subclient. Valid values are true/false. |
data |
Specifies which tablespaces and datafiles will be backed up. Valid values are true/false. |
backupMode |
Specifies manner in which data file backups for this Subclient will be conducted. Valid values are:
|
contentOperationType |
This can only be set when the backupMode is 'ONLINE_SUBSET_DB.' Add or delete subclient content. Valid values are:
|
content/oracleContent/tableSpace |
This can only be set when the backupMode is 'ONLINE_SUBSET_DB.' Set this parameter to the tablspace name that you want to add to the subclient. |
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. |
backupControlFile |
Specifies whether the backup control file is backed up. Valid values are true/false. |
backupSPFile |
Specifies whether the Server Parameter File is backed up. Valid values are true/false. |
backupControlFile |
Specifies whether the backup control file is backed up. Valid values are true/false. |
backupSPFile |
Specifies whether the Server Parameter File is backed up. Valid values are true/false. |
protectBackupRecoveryArea |
Specifies whether to back up the Flash Recovery Area for Oracle 10g or higher versions. This is not supported when the "validate" parameter is 'true'. Valid values are true/false. |
dataFilesPerBFS |
Specifies the number of data files to be bundled in each RMAN backup set. Valid Values are 1-1000. |
maxBackupSetSIzeInKB |
Specifies the maximum size in KB for an RMAN backup set. Valid values are 1-1072693248. |
sectionSizeInKB |
The size of each data file section (in KB) of an RMAN backup set. |
archiveFilesPerBFS |
Specifies the number of archive files to be bundled in each RMAN backup set. This can be set when the "protectBackupRecoveryArea" parameter is 'true'. Valid values are 1-1072693248. |
maxOpenFiles |
Specifies the maximum number of concurrent open datafiles that the RMAN can read from simultaneously during a backup operation. Valid values are 0-1000. |
oracleTag |
Specifies the character string that is used as the Oracle Tag argument associated with Subclient backups. |
lightsOutScript |
Specifies whether the shutdown script will be automatically executed before backing up databases. This is available when the backupMode is 'OFFLINE_DB'. Valid values are true/false. |
warning |
Specifies whether to issue a message to the physical node for users logged into the database warning them that the database will be shut down. This can only be set when the "lightsOutScript" parameter is 'true'. Valid values are true/false. |
delayTimeinMin |
Specifies 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'. Valid values are 0-100. |
sleepTimeinMin |
Specifies 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 that 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'. Valid values are 0-59. |
sleepTimeinSec |
Specifies 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'. Valid values are 0-59. |
triesNumber |
Specifies the number of times that the system will retry attempts to shut down the database when the Sleep Time (sec) option is activated. This can only be set when the "lightsOutScript" parameter is 'true'. Valid values are 0-59. |
useSqlConnect |
Specifies if the CommServe connects to the Oracle RAC 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/false |
startupPFile |
Specifies the location of the PFile to be used with the shutdown script option. Select this option when you want the database to start using the PFile. This can only be set when the "lightsOutScript" parameter is 'true'. Valid value is the full path to the PFile. |
skipReadOnly |
Specifies whether to omit read-only tablespaces from the backup. Valid values are true/false. |
skipOffline |
Specifies whether to omit offline tablespaces from the backup. Valid values are true/false. |
skipInaccessible |
Specifies whether to omit inaccessible tablespaces from the backup. Valid values are true/false. |
validate |
Specifies whether to run a validate backup job. Valid values are true/false. |
enableTableBrowse |
Specifies that the Oracle iDataAgent gathers the database tables and user information during the backup so that the backup data can be displayed in a table view during a browse operation. 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/false. |
mergeImageCopies |
Specifies that you can create an image copy of a database, then regularly create incremental backups of the database and apply them to this image copy. Valid values are true/false. |
resyncCatalog |
Specifies whether the contents of the Recovery Catalog will be synchronized with the contents of the control file. Valid values are true/false. |
backupArchiveLog |
Specifies whether to back up or delete archived redo log files. This can be set when the "backupMode" parameter is 'ONLINE_DB' or 'ONLINE_SUBSET_DB'. Valid values are true/false. |
backupArchiveLogOption |
Specifies what option will be used. This can be set when the "backupMode" parameter is 'ONLINE_DB' or 'ONLINE_SUBSET_DB'. Valid values are:
|
archiveDelete |
Specifies whether archived redo log files will be deleted 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'. Valid values are true/false. |
logThresholdStreams |
Specifies the log threshold streams. This can be set when the "backupArchiveLog" parameter is 'true'. Valid values are -1, 1-50. |
selectArchiveLogDestForBackup |
Specifies whether you want to add a location from where the archive logs will be backed up. Valid values are true/false. |
archiveLogDestForBackupOpType |
Specifies whether you are adding or deleting a backup location. This can only be set when the "selectArchiveLogDestForBackup" parameter is 'true'. Valid values are:
|
archiveLogDestForBackup |
Specifies the location from where the archive logs will be backed up. This can only be set when the "selectArchiveLogDestForBackup" parameter is 'true' and the "archiveLogForDestOpType" is set. A valid value for this is a directory name (e.g. 'e:/u2/logs'). |
selectArchiveLogDestForDelete |
Specifies whether you want to add a location from where the archive logs will be deleted. Valid values are true/false. |
archiveLogDestForDeleteOpType |
Specifies whether you are adding or deleting a location. his can only be set when the "selectArchiveLogDestForDelete" parameter is 'true'. Valid values are:
|
archiveLogDestForDelete |
Specifies the location from where the archive logs will be deleted. This can only be set when the "selectArchiveLogDestForDelete" parameter is 'true' and the "archiveLogForDeleteOpType" is 'true' A valid value for this is a directory name (e.g. 'e:/u2/logs'). |
dataThresholdStreams |
Specifies the data threshold streams. Valid values are 1-50. |
tableSpace |
Specifies which tablespaces will be backed up. |
dataFile |
Specifies which datafiles will be backed up. |