Command Line Interface - Configuration - Oracle RAC iDataAgent

Table of Contents

Log On to the CommServe

To run command line operations, you must first login to the CommServe.

From Command prompt, navigate to <Software_Installation_Directory>/Base and run the following command:

qlogin -cs <commserve name> -u <user name>

For example, to log on to CommServe 'server1' with username 'user1':

qlogin -cs server1 -u user1

Configuring a RAC

Creating RAC Pseudo Client

  1. Download the CreateRACClient.xml file and save it on the computer from where the command will be executed.
  2. Execute the following command from the <Software_Installation_Directory>/Base folder after substituting the parameters values.

    qoperation execute -af <xml_path>\CreateRACClient.xml -clientInfo/clientType 'RAC' -entity/clientName <RACpseudoclientname>

Adding First RAC Node

  1. Download the CreateRACInstance.xml file and save it on the computer from where the command will be executed.
  2. Execute the following command from the <Software_Installation_Directory>/Base folder after substituting the parameters values.

    qoperation execute -af <xml_path>\CreateRACInstance.xml –cs <CommServeName> -instance/appName 'Oracle RAC' -instance/clientName '<RACPseudoClientName>' -instance/instanceName '<RAC DatabaseName>' -useCatalogConnect true -oracleRACInstance/connectString/userName '<catalog_db_user_name>' -oracleRACInstance/connectString/password '<catalog_db_password>' -oracleRACInstance/connectString/domainName '<catalog_db_name>' -dataBackupStoragePolicy/storagePolicyName '<data_storage_policy>' -logBackupStoragePolicy/storagePolicyName '<log_storage_policy>' -racDBOperationType ADD -instancePhysicalClient/clientName '<RACnode1name>' -instanceOracleSID '<node1instancename>' -userAccount/userName '<oracleusername>' -oracleHome '<oracle_home_path>' -racDBInstance/connectString/userName '<racdb_username>' -racDBInstance/connectString/password '<racdb_password>' -racDBInstance/connectString/serviceName '<racdbname>'

    On Windows clients, Oracle user name and domain should be provided from the CommCell Console once the RAC instance is created.

Adding Second RAC Node

  1. Download the UpdateRACInstance.xml file and save it on the computer from where the command will be executed.
  2. Execute the following command from the <Software_Installation_Directory>/Base folder after substituting the parameters values.

    qoperation execute -af <xml_path>\UpdateRACInstance.xml –cs <CommServeName> -instance/appName 'Oracle RAC' -instance/clientName '<RACpseudoclientname>' -instance/instanceName '<RACDatabaseName>' -racDBOperationType ADD -instancePhysicalClient/clientName '<RACnode2name>' -instanceOracleSID '<node2instancename>' -userAccount/userName '<oracleusername>' -oracleHome '<oracle_home_path>' -racDBInstance/connectString/userName '<racdb_username>' -racDBInstance/connectString/password '<racdb_password>' -racDBInstance/connectString/ServiceName '<racdbname>'

    On Windows clients, Oracle user name and domain should be provided from the CommCell Console once the RAC instance is added.

Examples

Creating a RAC client

qoperation execute -af <xml_path>\CreateRACClient.xml –cs <CommServeName> -clientInfo/clientType 'RAC' -entity/clientName 'RacPseudoclient'

Adding first RAC node

qoperation execute -af <xml_path>\CreateRACInstance.xml –cs <CommServeName> -instance/appName 'Oracle RAC' -instance/clientName 'RacPseudoclient' -instance/instanceName 'racdb' -useCatalogConnect true -oracleRACInstance/connectString/userName 'cataloguser' -oracleRACInstance/connectString/password 'catalogpasswd' -oracleRACInstance/connectString/domainName 'catalogdb' -dataBackupStoragePolicy/storagePolicyName 'data_sp' -logBackupStoragePolicy/storagePolicyName 'log_sp' -racDBOperationType ADD -instancePhysicalClient/clientName 'racnode1' -instanceOracleSID racdb1 -userAccount/userName 'oracle' -oracleHome '/oracle/oraclehome/' -racDBInstance/connectString/userName 'sys' -racDBInstance/connectString/password 'syspasswd' -racDBInstance/connectString/serviceName 'racdb1'

Adding first RAC node without catalog connect

qoperation execute -af <xml_path>\CreateRACInstance.xml –cs <CommServeName> -instance/appName 'Oracle RAC' -instance/clientName 'RacPseudoclient' -instance/instanceName 'racdb' -useCatalogConnect false -dataBackupStoragePolicy/storagePolicyName ' data_sp ' -logBackupStoragePolicy/storagePolicyName 'log_sp' -racDBOperationType ADD -instancePhysicalClient/clientName 'racnode1' -instanceOracleSID racdb1 -userAccount/userName 'oracle' -oracleHome '/oracle/oraclehome/' -racDBInstance/connectString/userName 'sys' -racDBInstance/connectString/password 'oracle' -racDBInstance/connectString/serviceName ‘racdb1'

Adding Second RAC Node

qoperation execute -af <xml_path>\UpdateRACInstance.xml –cs <CommServeName> -instance/appName 'Oracle RAC' -instance/clientName 'RacPseudoclient' -instance/instanceName 'racdb' -racDBOperationType ADD -instancePhysicalClient/clientName 'racnode2' -instanceOracleSID racdb2 -userAccount/userName oracle -oracleHome '/oracle/oraclehome/' -racDBInstance/connectString/userName 'sys' -racDBInstance/connectString/password 'passwd' -racDBInstance/connectString/ServiceName 'racdb2'

Configuring an Instance

Available Parameters for Instance Configuration

The following table displays all the parameters you can use with the commands mentioned in the above sections. To add a parameter to your command, use the following syntax:

qoperation execute -af <template XML file> -<parameter name> <value>

Parameter Description of Parameter Values
appName Name of the application. In this case it would be 'Oracle RAC'
clientName Name of the RAC pseudo client as displayed in the CommCell Browser (e.g RacPseudoclient)
instancePhysicalClient/clientName Name of RAC client node (for example., racnode1)
instanceName Name of the Oracle instance (for example., racdb)
userAccount/userName Name of the user that has local administrator rights to administer the Oracle application. This is the account used by the user to log in to and use the application to run jobs.  (for example., oracle)
userAccount/password Password of the user that has local administrator rights to administer the Oracle application.
userAccount/domainName Domain name of the user that has local administrator rights to administer the Oracle application.
oracleRACInstance/connectString/userName User account with all privileges to access the Oracle recovery catalog database (for example., cataloguser)
oracleRACInstance/connectString/password Password for the catalog user (for example., catalogpasswd)
oracleRACInstance/connectString/serviceName Name of the Oracle recovery catalog database (for example., catalogdb)
racDBInstance/connectString/userName Super user with all privileges to access the RAC database (for example., sys)
racDBInstance/connectString/password Password for the RAC super user (for example., syspasswd)
instanceOracleSID Name of the RAC node database. (for example., dbname1 for racnode1 and dbname2 for racnode2)
oracleHome Path for the Oracle application software (for example., /oracle/oraclehome/)
tnsAdminFolder Path to the TNS Admin directory (for example, /u01/app/oracle/product/11.2.0.3/db_1/network/admin/)
dataBackupStoragePolicy/storagePolicyName Name of the data storage policy (for example, data_sp)
logBackupStoragePolicy/storagePolicyName Name of the log storage policy (for example., log_sp)
blockSize Block size value for backup and restore operations on the selected instance (for example., 262144)
enableDeduplication Option to enable or disable deduplication.

Valid values are True/False.

networkAgents Number of Network Agents (for example, 2)
useCatalogConnect Option to establish connection between the target database and the Recovery Catalog database using the specified connect string, and the Recovery Catalog database will be used for backups.

Valid values are True/False.

softwareCompression Option to enable compression on the Client or MediaAgent computer. Valid values are:
  • ON_CLIENT, to enable software compression on the client.
  • ON_MEDIA_AGENT, to enable software compression on the MediaAgent.
  • USE_STORAGE_POLICY_SETTINGS, to use the software compression options defined on the storage policy.
  • OFF, to disable software compression.

Getting Instance Properties

  1. Download the GetRACInstance.xml file and save it on the computer from where the command will be executed.
  2. Execute the following command from the <Software_Installation_Directory>/Base folder after substituting the parameters values.

    qoperation execute -af <xml_path>\GetRACInstance.xml -appName 'Oracle RAC' -clientName '<RACpseudoclientname>' -instanceName '<RACDatabasename>'

    Click here to see a Sample Output

Modifying an Instance

  1. Download the UpdateRACInstance.xml file and save it on the computer from where the command will be executed.
  2. Execute the following command from the <Software_Installation_Directory>/Base folder after substituting the parameters values.

    qoperation execute -af <xml_path>\UpdateRACInstance.xml –cs <CommServeName> -instance/appName 'Oracle RAC' -instance/clientName '<RACPseudoClientName>' -instance/instanceName '<RACDatabaseName>' -racDBOperationType OVERWRITE -instancePhysicalClient/clientName '<RACnodename>' -instanceOracleSID <instancename_for_node> -userAccount/userName <username> -oracleHome '<homepath>' -racDBInstance/connectString/userName '<connect_string_username>' -racDBInstance/connectString/password '<connect_string_password>' -racDBInstance/connectString/ServiceName '<connect_string_name>' -tnsAdminFolder '<tnsadmin_path>'

Adding a Data Storage Policy to an Instance

  1. Download the UpdateRACInstance.xml file and save it on the computer from where the command will be executed.
  2. Execute the following command from the <Software_Installation_Directory>/Base folder after substituting the parameters values.

    qoperation execute -af C:\XML\UpdateRACInstance.xml –cs <CommServeName> -instance/appName 'Oracle RAC' -instance/clientName '<RACPseudoClientName>' -instance/instanceName '<RACDatabaseName>' -dataBackupStoragePolicy/storagePolicyName '<data_storage_policy>'

Adding a Log Storage Policy to an Instance

  1. Download the UpdateRACInstance.xml file and save it on the computer from where the command will be executed.
  2. Execute the following command from the <Software_Installation_Directory>/Base folder after substituting the parameters values.

    qoperation execute -af C:\XML\UpdateRACInstance.xml –cs <CommServeName> -instance/appName 'Oracle RAC' - instance/clientName '<RACPseudoClientName>' -instance/instanceName '<RACDatabaseName>' -logBackupStoragePolicy/storagePolicyName '<log_storage_policy>'

Examples

Changing Control File Auto Backup Type

qoperation execute -af <xml_path>\UpdateRACInstance.xml –cs <CommServeName> -appName 'Oracle RAC' -instance/clientName 'RacPseudoclient' -instance/instanceName 'racdb' -ctrlFileAutoBackupType CONFIGURE_ON

Disable Catalog User

qoperation execute -af <xml_path>\UpdateRACInstance.xml –cs <CommServeName> -instance/appName 'Oracle RAC' -instance/clientName 'RacPseudoclient' -instance/instanceName 'racdb' -useCatalogConnect false

Disable RMAN CrossCheck

qoperation execute -af <xml_path>\UpdateRACInstance.xml –cs <CommServeName> -instance/appName 'Oracle RAC' -instance/clientName 'RacPseudoclient' -instance/instanceName 'racdb' -disableRMAN true

Changing Block Size

qoperation execute -af <xml_path>\UpdateRACInstance.xml –cs <CommServeName> -instance/appName 'Oracle RAC' -instance/clientName 'RacPseudoclient' -instance/instanceName 'racdb' -blockSize 1048576

Modify Storage Policy

qoperation execute -af <xml_path>\UpdateRACInstance.xml –cs <CommServeName> -instance/appName 'Oracle RAC' -instance/clientName 'RacPseudoclient' -instance/instanceName 'racdb' -dataBackupStoragePolicy/storagePolicyName 'data_sp' -logBackupStoragePolicy/storagePolicyName 'log_sp'

Configure Data Transfer Options

qoperation execute -af <xml_path>\UpdateRACInstance.xml –cs <CommServeName> -instance/appName 'Oracle RAC' -instance/clientName 'RacPseudoclient' -instance/instanceName 'racdb' -softwareCompression ON_CLIENT -networkAgents 2

Enable Deduplication

qoperation execute -af <xml_path>\UpdateRACInstance.xml -instance/appName 'Oracle RAC' -instance/clientName 'RacPseudoclient' -instance/instanceName 'racdb' -enableDeduplication true -generateSignature ON_MEDIA_AGENT

Modify Oracle User details for RAC instance ‘racdb1’ on ‘racnode1’ On UNIX clients:

qoperation execute -af <xml_path>\UpdateRACInstance.xml –cs <CommServeName> -appName 'Oracle RAC' -instance/clientName 'RacPseudoclient' -instance/instanceName 'racdb' -racDBOperationType OVERWRITE -instancePhysicalClient/clientName 'racnode1' -instanceOracleSID 'racdb1' userAccount/userName 'backupadmin'

Modify Connect String for RAC instance ‘racdb1’ on ‘racnode1’

qoperation execute -af <xml_path>\UpdateRACInstance.xml –cs <CommServeName> -appName 'Oracle RAC' -instance/clientName 'RacPseudoclient' -instance/instanceName 'racdb' -racDBOperationType OVERWRITE -instancePhysicalClient/clientName 'racnode1' -instanceOracleSID 'racdb1' racDBInstance/connectString/userName 'sys' -racDBInstance/connectString/password 'syspasswd1' -racDBInstance/connectString/serviceName 'racdb1'

Modifying TNS_ADMIN for RAC instance ‘racdb1’ on ‘racnode1’

qoperation execute -af <xml_path>\UpdateRACInstance.xml –cs <CommServeName> -appName 'Oracle RAC' -instance/clientName 'RacPseudoclient' -instance/instanceName 'racdb' -racDBOperationType OVERWRITE -instancePhysicalClient/clientName 'racnode1' -instanceOracleSID 'racdb1' -tnsAdminFolder '/oracle/network/admin/'

Modifying Oracle Home on RAC instance ‘racdb2’ on ‘racnode2’

qoperation execute -af <xml_path>\UpdateRACInstance.xml –cs <CommServeName> -appName 'Oracle RAC' -instance/clientName 'RacPseudoclient' -instance/instanceName 'racdb' -racDBOperationType OVERWRITE -instancePhysicalClient/clientName 'racnode2' -instanceOracleSID 'racdb2' -oracleHome '/oracle/app/prodcut/dbhome/'

Deleting RAC instance 'racdb1' on ‘racnode1'

qoperation execute -af <xml_path>\UpdateRACInstance.xml –cs <CommServeName> -appName 'Oracle RAC' -instance/clientName 'RacPseudoclient' -instance/instanceName 'racdb' -racDBOperationType DELETE -instancePhysicalClient/clientName 'racnode1' -instanceOracleSID 'racdb1'

Deleting an Instance

  1. Download the DeleteRACInstance.xml file and save it on the computer from where the command will be executed.
  2. Execute the following command from the <Software_Installation_Directory>/Base folder after substituting the parameters values.

    qoperation execute -af <xml_path>\DeleteRACInstance.xml –cs <CommServeName> -appName 'Oracle RAC' –instance/clientName '<RACpseudoclientname>' –instance/instanceName '<RACDatabaseName>'

Deleting RAC Instance

qoperation execute -af <xml_path>\DeleteRACInstance.xml –cs <CommServeName> -appName 'Oracle RAC' –instance/clientName 'RacPseudoclient' –instance/instanceName 'racdb'

Adding Instances to an Oracle RAC Pseudo Client

You can add multiple instances to an Oracle RAC multi instance pseudo client, or add an additional instance by using the command line interface.

  1. Create a Oracle RAC instance and include all instances that are part of the configuration.
  2. To add an additional instance, use the UpdateRACInstance.xml template and specify the instance to add on the instanceOracleSID parameter.

Example

Oracle RAC pseudo client RAC_multiInstance contains two instanced databaseX and databaseY.

qoperation execute -af <xml_path>/CreateRACInstance.xml -instance/appName 'Oracle RAC' -instance/clientName 'Rac_MultiInstance' -instance/instanceName 'sales' -ctrlFileAutoBackupType CONFIGURED -disableRMAN true -networkAgents 2 -softwareCompression OFF -dataBackupStoragePolicy/storagePolicyName 'DEDUP_SP' -logBackupStoragePolicy/storagePolicyName 'NONDEDUP_SP' -enableDeduplication true -generateSignature ON_CLIENT -racDBOperationType ADD -instancePhysicalClient/clientName 'node1' -instanceOracleSID databaseY1 -userAccount/userName 'oracle' -oracleHome '/u01/app/oracle/oracleHome/db_1' -racDBInstance/connectString/userName 'sys' -racDBInstance/connectString/password 'syspassword' -racDBInstance/connectString/serviceName 'databaseY1' -useCatalogConnect false

Add another instance, databaseZ, to the pseudo client.

qoperation execute -af <xml_path>/UpdateRACInstance.xml -instance/appName 'Oracle RAC' -instance/clientName 'Rac_MultiInstance' -instance/instanceName 'sales' -racDBOperationType ADD instancePhysicalClient/clientName 'node2' -instanceOracleSID databaseY2 -userAccount/userName oracle -oracleHome '/u01/app/oracle/oracleHome/db_1' -racDBInstance/connectString/userName 'sys' -racDBInstance/connectString/password 'syspassword' -racDBInstance/connectString/ServiceName 'databaseY2'

Configuring a Subclient

Available Parameters for Subclient Configuration

The following table displays all the parameters you can use with the commands mentioned in the above sections. To add a parameter to your command, use the following syntax:

qoperation execute -af <template XML file> -<parameter name> <value>

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 (for example., RacPseudoclient1).
instanceName Specifies the name of the Oracle instance (for example, racdb).
subclientName Specifies the name of the Subclient (for example subclient1).
encryptionFlag Specifies whether to enable encryption.

Valid values are:

  • ENC_NONE,
  • ENC_NETWORK_MEDIA
description Specifies the Subclient description.
enableBackup Option to allow backup.  Set this to 'true'.
networkAgents Number of Network Agents (for example., 2). 

Valid vales are 1-4.

softwareCompression Specifies whether to enable compression on the Client or MediaAgent computer.

Valid values are:

  • ON_CLIENT, to enable software compression on the client.
  • ON_MEDIAAGENT, to enable software compression on the MediaAgent.
  • USE_STORAGE_POLICY_SETTINGS, to use the software compression options defined on the storage policy.
  • OFF, to disable software compression.
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:
  • ON_CLIENT, to enable signature generation on the client.
  • ON_MEDIA_AGENT, to enable signature generation on the MediaAgent.
  • OFF, to disable the signature generation.
isSnapBackupEnabled Specifies whether to enable or disable SnapProtect.

Valid values are true/false.

snapShotEngineName Specifies the Snapshot Engine Name.
snapToTapeProxyToUse/clientName Specifies the proxy server used for SnapProtect 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:

  • ONLINE_DB, to perform an online backup of the database,
  • ONLINE_SUBSET_DB, to perform an online subset backup that includes tablespaces and datafiles,
  • OFFLINE_DB - to perform an offline (cold) backup of the database
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.

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 Lights Out 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 Lights Out 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:

  • BACKUP_ARCHIVE_LOG_ALL,
  • BACKUP_INSTANCE_ARCHIVE_LOG
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:

  • ADD, add a location.
  • DELETE, delete the location.
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 (for example '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:

  • ADD, add a location.
  • DELETE, delete the location
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 (for example 'e:/u2/logs').

dataThresholdStreams Specifies the data threshold streams.

Valid values are -1, 1-50.

oracleDataBackupStreams/streamInstanceName The instance name that you want to set the data streams for
oracleDataBackupStreams/streamNumber The number of streams to use for the oracleDataBackupStreams/streamInstanceName data backups.
oracleDataBackupStreams/priority The stream priority for the oracleDataBackupStreams/streamInstanceName data backups.
oracleLogBackupStreams/streamInstanceName The instance name that you want to set the log streams for
oracleLogBackupStreams/streamNumber The number of streams to use for the oracleLogBackupStreams/streamInstanceName log backups.
oracleLogBackupStreams/priority The stream priority for the oracleLogBackupStreams/streamInstanceName log backups.
tableSpace Specifies which tablespaces will be backed up.
dataFile Specifies which datafiles will be backed up.

Creating a Subclient

  1. Download the CreateSubclient.xml file and save it on the computer from where the command will be executed.
  2. Execute the following command from the <Software_Installation_Directory>/Base folder after substituting the parameters values.

    qoperation execute -af C:\XML\create_subclient_template.xml -cs <CommServeName> -appName "Oracle RAC" -clientName 'RACPseudoClient' -instanceName 'racdb' -subclientName 'subclient1'

Getting Subclient Properties

  1. Download the GetSubclient.xml file and save it on the computer from where the command will be executed.
  2. Execute the following command from the <Software_Installation_Directory>/Base folder after substituting the parameters values.

    qoperation execute -af C:\XML\get_subclient_template.xml -cs <CommServeName> -appName 'Oracle RAC' -clientName 'RACPseudoClient' -instanceName 'racdb' -subclientName 'subclient1'

Modifying Subclient Properties

  1. Download the UpdateSubclient.xml file and save it on the computer from where the command will be executed.
  2. Execute the following command from the <Software_Installation_Directory>/Base folder after substituting the parameters values.

    qoperation execute -af C:\XML\update_subclient_template.xml -cs <CommServeName> -appName "Oracle RAC" -clientName 'RACPseudoClient' -instanceName 'racdb' -subclientName 'subclient1' -dataBackupStoragePolicy/storagePolicyName 'data_sp'

Deleting a Subclient

  1. Download the DeleteSubClient.xml file and save it on the computer from where the command will be executed.
  2. Execute the following command from the <Software_Installation_Directory>/Base folder after substituting the parameters values.

    qoperation execute -af C:\XML\delete_subclient_template.xml -cs <CommServeName> -appName 'Oracle RAC' -clientName 'RACPseudoClient' -instanceName 'racdb' -subclientName 'subclient1'

Examples

Creating an online full Subclient To create an online full Subclient, use the following:
  • selectiveOnlineFull - set to 'true',
  • dataBackupStoragePolicy/storagePolicyName - set to the Storage Policy Name (in this example 'data_sp'),
  • logBackupStoragePolicy/storagePolicyName - set to the backup log Storage Policy name (in this example 'log_sp')

qoperation execute -af /CLI/create_subclient_template.xml -cs <CommServeName> -appName "Oracle RAC" -clientName 'RACPseudoClient' -instanceName 'racdb' -subclientName 'Selective_Online_Full' -selectiveOnlineFull true -dataBackupStoragePolicy/storagePolicyName 'data_sp'

Creating an online Subclient To create an online Subclient, use the following:
  • backupMode - set to 'true',
  • dataBackupStoragePolicy/storagePolicyName - set to the Storage Policy Name (in this example 'data_sp'),
  • logBackupStoragePolicy/storagePolicyName - set to the backup log Storage Policy name (in this example 'log_sp')

qoperation execute -af /CLI/create_subclient_template.xml cs <CommServeName> -appName "Oracle RAC" -clientName 'RacPseudoClient' -instanceName 'racdb' -subclientName 'onlinesubclient' -backupMode ONLINE_DB -dataBackupStoragePolicy/storagePolicyName 'data_sp' -oracleDataBackupStreams/streamInstanceName 'racdb1' -oracleDataBackupStreams/streamNumber 5

Creating a Subclient with table level backup To create a Subclient with table level backup, use the following:
  • enableTableBrowse - set to 'true',
  • dataBackupStoragePolicy/storagePolicyName - set to the Storage Policy Name (in this example 'data_sp'),
  • logBackupStoragePolicy/storagePolicyName - set to the backup log Storage Policy name (in this example 'log_sp')

qoperation execute -af /CLI/create_subclient_template.xml -cs <CommServeName> -appName "Oracle RAC" -clientName 'RacPseudoClient' -instanceName 'racdb' -subclientName 'oracleTableBackup' -enableTableBrowse true -dataBackupStoragePolicy/storagePolicyName 'data_sp'

Creating a selective online Subclient To create a selective online Subclient, use the following:
  • backupMode - set to 'ONLINE_DB',
  • dataBackupStoragePolicy/storagePolicyName - set to the Storage Policy Name (in this example 'data_sp'),
  • logBackupStoragePolicy/storagePolicyName - set to the backup log Storage Policy name (in this example 'log_sp')

qoperation execute -af /CLI/create_subclient_template.xml -cs <CommServeName> -appName "Oracle RAC" -clientName 'RacPseudoClient' -instanceName 'racdb' -subclientName 'Selective_Online_Full' -selectiveOnlineFull true -dataBackupStoragePolicy/storagePolicyName 'data_sp'

Creating an Offline Subclient with lightsoutScript option with warning in 3 mins.: To create an offline Subclient that uses a lightsOut warning script, use the following:
  • backupMode - set to 'OFFLINE_DB',
  • lightsOutScript - set to 'true'
  • warning - set to 'true',
  • delayTimeinMin - set to the number of minutes (in this example , '3')
  • dataBackupStoragePolicy/storagePolicyName - set to the Storage Policy Name (in this example 'data_sp'),
  • logBackupStoragePolicy/storagePolicyName - set to the backup log Storage Policy name (in this example 'log_sp')

qoperation execute -af /CLI/create_subclient_template.xml -cs <CommServeName> -appName "Oracle RAC" -clientName 'RacPseudoClient' -instanceName 'racdb' -subclientName 'offlinesubclient' -backupMode OFFLINE_DB -lightsOutScript true -warning true -delayTimeinMin 3 -dataBackupStoragePolicy/storagePolicyName 'data_sp'

Log Only Subclient Creation To create log only subclient , use the following:
  • backupArchiveLog - set to 'true',
  • backupArchiveLogOption- set to 'BACKUP_ARCHIVE_ALL'
  • -data - set to 'false'

qoperation execute -af C:\XML\create_subclient_template.xml -cs <CommServeName> -appName "Oracle RAC" -clientName 'RacPseudoClient' -instanceName 'racdb' -subclientName 'logonly_subclient' -data 'false' -backupArchiveLog true -backupArchiveLogOption BACKUP_ARCHIVE_LOG_ALL -backupControlFile false -dataBackupStoragePolicy/storagePolicyName 'data_sp'

Creating log backup only Subclient with Archive Delete Option: To create a log backup only Subclient using the Archive delete option,  use the following:
  • backupArchiveLog - set to 'true',
  • backupArchiveLogOption- set to 'BACKUP_ARCHIVE_ALL'
  • archiveDelete - set to 'true',
  • -data - set to 'false'

qoperation execute -af /CLI/create_subclient_template.xml -cs <CommServeName> -appName "Oracle RAC" -clientName 'RacPseudoClient' -instanceName 'racdb' -subclientName 'logonlysubclient' -data 'false'-backupArchiveLog 'true' -backupArchiveLogOption BACKUP_ARCHIVE_LOG_ALL -archiveDelete 'true -dataBackupStoragePolicy/storagePolicyName 'data_sp''

Creating an online subset Subclient This can be used to create an online subset Subclient.

Note: Only one tablespace and one datafile can be selected during creation. using modification to add more tablespaces/datafiles.

  • backupMode - set to 'ONLINE_SUBSET_DB',
  • contentOperationType - set to 'ADD',
  • content/oracletablespace - set to the tablespace name,
  • content/oracleContent/dataFile - set to the datafile (directory and name)

qoperation execute -af /CLI/create_subclient_template.xml -cs <CommServeName> -appName "Oracle RAC" -clientName 'RacPseudoClient' -instanceName 'racdb' -subclientName 'onlinesubclient' -backupMode ONLINE_SUBSET_DB -contentOperationType ADD -content/oracleContent/tableSpace 'TABLESPACENAME' -content/oracleContent/dataFile '+DISK/datafile/datafilename'

Creating an SnapProtect Subclient To create an SnapProtect Subclient, use the following parameters:
  •  isSnapEnabled - set to 'true',
  •  dataFilesPerBFS- set to the numerical value (in this example '40'),
  •  skipOffline - set to 'true',
  •  skipInaccessible - set to 'true',
  • maxBackupsetSizeinKB - set the numerical value (in this example '2'),
  • softwareCompression - set to where it will be (in this example 'ON_CLIENT'),
  • networkAgents - set to the numerical value (in this example '2')

qoperation execute -af /CLI/create_subclient_template.xml -cs <CommServeName> -appName "Oracle RAC" -clientName 'RacPseudoClient' -instanceName 'racdb' -subclientName 'snap_backup' -isSnapBackupEnabled true -dataBackupStoragePolicy/storagePolicyName 'data_sp'

Update an Online Subclient to Update the Data Stream for the 2nd Node and Log Streams for both the nodes. Update the data stream on the 2nd node

Use the following parameters:

  •  oracleDataBackupStreams/streamInstanceName - in this case, "racdb2"
  • oracleDataBackupStreams/streamNumber - in this case "6"

qoperation execute -af /CLI/update_subclient_template.xml -appName "Oracle RAC" -clientName 'NEW_PSEUDO' -instanceName 'racdb ' -subclientName 'fullbackup_subclient' - oracleDataBackupStreams/streamInstanceName 'racdb2' -oracleDataBackupStreams/streamNumber

Update the log streams on 1st and the 2nd node

Use the following parameters for the 1st node:

  • oracleLogBackupStreams/streamInstanceName - in this case, "racdb1"
  • oracleLogBackupStreams/streamNumber - in this case "4"

qoperation execute -af /CLI/update_subclient_template.xml appName "Oracle RAC" -clientName 'NEW_PSEUDO' -instanceName 'racdb ' -subclientName 'fullbackup_subclient' -oracleLogBackupStreams/streamInstanceName 'racdb1' -oracleLogBackupStreams/streamNumber 4

Use the following parameters for the 2nd node:

  • oracleLogBackupStreams/streamInstanceName - in this case, "racdb2"
  • oracleLogBackupStreams/streamNumber - in this case "3"

qoperation execute -af /CLI/update_subclient_template.xml appName "Oracle RAC" appName "Oracle RAC" -clientName 'NEW_PSEUDO' -instanceName 'racdb ' -subclientName 'fullbackup_subclient' -oracleLogBackupStreams/streamInstanceName 'racdb2' -oracleLogBackupStreams/streamNumber 3

Updating an SnapProtect Subclient with a Snap engine and proxy To update the Subclient with a Snap engine and proxy, use the following parameters:
  •  isSnapBackupEnabled - set to 'true',
  • snapShotEngineName - set to engine (in this example 'NetApp'),
  •  snapToTapeProxyToUse/clientName - set to proxy name (in this example 'dbserve43')

qoperation execute -af /CLI/update_subclient_template.xml -cs <CommServeName> -appName "Oracle RAC" -clientName 'RacPseudoClient' -instanceName 'racdb' -subclientName 'snap_backup' -isSnapBackupEnabled true -snapShotEngineName 'NetApp' -snapToTapeProxyToUse/clientName 'dbserve43'

Updating a Subclient with the deduplication and generate signature options. To update the Subclient with the deduplication and generate signature options, use the following.

Note: Set the enableDeduplication option to 'true' when using the generateSignature option.

  • backupMode - set to 'ONLINE_SUBSET_DB',
  • contentOperation Type - set to 'ADD'
  • content/oracletablespace - set to the tablespace name,
  • content/oracleContent/dataFile - set to the datafile (directory and name).

qoperation execute -af /CLI/update_subclient_template.xml –cs <CommServeName> -appName "Oracle RAC" -clientName 'RacPseudoClient' -instanceName 'racdb' -subclientName 'oracleSOF' -enableDeduplication true -generateSignature ON_MEDIA_AGENT

Deleting a Subclient

qoperation execute -af /home/oracle/delete_subclient_template.xml –cs <CommServeName> -appName "Oracle RAC" -clientName 'RacPseudoClient' -instanceName 'racdb' -subclientName 'snap_backup'

Available Commands

The following section provides a list of commands that can be used by the Oracle RAC iDataAgent.

Before executing a command, make sure to log on to the CommServe using the qlogin command. Similarly, use the qlogout command to log off from the CommServe.

qinfo

backupset

subclient

qlist

backupset

subclient

qmodify

subclient

qdelete

client

dataagent

Qinfo Backupset

Description

This command displays information about a given backup set. If the agent supports instances above backup sets, only the backup sets under the specified instance are listed.

In case of an error, an error code and description are displayed as: "backupset: Error errorcode: errordescription"

Usage

qinfo backupset -c client -a dataagenttype -i instance -b backupset [-desc] [-tf tokenfile] [-tk token] [-h]

Options

-c Client computer name
-a Agent type installed on client computer (see Argument Values - Agent Types)
-i Instance name, required for a few agents
-b Backup set name
-desc Displays description provided by the user

To display the entire user description for the backup set without any other information, be sure to include the -desc option when you run the command. Otherwise, all the requested information along with only a partial description will be displayed.

-tf Reads token from a file
-tk Token string
-h Displays help

Diagnostics

Possible exit status values are:

0 - Successful completion.

1 - CLI usage failures, due to the use of an unsupported option or missing argument.

2 - Any other failure.

Example

Display information about a backup set defaultBackupSet in client client1 and Agent Q_ORACLE_RAC.

qinfo backupset -c client1 -a Q_ORACLE_RAC -b defaultBackupSet

Sample Output:

Name         : defaultBackupSet
Default      : Yes
OnDemand     : No
Description  : Backup Set description

Qinfo Subclient

Description

This command displays information about a subclient under a specified client, agent, and instance/backup set. The backup set name and instance name should be specified based on the agent, as certain agents place subclients under backup sets, and others place them under the instance.

In case of an error, an error code and description are displayed as: "subclient: Error errorcode: errordescription"

Usage

qinfo subclient -c client -a dataagenttype -i instance -b backupset -s subclient [-desc] [-tf tokenfile] [-tk token] [-h]

Options

-c Client computer name
-a Agent type installed on client computer (see Argument Values - Agent Types)
-i Instance name, required for a few agents
-b Backup set name, required for a few agents
-s Subclient name
-desc Displays description provided by the user

To display the entire user description for the backup set without any other information, be sure to include the -desc option when you run the command. Otherwise, all the requested information along with only a partial description will be displayed.

-tf Reads token from a file
-tk Token string
-h Displays help

Diagnostics

Possible exit status values are:

0 - Successful completion.

1 - CLI usage failures, due to the use of an unsupported option or missing argument.

2 - Any other failure.

Example

Display information about a subclient sc1 in the client client1, Agent Q_ORACLE_RAC and backup set bs1.

qinfo subclient -c client1 -a Q_ORACLE_RAC -b bs1 -s sc1

Sample Output:

Name            : sc1
Default         : Yes
Storage Policy  : battra_t(battra)-DP(2)
Description     : Subclient description

Qlist Backupset

Description

This command lists the names of all the backup sets in the specified client and agent. If the agent supports instances above the backup set level, then only the backup sets under the specified instance are listed. Whenever more than one backup set is found, each backup set is listed in its own line on the command prompt. No message is displayed whenever backup sets are not found.

In case of an error, an error code and description are displayed as: "backupset: Error errorcode: errordescription"

Usage

qlist backupset -c client -a dataagenttype -i instance [-tf tokenfile][-tk token] [-h]

Options

-c Client computer name
-a Agent type installed on client computer (see Argument Values - Agent Types)
-i Instance name, required for certain agents
-tf Reads token from a file
-tk Token string
-h Displays help

Diagnostics

Possible exit status values are:

0 - Successful completion.

1 - CLI usage failures, due to the use of an unsupported option or missing argument.

2 - Any other failure.

Example

List all the Backup sets in the client client1, agent MyDataAgent.

qlist backupset -c client1 -a MyDataAgent

The output for the qlist backupset command is:

defaultBackupSet
bs1

Qlist Subclient

Description

This command lists the names of all the subclients in a specified client, agent, and instance/backup set. Whenever more than one subclient is found, each subclient is listed in its own line on the command prompt. No message is displayed whenever subclients are not found.

In case of an error, an error code and description are displayed as: "subclient: Error errorcode: errordescription"

Usage

qlist subclient -c client -a dataagenttype -i instance -b backupset [-tf tokenfile] [-tk token] [-h]

Options

-c Client computer name
-a Agent type installed on client computer (see Argument Values - Agent Types)
-i Instance name, required for certain agents
-b Backup set name, required for certain agents
-tf Reads token from a file
-tk Token string
-h Displays help

Diagnostics

Possible exit status values are:

0 - Successful completion.

1 - CLI usage failures, due to the use of an unsupported option or missing argument.

2 - Any other failure.

Example

List all the Subclients in the client client1, Agent Q_ORACLE_RAC and backup set bs1.

qlist subclient -c client1 -a Q_ORACLE_RAC -b bs1 default sc1

The output for the qlist command is:

default
sc1

Qmodify Subclient

Description

This command modifies the storage policy, content, or user-defined description of a given subclient.

Upon successful completion, the qmodify subclient command displays the message "Modified subclient successfully" on the command prompt. In case of an error, an error code and description are displayed as: "subclient: Error errorcode: errordescription"

To use this command, you must ensure that the  QCMD_SUPPORT_MODIFY_SUBCLIENT additional setting is set to 1.

Usage

qmodify subclient -c client -a dataagenttype -i instance -b backupset -s subclient -sp storagepolicy -f content [-ow overwrite] [-drs datareaders] [-wc y|n] [-af ArgumentFilepath] [-tf tokenfile] [-tk token] [-h]

Options

-c Client computer name
-a Agent type installed on client computer (see Argument Values - Agent Types)
-i Instance name, required for a few agents
-b Backup set name, required for a few agents
-s Name of the subclient to be modified
-sp Name of the storage policy to be associated with the subclient
-f File/Directory Path to be added to the existing content

When using the -f content option, you must verify that the subclient content is in the correct format path. This command does not enforce the content format, and any path (including an incorrect path) can be specified. This may result in incorrect content being assigned to a file system subclient and a "pending" subclient scan.

-wc Do file/directory paths have wildcards (y|n)
-ow If the contents needs to be overwritten (0:1)
-drs Number of data readers
-af Input file containing arguments
-tf Reads token from a file
-tk Token string
-h Displays help

Argument File

client Client computer name
dataagent Agent type installed on source client computer (see Argument Values - Agent Types)
instance Instance name to which the subclient belongs, required for certain agents
backupset Backup set name to which the subclient belongs, required for certain agents
subclient Name of the subclient to be modified
sp New storage policy for the subclient
content List of files/directories to be added to the existing content

The content option is supported for file system Agents. Although, changing the storage policy association of a subclient is supported for all agents.

datareaders Number of data readers
wildcard Do file/directory paths have wildcards (y|n)
description User-defined description

Diagnostics

Possible exit status values are:

0 - Successful completion.

1 - CLI usage failures, due to the use of an unsupported option or missing argument.

2 - Any other failure.

Examples

Modify a subclient with name sc1 under client client1 and Agent Q_ORACLE_RAC and backup set bs1 by changing its storage policy to sp2.

qmodify subclient -c client1 -a Q_ORACLE_RAC -b bs1 -s sc1 -sp sp2

Qdelete Client

Description

This command can be used to deconfigure and/or delete a client, along with its iDataAgents.

By default, the qdelete client command asks for confirmation before deleting the client. You can skip the confirmation prompt with the -y option.

Upon successful completion, qdelete client displays the message "Deleted the client successfully" on the command prompt. In case of an error, an error code and description are displayed as: "client: Error errorcode: errordescription

Usage

qdelete client [-cs <commserve_host_name>] -c <client> [-deconfigure] [-y] [-tf <tokenfile>] [-tk <token>] [-af <clientfile>] [-h]

Options

-cs CommServe host name
-c Client computer name
-deconfigure Deconfigures a client without deleting it
-y Delete without confirmation
-tf Reads token from a file
-tk Token string
-af Reads client name from a file
-h Displays help

Diagnostics

Possible exit status values are:

0 - Successful completion.

1 - CLI usage failures, due to the use of an unsupported option or missing argument.

2 - Any other failure.

Examples

  • Delete a client with name client1.

    qdelete client -c client1
    This command deconfigures and deletes a client, do you want to continue (y/n)? [n]

  • Deconfigure, but do not delete, a client with name client1

    qdelete client -c client1 -deconfigure -y

  • Delete a set of clients specified in an argument file.

    qdelete client -af "E:\clients.txt"

    In this example, clients.txt is a text file containing a list of client names. Ensure that the file is in the following format:

    [client]
    Client01
    Client02
    ClientXX

You can mass-delete clients with or without their associated MediaAgents using the qdelete client command. You can include this command (along with the qdelete mediaagent command, if desired) in a script. Mass deletion of these items is useful if you want to remove them after a split of a CommCell. To mass-delete items where the CommCell is not split, be sure to run the script from the install location of the CommServe.

Qdelete dataagent

Description

This command deconfigures and/or deletes a given iDataAgent.

By default, the qdelete dataagent command asks for confirmation before deletion. You can skip the confirmation prompt using the "-y" option.

Upon successful completion, qdelete dataagent displays the message "Deleted the iDataAgent successfully" on the command prompt. In case of an error, an error code and description are displayed as: "dataagent: Error errorcode: errordescription"

Usage

qdelete dataagent -c client -a iDataAgent [-deconfigure] [-y] [-tf tokenfile] [-tk token] [-h]

Options

-c Client computer name
-a iDataAgent to be deleted (see Argument Values - Agent Types)
-d Deconfigures the iDataAgent without deleting it
-y Delete without confirmation
-tf Reads token from a file
-tk Token string
-h Displays help

Diagnostics

Possible exit status values are:

0 - Successful completion.

1 - CLI usage failures, due to the use of an unsupported option or missing argument.

2 - Any other failure.

Examples

  • Delete an iDataAgent MyDataAgent under client client1.

    qdelete dataagent -c client1 -a MyDataAgent
    This command deconfigures and deletes an iDataAgent, do you want to configure (y/n)

  • Deconfigure an iDataAgent MyDataAgent under client client1 without any confirmation.

    qdelete client -c client1 -a MyDataAgent -deconfigure - y

Log Off from the CommServe

Once you have completed the command line operations, you can logout from the CommServe using the following command:

qlogout -cs commserve

For example, to log out from the CommServe 'Server1'.

qlogout -cs Server1