Veritas Enterprise Vault™ Utilities

Last Published:
Product(s): Enterprise Vault (12.1)
  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 EMC Celerra/VNX placeholders
      1.  
        Configuring which API call FSAUtility uses to identify 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
        1.  
          Disable method for Provisioning API Interface for Policy Manager scripts
        2.  
          Enable method for Provisioning API Interface for Policy Manager scripts
        3.  
          ExecuteScript method for Provisioning API Interface for Policy Manager scripts
        4.  
          SetScriptFile method for Provisioning API Interface for Policy Manager scripts
        5.  
          SetScriptText method for Provisioning API Interface 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

Repair operations in EVSVR

If EVSVR reports any errors when you perform a Verify operation, you can correct them by performing a Repair operation. The function of the Repair operations is to recreate missing records in the vault store and fingerprint databases. In rare instances, a Repair operation creates new SIS parts on disk for items that have been shared many times.

It is very important to note the following points before you perform any Repair operation with EVSVR:

  • Many of the Repair operations that are described below can cause data loss in some circumstances. Only the ArchivesVaultStore, BlacklistBadSISParts, and UndatedCollections operations cannot cause data loss.

    See Risk of data loss when you run certain EVSVR Repair operations.

    We strongly recommend that you contact Veritas Technical Support before you run any operation that can cause data loss.

  • Only consider running a Repair operation if you encounter errors when you run a Verify operation.

  • Before you run a Repair operation, make a backup copy of your databases and place the vault stores that you want to repair in backup mode. This is the case even if you have stopped the associated Storage service.

    Caution:

    Starting the Storage service on a damaged system can damage it further. Do not start the Storage service before you have put the problematic vault stores in backup mode. Even then, only start the Storage service if it needs to be running.

A Repair operation has several Option settings from which you can select. Table: Option settings for Repair operations describes the available settings.

Table: Option settings for Repair operations

Option setting

Action

Archives

Combines the functions of multiple Repair operations: QueuedItems, ArchivesDirectory, and DatabaseReferences. In outline, the Archives operation does the following:

  • Scans the files in a Storage Queue location and recreates or corrects the expected records in a vault store database.

  • Recreates any missing records in the fingerprint databases and vault store databases.

  • Recreates any missing Archive and ArchiveFolder records in the Directory database to make it consistent with the vault store databases.

This operation may be unable to recreate records if it cannot obtain the required information from the Directory database, vault store databases, savesets, target Exchange system (for Exchange Mailbox archives), or target file system volumes (for File System archives).

Before you can run this operation, you must select the type of archive that you want to repair: Exchange Mailbox or File System. If the operation finds any items in the archive that do not match the selected type, it reports an error and stops processing.

ArchivesDirectory

Recreates any missing Archive and ArchiveFolder records in the Directory database to make it consistent with the vault store databases. To do this, the ArchivesDirectory operation does the following:

  • Verifies that each ArchivePoint record in the vault store databases has a corresponding Archive record in the Directory database. If an Archive record is missing, the operation recreates it.

  • Verifies that each Vault record in the vault store databases has a corresponding ArchiveFolder record in the Directory database. If an ArchiveFolder record is missing, the operation recreates it.

Before you can run this operation, you must select the type of archive that you want to repair: Exchange Mailbox or File System. If the operation finds any items in the archive that do not match the selected type, it reports an error and stops processing.

ArchivesVaultStore

Recreates any missing ArchivePoint and Vault records in the vault store databases to make them consistent with the Directory database. To do this, the ArchivesVaultStore operation does the following:

  • Verifies that each Archive record in the Directory database has a corresponding ArchivePoint record in the vault store databases. If an ArchivePoint record is missing, the operation recreates it.

  • Verifies that each ArchiveFolder record in the Directory database has a corresponding Vault record in the vault store databases. If a Vault record is missing, the operation recreates it.

You can also recreate missing ArchivePoint and Vault records in the vault store databases by running a DatabaseReferences Repair operation. However, after you run the DatabaseReferences operation, there can still be missing ArchivePoint and Vault records for archives and archive folders that do not contain savesets. In these circumstances, you must perform an ArchivesVaultStore Repair operation to recreate any missing records. Alternatively, you can do the following:

  1. Run an ArchivesVaultStore Repair operation to recreate the missing ArchivePoint and Vault records.

  2. Run a DatabaseReferences Repair operation to recreate the missing saveset records and update the recreated ArchivePoint and Vault records.

BlacklistBadSISParts

Blacklists any SIS part that does not verify correctly because it does not exist, has the wrong size, or does not match the value in the fingerprint database. After you blacklist a SIS part, archiving a new item with the same SIS part causes Enterprise Vault to create a new SIS part file on disk.

DatabaseLinkages

Does the following:

  • Verifies and corrects the reference counts of savesets and SIS parts in the collection records in the vault store databases.

  • Recreates any missing information on the SIS parts used by savesets in the vault store databases.

  • Verifies the number of references to SIS parts in the fingerprint databases against the number of references in all vault store databases in the vault store group, and corrects any that are wrong.

  • Reports on the number of unreferenced, unshared, and shared SIS parts, after the repair operation has completed.

DatabaseReferences

Recreates any missing records in the fingerprint databases and vault store databases. This option also updates any records that are found to be incorrect from the viewpoint of the partition.

Note the following:

  • This operation is not supported on CIFS and NTFS partitions if you have enabled both the collection process and migration to secondary storage using a migrator other than the Enterprise Vault migrator. This is because non-Enterprise Vault migrators do not provide a way to scan the migrated data.

  • If you want to perform this operation on an EMC Centera partition, you must ensure that the Query capability is enabled for the Centera profile with which you connect to the Centera. If the Query capability is disabled, use the Centera CLI or Centera Viewer to run the Show Profile command. This command lists the current capabilities of the Centera profile, which you can then enable or disable by running the Update Profile command.

The following additional settings are available when you choose to run a DatabaseReferences operation:

  • Check Collection Counts. When selected, EVSVR checks the counts of referenced and unreferenced items in each CAB file and EMC Centera clip. If the number of unreferenced items is equal to the total number of items minus the number of referenced items - so, "unreferenced count = total count - referenced count" - then EVSVR does not recreate the database records for the unreferenced items because it assumes that they have been deleted. However, if you do not select Check Collection Counts, EVSVR considers all the missing database records as suitable for recreation.

  • Require Index Entries. When selected, EVSVR recreates missing saveset records for which the corresponding index entries exist, but it does not recreate any records that do not have index entries.

After you have performed a DatabaseReferences Repair operation, check that it was successful by reviewing its log file and performing a DatabaseReferences Verify operation. When you are satisfied that EVSVR has made the expected repairs, perform a DatabaseLinkages Repair operation on the same dataset.

 

The DatabaseReferences operation processes all SIS parts before it processes anything else. This can lead to the situation where the operation recreates unused SIS parts that it finds in CAB files. After the operation has completed, you can resolve this issue as follows:

  1. Check the DatabaseReferences Repair log file for any errors that the operation encountered. Use the severity of any issues as a guide to what to do next. For example, you may need to restore missing or corrupt files in the partition from backup copies and then rerun the DatabaseReferences Repair operation.

  2. After you have completed step 1 and judged the repair to be successful, run the DatabaseLinkages Repair operation.

  3. After you have completed step 2 and judged the repair to be successful, run the Complete Verify operation to confirm this.

  4. After you have completed step 3, verify that your environment is consistent and EVSVR has repaired everything that can be repaired. As a last resort, run the DeleteSurplusReferences Repair operation to remove any irreparable items and unused SIS parts.

DeleteSurplusReferences

As a last resort, deletes the vault store and fingerprint database records that are associated with missing and irretrievably lost items. When a missing item consists of multiple parts, this option also deletes from disk any remaining parts that are associated with the item.

You can also use this operation to remove unused SIS parts, but you must only do so when your environment is consistent.

When you start a DeleteSurplusReferences operation, it first performs an internal DatabaseLinkages Verify operation. The DeleteSurplusReferences operation only starts to process when the DatabaseLinkages Verify operation reports that the environment is consistent and error-free.

Before you perform a DeleteSurplusReferences operation, we recommend that you use the DatabaseReferences Repair operation to recreate any missing database references and ensure that the environment is consistent

Note the following:

  • The DeleteSurplusReferences operation does not take any action unless it can conclusively determine that the items in question are missing. For example, suppose that you have migrated archived data to secondary storage by using a non-Enterprise Vault migrator, such as Veritas NetBackup. If the migrator returns generic errors such as E_FAIL or E_UNEXPECTED, EVSVR does not take any action other than to report the errors.

  • When the DeleteSurplusReferences operation finds a CAB file or EMC Centera clip, it assumes that all the items that should exist within the CAB file or clip do exist.

ItemCounts

Repairs any Vault and ArchivePoint records in the vault store databases that have an incorrect count of archived items.

QueuedItems

Scans the files in a Storage Queue location and recreates or corrects the expected records in a vault store database.

RequeueStorageQueueFailedItems

Checks the Failed Items folder for any items that Enterprise Vault was unable to archive and places them on the Storage Queue again.

StorageQueue

Scans the vault store database records for queued items and verifies that the expected files exist in the Storage Queue location. If any files are missing, EVSVR deletes the vault store database records and requests that the original items are rearchived.

UndatedCollections

Assigns a creation date to any collection record in a vault store database that does not have one. In Enterprise Vault 8.0 and later, all new collection records automatically have a specified creation date. However, this is not the case for any collection records that an earlier version of Enterprise Vault has created. When the creation date for a collection record is missing, EVSVR assigns the creation date of the associated CAB file or Centera clip to it.

The DatabaseReferences and DeleteSurplusReferences Repair operations do not work with savesets and SIS parts that you have migrated to secondary storage. The reason for this is that each operation needs to determine the locations of the migrated files from the vault store and fingerprint databases. As the information in these databases may be incorrect, the operation cannot proceed effectively.

If you want to perform a Repair operation on migrated files, we recommend that you first return them to their original store location.