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

[NSFDefaults] section in the Policy Manager initialization file

This section is mandatory when you use Policy Manager to migrate the contents of NSF files to Enterprise Vault.

Use this section to specify the default settings that apply to NSF migrations. You can override these default settings for individual NSF files in the [NSF] section of the initialization file.

If you do not specify a value for an optional keyname in the [NSFDefaults] section, Policy Manager uses the value that is marked as "default" as the default setting.

ArchiveNonExpiredCalItems

Optional. Controls whether Policy Manager migrates the unexpired calendar items that are contained in the NSF files. If you choose to migrate unexpired calendar items, users must restore the items before they can modify them.

Possible values:

  • True

  • False (default)

CompactNSF

Optional. Controls whether the NSF files are compacted after successful migration.

Possible values:

  • True (default)

  • False

ConcurrentMigrations

Optional. Sets the maximum number of concurrent NSF migrations. This setting takes effect only when MigrationMode is set to Process.

Possible values:

  • An integer in the range 1 (default) to 5

DeleteNSF

Optional. Controls whether the NSF files are deleted after successful migration.

Possible values:

  • True

  • False (default)

IgnoreInsufficientMailFileAccess

Optional. By default, EVPM does not process an NSF file if the Domino archiving user does not have sufficient access set the ACL of the corresponding mail file. Set this keyname to True to override this default behavior.

Possible values:

  • True

  • False (default)

IgnoreNoManagerAccess

Optional. By default, EVPM does not process an NSF file if the Domino archiving user does not have manager access set in the ACL of the corresponding mail file. Set this keyname to True to override this default behavior.

Possible values:

  • True

  • False (default)

IgnoreNonExistentMailFile

Optional. By default, EVPM does not migrate the contents of NSF files whose associated mail file is not available. Set this keyname to True to override this default behavior.

Possible values:

  • True

  • False (default)

IgnoreNonStandardTemplate

Optional. By default, EVPM does not process an NSF file that is based on a non-standard template. The list of standard templates is determined by a registry string value which is called DominoMailTemplates under the following registry key on all the storage servers:

HKEY_LOCAL_MACHINE
 \SOFTWARE
  \Wow6432Node
   \KVS
    \Enterprise Vault
     \Agents

Set this keyname to True to override this default behavior and migrate the contents of NSF files that are based on non-standard templates.

Possible values:

  • True

  • False (default)

IncludeTrash

Optional. Controls whether Policy Manager migrates the deleted items from the Trash folders in the NSF files.

Possible values:

  • True

  • False (default)

MailFileFolder

Optional. Sets the name of the migration target folder. Policy Manager creates this folder beneath the Folders view in each user's mail file, if it does not exist already. Policy Manager then places shortcuts and migrated content in this folder.

Possible values:

  • A folder name. For example, NSF items. If you do not specify a folder name, Policy Manager uses the default name Notes Archive.

MergeNSFFolders

Optional. For users who have multiple NSF files, MergeNSFFolders controls whether the NSF files' folder structures are merged or kept separate in the users' mail files.

Possible values:

  • True (default). Merge the folder structures that are contained in multiple NSF files. For example, two NSF files that belong to one user, both contain a folder called Personal. Policy Manager places the shortcuts to the contents of these folders in a merged Personal folder in the user's mail file.

  • False. Keep separate the folder structures from multiple NSF files. In the user's mail file, a new folder is created for each NSF file, and the shortcuts to its contents are placed in the folders.

MigrationMode

Mandatory. Controls whether Policy Manager runs in report mode or in process mode.

Possible values:

  • Report. Policy Manager checks each NSF file listed in the [NSF] sections of the initialization file, to determine whether it can migrate the file's contents. Policy Manager creates a new initialization file, which contains a count of all the files that are not ready for migration. In the new initialization file, any NSF file which cannot be migrated has the entry DoNotProcess=True added to its [NSF] section. This setting prevents Policy Manager from attempting to process the file when it is next run in process mode.

    The new initialization file has the same name as the original, with a number appended to make it unique. For example, if the original file was called NSFMigration.ini, the new file is called NSFMigration_1.ini.

  • Process. Policy Manager migrates items from the NSF files that are listed in the [NSF] section, and generates summary and detailed reports. Policy Manager also writes a new initialization file. You can use the new file to migrate any failed files when you have corrected the problems that prevented their migration. Each NSF file has a JobStatus entry added to its [NSF] section of the new initialization file. For example, the files that were successfully migrated have JobStatus=Processed added to the [NSF] section. Policy Manager does not attempt to migrate these files again when you use the new initialization file for the next migration run.

    The new initialization file has the same name as the original, with a number appended to make it unique. For example, if the original file was called NSFMigration.ini, the new file is called NSFMigration_1.ini.

RetentionCategory

Mandatory. Specifies the name of the default retention category that is applied to items during migration.

Possible values:

  • A retention category name

  • A retention category ID

SetNSFHidden

Optional. Controls whether Policy Manager sets the hidden attribute on NSF files after successful migration. This option is provided for compatibility with the NSF migrator wizard and is not likely to be used in scripted migrations.

Possible values:

  • True

  • False (default)

SetNSFReadOnly

Optional. Controls whether Policy Manager sets the read-only attribute on NSF files after successful migration. This setting prevents users from adding new items to the NSF files after migration.

Possible values:

  • True

  • False (default)

ShortcutMode

Optional. Controls what Policy Manager does with the contents of the NSF files after migration.

Possible values:

  • MailFileShortcuts (default). Creates shortcuts to the migrated items and puts them in the users' mail files.

  • NSFShortcuts. Creates shortcuts to the migrated items and leaves the shortcuts in the NSF files.

  • NoShortcuts. Does not create any shortcuts to migrated items. Any items that were excluded from archiving remain in the NSF files.