Adding Oracle Subclients Using the SnapProtect Command Line Interface

Use XML to create Oracle subclients. 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 computer.

  2. Download the CreateSubclient.xml file to the computer where you will run the command.
  3. Open the CreateSubclient.xml file, add your specific parameters and save the file.

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

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

    qoperation execute -af xml_path\create_subclient_template.xml -appName 'Oracle' -clientName '<client_name>' -instanceName '<dbname>' -subclientName '<subclient_name>'

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

Examples

To create a selective online full Subclient, set the following parameters:

Parameter Value
data 'true'
selectiveOnlineFull 'true'
dataBackupStoragePolicy/storagePolicyName Storage Policy Name (in this example, 'data_sp')

qoperation execute -af /CLI/create_subclient_template.xml -appName 'Oracle' -clientName 'client1' -instanceName 'dbname' -subclientName 'subclient1' -selectiveOnlineFull true -dataBackupStoragePolicy/storagePolicyName 'data_sp'

To create an online Subclient, set the following parameters:

Parameter Value
data 'true'
backupMode 'true'
dataBackupStoragePolicy/storagePolicyName Storage Policy Name (in this example, 'data_sp')

qoperation execute -af /CLI/create_subclient_template.xml -appName 'Oracle' -clientName 'client1' -instanceName 'dbname' -subclientName 'subclient1' -data true -backupMode ONLINE_DB -dataBackupStoragePolicy/storagePolicyName 'data_sp'

To create a Subclient with table level backup, set the following parameters:

Parameter Value
data 'true'
backupMode 'true'
enableTableBrowse 'true'
dataBackupStoragePolicy/storagePolicyName Storage Policy Name (in this example, 'data_sp')

qoperation execute -af /CLI/create_subclient_template.xml -appName 'Oracle' -clientName 'client1' -instanceName 'dbname' -subclientName 'oracleTableBackup' -data true -backupMode ONLINE_DB -enableTableBrowse true -dataBackupStoragePolicy/storagePolicyName 'data_sp'

To create an offline Subclient, set the following parameters:

Parameter Value
data 'true'
backupMode 'OFFLINE_DB'
dataBackupStoragePolicy/storagePolicyName Storage Policy Name (in this example, 'data_sp')

qoperation execute -af /CLI/create_subclient_template.xml -appName 'Oracle' -clientName 'client1' -instanceName 'dbname' -subclientName 'offlinesubclient' -data true -backupMode OFFLINE_DB -dataBackupStoragePolicy/storagePolicyName 'data_sp'

Adding an Offline Subclient With a lightsoutScript and the Delay Time Set to 3 Minutes:

To create an offline Subclient that uses a lightsOut warning script, set the following parameters:

Parameter Value
data 'true'
backupMode 'OFFLINE_DB'
lightsOutScript 'true'
warning 'true'
delayTimeinMin The number of minutes (in this example '3')
sleepTimeinSec The number of seconds to wait (in this example '15')
triesNumber The number of attempts to make (in this example 5)
useSQLConnect If the CommServe connects to the Oracle database using the SQL command
startupPFile The PF file to use with the lights-out script (in this example '/tmp/spfileRDMDB.ora' )
dataBackupStoragePolicy/storagePolicyName The storage policy name (in this example, 'data_sp')

qoperation execute -af /CLI/create_subclient_template.xml -appName 'Oracle' -clientName 'client1' -instanceName 'dbname' -subclientName 'offlinesubclient' -data true -backupMode OFFLINE_DB -lightsOutScript true -warning true -delayTimeinMin 3 -sleepTimeinSec 15 -triesNumber 5 -useSQLConntect true -startupPFile '/tmp/spfileRDMDB.ora' -dataBackupStoragePolicy/storagePolicyName 'data_sp'

To create a log backup only Subclient, set the following parameters:

Parameter Value
data 'false'
backupArchiveLog 'true'
dataBackupStoragePolicy/storagePolicyName Storage Policy Name (in this example, 'data_sp')
disableSwitchCurrentLog 'true'

qoperation execute -af /CLI/create_subclient_template.xml -appName 'Oracle' -clientName 'client1' -instanceName 'dbname' -subclientName 'logonlysubclient' -data false -backupArchiveLog true -archiveDelete true -dataBackupStoragePolicy/storagePolicyName 'data_sp' -disableSwitchCurrentLog true

Adding a Log Backup Only Subclient with the Archive Delete Option

To create a log backup only Subclient using the Archive delete option, set the following parameters:

Parameter Value
data 'false'
backupArchiveLog 'true'
archiveDelete 'true'

qoperation execute -af /CLI/create_subclient_template.xml -appName 'Oracle' -clientName 'client1' -instanceName 'dbname' -subclientName 'logonlysubclient' -data false -backupArchiveLog true -archiveDelete true -dataBackupStoragePolicy/storagePolicyName 'data_sp'

Adding an Online Subset Subclient

Note: Only one tablespace and one datafile can be specified during creation. Use the modify command to add additional tablespaces.

To create an online subset Subclient, set the following parameters:

Parameter Value
data 'true'
backupArchiveLog ''ONLINE_SUBSET_DB''
contentOperation 'ADD'
content/oracletablespace The tablespace name
content/oracleContent/dataFile The datafile (directory and name)

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