Loading...

Command Line Interface - Configuration - Oracle RAC iDataAgent

Table of Contents

Configuring a RAC

Creating RAC Pseudo Client

Use XML to create an Oracle RAC client.

You can include the XML parameters in the xml file, or you can specify them on the command line when they frequently change. For more information on command line parameters and XML elements, see Command Line - Syntax.

  1. On the Oracle RAC Agent host, run the qlogin command to log on to the CommServe computer.
  2. Download the CreateRACClient.xml file to the computer where you will run the command.
  3. Open the CreateRACClient.xml file, add your specific parameters, and save the file.
  4. On the command line, go to Software_Installation_Directory/Base and type the command.

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

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

Adding First RAC Node

Use XML to add the first Oracle RAC node.

You can include the XML parameters in the xml file, or you can specify them on the command line when they frequently change. For more information on command line parameters and XML elements, see Command Line - Syntax.

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

    For information on supported instance XML parameters, see Available XML Parameters for Oracle Instance Configuration.

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

    qoperation execute -af 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>' -commandLineStoragePolicy/storagePolicyName '<data_sp>' -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>'

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

Adding Second RAC Node

Use XML to add the second Oracle RAC node

You can include the XML parameters in the xml file, or you can specify them on the command line when they frequently change. For more information on command line parameters and XML elements, see Command Line - Syntax.

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

    For information on supported instance XML parameters, see Available XML Parameters for Oracle Instance Configuration.

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

    qoperation execute -af 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>'

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

Getting Instance Properties

Use XML to view Oracle RAC database instance properties. Run the operation from the command line, or automate configuration by combining command line operations in a script.

Use this command to:

  • View the current Oracle RAC database instance properties
  • View the Oracle RAC database instance properties to verify the changes after using XML to modify the instance

You can include the XML parameters in the xml file, or you can specify them on the command line when they frequently change. For more information on command line parameters and XML elements, see Command Line - Syntax.

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

    For information on supported instance XML parameters, see Available XML Parameters for Oracle RAC Instance Configuration.

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

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

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

Modifying an Instance

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

You can include the XML parameters in the xml file, or you can specify them on the command line when they frequently change. For more information on command line parameters and XML elements, see Command Line - Syntax.

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

    For information on supported instance XML parameters, see Available XML Parameters for Oracle Instance Configuration.

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

    qoperation execute -af 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>'

Examples

Changing Control File Autobackup Type

qoperation execute -af <xml_path>\UpdateRACInstance.xml –cs <CommServeName> -instance/appName 'Oracle RAC' -instance/clientName 'RacPseudoclient' -entity/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' -instanceinstanceName '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 –cs <CommServeName> -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> -instance/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> -instance/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> -instance/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> -instance/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> -instance/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> -entity/appName 'Oracle RAC' –entity/clientName '<RACpseudoclientname>' –entity/instanceName '<RACDatabaseName>'

Deleting RAC Instance

qoperation execute -af <xml_path>\DeleteRACInstance.xml –cs <CommServeName> -entity/appName 'Oracle RAC' –entity/clientName 'RacPseudoclient' –entity/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 -entity/appName 'Oracle RAC' -entity/clientName 'Rac_MultiInstance' -entity/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 -entity/appName 'Oracle RAC' -entity/clientName 'Rac_MultiInstance' -entity/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

Creating a Subclient

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

  1. On the Oracle RAC 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 RAC Subclient Configuration.

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

    qoperation execute -af xml_path\CreateSubclient.xml -cs <CommServeName> -subClientEntity/appName "Oracle RAC" -subClientEntity/clientName 'RACPseudoClient' -instanceName 'racdb' -subclientName 'subclient1'

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

Getting Subclient Properties

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.

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

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

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

    qoperation execute -af xml_path\get_subclient_template.xml -cs <CommServeName> -subClientEntity/appName 'Oracle RAC' -subClientEntity/clientName 'RACPseudoClient' -instanceName 'racdb' -subclientName 'subclient1'

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

Modifying Subclient Properties

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.

  1. On the Oracle RAC Agent host, run the qlogin command to log on to the CommServe.
  2. Download the UpdateSubclient.xml file 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 Available XML Parameters for Oracle RACSubclient 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 -cs <CommServeName> -subClientEntity/appName "Oracle RAC" -subClientEntity/clientName 'RACPseudoClient' -instanceName 'racdb' -subclientName 'subclient1' -newName 'new_subclient_name' -dataBackupStoragePolicy/storagePolicyName 'data_sp''

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

Deleting a Subclient

Use XML to delete Oracle subclients. Run the operation from the command line, or automate configuration by combining command line operations in a script.

You can include the XML parameters in the xml file, or you can specify them on the command line when they frequently change. For more information on command line parameters and XML elements, see Command Line - Syntax.

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

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

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

    qoperation execute -af <xml_path>\delete_subclient_template.xml -cs <CommServeName> -entity/appName 'Oracle RAC' -entity/clientName 'RACPseudoClient' -entity/instanceName 'racdb' -entity/subclientName 'subclient1'

  5. Once the job completes, run the qlogout command to log off the CommServe computer.

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> -entity/appName "Oracle RAC" -entity/clientName 'RACPseudoClient' -entity/instanceName 'racdb' -entity/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> -entity/appName "Oracle RAC" -entity/clientName 'RacPseudoClient' -entity/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> -entity/appName "Oracle RAC" -entity/clientName 'RacPseudoClient' -entity/instanceName 'racdb' -entity/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> -entity/appName "Oracle RAC" -entity/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> -entity/appName "Oracle RAC" -entity/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> -entity/appName "Oracle RAC" -entity/clientName 'RacPseudoClient' -entity/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> -entity/appName "Oracle RAC" -entity/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.

  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> -entity/appName "Oracle RAC" -entity/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> -entity/appName "Oracle RAC" -entity/clientName 'RacPseudoClient' -instanceName 'racdb' -subclientName 'snap_backup' -isSnapBackupEnabled true -dataBackupStoragePolicy/storagePolicyName 'data_sp'

Updating a Subclient with Data Threshold Streams, Backup SP File, Datafiles per BFS, Skip Offline, Skip Inaccessible, Max Backup Set Size, Software Compression and Network Agents:  Use the following parameters:
  •  dataThresholdStreams - set to the numerical value (in this example '3'),
  •  backupSPFile - 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/update_subclient_template.xml -cs <CommServeName> -entity/appName "Oracle RAC" -entity/clientName 'RacPseudoClient' -instanceName 'racdb' -subclientName 'oracleSOF' -dataThresholdStreams 3 -backupSPFile true -dataFilesPerBFS 40 -skipOffline true -skipInaccessible true -maxBackupSetSizeInKB 2 -softwareCompression ON_CLIENT -networkAgents 2

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> -entity/appName "Oracle RAC" -entity/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.

  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> -entity/appName "Oracle RAC" -entity/clientName 'RacPseudoClient' -instanceName 'racdb' -subclientName 'oracleSOF' -enableDeduplication true -generateSignature ON_MEDIA_AGENT

Update an Online Subclient to Update the Data Stream for the 2nd Node and Values for Both Log Streams

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

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

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

Deleting a Subclient

qoperation execute -af /home/oracle/delete_subclient_template.xml –cs <CommServeName> -entity/appName "Oracle RAC" -entity/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 -i <instance name>

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 agents.

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 or deletes the specified agent.

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

Upon completion, qdelete dataagent displays a message that the agent was successfully deleted 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 agent [-deconfigure] [-y] [-tf tokenfile] [-tk token] [-h]

Options

-c Client computer name
-a The agent to be deleted (see Argument Values - Agent Types)
-d Deconfigures the agent 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 agent named MyDataAgent under client client1.

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

  • Deconfigure an agent named MyDataAgent under client client1 without any confirmation.

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