Search <book_title>...

Enterprise Vault™ Utilities

Last Published: 2019-10-21

Product(s): Enterprise Vault (12.5)

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

[Folder] section of the Policy Manager initialization file

Include this section if you want to modify the properties of individual folders or complete mailboxes.

ArchiveName

Optional. Identifies the archive in which items from the folder are archived. The default is the value that is set on the mailbox root.

Possible values:

An archive name or archive ID

DisassociateArchiveFromMailbox

Optional. Disassociates a mailbox from its related archive. Use DisassociateArchiveFromMailbox in conjunction with Zap.

If you zap a mailbox and disassociate it from its archive, Enterprise Vault creates a new archive for the mailbox when it is later enabled instead of relinking the mailbox to its old archive.

DisassociateArchiveFromMailbox is valid only if:

Name=mailboxroot
zap=true

Possible values:

true
false

Enabled

Optional. Specifies that the mailbox is enabled or disabled. If not specified, the mailbox setting remains unchanged. Can be applied to the mailbox root folder only.

If you enable a mailbox that was once enabled but subsequently disabled, Policy Manager automatically reconnects it to the existing mailbox archive.

Possible values:

true
false

ExchangePermissions

Optional. Specifies the folder permissions that you want to add, change, or remove.

You can specify one of the following:

Author
Contributor
Editor
NoneditingAuthor
Owner
PublishingAuthor
PublishingEditor
Reviewer

When you specify users, you can use either of the following forms:

The user's display name from the Global Address List (GAL). For example, "Sue Smith".
The mailbox Distinguished Name. For example, "/o=Org1/ou=Admin Group/cn=Recipients/cn=smith". Use this format if there are likely to be duplicate display names in the GAL.
The distinguished name value required is the legacyExchangeDN property for the mailbox in Active Directory.
See [Mailbox] section of the Policy Manager initialization file.

Possible values:

To grant access to a folder, use either of the following forms:
```
ExchangePermissions = ADD; UserA:RoleA;UserB:RoleB;...
ExchangePermissions = +; UserA:RoleA;UserB:RoleB;...
```
Where UserA is the first user and RoleA is the permission that you want to add.
To remove permissions, use either of the following forms:
```
ExchangePermissions = DEL; UserA;UserB;...
ExchangePermissions =  - ; UserA;UserB;...
```
Where UserA is the first user to remove and UserB is the second user to remove.
To replace the permissions of users who already have access to the folder:
```
ExchangePermissions = UserA:RoleA;UserB:RoleB;...
```
Where UserA is the first user and RoleA is the permission that you want to add or modify.

Filtername

Optional. Specifies the name of one of the standard filters, or the name of a filter that you have defined within the initialization file. The filter defines the settings that you want Policy Manager to apply to mailboxes.

Possible values:

SystemDefault. (Default. Use the default Enterprise Vault site settings, as defined in the Administration Console.)
DoNotArchive. (Do not archive from the folder to which the filter is applied.)
Name of filter. (A filter that is defined within the initialization file.)
Parent. (Use the settings that are configured for the parent folder.)

MailboxDN

Optional. Specifies a mailbox and restricts the [Folder] section so that it applies only to the specified mailbox.

The distinguished name value required is the legacyExchangeDN property for the mailbox in Active Directory.

Name

Mandatory. If the specified folder hierarchy does not exist, Policy Manager creates it and sets the specified properties.

Possible values:

mailboxroot (specifies the root folder).
folder path. You do not need to specify a path for the following special folders that Outlook creates: Inbox, Outbox, SentItems, DeletedItems, Drafts, Calendar, Contacts, Journal, Notes, and Tasks. In these cases, specify only the folder name without the leading backslash. These names work for all languages. For example, you can specify "Inbox" on a Japanese system.

Examples:

To create a folder that is called "xyz" in the root folder:
```
Name = \xyz
```
To specify the Deleted Items folder:
```
Name = DeletedItems
```

NonDeletable

Optional. Specifies whether Outlook and OWA users can delete, move, or copy the folder and all subfolders.

Possible values:

true
false

Caution:

For information on known problems with this setting, see the following article on the Veritas Support website:

https://www.veritas.com/docs/100029818

OverrideArchiveLocks

Optional. Overrides all Administration Console lock settings. This setting forces Policy Manager to modify folder settings even if the Administration Console has Force Users To Use Site Settings For Archiving set on the Mailbox Actions property page.

Note:

The default is for Policy Manager to obey all lock settings. If you want to override lock settings, include OverrideArchiveLocks and set the value to true.

Possible values:

true
false (default)

RetentionCategory

Optional. Specifies the retention category to use when you archive from the folder. If not specified, the site default retention category is used.

Note:

Some Enterprise Vault features can override the specified retention category. For example, the retention plan feature lets you set up one or more retention folders in your users' archives. If a retention folder has the same name and place in the folder hierarchy as the folder that you create with Policy Manager, the retention folder's retention category can override the one that you have set with Policy Manager.

For more information on retention, see the Administrator's Guide.

SiteName

Optional. Can be applied to the mailbox root folder only.

Suspended

Optional. Specifies whether the mailbox is suspended. If not specified, the default of false is applied. Can be applied only to the mailbox root folder.

Possible values:

true
false (default)

URL

Optional. Specifies the URL of the web page that is displayed when a user opens the folder in Outlook. For example, you can use this feature to create folders with links to Enterprise Vault Search.

VaultStoreName

Optional. Identifies the vault store to use when you create a new archive. If the mailbox is already enabled or disabled, VaultStoreName is ignored. If VaultStoreName is not specified, Policy Manager uses the default vault store.

VaultStoreName is valid only if:

Name=mailboxroot
Enabled=true
ArchiveName is not specified
The mailbox has never been enabled

Possible values:

The name or ID of the vault store to use

Zap

Optional, but mandatory when you set DisassociateArchiveFromMailbox to true. Removes all Enterprise Vault properties from the folder. If you apply this setting to the mailbox root, it makes the mailbox appear as though it has never been enabled for archiving. If Zap is specified, it overrides all other [Folder] keynames.

Possible values:

true
false (default)