Generate the Command Line Script from the CommCell Console
In order to run the restores from command line, you need an input XML file which contains the parameter values for configuring the restore 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 restore will be performed.
-
From the CommCell Browser, navigate to Client Computers > client > Exchange Public Folder > backup_set.
-
Right-click the subclient in the right pane and then click Browse Backup Data.
-
Click OK.
-
In the right pane of the Browse window, select the data that you want to restore and click Recover All Selected.
-
Select the required restore options which you want to execute using the script.
-
Click Save as Script.
-
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.
-
Enter the username and password for the user account which you want to use to perform the restore.
By default, the user account which you have used to login to CommCell console is used for performing the restore. However, if the user account does not have access to application and database, click Use a different account.
-
Click OK.
Perform the Restore
-
From Command prompt, navigate to <software installation directory>\Base and run the following command:
qlogin -cs <commserve name> -u <user name>
-
Navigate to the location where the .xml file is saved and execute the saved .xml script using the qoperation execute command.
qoperation execute -af restore.xml -appName 'Exchange Public Folder' -clientName xxxxx -backupsetName xxxxx -destPath 'xxxxx' -sourceItem 'xxxxx'
Note: If the sourceItem parameter contains a directory path, verify the path is valid before you run the command.
-
Verify the status of the job using the following command:
qlist job -j jobID -
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
|
Restoring from a Current Backup |
|
|---|---|
|
Restoring Files to a Point-in-Time (Date) |
|
|
Restoring Files to a Point-in-Time (Date and Time) |
|
Find Data
The following command is available for finding backed up data.
qlist backupfiles
Description
This command performs a search operation on backed up files and saves the results to a file. The type of operation is defined in the opType attribute in the XML request file:
-
Find: Performs a recursive search and returns a list of files and folders. Specify recursion by using asterisks in the path attribute as shown: <paths path="C:\data\**\*" />.
-
Browse: Performs a search on one directory and returns a list of files and folders in that directory. (The Browse operation is not recursive.)
-
Versions: Lists all of the versions of a single file.
For the Find and Browse operations, you can limit the results to backed up files for a specific job by using the <jobId> element in the XML request file.
In case of an error, an error code and description are displayed as: "backupfiles: Error errorcode: errordescription"
Usage
qlist backupfiles -af <path_to_input_XML_file> -dpath <path_to_output_XML_file> [-tf <tokenfile>] [-tk <token>] [-example] [-h]Options
|
-af |
XML file that contains the request |
|
-dpath |
Destination path and file name for the XML output file |
|
-tf |
Reads token from a file |
|
-tk |
Token string |
|
-example |
Sample "find" and "browse" XML requests |
|
-h |
Displays help |
Diagnostics
Possible exit status values are:
0 - Successful completion.
1 - CLI usage failures, due to the use of an unsupported option or missing argument.
2 - Any other failure.
Examples
-
For the default subclient, finds all of the files and folders in the C:\data directory and its subdirectories.
qlist backupfiles -af c:\searches\find.xml -dpath c:\results\find_results.xmlXML example for the Find operation:
<databrowse_BrowseRequest opType="Find"> <entity _type_="0" appName="Windows File System" backupsetName="defaultBackupSet" clientName="vmcs100_cn" subclientName="default"/> <paging pageSize="4294967295" skipNode="0"/> <mode mode="2"/> <paths path="C:\data\**\*" /> </databrowse_BrowseRequest> -
For the default subclient, browses the files and folders in the C:\ directory.
qlist backupfiles -af c:\searches\browse.xml -dpath c:\results\browse_results.xmlXML example for the Browse operation:
<databrowse_BrowseRequest opType="Browse"> <entity _type_="0"appName="Windows File System" backupsetName="defaultBackupSet" clientName="vmcs100_cn" subclientName="default"/> <mode mode="2"/> <paging pageSize="4294967295" skipNode="0"/> <paths path="C:\"/> <timeRange fromTime="0" toTime="1331280338"/> </databrowse_BrowseRequest> -
For job ID 857 run on the default subclient, browses the files and folders in the C:\ directory.
qlist backupfiles -af c:\searches\find.xml -dpath c:\results\find_results.xmlXML example for the Browse operation for a specific job ID:
<databrowse_BrowseRequest opType="Browse"> <entity _type_="0"appName="Windows File System" backupsetName="defaultBackupSet" clientName="vmcs100_cn" subclientName="default"/> <mode mode="2"/> <paging pageSize="4294967295" skipNode="0"/> <paths path="C:\"/> <timeRange fromTime="0" toTime="1331280338"/> <advOptions> <advConfig> <browseAdvancedConfigBrowseByJob> <jobId>857</jobId> </browseAdvancedConfigBrowseByJob> </advConfig> </advOptions> </databrowse_BrowseRequest> -
For the default subclient, lists the versions available for the mydata.txt file.
qlist backupfiles -af c:\searches\versions.xml -dpath c:\results\versions_results.xmlXML example for the Versions operation:
<databrowse_BrowseRequest opType="Versions"> <entity _type_="0"appName="Windows File System" backupsetName="defaultBackupSet" clientName="vmcs100_cn" subclientName="default"/> <mode mode="2"/> <paths path="C:\Users\Administrator\Documents\test\mydata.txt"/> </databrowse_BrowseRequest>