Command Line Interface - Backup - Exchange Mailbox Agent

Table of Contents

Generate the Command Line Script from the CommCell Console

In order to run the backups from command line, you need an input XML file that contains the parameter values for configuring the backup options. This input XML file can be obtained by generating the script from the CommCell Console and saving it on the computer from where the backup will be performed.

  1. From the CommCell Browser, navigate to <Client> | Exchange Mailbox | defaultBackupSet.
  2. Right click the <Subclient> and click Backup.
  1. Select the required backup options which you want to execute using the script.
  2. Click Save as Script.
  1. Enter the location to save the script along with the file name and extension. For example, "C:\scripts\myscript.bat" on Windows and "/usr/scripts/myscript.sh" on Unix. Alternatively, you can also click Browse and navigate to the location.

    The script will be saved as a .xml file and .bat/.sh file.

    If a file with the same name already exists in the specified location, both the .xml and .bat/.sh files will be overwritten.

  2. Enter the username and password for the user account which you want to use to perform the backup.

    By default, the user account which you have used to login to CommCell console is used for performing the backup. However, if the user account does not have access to any application or database, click Use a different account.

  3. Click OK.

Perform the Backup

  1. From Command prompt, navigate to <software installation directory>\Base and run the following command:

    qlogin -cs <commserve name> -u <user name>

  2. Navigate to the location where the XML file is saved and execute the saved XML script using the qoperation execute command.

    qoperation execute -af backup.xml -appName 'Exchange Mailbox' -clientName xxxxx -backupsetName xxxxx -subclientName xxxxx -backupLevel FULL

  1. Verify the status of the job using the following command:

    qlist job −j jobID

  2. Once the job completes, log off from the CommServe using the qlogout command.

    qlogout [−cs <commserve_host_name>] [−all] [−tf <tokenfile>] [−tk <token>] [−h]

Examples

Performing a Full Backup

qoperation execute -af backup.xml -appName 'Exchange Mailbox' -clientName client1 -backupsetName backupset1 -subclientName subclient1 -backupLevel FULL

Performing an Incremental Backup

qoperation execute -af backup.xml -appName 'Exchange Mailbox' -clientName client1 -backupsetName backupset1 -subclientName subclient1 -backupLevel INCREMENTAL