Enterprise Vault™ Utilities

Last Published:
Product(s): Enterprise Vault (12.3)
  1. About this guide
    1.  
      About Enterprise Vault utilities
    2.  
      Running the Enterprise Vault command-line utilities with administrator privileges
    3. Where to get more information about Enterprise Vault
      1.  
        Enterprise Vault training modules
  2. ArchivePoints
    1.  
      About ArchivePoints
    2.  
      ArchivePoints syntax
    3.  
      ArchivePoints examples
  3. Audit Viewer
    1.  
      About Audit Viewer
    2.  
      Using Audit Viewer to run a report on audit data
    3.  
      Copying the search results from Audit Viewer
    4.  
      Changing Audit Viewer settings
  4. Backtrace
    1.  
      About Backtrace
    2.  
      Backtrace default settings
    3.  
      Backtrace registry values
    4.  
      Backtrace file name format
    5.  
      Backtrace examples
  5. CenteraPing
    1.  
      About CenteraPing
    2.  
      CenteraPing syntax
  6. Domino Archive Exporter
    1.  
      About Domino Archive Exporter
    2.  
      Domino Archive Exporter syntax
    3.  
      Domino Archive Exporter example
  7. Domino Profile Document Tool
    1.  
      About Domino Profile Document Tool
    2.  
      Domino Profile Document Tool syntax
    3.  
      Domino Profile Document Tool examples
  8. Domino Retention Plan Tool
    1.  
      About Domino retention plans
    2.  
      Domino Retention Plan Tool permissions
    3.  
      Defining a Domino retention plan
    4.  
      EVDominoRetentionPlans.exe syntax
  9. DTrace
    1.  
      About DTrace
    2.  
      Running DTrace from the command line
    3.  
      Running DTrace from the Administration Console
    4.  
      About the DTrace log
    5.  
      DTrace troubleshooting
  10. EVDominoExchangeMigration Tool
    1.  
      About the EVDominoExchangeMigration tool
    2.  
      Client requirements for the EVDominoExchangeMigration tool
    3.  
      Adding the EVDominoExchangeMigration tool to the Windows Server firewall exceptions list
    4.  
      EVDominoExchangeMigration tool and Binary Tree
    5.  
      Using Quest Notes Migrator for Exchange and the EVDominoExchangeMigration tool
    6.  
      Requirements for other migration software with the EVDominoExchangeMigration tool
    7. Running the EVDominoExchangeMigration tool
      1.  
        Syntax for EVDominoExchangeMigration tool
      2.  
        Log files for EVDominoExchangeMigration tool
      3.  
        Limitations of EVDominoExchangeMigration tool
  11. EVDuplicateCleaner
    1.  
      About EVDuplicateCleaner
    2.  
      Prerequisites for EVDuplicateCleaner
    3.  
      Configuring EVDuplicateCleaner
    4.  
      Running EVDuplicateCleaner
    5.  
      Fixing broken shortcuts after you have run EVDuplicateCleaner
  12. EVEARemovalUtility
    1.  
      About EVEARemovalUtility
    2.  
      EVEARemovalUtility prerequisites
    3.  
      Running EVEARemovalUtility
    4.  
      EVEARemovalUtility syntax
    5.  
      Format of the EVEARemovalUtility output and log files
    6. EVEARemovalUtility usage examples
      1.  
        EVEARemovalUtility example: processing a single file
      2.  
        EVEARemovalUtility example: processing a folder and its subfolders
  13. EVFSASetRightsAndPermissions
    1.  
      About EVFSASetRightsAndPermissions
    2.  
      Running EVFSASetRightsAndPermissions
  14. EVrights
    1.  
      About EVrights
    2.  
      EVrights syntax
  15. EVservice
    1.  
      About EVservice
    2.  
      EVservice prerequisites
    3.  
      EVservice syntax
    4.  
      EVservice list file format
  16. EVSPShortcutManager
    1.  
      About EVSPShortcutManager
    2.  
      Permissions required to run EVSPShortcutManager
    3.  
      EVSPShortcutManager syntax
    4.  
      EVSPShortcutManager examples
  17. EVSVR
    1. About EVSVR
      1.  
        About the checkpointing facility in EVSVR
      2.  
        Note on performing EVSVR operations on CIFS and NTFS partitions
    2.  
      Starting EVSVR
    3.  
      EVSVR commands
    4.  
      EVSVR application states
    5.  
      Creating an EVSVR operation file
    6.  
      Editing an EVSVR operation file in which you have enabled checkpointing
    7.  
      Running an EVSVR operation
    8. About the EVSVR operation settings
      1. Report operations in EVSVR
        1.  
          EVSVR Directory report options
        2.  
          EVSVR Directory and VaultStore report options
        3.  
          EVSVR Fingerprint report options
        4.  
          EVSVR Partition report options
        5.  
          EVSVR StorageQueue report options
        6.  
          EVSVR VaultStore report options
      2. Verify operations in EVSVR
        1.  
          Verification levels for an EVSVR ArchiveObjects Verify operation
        2.  
          Choosing a suitable EVSVR Verify operation
        3.  
          Example: Using EVSVR to verify the savesets in a vault store database
      3. Repair operations in EVSVR
        1.  
          Risk of data loss when you run certain EVSVR Repair operations
        2.  
          Choosing a suitable EVSVR Repair operation
        3.  
          EVSVR repair procedures
    9. Using the output from one EVSVR operation as input for another operation
      1.  
        About EVSVR item list files
      2.  
        EVSVR operations that support item list processing
    10. Viewing the EVSVR output log file
      1.  
        About the checkpointing information in the EVSVR log file
      2.  
        About the item list information in the EVSVR log file
      3.  
        Additional log file information when you run certain EVSVR Repair operations
    11. Running EVSVR in interactive mode
      1.  
        DumpSaveset command
      2.  
        DumpSISPart command
      3.  
        ExtractSavesets command
      4.  
        GetNativeItem command
      5.  
        ListSavesetLocations command
      6.  
        Note on reviewing the messages in the EVSVR log files
    12.  
      Improving EVSVR performance when processing CAB collections
  18. FSARunNow
    1.  
      About FSARunNow
    2.  
      Running FSARunNow
    3.  
      FSARunNow syntax
    4.  
      FSARunNow examples
  19. FSAUndelete
    1.  
      About FSAUndelete
    2.  
      Running FSAUndelete
    3.  
      FSAUndelete syntax
    4.  
      FSAUndelete examples
  20. FSAUtility
    1.  
      About FSAUtility
    2.  
      Running FSAUtility
    3. About using FSAUtility with Dell EMC Celerra/VNX placeholders
      1.  
        Configuring which API call FSAUtility uses to identify Dell EMC Celerra/VNX placeholders
      2.  
        Example FSAUtility.exe.config file settings
    4. FSAUtility options
      1.  
        Recreating archive points
      2.  
        Recreating placeholders
      3.  
        Moving placeholders and corresponding files
      4.  
        Migrating placeholders
      5.  
        Deleting orphaned placeholders
      6.  
        Restoring archived files
      7.  
        Recalling files corresponding to placeholders
  21. NTFS to Centera Migration
    1.  
      About NTFS to Centera Migration
    2.  
      Managing migrator jobs using NTFS to Centera Migration
    3.  
      Creating migrator jobs using NTFS to Centera Migration
    4.  
      Deleting active jobs using NTFS to Centera Migration
    5.  
      Deleting source files after migration using NTFS to Centera Migration
    6.  
      NTFS to Centera Migration log files
  22. Permissions Browser
    1.  
      About Permissions Browser
    2.  
      Running Permissions Browser
    3.  
      About the information that Permissions Browser provides
  23. Policy Manager (EVPM)
    1.  
      About Policy Manager
    2.  
      Policy Manager syntax
    3.  
      Saving a Policy Manager initialization file as a Unicode file
    4.  
      Policy Manager initialization file syntax
    5. Sections and keynames in Policy Manager initialization file
      1.  
        [Directory] section of the Policy Manager initialization file
      2.  
        [Archive] section of the Policy Manager initialization file
      3.  
        [ArchivePermissions] section of the Policy Manager initialization file
      4.  
        [Filter] section of the Policy Manager initialization file
      5.  
        [Mailbox] section of the Policy Manager initialization file
      6.  
        [Folder] section of the Policy Manager initialization file
      7.  
        [PublicFolder] section in the Policy Manager initialization file
      8.  
        [PSTdefaults] section in the Policy Manager initialization file
      9.  
        [PST] section in the Policy Manager initialization file
      10.  
        [PSTcheckpoint] section in the Policy Manager initialization file
      11.  
        [NSFDefaults] section in the Policy Manager initialization file
      12.  
        [NSF] section in the Policy Manager initialization file
      13.  
        [NSFCheckPoint] section in the Policy Manager initialization file
    6. Policy Manager initialization file examples
      1.  
        Policy Manager initialization file example 1
      2.  
        Policy Manager initialization file example 2
      3.  
        Policy Manager initialization file example 3
      4.  
        Policy Manager initialization file example 4: PST migration
      5.  
        Policy Manager initialization file example 5: NSF migration
      6.  
        Policy Manager initialization file example 6: folder permissions
    7. About using the Provisioning API to run Policy Manager scripts
      1. Provisioning API scripting properties for Policy Manager scripts
        1.  
          Example provisioning API Policy Manager script
      2. Provisioning API Advanced settings for Policy Manager scripts
        1.  
          SetScript methods for provisioning API advanced settings for Policy Manager scripts
        2.  
          Sample script for provisioning API advanced settings for Policy Manager
        3.  
          Example of enabling a mailbox using a script file with provisioning API advanced settings for Policy Manager
      3.  
        Provisioning API Interface methods for Policy Manager scripts
      4.  
        Provisioning API error handling for Policy Manager scripts
  24. ResetEVClient
    1.  
      About ResetEVClient
    2.  
      ResetEVClient syntax
  25. Vault Store Usage Reporter
    1.  
      About Vault Store Usage Reporter
    2.  
      Starting Vault Store Usage Reporter
    3.  
      Setting up a shortcut link to Vault Store Usage Reporter
    4.  
      Understanding the usage summary from Vault Store Usage Reporter
    5.  
      Checking that the IIS authentication method is correctly set for Vault Store Usage Reporter

DumpSaveset command

The DumpSaveset command retrieves the saveset and associated SIS parts of the specified archived item.

Syntax

DumpSaveset EntryId SavesetId [-o OutputFolder]

Where the parameters are as follows:

EntryId

Identifies the required vault store entry, archive entry, or archive folder entry. EVSVR uses this to determine the location of the saveset.

SavesetId

Specifies the required saveset ID or transaction ID.

OutputFolder

Specifies the path to the folder in which to store the retrieved files and log file. By default, this is the Reports\EVSVR subfolder of the Enterprise Vault program folder (for example C:\Program Files (x86)\Enterprise Vault).

Example

In the following example, the two parameters specify the vault store entry ID and saveset transaction ID of the required saveset:

ds 1995C3ACBB9472646AB0F3A0FDC7066B91210000testsrv1.domain.local 713C88D67D80E8046FFF279AE27D46B1

This command does not specify an output folder with the -o parameter, so DumpSaveset outputs the files to the default location, for example C:\Program Files (x86)\Enterprise Vault\Reports\EVSVR. All DumpSaveset files are output to a time-stamped folder under this output folder, such as EVSVR_DumpSaveset_20100714181917. So, in this example, the full output path is as follows:

C:\Program Files (x86)\Enterprise Vault\Reports\EVSVR\EVSVR_DumpSaveset_20100714181917

Expected outputs

Except where noted, DumpSaveset outputs all the files and folders that are described below.

Table: Files and folders that are directly under the full output path

Output

Description

Log

This is the log file. In the example above, its file name is EVSVR_DumpSaveset_20100714181917.Log.

Always review the log file to determine how successful the operation was. The file shows any errors that occurred.

VSDBRecords.xml

This XML file contains the vault store database records for the saveset that DumpSaveset has retrieved.

Recombined folder

This folder contains the files that Enterprise Vault reconstructs after the entire saveset has been retrieved. See Table: Contents of the Recombined folder.

Parts folder

This folder contains the files that comprise the retrieved saveset. See Table: Contents of the Parts folder.

Table: Contents of the Recombined folder

Output

Description

DVS

This file contains all the data related to the retrieved saveset, except where this is a large-file saveset. DumpSaveset outputs large-file data to the Parts folder in the form of a DVF or DVFSP file, and it also outputs the data as a native item (see below). Sample file name:

DS_201007078497509~201007071011490000~Z~611F6F215A2134E015849E23A4D6D601.DVS

DocFile

This file is an uncompressed structured storage version of the above recombined DVS file. You can inspect its contents with a structured storage viewer. Sample file name:

DS_201007078497509~201007071011490000~Z~611F6F215A2134E015849E23A4D6D601.DocFile

Native item

This is the original item that Enterprise Vault retrieved: a Domino message (DVNS) file, Exchange message (MSG) file, IMAP message (EML) file, or the original large file.

Table: Contents of the Parts folder

Output

Description

DVS/ARCHDVS (if CAB collected or migrated)

This file is either the entire saveset or, where sharing has been enabled, one part of a multipart saveset. Sample file name:

DS_713C88D67D80E8046FFF279AE27D46B1.DVS

DocFile

This file is an uncompressed structured storage version of the above DVS file. You can inspect its contents with a structured storage viewer. Sample file name:

DS_713C88D67D80E8046FFF279AE27D46B1.DocFile

DVSSP/ARCHDVSSP (if CAB collected or migrated)

Only output for multipart savesets where sharing has been enabled. The files are not generated for savesets that are stored on a Centera device. Sample file name:

DS_713C88D67D80E8046FFF279AE27D46B1~2B~34D8CA20~00~1.DVSSP

DVSCC/ARCHDVSCC (if CAB collected or migrated)

Only output for multipart savesets where sharing has been enabled and converted content has been generated. The files are not generated for savesets that are stored on a Centera device. Sample file name:

DS_713C88D67D80E8046FFF279AE27D46B1~2B~34D8CA20~00~1.DVSCC

DVFSP/ARCHDVFSP (if migrated)

Only output for large-file multipart savesets where sharing has been enabled. The files are not generated for savesets that are stored on a Centera device. Sample file name:

DS_9111FB9F5230E0D6AB99C2014DC51611~CE~6E068DCC~00~1.DVFSP

DVF/ARCHDVF (if migrated)

Only output for large-file savesets where sharing has not been enabled. The files can also be generated for savesets that are stored on a Centera device. Sample file name:

DS_713C88D67D80E8046FFF279AE27D46B1.DVF

DVFCC/ARCHDVFCC (if migrated)

Only output for large-file savesets where sharing has not been enabled and where converted content has been generated. The files are not generated for savesets that are stored on a Centera device. Sample file name:

DS_713C88D67D80E8046FFF279AE27D46B1.DVFCC

CAB/ARCHCAB (if migrated)

Only output when parts of the retrieved saveset are stored on CIFS partitions that have been configured for collection using CAB files. DumpSaveset outputs a CAB file for each collected part of the saveset. The name of the CAB file has the form DS_VaultStoreIdentity_CABfileName. For example:

DS_VS8_Collection100.CAB

CDF.xml

Only output for savesets that are stored on Centera devices. The XML file uses the Clip-Id related to the retrieved saveset as its file name. For example:

DS_8O58S6H8CJLGLeDF3SPTVDEKITTG4156M190NG0Q98CDMO8MC3SPT.CDF.xml

MetaData.xml

Only output for savesets that have parts that are stored on streamer devices. DumpSaveset outputs an XML file for each part of the saveset. Sample file name:

DS_9111FB9F5230E0D6AB99C2014DC51611~CE~6E068DCC~00~1.DVSSP.MetaData.xml