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
Subclient Configuration
Creating a Subclient
-
Download the create_subclient_template.xml file and save it on the computer from where the command will be executed.
-
Execute the following command from the <Software_Installation_Directory>/Base folder after substituting the parameters values.
qoperation execute -af create_subclient_template.xml -appName 'Notes Database' -clientName xxxxx -subclientName xxxxx
Modifying a Subclient
-
Download the update_subclient_template.xml file and save it on the computer from where the command will be executed.
-
Execute the following command from the <Software_Installation_Directory>/Base folder after substituting the parameters values.
qoperation execute -af update_subclient_template.xml -appName 'Notes 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 executed.
-
Execute the following command from the <Software_Installation_Directory>/Base folder after substituting the parameters values.
qoperation execute -af delete_subclient_template.xml -appName 'Notes 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 executed.
-
Execute the following command from the <Software_Installation_Directory>/Base folder after substituting the parameters values.
qoperation execute -af get_subclient_template.xml -appName 'Notes Database' -clientName xxxxx -subclientName xxxxx
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: (Some examples are provided at the end of the table.)
qoperation execute -af <template XML file> -<parameter name> <value>
Parameter |
Description of Parameter Values |
clientName |
Name of the client computer. |
backupsetname |
Name of the backup set. |
appName |
Name of the application. In this case it would be 'Notes 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-process and post-process scripts. Valid values are:
|
lotusNotesDBContent/databaseTitle |
Name of the Notes Database to be backed up. This parameter must be used along with the lotusNotesDBContent/relativePath (path to the database, starting from beneath the partition folder) and the contentOperationType parameter, for example: -contentOperationType <value> -lotusNotesDBContent/databaseTitle '<DB name>' -lotusNotesDBContent/relativePath '<DB relative path>' |
contentOperationType |
Modification type. Valid values are
|
Examples
The following examples show how to add a parameter for a command:
Adding Content |
To update the location for the subclient content use the following command: qoperation execute -af update_subclient_template.xml -appName 'Notes Database' -clientName client1 -subclientName subclient1 -contentOperationType ADD -lotusNotesDBContent/databaseTitle 'LotusDB' -lotusNotesDBContent/relativePath '/DBset/DB1' |
Setting a Storage Policy |
To assign a storage policy to a subclient, add the 'storagePolicyName' parameter to the following command: qoperation execute -af update_subclient_template.xml -appName 'Notes Database' -clientName client1 -subclientName subclient1 -dataBackupStoragePolicy/storagePolicyName sp1 |
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