Enterprise Vault™ Utilities

Last Published:
Product(s): Enterprise Vault (15.0)
  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.  
          Repair levels for an EVSVR ArchiveObjects Repair operation
        2.  
          Risk of data loss when you run certain EVSVR Repair operations
        3.  
          Choosing a suitable EVSVR Repair operation
        4.  
          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

[Filter] section of the Policy Manager initialization file

Include this section to specify a group of settings to apply to folders within mailboxes. You then apply this setting by specifying the filter name in the [Folder] section.

Note:

The [Filter] section must be specified before the [Folder] section in the initialization file.

ALargeItemThresholdPeriod

Optional. This setting is equivalent to the number that you select for Never archive items younger than on the Archiving Rules tab of the Exchange Mailbox Policy dialog box.

If you use this setting, you must specify Name = mailboxroot in the [Folder] section that references the filter.

If you specify ALargeItemThresholdPeriod, you must also set values for all the following:

  • UseInactivityPeriod (must be set to true)

  • APrioritizeLargeItems

  • APrioritizeItemsOver

  • ALargeItemThresholdUnits

Possible values:

  • A positive integer

ALargeItemThresholdUnits

Optional. This setting is equivalent to the units entry for Never archive items younger than on the Archiving Rules tab of the Exchange Mailbox Policy dialog box.

If you use this setting, you must specify Name = mailboxroot in the [Folder] section that references the filter.

If you specify ALargeItemThresholdUnits, you must also set values for all the following:

  • UseInactivityPeriod (must be set to true)

  • APrioritizeLargeItems

  • APrioritizeItemsOver

  • ALargeItemThresholdPeriod

Possible values:

  • Days

  • Weeks

  • Months

  • Years

APrioritizeItemsOver

Optional. This setting is equivalent to the size that you select for Start with items larger than on the Archiving Rules tab of the Exchange Mailbox Policy dialog box.

If you use this setting, you must specify Name = mailboxroot in the [Folder] section that references the filter.

If you specify APrioritizeItemsOver, you must also set values for all the following:

  • UseInactivityPeriod (must be set to true)

  • APrioritizeLargeItems

  • ALargeItemThresholdUnits

  • ALargeItemThresholdPeriod

Possible values:

  • An integer that specifies the size of items in KB to which you want to give priority

APrioritizeLargeItems

Optional. This setting is equivalent to the Start with items larger than option on the Archiving Rules tab of the Exchange Mailbox Policy dialog box.

If you use this setting, you must specify Name = mailboxroot in the [Folder] section that references the filter.

If you specify APrioritizeLargeItems, you must also set values for all the following:

  • UseInactivityPeriod (must be set to true)

  • APrioritizeItemsOver

  • ALargeItemThresholdUnits

  • ALargeItemThresholdPeriod

Possible values:

  • true

  • false

CreateShortcut

Mandatory. Specifies whether Enterprise Vault is to create shortcuts to items that are archived from the folder to which this filter is applied.

Possible values:

  • true

  • false

DeleteOriginal

Mandatory. Specifies whether Enterprise Vault is to delete the original items when it archives from the folder to which this filter is applied.

Possible values:

  • true

  • false

InactivityPeriod

Optional, but mandatory when you set UseInactivityPeriod to true. InactivityPeriod is valid only when you specify UseInactivityPeriod. You must also specify InactivityUnits to indicate how long an item can remain unmodified before it is eligible for archiving. This is the same as the Archive items when they are older than setting in the Archiving Rules tab of the Exchange Mailbox Policy dialog box.

Possible values:

  • An integer between 0 and 500

InactivityUnits

Optional, but mandatory when you set UseInactivityPeriod to true. Valid only when you specify UseInactivityPeriod. When you use this setting, you must specify it with InactivityPeriod to indicate how long an item can remain unmodified before it is eligible for archiving. This is the same as the Archive items when they are older than setting in the Archiving Rules tab of the Exchange Mailbox Policy dialog box.

Possible values:

  • Days

  • Weeks

  • Months

  • Years

Name

Mandatory. Identifies the filter. This name applies only within this initialization file. You refer to this filter section by name in any [Folder] section in the initialization file.

PercentageQuota

Optional, but mandatory when you set UsePercentageQuota to true. This setting applies only when using quota-based archiving. Enterprise Vault archives from the mailbox until this percentage of mailbox storage limit is free.

If you use this setting, you must specify Name = mailboxroot in the [Folder] section that references the filter.

PercentageQuota is not valid for public folders.

Possible values:

  • An integer between 0 and 99

QMinimumAgeThresholdPeriod

Optional. This setting is equivalent to the value that you select for Never archive items younger than on the Archiving Rules tab of the Exchange Mailbox Policy dialog box.

If you use this setting, you must specify Name = mailboxroot in the [Folder] section that references the filter.

If you specify QMinimumAgeThresholdPeriod, you must also set values for the following:

  • UsePercentageQuota (must be set to true)

  • QMinimumAgeThresholdUnits.

QMinimumAgeThresholdPeriod is not valid for public folders.

Possible values:

  • An integer

QMinimumAgeThresholdUnits

Optional. This setting is equivalent to the units that you select for Never archive items younger than on the Archiving Rules tab of the Exchange Mailbox Policy dialog box.

If you use this setting, you must specify Name = mailboxroot in the [Folder] section that references the filter.

If you specify QMinimumAgeThresholdUnits, you must also set values for the following:

  • UsePercentageQuota (must be set to true)

  • QMinimumAgeThresholdPeriod.

QMinimumAgeThresholdUnits is not valid for public folders.

Possible values:

  • Days

  • Weeks

  • Months

  • Years

QPrioritizeItemsOver

Optional. This setting is equivalent to the Start with items larger than size entry on the Archiving Rules tab of the Exchange Mailbox Policy dialog box.

If you use this setting, you must specify Name = mailboxroot in the [Folder] section that references the filter.

If you specify QPrioritizeItemsOver, you must also set values for the following:

  • UsePercentageQuota (must be set to true)

  • QPrioritizeLargeItems

QPrioritizeItemsOver is not valid for public folders.

Possible values:

  • An integer that specifies the size of items in KB to which you want to give priority.

QPrioritizeLargeItems

Optional. This setting is equivalent to the Start with items larger than check box on the Archiving Rules tab of the Exchange Mailbox Policy dialog box.

If you use this setting, you must specify Name = mailboxroot in the [Folder] section that references the filter.

If you specify QPrioritizeLargeItems, you must also set values for the following:

  • UsePercentageQuota (must be set to true)

  • QPrioritizeItemsOver

QPrioritizeLargeItems is not valid for public folders.

Possible values:

  • true

  • false

UnreadMail

Mandatory. Specifies whether Enterprise Vault archives unread mail items from the folder to which you apply this filter.

Possible values:

  • true

  • false

UseInactivityPeriod

Mandatory, unless Filtername in the [Folder] section is set to SystemDefault or DoNotArchive.

When you use UseInactivityPeriod and UsePercentageQuota, you must set at least one of them to true.

UseInactivityPeriod specifies whether to use age-based archiving.

If you use this setting, you must specify Name = mailboxroot in the [Folder] section that references the filter.

Possible values:

  • true (use age-based archiving)

  • false (do not use age-based archiving)

UsePercentageQuota

Optional. When you use UseInactivityPeriod and UsePercentageQuota, you must set at least one of them to true.

UsePercentageQuota specifies whether to use quota-based archiving.

If you use this setting, you must specify Name = mailboxroot in the [Folder] section that references the filter.

If you set UsePercentageQuota to true, you must also set a value for PercentageQuota.

UsePercentageQuota is not valid for public folders.

Possible values:

  • true (use quota-based archiving)

  • false (do not use quota-based archiving)