Generating the XML Version of the File Level Analytics Report on the Command Line

You can perform index queries using the qlist backupfiles command, which takes input from an XML file that you download and customize. This method returns the results to another XML file that you name.


  1. Download the XML template file for an XML query example, onto the client computer from which you will run the query command.
  2. Edit the template file, by inserting values for these required parameters into their provided placeholders:



    entity clientName="clientName"

    The name of the client the backup set belongs to.

    entity backupsetName="backupsetName"

    Name of the backup set to browse. If no name is specified, defaultBackupSet is used.

    entity subclientName="subclientName"

    The name of a subclient within the above backup set.

    paths path="path"

    For Browse operations, supply the path to a single folder containing the backed-up files. For example:

    E:\superbrowse\SC2 displays all data in the SC2 folder.

    For Find operations, which are recursive, wildcards are supported. For example:

    c:\User\Admin\Documents\**\* finds all files meeting filter criteria, starting at the Documents directory, including those in its subdirectories, the subdirectories of those, and so on. To find all files beginning at the root directory, use just "\**\*". Note that the syntax at the end of the path (\**\*) specifies performing a recursive search beginning at that point.

    For Versions operations, which return a list of the versions of a file available for restore, the last component of the path is a single filename. For example:


  3. Modify the parameters listed in the Supported Elements and Parameters Used in Index Queries table if you find them in your query template and want to change the template's behavior accordingly. Values appearing in the template but not mentioned in the table should be left as supplied.
  4. Save your edited XML file.
  5. Log on to the CommServe computer.
  6. Change to the base installation directory:

    cd software_installation_path/Base

  7. Run the qlist backupfiles command, pointing to the XML file you edited:

    qlist backupfiles -af path_to_input_xml -dpath path_to_output_xml

  8. The command returns its output to the file you specify in the -dpath option, which you can redirect as needed using the operating system's built-in functionality.
  9. Log off of the CommServe Computer.

Last modified: 12/14/2018 8:49:35 PM