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

Migrating placeholders

Note:

Before you migrate placeholders, make sure that you have a backup of the Directory database, the vault store databases, and the folder hierarchy under the source path. Back up the folder hierarchy under the destination path also, if it contains archived files.

You can use FSAUtility with the -pm parameter to migrate placeholders and archive points from a source folder structure to a destination folder structure, for example on another volume or file server.

This option moves the placeholders and archive points, but it does not move any files in the archives. The migrated placeholders retain their links to the archived files in their original locations. This option therefore provides a faster solution for moving placeholders than the FSAUtility move (-m) option. Use the -m option if you want to move archives, consolidate vault stores, or align archives with file servers.

This option always migrates placeholders in subfolders recursively, provided that they reside under a valid archive point. The option creates the destination subfolders, if necessary.

Before performing a placeholder migration, FSAUtility checks for any conflicts between the archive points at the source location and the destination location. It then performs the following actions, in the order listed:

  • Moves the placeholders. FSAUtility creates the placeholders on the destination location and then deletes the placeholders at the source location. The migration retains the placeholder file's security descriptor, which contains information about the ownership and NTFS permissions for the file. The migration also retains any alternate data streams associated with the placeholder file.

  • Moves the archive points to the destination location.

  • Updates the Directory database with the new folder paths.

Note the following requirements for placeholder migration:

  • The source volume and destination volume must both be specified as FSA targets in the Administration Console.

  • The same Enterprise Vault server must manage the source volume's vault store and the destination volume's vault store. If FSAUtility cannot confirm that the same Storage service computer manages both vault stores, it quits with an explanatory message.

  • If the destination volume is on a NetApp file server, you must run the FSAUtility command from an Enterprise Vault server that is registered with the destination file server's FPolicy. For example, to migrate placeholders from NetAppFiler1\volumeA to NetAppFiler2\volumeB, you must run FSAUtility from an Enterprise Vault server that is registered with NetAppFiler2.

  • If any folders with archive points are missing from the source folder structure, FSAUtility does not proceed with the migration.

  • You cannot migrate placeholders to a subfolder of the source folder.

Note that FSAUtility does not proceed with a migration if the destination path already contains an archive for a folder that matches the folder hierarchy on the source path. This restriction prevents a split archive, where the files with the migrated placeholders are in a different vault store from the other archived files. You must specify a destination path that has not been archived from, or one that contains no folders with archived files in the same folder structure as the source path. For example, consider the example source folder structure and destination folder structure shown in Figure: FSAUtility placeholder migration: example folder structures:

Figure: FSAUtility placeholder migration: example folder structures

FSAUtility placeholder migration: example folder structures

FSAUtility does not proceed with the migration if either of the following applies:

  • An archive point with archived files exists at the root level, for both the source volume and the destination volume.

  • An archive point with archived files exists in both of the folder structures, on any of the following folders:

    • Folder1

    • Subfolder1

    • Folder2

FSAUtility can migrate the placeholders if there is no clash of archive points that have archived files. For example, the migration is not prevented if either of the following applies:

  • On the destination folder structure, only Folder5 and Folder 6 have archive points with archived files.

  • Folder2 in the source folder structure has an archive point with archived files, but Folder2 in the destination folder structure does not.

FSAUtility records the following events in the event log:

  • The start of a placeholder migration

  • Whether a migration completes without errors, or with errors.

Additionally, during a placeholder migration FSAUtility displays appropriate messages on the console, and records detailed entries including errors in the DTrace logs and in the Reports\FSAUtility\EV_FILESYSTEM_UTILITY_LOG_DateTime.xml file.

If a placeholder migration fails, do not archive files on the destination path. Otherwise the archived data for that path may become split across multiple archives. Retry the placeholder migration to see whether it can complete successfully.

Note:

Before you use this option with Dell EMC Celerra/VNX placeholders, ensure that FSAUtility is configured to use a suitable method for identifying the placeholders.

See About using FSAUtility with Dell EMC Celerra/VNX placeholders.

Syntax

FSAUtility -pm -s UNC_path -d UNC_path [-cs] [-csf] [-f] [-l log_level] [-i]

Where:

  • -s UNC_path specifies the path to the source folder. The path must specify the volume in the format that you used when you added the volume target in the Administration Console.

  • -d UNC_path specifies the path to the destination folder. This path to the folder must already exist. The path must specify the volume in the format that you used when you added the volume target in the Administration Console.

  • -cs copies folder security descriptors to new folders at the destination. Security descriptors of existing folders at the destination are not overwritten. This option cannot be used with -csf. If you do not specify -cs or -csf, no folder security descriptors are copied.

  • -csf copies folder security descriptors from source folders to destination folders, overwriting the security descriptors of destination folders that already exist. This option cannot be used with -cs. If you do not specify -cs or -csf, no folder security descriptors are copied.

  • -f forces the migration of placeholders when placeholders or files of the same name already exist at the destination. The utility first deletes the existing placeholders or files at the destination and then creates the new ones.

  • -l log_level specifies whether to log both successful operations and failed operations (0), or failed operations only (1). By default, FSAUtility logs failed operations only.

  • -i causes FSAUtility to ignore any errors that occur when it moves the placeholders, such as:

    • Failure to determine whether a file is a placeholder.

    • Failure to create placeholders at the destination location, for example as a result of permission issues or insufficient disk space.

    • Failure to delete placeholders from the source location.

    If you omit the -i parameter and any placeholder move errors occur, FSAUtility logs the errors and stops when it has finished attempting to move all the placeholders. It does not go on to move the archive points or update the Directory database. In this case you may need to rerun FSAUtility -pm when you have fixed the causes of the placeholder move failures.

    If you specify the -i parameter and any placeholder move errors occur, FSAUtility logs the errors but it continues with the remaining steps of the migration: it goes on to move the archive points and update the Directory database. Errors that occur during the archive point migration or the database update are not ignored. FSAUtility continues to log all errors in the log file Reports\FSAUtility\EV_FILESYSTEM_UTILITY_LOG_DateTime.xml.

    If you specify -i and any placeholder move errors occur, you can correct these errors when the command has completed, if you want. For example, you can:

    • Delete placeholders at the source location.

    • Recreate unmigrated placeholders at the destination location, using the FSAUtility -c option.

      See Recreating placeholders.

    Recreating unmigrated placeholders using these methods does not retain the security descriptors of the original placeholders, and it does not recreate any alternate data streams that were associated with the placeholders.

    Note:

    We recommend that on the first run of a placeholder migration you omit the -i parameter. If the migration fails and the report indicates that the failure was due to errors when moving some placeholders, you can rerun the command with the -i parameter if you want FSAUtility to ignore those errors.

Examples

The following command migrates the placeholders along with the archive points from the first folder structure to the second folder structure. The command copies the security descriptors for newly-created folders from the source folders. If any files or placeholders of the same name already exist, the command overwrites them with new placeholders. FSAUtility does not ignore errors when it moves the placeholders.

FSAUtility -pm -s \\myserver\users\user1 -d \\server2\share\user1 -cs -f

Notes
  • You cannot run -pm in report mode.

  • After a placeholder migration, other FSAUtility options do not work on the destination folder until File System Archiving task has processed the folder at least once.

  • The migration migrates any placeholders in the source folder tree, including placeholders that were cut and pasted into it. However, if the archived files associated with cut and pasted placeholders are not available in the source tree's archives before the migration occurs, the files will not be in the archives afterwards.

  • If a source folder has an archive point and the names of the source folder and destination folder differ, then after a placeholder migration the archive's name does not change to match the destination folder until the File System Archiving task has processed the volume.

  • If a vault store already contains an archive with the same name as a destination folder name, then after the migration you see a second archive with the same name. There is no consolidation of the archives.

See also

See Moving placeholders and corresponding files.