Command Line Interface - SAP MaxDB 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

Instance Configuration

Adding an Instance

  1. Download the create_instance_template.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 create_instance_template.xml -appName "SAP for MAX DB" -clientName xxxxx -instanceName xxxxx -commandLineStoragePolicy/storagePolicyName xxxxx -logBackupStoragePolicy/storagePolicyName xxxxx -userGroupName xxxxx -associatedUserGroupsOperationType ADD

Modifying an Instance

  1. Download the modify_instance_template.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 and attributes.

    For example, the command below modifies the name of the instance.

    qoperation execute -af modify_instance_template.xml -appName "SAP for MAX DB" -clientName xxxxx -instanceName xxxxx -newName xxxxx

Deleting an Instance

Warning: If you do not include the instanceName parameter when you delete instances, all SAP MaxDB instances are deleted for the client.

  1. Download the delete_instance_template.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 and attributes.

    qoperation execute -af delete_instance_template.xml -appName "SAP for MAX DB" -clientName xxxxx -instanceName xxxxx

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
clientName Name of the client computer.
appName Name of the application. In this case it would be 'SAP for MAX DB'.
instanceName Name of the SAP for MAX DB instance.
description A general description of the instance.
encryptionFlag Option to set the encryption points during backups. Valid values are:
  • ENC_MEDIA_ONLY, to encrypt the backup data after transmission and prior to storage on the media.
  • ENC_NETWORK_AND_MEDIA, to encrypt the backup data before transmission. The data is stored encrypted on the media.
  • ENC_NETWORK_ONLY, to encrypt the backup data for transmission and then decrypt the data prior to storage on the media.
  • ENC_NONE, to disable data encryption.
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 signature generation.
networkAgents Number of Network Agents.
softwareCompression Option to enable compression. 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.

enableDeduplication Option to enable deduplication on subclient.

Valid values are True/False.

commandLineStoragePolicy/storagePolicyName Name of the storage policy used to back up this instance.
logStoragePolicy/storagePolicyName Name of the storage policy used to back up data and logs of this instance.
userGroupName Name of the user group to be associated to the instance. This is the user group that you associate from the Security tab of the instance properties dialog box in the CommCell Console.
associatedUserGroupsOperationType Specifies the operation that you want to perform on the user groups. Valid values are:
  • ADD, to add a new user group.
  • OVERWRITE, to change the existing user groups with others.
  • DELETE, to delete a user group.

The following example shows how to add a parameter for a command:

Modify the Log Storage Policy

qoperation execute -af modify_instance_template.xml -appName "SAP for MAX DB" -clientName client1 -instanceName instance1 -logBackupStoragePolicy/StoragePolicyName log_SP1

Enable Encryption and Software Compression

qoperation execute -af modify_instance_template.xml -appName "SAP for MAX DB" -clientName client1 -instanceName instance1 -encryptionFlag ENC_NETWORK_AND_MEDIA -softwareCompression USE_STORAGE_POLICY_SETTINGS

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