Command Line Interface - Configuration - Exchange Database Agent

Table of Contents

Log On to the CommServe Computer

Before you run command line operations, use the qlogin command to log on to the CommServe computer.

  1. At the command prompt, navigate to <software installation directory>\Base.
  2. Use the appropriate method to log on to the CommServe computer.

Method 1: User Name/Password

  1. Log on to CommServe using a CommServe name and a user name.

    For example, if CommServe name = server1 and user name = user1:

    qlogin -cs server1 -u user1
    Password:
    User logged in successfully.

Method 2: Token File

When you use the token file method, you must append the token file to your qcommand.

  1. Create a token file (record the name and location of the file).
  2. Run the following command:

    qlogin -f <tokenFile>

  3. Enter the user name and password.

    Enter User Name:
    Password:

Subclient Configuration

Creating a Subclient

  1. Download the create_subclient_template.xml file and save it on the computer from where the command will be run.
  2. Change the XML element values.
  3. Run the following command from the <software installation directory>\Base folder.

    qoperation execute -af create_subclient_template.xml -appName 'Exchange Database' -clientName xxxxx -subclientName xxxxx

Modifying a Subclient

  1. Download the update_subclient_add_template.xml file and save it on the computer from where the command will be run.
  2. Change the XML element values.
  3. Run the following command from the <software installation directory>\Base folder.

    qoperation execute -af update_subclient_add_template.xml -appName 'Exchange Database' -clientName xxxxx -subclientName xxxxx

Deleting a Subclient

  1. Download the delete_subclient_template.xml file and save it on the computer from where the command will be run.
  2. Change the XML element values.
  3. Run the following command from the <software installation directory>\Base folder.

    qoperation execute -af  delete_subclient_template.xml -appName 'Exchange Database' -clientName xxxxx -subclientName xxxxx

Getting Subclient Properties

  1. Download the get_subclient_template.xml file and save it on the computer from where the command will be run.
  2. Change the XML element values.
  3. Run the following command from the <software installation directory>\Base folder.

    qoperation execute -af get_subclient_template.xml -appName 'Exchange Database' -clientName xxxxx -subclientName xxxxx

Available Elements for Subclient Configuration

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

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

Element Description of the Element Value
clientName Name of the client computer.
backupsetname Name of the backup set.
appName Name of the application. In this case it is 'Exchange Database'.
subclientname Name of the subclient.
enableBackup Option to enable/disable backup.

Valid values are True/False.

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.
networkAgents Number of Network Agents.
softwareCompression Option 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.
  • 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.

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.
dataBackupStoragePolicy/storagePolicyName Name of the Storage Policy to be associated for backup.
postBackupCommand Path to the post process script that will be run after the backup.
postScanCommand Path to the post process script that will be run after the scan phase
preBackupCommand Path to the pre process script that will be run before the backup.
preScanCommand Path to the pre process script that will be run before the scan phase
runAs Option to specify the user name who has permissions to run the pre/post process scripts. Valid values are:
  • USE_IMPERSONATION, to specify a user with enough privileges to run the scripts. When using this value, you also need to provide the user credentials:

    -prepostUserName/userName <user name> -prepostUserName/password <password>

  • USE_LOCAL_SYS_ADMIN, to use the administrator account to run the scripts.
exchangeDBContent/storageGroup Name of the storage group where the Exchange database to be backed up resides. This parameter must be used along with the exchangeDBContent/databaseName and contentOperationType parameter, for example:

-contentOperationType <value> -exchangeDBContent/storageGroup '<group name>' -exchangeDBContent/databaseName '<DB name>'

exchangeDBContent/forceFull Option to force a full backup of the databases specified in the subclient content. Valid values are true/false.

This parameter must be used along with the contentOperationType parameter, for example:

-contentOperationType <value> -exchangeDBContent/forceFull <value>

contentOperationType Modification type. Valid values are
  • ADD, to add content to the subclient
  • OVERWRITE, to overwrite contents to the subclient.
  • DELETE, to delete the contents from the subclient.

Examples

Adding Content To update the location for the subclient content, use the following command:

qoperation execute -af update_subclient_add_template.xml -appName 'Exchange Database' -clientName client1 -subclientName subclient1 -contentOperationType ADD -exchangeDBContent/storageGroup 'Microsoft Information Store' -exchangeDBContent/databaseName 'DB1'

Setting a Storage Policy To assign a storage policy to a subclient, add the storagePolicyName element to the following command:

qoperation execute -af update_subclient_add_template.xml -appName 'Exchange Database' -clientName client1 -subclientName subclient1 -dataBackupStoragePolicy/storagePolicyName sp1

Exchange Database Agent Properties

You can set and get the properties of the Exchange Database Agent from the command line interface.

Configuring Exchange Database Agent Properties: Set Method

You can use the Set method to change certain Exchange Database Agent properties while jobs are running.

  1. Download the set_exchange_database_properties.xml file and save it on the computer where the command is run.
  2. Open the XML file.
  3. Change the XML element values.
    Element Description of the Element Value
    appName Name of the application. In this case, the value is "Exchange Database".
    clientName Name of the client computer.
    userAccount/username The service account username.
    userAccount/password The service account password.
    serverName Name of the Exchange server.
  4. Run the following command from the <software installation directory>\Base folder.

    qoperation execute -af <download_location> -clientName "xxxxx" -appName "Exchange Database" -userAccount/userName "xxxxx" -userAccount/password "xxxxx" -serverName "xxxxx" -exchangeDBProp/idaVersion "xxxxx"

Configuring Exchange Database Agent Properties: Get Method

You can use the Get method to verify the properties that you configured using the Set method.

  1. Download the get_exchange_database_properties.xml file and save it on the computer where the command is run.
  2. Open the XML file.
  3. Change the XML element values.
    Element Description of the Element Value
    appName Name of the application. In this case, the value is "Exchange Database".
    clientName Name of the client computer.
  4. Run the following command from the <software installation directory>\Base folder.

    qoperation execute -af <download_location> -clientName "xxxxx" -appName "Exchange Database" -filterOptions/propertyLevel AllProperties

Log Off from the CommServe Computer

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