V11 SP8
Loading...

Modifying Subclient Properties Using the Commvault Command Line Interface

Use XML to modify subclient properties. Run the operation from the command line, or automate configuration by combining command line operations in a script.

The XML parameters can be included in the XML file, or specified on the command line when they frequently change. For more information on command line parameters and XML elements, see Command Line - Syntax.

Procedure

  1. On the Oracle Agent host, run the qlogin command to log on to the CommServe.
  2. Download the UpdateSubclient.xmlfile and save it on the computer from where you will run the command.
  3. Open the UpdateSubclient.xml file, add your specific parameters and save the file.

    For information on supported subclient XML parameters, see XML Parameters for Oracle Subclient Configuration.

  4. On the command line, go to Software_Installation_Directory/Base and type the command.

    qoperation execute -af xml_path\update_subclient_template.xml -appName 'Oracle' -clientName '<client_name>' -instanceName '<dbname>' -subclientName '<subclient_name>' -dataBackupStoragePolicy/storagePolicyName '<storage_policy>'

  5. Run the qlogout command to log off the CommServe computer.

Examples

Expand All

Modifying an Online Subclient

To modify the subclient, set the following parameters:

Parameter Value
backupControlFile 'false'
backupSPFile 'true'
dataFilesPerBFS The data file BFS numerical value (in this example, '64')
maxBackupsetSizeinKB The maximum backup set size numerical value (in this example, '204800')
maxOpenFiles The maximum number of open files numerical value (in this example, '16')
archiveFilesPerBFS The archive file BFS numerical value (in this example, '64')
oracleTag The number of open files (in this example, '16'
skipReadOnly 'false'
skipOffline 'false'
skipInaccessible 'false'
validate 'false'
enableTableBrowse 'false'
mergeIncImage 'false'
resyncCatalog 'false'

qoperation execute -af /CLI/update_subclient_template.xml -appName 'Oracle' -clientName dbserve4 -instanceName RDMDB -subclientName CMD_online_1 -selectiveOnlineFull false -data true -backupMode ONLINE_DB -backupControlFile false -backupSPFile false -dataFilesPerBFS 64 -maxBackupSetSizeInKB 204800 -archiveFilesPerBFS 64 -maxOpenFiles 16 -oracleTag tag_online_1 -skipReadOnly false -skipOffline false -skipInaccessible false -validate false -enableTableBrowse true -mergeIncImageCopies false -resyncCatalog false

Modifying an Online Subset Subclient by Adding a New Tablespace/Datafile

To update the Subset Subclient with the deduplication and generate signature options,

Set the following parameters:

Parameter Value
backupMode 'ONLINE_SUBSET_DB'
contentOperationType 'ADD'
content/oracletablespace The Oracle tablespace name
content/oraclecontent/dataFile The Oracle datafile

qoperation execute -af /CLI/update_subclient_template.xml -appName 'Oracle' -clientName 'client1' -instanceName 'dbname' -subclientName 'subclient1' -backupMode ONLINE_SUBSET_DB -contentOperationType ADD -content/oracleContent/tableSpace 'TABLESPACENAME' -content/oracleContent/dataFile '+DISK/datafile/datafilename'

Modifying the Storage Policy and Deduplication on a Subclient

Note: You must set the enableDedduplication parameter to 'true' when you use the generateSignature parameter.

To modify a subclient's Storage Policy (in this example, the software compression will use the Storage Policy Settings and deduplication is enabled with the signature on the MediaAgent), set the following parameters:

Parameter Value
storagePolicy 'the data storage policy
enableDeduplication 'true'
generateSignature 'ON_MEDIA_AGENT'
dataBackupStoragePolicy/storagePolicyName Storage Policy Name (in this example, 'data_sp'),

qoperation execute -af /CLI/update_subclient_template.xml -appName 'Oracle' -clientName 'client1' -instanceName 'dbname' -subclientName 'subclient1' -enableDeduplication true -generateSignature ON_MEDIA_AGENT -dataBackupStoragePolicy/storagePolicyName 'data_sp'

Modifying an Offline Subclient to Use a Lights-Out Script

To modify a subclient to use a lights-out script with no warning and a specific pfile location, set the following parameters:

Parameter Value
lightsOutScript 'true'
warning 'false'
delayTimeMin The delay time (in this example, '6')
sleepTimeinMin The interval (in this example, '6')
triesNumber The retry number (in this example, 10)
sqlConnect 'false'
startupPFile The pfile location

qoperation execute -af /CLI/update_subclient_template.xml -appName 'Oracle' -clientName 'client1' -instanceName 'dbname' -subclientName 'offlinesubclient' -lightsOutScript true -warning false -delayTimeinMin 6 -sleepTimeinMin 6 -sleepTimeinSec 30 -triesNumber 10 -useSQLConnect false -startupPFile '/u2/script/'

Modifying the Archive Log Destination for a Subclient Using the Destination for Backup Operation

To add a log backup destination to Subclient, set the following parameters:

Parameter Value
selectArchiveLogDestForBackup 'true'
archiveLogDestforBackupOpType 'ADD'
delayTimeMin The location (in this example, '/tmp/Archive2')

qoperation execute -af /CLI/update_subclient_template.xml -appName 'Oracle' -clientName 'client1' -instanceName 'dbname' -subclientName 'subclient' -selectArchiveLogDestForBackup 'true'-archiveLogDestforBackupOpType 'ADD'-archiveLogDestForBackup '/tmp/Archive2'

Changing an Online Subclient to an Offline Subclient

To change an online subclient to offline mode, a lights-out script, no warning and specifies the pfile location, set the following parameters:

Parameter Value
data 'true'
backupMode 'OFFLINE_DB'
lightsOutScript 'true'
warning 'false'
delayTimeMin The delay time (in this example, '6')
sleepTimeinMin The interval (in this example, '6')
triesNumber The retry number (in this example, 10)
sqlConnect 'false'
startupPFile The pfile location

qoperation execute -af /CLI/update_subclient_template.xml -appName 'Oracle' -clientName 'client1' -instanceName 'dbname' -subclientName 'offlinesubclient' -data ture -backupMode OFFLINE_DB -lightsOutScript true -warning false -delayTimeinMin 6 -sleepTimeinMin 6 -sleepTimeinSec 30 -triesNumber 10 -useSQLConnect false -startupPFile '/u2/script/'