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

[PST] section in the Policy Manager initialization file

Include this section if you want to migrate the contents of PST files to Enterprise Vault.

The settings you provide in this section override any default settings that you may have defined in the [PSTdefaults] section.

ArchiveName

Optional for marked PST files. Mandatory for unmarked PST files.

Specifies the name or archive ID of the archive to which Policy Manager migrates the items in the PST files.

Notes:

  • You can make Policy Manager automatically determine the correct archive to use, in which case you do not need to specify ArchiveName.

  • Policy Manager uses the first archive that has a matching name. If you have archives with duplicate names, the result may not be what you want. To avoid this problem, use the archive ID, which you can copy from the Advanced tab of the archive's properties in the Administration Console.

Possible values:

  • The name of the archive to process

  • The archive ID of the archive to process

ArchiveNonExpiredCalItems

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

Possible values:

  • True

  • False (default)

CancelMbxAutoArchive

Optional. Controls whether Policy Manager turns off Outlook AutoArchiving for all the folders in the target mailboxes. This stops Outlook from automatically archiving items to PST files.

  • true

  • false (default)

CompactPST

Optional. Controls whether the PST file is compacted after successful migration of its contents.

If you intend to use this PST compaction feature at the end of migrations, you may need some spare disk capacity to provide room for the compaction to take place. This capacity is typically the size of the largest PST file plus approximately 5% of that size.

Possible values:

  • true

  • false (default)

DeletePST

Optional. Controls whether the PST file is deleted after the successful migration of its contents.

Possible values:

  • true

  • false (default)

DoNotProcess

Optional. Indicates whether Policy Manager is to ignore this file when it processes PST files. In report mode, Policy Manager ignores this setting and checks the status of every PST file listed.

In the new initialization file that Policy Manager creates after a report mode run, [PST] sections that have caused errors contain the entry DoNotProcess = True.

Possible values:

  • true

  • false (default)

FileName

Mandatory. Specifies the path to the PST file that you want to process.

Examples:

\\central\share\test1.pst
e:\PSTfiles\test2.pst
IncludeDeletedItems

Optional. Controls whether the PST Deleted Items folder is migrated.

Possible values:

  • true

  • false (default)

JobStatus

Optional. Do not use. Policy Manager inserts JobStatus when you run in process mode. JobStatus indicates whether the file was successfully processed.

Possible values:

  • Processed. The file has been successfully processed. Its [PST] section is commented out to prevent reprocessing.

  • Unprocessed. Policy Manager cannot begin processing this file.

  • Incomplete. Policy Manager was processing this file when a failure occurred that stopped all processing, such as a power cut.

  • Partially_Processed. Some items in the PST file cannot be processed. All these items have been placed in a folder that is called PST Migration Failed Items in the PST file. Policy Manager cannot migrate these items.

  • Failed. The file cannot be processed for some reason. For example, the Storage Service may not be running, or the user may have opened the file.

Log

Optional. Creates a log file with the same name as the original initialization file and a file type of .log. For example, if the original script was called PSTMigration.ini then the log would be called PSTMigration.log.

MailboxDN

Optional. Specifies the distinguished name of the mailbox in which to place shortcuts to the items that have been migrated. The distinguished name value required is the legacyExchangeDN property for the mailbox in Active Directory.

The easiest way to determine a number of MailboxDN values is to run the Exchange Mailbox Task in report mode. For instructions on how to use report mode to test archiving, see the Administration Console help file. The output file then contains the MailboxDN of each mailbox on that Exchange Server computer.

Possible values:

  • A distinguished name, such as the following:

    /o=acme/ou=developer/cn=Recipients/cn=smithj
MailboxFolder

Optional. Identifies the top-level mailbox folder in which Policy Manager places shortcuts to migrated items. If the folder does not exist, Policy Manager creates it. Beneath this folder, PST Migrator duplicates the original folder structure and places shortcuts in the appropriate folders.

If not specified in either the [PST] or [PSTDefaults] sections, the original folder structure is recreated at the top level of the mailbox.

Possible values:

  • A folder name. For example, PST items.

MergePSTFolders

Optional. Controls the placement of migrated folders in the target mailbox. When set to true, migrating more than one PST file for the same user causes Policy Manager to merge the identically-named folders.

When set to false, Policy Manager appends a number to the folder names, if necessary, and thereby keeps the folders separate. For example, if two folders at the same level are called "MyFolder", Policy Manager creates "MyFolder" and "MyFolder 1".

Possible values:

  • true (default)

  • false

Examples:

If MergePSTFolders is set to false and you migrate three PST files that have the display name "Personal Folders", and all contain top-level folders "Inbox" and "Sent Items", then you get a structure like the following:

PST Migration (specified by MailboxFolder)
  Personal Folders
    Inbox
    Sent Items
  Personal Folders 1
    Inbox
    Sent Items
  Personal Folders 2
    Inbox
    Sent Items
PSTLanguage

Mandatory for Outlook 97 to Outlook 2002 PST files. Not required for Outlook 2003 or later PST files. Specifies the Windows codepage that was used when the PSTs were created. You must specify the language here, in the [PSTdefaults] section, or, for individual PST files, in the [PST] section.

Note the following if the language used was not Western European:

  • If the wrong codepage is used, limitations in Exchange Server mean that the folder names may be corrupted. However, there are no problems with items within the folders.

  • If a folder name is corrupted, you may experience the following problems:

    • The corrupt folder name is used if a user ever chooses to restore an item to its original folder.

    • A user who wants to search for an item, and who enters the original location, must enter the corrupt folder name.

    To avoid these problems, specify the language that was used when the PSTs were created.

  • The language that you specify here must be available on the Storage Service computer that archives the contents of the PST files.

Possible values:

  • Arabic

  • Baltic

  • Central European

  • Cyrillic

  • Greek

  • Hebrew

  • Japanese

  • Korean

  • Simplified Chinese

  • Thai

  • Traditional Chinese

  • Turkish

  • Vietnamese

  • Western European (default)

RetentionCategory

Optional for marked PST files. Mandatory for unmarked PST files.

Specifies the name or ID of the retention category to apply to the migrated PST items.

Although RetentionCategory is optional, Policy Manager must be able to obtain a retention category from somewhere.

Policy Manager takes the first retention category it finds in the following:

  • The file's RetentionCategory setting in the [PST] section.

  • If MailboxDN is specified in the [PST] section, the default retention category for that mailbox.

  • If ArchiveName is specified in the [PST] section, the default retention category for the mailbox that is associated with that archive.

Possible values:

  • A retention category name

  • A retention category ID

Note:

RetentionCategory is mandatory if you want to migrate unmarked PST files.

ServerComputerName

Optional. Identifies the computer that is running the Storage Service. If you omit ServerComputerName, Policy Manager uses the name of the computer on which it is running.

Possible values:

A computer identification, which can be its LanMan name, DNS name, or IP address.

Examples:

  • LanMan: SERVER2

  • DNS: server2.Veritas.com

  • IP address: 18.94.12.3

ShortcutMode

Optional. Defines the PST migration mode, which determines how Policy Manager treats the contents of the PST at the end of the migration.

Possible values:

PSTShortcuts (default)

Create shortcuts to the migrated items and leave the shortcuts in the PST files.

MailboxShortcuts

Create shortcuts to the migrated items and put the shortcuts into the designated Exchange mailbox. Also copies to the mailbox any items that were excluded from archiving.

NoShortcuts

Do not create any shortcuts to migrated items. Any items that were excluded from archiving remain in the PST files.

SetPSTHidden

Optional. Controls whether the PST file is set as hidden after successful migration of its contents. If you have set your desktop so that it does not show hidden files, this hides the PST files that you have migrated successfully. This option is provided for compatibility with the PST Migrator wizard and is not likely to be used in scripted migrations.

Possible values:

  • true

  • false (default)

SetPSTReadOnly

Optional. Controls whether the PST file is set to be read-only after the successful migration of its contents. This prevents users from opening the files with Outlook.

Possible values:

  • true

  • false (default)