The following table describes the supported Oracle subclient parameters.
Element |
Description of attribute values |
Parent Element |
---|---|---|
-appName |
The name of the application, 'Documentum'. |
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 Documentum instance. |
subClientEntity |
-subclientName |
The name of the subclient. |
subClientEntity |
-encryptionFlag {ENC_MEDIA_ONLY | ENC_NETWORK_MEDIA | ENC_NETWORK_ONLY | ENC_NONE} |
Enable encryption. 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 |
An intuitive description of the subclient. |
commonProperties |
-enableBackup {true | false} |
Allow backups. |
commonProperties |
-networkAgents {1 | 2 | 3 | 4} |
Number of network agents. |
storageDevice |
-softwareCompression {ON_CLIENT | ON_MEDIAAGENT | USE_STORAGE_POLICY_SETTINGS | OFF} |
Enable compression on the client or MediaAgent computer. ON_CLIENT Enable software compression on the client ON_MEDIAAGENT Enable software compression on the MediaAgent USE_STORAGE_POLICY_SETTINGS Use the software compression settings defined on the storage policy OFF Disable software compression |
storageDevice |
-throttleNetworkBandwidth |
Enhance backup performance by reducing the network bandwidth overhead. Range: 2-2147483647. |
storageDevice |
-dataBackupStoragePolicy/storagePolicyName |
The data backup storage policy for the Oracle data backup. |
dataBackupStoragePolicy |
-enableDeduplication {true | false} |
Enable or disable deduplication true Enable deduplication false Disable deduplication |
deDuplicationOptions |
-generateSignature {ON_CLIENT | ON_MEDIAAGENT | OFF} |
Deduplication signature generated on the client or MediaAgent computer. ON_CLIENT Enable signature generation on the client ON_MEDIA_AGENT Enable signature generation on the MediaAgent OFF Disable the signature generation |
deDuplicationOptions |
-dbProperties/preBackupProcess |
The script that is run before a database backup operation starts. |
prepostProcess |
-dbProperties/postBackupProcess |
The script that is run after the database backup operation ends. |
prepostProcess |
-ftiProperties/preBackupProcess |
The script that is run before an FTI backup operation starts. Specify the FTI server quiscescript. |
oracleSubclientProperties |
-ftiProperties/postBackupProcess |
The script that is run after an FTI backup operation ends. Specify the FTI server unquiscescript. |
oracleSubclientProperties |
-dbProperties/backupMode {db_backup_online | db_backup_offline} |
Specifies manner in which the data file backups for this subclient are conducted. db_backup_online Perform an online backup of the database db_backup_offline Perform an online subset backup that includes tablespaces and datafiles |
oracleSubclientProperties |
-backupControlFile {true | false} |
Include the control file in the backup. true Include the control file false Do not include the control file |
oracleSubclientProperties |
-backupSPFile {true | false} |
Include the Oracle System Parameter (SP) file in the backup. true Include the SP file false Exclude the SP file |
oracleSubclientProperties |
-backupSA {true | false} |
Include the storage area (sa) component in the backup. true Enable backup of sa component false Disable backup of sa component |
oracleSubclientProperties |
-backupFTI {true | false} |
Include the Full-Text Index components in the backup. true Enable backup of FTI false Disable backup of FTI |
oracleSubclientProperties |
-backupArchiveLog {true | false} |
Include the archive redo log in the backup. You can set this parameter only if the corresponding backupMode parameter is set to 'db_backup_online'. true Back up the archived redo log false Do not back up the archived redo log |
oracleSubclientProperties |
-archiveDelete {true | false} |
Delete the archived redo log files after they are backed up. You can set this parameter only if the backupMode parameter is set to 'db_backup_online' and the backupArchiveLog parameter is set to 'true'. true Delete the archived redo logs false Do not delete the archive redo logs |
oracleSubclientProperties |
-dataThresholdStreams {1| 2} |
The minimum number of streams required to run a backup process. You can set this parameter only if the dataThreshold parameter is set to 'true'. |
oracleSubclientProperties |