Veritas Enterprise Vault™ Utilities

Last Published:
Product(s): Enterprise Vault (12.2)
  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

Creating an EVSVR operation file

You must create an operation file before you can perform an EVSVR operation. An operation file is an XML file that defines the actions that EVSVR is to perform, and on what data set.

You create an operation file by selecting the required options from the EVSVR Operations dialog box.

Figure: The EVSVR Operations dialog box

The EVSVR Operations dialog box

This dialog box lets you define the following:

  • The storage data and Directory data to process. EVSVR processes the data that is associated with one of the following:

    • All the partitions in all the vault stores in all the vault store groups in the Enterprise Vault site.

    • All the partitions in all the vault stores in a single vault store group.

    • All the partitions in a single vault store.

    • A single partition.

  • A specific archive to process. This applies only when EVSVR processes vault store databases or the archive information in the Directory database.

  • The date range of archived items to process.

  • The operation to perform.

  • The location of the output log file. If you choose to enable the checkpointing or item list facilities, the name of the log file also determines the names of the checkpoint file and the folder in which EVSVR processes the item list files.

  • The number of threads to use, and their priority level.

Note:

Depending on the operation that you choose to perform, some of these options may not be available.

To create an operation file

  1. At the EVSVR> prompt, type edit to open the EVSVR Operations dialog box.

    Note the following:

    • Operations XML File shows the name of the current operation file.

    • Site shows the name of the Enterprise Vault site for which to process the data. This is the site to which the Enterprise Vault server belongs. You cannot change the site.

  2. Specify the storage data that you want to process. By default, the operation file specifies that EVSVR is to process the data for all partitions in all vault stores in all vault store groups in the Enterprise Vault site. However, you can minimize the amount of data that you process as follows:

    • To process a single vault store group, clear Process All Vault Store Groups and then select the required group.

    • To process a single vault store, clear Process All Vault Stores and then select the required vault store.

    • To process a single partition, clear Process All Partitions and then select the required partition.

  3. Select the required values for the other settings, as follows:

    Process All Archives

    By default, EVSVR processes all the archives in the selected storage data set. To select an individual archive, clear Process All Archives and then select an archive.

    If there are a large number of archives, the dialog box displays a form so that you can filter by archive name.

    Date Range To Process

    Do one of the following:

    • Use the default setting, which does not impose a date range.

    • Select a time unit in the Unit box, and then specify the number of units in the Units box. For example, if you select Hour and 2, EVSVR processes the items that were archived in the two hours before the time that you start the EVSVR operation.

    • Select Use date range in the Unit box, and then select Set Date Range and specify a date range in the Items Archived From boxes.

      When you set a date range, the option Trust CIFS Partition Created Dates becomes available. For operations that scan CIFS partitions, this option can increase the speed with which EVSVR scans the partitions. However, you must be confident that all the folders and files that you want to scan have accurate creation dates, because these dates play an important part in helping EVSVR to determine when certain, older items were archived.

      • For each saveset (.dvs) file that Enterprise Vault 2007 or earlier has made, EVSVR uses the creation date to determine the date of the first archived item in the file. The last-modified date of the saveset file gives EVSVR the date of the last archived item that Enterprise Vault has added to the file as a sharer.

        The creation dates of saveset files may have changed if you have copied or moved them while restoring the partition from backup. On the other hand, if you trust the creation dates, and they fall outside the date range that you specify in EVSVR, then you can safely omit the files from the scan and so run it more quickly.

      • For each saveset file that Enterprise Vault 8.0 or later has made, EVSVR establishes the archive date by looking at both the last-modified date of the file and the date in its folder path. These dates are preserved during backup and restore operations, so they provide a more robust way to determine each item's archive date.

      Some EVSVR operations scan database records rather than the files in vault store partitions. For example, this is true of the ArchiveObjects Verify operation and DatabaseLinkages Verify operation. These operations ignore the Trust CIFS Partition Created Dates setting.

     

    Whether you choose a date range depends on the severity of the issues that you want to address. If you want to repair a substantial number of items as part of a recovery procedure, it is important not to set a date range. This allows EVSVR to repair as many items as possible. On the other hand, setting a date range is desirable if you want to process a handful of items or a known range of items.

    For example, suppose that a Repair operation has failed to repair a number of items. By repeating the operation against a date range that includes all the failed items, you may be able to identify the cause of the problem quickly. If you were to repeat the operation without specifying a date range, it could take days to complete.

    For a non-critical operation, it is usually desirable to choose a small date range - especially if you select a data set with a large number of archived items. For example, this may be the case if you want to perform a daily Verify operation to validate the last week's archived items only.

    Operation To Perform

    Select an operation type (Report, Verify, or Repair), and then set the required options.

    Log, Checkpoint And Item List Files

    Specify the following:

    • The folder in which to save the output log file. By default, EVSVR saves the file in the Reports\EVSVR subfolder of the Enterprise Vault program folder. If the log file already exists, EVSVR appends the new information to it.

    • The name of the log file. If you select Auto Generate Filenames, EVSVR uses the default file name, which is as follows:

      EVSVR_yyyymmddhhmmss.Log

      Where yyyymmddhhmmss specifies the date and time at which EVSVR created the log file.

    • Whether to enable checkpointing. If you choose to do so, EVSVR stores the checkpoint information in an XML file that is in the same folder as the log file. The name of the checkpoint file matches that of the log file but includes the suffix _Checkpoint. For example, if you set the log file name to EVSVR_Logfile.log, the corresponding checkpoint file has the name EVSVR_Logfile_Checkpoint.xml.

      See About the checkpointing facility in EVSVR.

    • Whether to process item list files. Some EVSVR operations let you output a list of items that have failed verification and need repairing. You can then input these item lists to a second EVSVR operation, which typically runs much faster than normal because it has less data to process. The name of the folder in which EVSVR outputs the item list files matches that of the log file but includes the suffix _Items. For example, EVSVR_Logfile_Items.

      See Using the output from one EVSVR operation as input for another operation.

    Threads

    Specify the number of threads to use for the EVSVR operation. The maximum is 16.

    All the Verify and Repair operations can benefit from using multiple threads, but this is particularly the case with the DatabaseReferences Repair operation. Most Report operations always run with one thread only, even if you request more.

    Specify the thread priority as Normal, Low, or High.

    If you set the thread priority to High for the DatabaseReferences Repair operation, EVSVR automatically resets the priority level to Normal. This is designed to stop potential problems with resource scheduling and thread contention. Although intermittent, these problems can lead to errors when EVSVR tries to repair certain database references.

  4. Click one of the following to save the specified values in an operation file:

    • Save. Saves the selected settings and their values in an operation file. If you previously saved the file, EVSVR overwrites the file. Otherwise, EVSVR prompts you for a file name.

    • Save As. Saves the selected parameters and their values in an operation file. EVSVR prompts you for a file name.

  5. After you have defined the operation, click one of the following to exit from edit mode and return to the EVSVR> prompt:

    • OK. Exits and loads the last saved operation file. Any changes that you have made since your last save are lost.

    • Cancel. Exits without loading an operation file. Any changes that you have made since your last save are lost.