Search <book_title>...

Enterprise Vault™ Utilities

Last Published: 2020-11-13

Product(s): Enterprise Vault (14.0)

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
ArchivePoints
1. About ArchivePoints
2. ArchivePoints syntax
3. ArchivePoints examples
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
Backtrace
1. About Backtrace
2. Backtrace default settings
3. Backtrace registry values
4. Backtrace file name format
5. Backtrace examples
CenteraPing
1. About CenteraPing
2. CenteraPing syntax
Domino Archive Exporter
1. About Domino Archive Exporter
2. Domino Archive Exporter syntax
3. Domino Archive Exporter example
Domino Profile Document Tool
1. About Domino Profile Document Tool
2. Domino Profile Document Tool syntax
3. Domino Profile Document Tool examples
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
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
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
EVDuplicateCleaner
1. About EVDuplicateCleaner
2. Prerequisites for EVDuplicateCleaner
3. Configuring EVDuplicateCleaner
4. Running EVDuplicateCleaner
5. Fixing broken shortcuts after you have run EVDuplicateCleaner
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
EVFSASetRightsAndPermissions
1. About EVFSASetRightsAndPermissions
2. Running EVFSASetRightsAndPermissions
EVrights
1. About EVrights
2. EVrights syntax
EVservice
1. About EVservice
2. EVservice prerequisites
3. EVservice syntax
4. EVservice list file format
EVSPShortcutManager
1. About EVSPShortcutManager
2. Permissions required to run EVSPShortcutManager
3. EVSPShortcutManager syntax
4. EVSPShortcutManager examples
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
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
11. Running EVSVR in interactive mode
12. Improving EVSVR performance when processing CAB collections
FSARunNow
1. About FSARunNow
2. Running FSARunNow
3. FSARunNow syntax
4. FSARunNow examples
FSAUndelete
1. About FSAUndelete
2. Running FSAUndelete
3. FSAUndelete syntax
4. FSAUndelete examples
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
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
Permissions Browser
1. About Permissions Browser
2. Running Permissions Browser
3. About the information that Permissions Browser provides
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
6. Policy Manager initialization file examples
7. About using the Provisioning API to run Policy Manager scripts
ResetEVClient
1. About ResetEVClient
2. ResetEVClient syntax
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

[NSF] section in the Policy Manager initialization file

The initialization file must contain one [NSF] section for each NSF file you migrate. Each [NSF] section must contain at least a FileName setting to specify the name and location of the NSF file. You can also make further migration settings in the [NSF] section to override the default settings that are specified in the [NSFDefaults] section.

ArchiveName

Optional. Specifies the name or the ID of the archive to which Policy Manager migrates the items from the current the NSF file.

Note:

In the [NSF] section, you can set either the ArchiveName or the UserCN. You cannot set both. See the details for the UserCN setting.

This keyname is optional because Policy Manager can automatically match archives to NSF files. However, it always uses the first archive that has a matching name. If there are archives with duplicate names, items can be migrated to the wrong archives. To avoid this issue, use ArchiveName to specify the ID of an archive for each NSF file.

You can find the ID of an archive on the Advanced tab of the archive's properties page in the administration console.

Possible values:

The ID of the target archive
The name of the target archive

ArchiveNonExpiredCalItems

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

Possible values:

True
False

CompactNSF

Optional. Controls whether the current NSF file is compacted after successful migration.

Possible values:

True
False

DeleteNSF

Optional. Controls whether the current NSF file is deleted after successful migration.

Possible values:

True
False

DoNotProcess

Optional. When Policy Manager runs in report mode (MigrationMode=Report), it writes a new initialization file. In the new file, it sets DoNotProcess to True for any NSF file on which it encounters errors. This setting prevents Policy Manager from processing the NSF file when you run it again in process mode (MigrationMode=Process), using the new initialization file.

Policy Manager ignores this setting when it runs in report mode.

Possible values:

True
False (default)

FileName

Mandatory. Specifies the path and the file name of each NSF file.

Note:

You should use UNC paths to specify the locations of the NSF files. The NSF migrator server that processes the NSF files might be on a different computer from the one on which you run EVPM. Additionally, the NSF migrator server might run under a different user context from the one under which you run EVPM. In both these cases, only full UNC paths provide a reliable way for the NSF migrator server to access the files.

Examples:

\\Server1\home\JohnDoe\quarter1.nsf
E:\data\backup.nsf

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 for the current NSF file.

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 for the current NSF file.

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 for the current NSF file.

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 the current NSF files if it is not based on non-standard templates.

Possible values:

True
False (default)

IncludeTrash

Optional. Controls whether Policy Manager migrates the deleted items from the Trash folder in the current NSF file.

Possible values:

True
False

JobStatus

Policy Manager writes a JobStatus in each [NSF] section of the new initialization file when it runs in process mode. This value indicates the status of each NSF file after the last process run. See also the details for MigrationMode.

Possible values:

Failed. The NSF file failed migration.
Partially_Processed. The NSF file contains items that Policy Manager was unable to migrate.
Processed. Policy Manager migrated the NSF file successfully.
Unprocessed. Policy Manager ignored the NSF file.

MailFileFolder

Optional. Sets the name of the migration target folder. Policy Manager creates this folder beneath the Folders view in the 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 that the setting in the [NSFDefaults] section of the initialization file determines.

MergeNSFFolders

Optional. For a user who has multiple NSF files, MergeNSFFolders controls whether the folder structures they contain are merged or kept separate in the user's mail file.

Possible values:

True. 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 that is called Personal. The shortcuts to the contents of these folders are placed in a merged Personal folder in the user's mail file.
False. Keep separate the folder structures from multiple NSF files. Beneath the Folders view in the user's mail file, a new folder is created for each NSF file. The shortcuts to the contents of these NSF files are placed in the corresponding folders.

RetentionCategory

Optional. Specifies the name of the retention category that is applied to items from the current NSF file during migration.

Possible values:

A retention category name
A retention category ID

SetNSFHidden

Optional. Controls whether Policy Manager sets the hidden attribute on the current NSF file 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

SetNSFReadOnly

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

Possible values:

True
False

ShortcutMode

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

Possible values:

MailFileShortcuts. Create shortcuts to the migrated items and put them in the user's mail file. Also copies to the mail file any items that were excluded from archiving.
NSFShortcuts. Create shortcuts to the migrated items and leave the shortcuts in the NSF file.
NoShortcuts. Do not create any shortcuts to migrated items. Any items that were excluded from archiving remain in the NSF file.

UserCN

Optional. Specifies the canonical name (CN) of the user whose archive and mail file are the targets for the migration of the current NSF file.

Note:

In the [NSF] section, you can set either the ArchiveName or the UserCN. You cannot set both. See also the details for ArchiveName

Possible values:

Canonical form of the user name in the user's person record. For example for user John Doe/Acme, the canonical name form is cn=John Doe/o=Acme

More Information

[NSFDefaults] section in the Policy Manager initialization file