Command Line Interface - Configuration - Exchange Database Agent
- Log On to the CommServe Computer
- Subclient Configuration
- Creating a Subclient
- Modifying a Subclient
- Deleting a Subclient
- Getting Subclient Properties
- Available Elements for Subclient Configuration
- Exchange Database Agent Properties
- Configuring Exchange Database Agent Properties: Set Method
- Configuring Exchange Database Agent Properties: Get Method
- Log Off from the CommServe Computer
Log On to the CommServe Computer
Before you run command line operations, use the qlogin command to log on to the CommServe computer.
- At the command prompt, navigate to <software installation directory>\Base.
- Use the appropriate method to log on to the CommServe computer.
Method 1: User Name/Password
- 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.
- Create a token file (record the name and location of the file).
- Run the following command:
qlogin -f <tokenFile>
- Enter the user name and password.
Enter User Name:
Password:
Subclient Configuration
Creating a Subclient
- Download the create_subclient_template.xml file and save it on the computer from where the command will be run.
- Change the XML element values.
- 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
- Download the update_subclient_add_template.xml file and save it on the computer from where the command will be run.
- Change the XML element values.
- 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
- Download the delete_subclient_template.xml file and save it on the computer from where the command will be run.
- Change the XML element values.
- 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
- Download the get_subclient_template.xml file and save it on the computer from where the command will be run.
- Change the XML element values.
- 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:
|
networkAgents | Number of Network Agents. |
softwareCompression | Option to enable compression on the Client or MediaAgent computer. Valid values are:
|
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:
|
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:
|
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
|
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.
- Download the set_exchange_database_properties.xml file and save it on the computer where the command is run.
- Open the XML file.
- 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. - 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.
- Download the get_exchange_database_properties.xml file and save it on the computer where the command is run.
- Open the XML file.
- 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. - 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