Search <book_title>...

Veritas Enterprise Vault™ Utilities

Last Published: 2017-07-28

Product(s): Enterprise Vault (12.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
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 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
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

ArchivePoints syntax

Use one of the following formats:

To create archive points:
ArchivePoints create archive_point_path_share_name subfolders|nosubfolders [XML_template_file_path_name]
To update the attributes of archive points:
ArchivePoints update archive_point_path_share_name subfolders|nosubfolders XML_template_file_path_name
To list all the archive points beneath a specified network share:
ArchivePoints find archive_point_path_share_name
To display the contents of the archive points:
ArchivePoints read archive_point_path_share_name
To delete the archive points:
ArchivePoints delete archive_point_path_share_name
To create an auto-enabling folder:
ArchivePoints autoenable autoenabling_folder_path on
To turn off the auto-enabling property for a folder:
ArchivePoints autoenable autoenabling_folder_path off [subfolderdelete]

where the parameters are as follows:

*archive_point_path_share_name*	Specifies the UNC path to the network share to which the command applies. Enclose the path in quotes if it includes any non-alphanumeric characters.
subfolders\|nosubfolders	Specifies whether to create an archive point for each immediate subfolder.
*XML_template_file_path_name*	Specifies the full path to an XML template file of archive point attribute values, which override the default values or existing values.
*autoenabling_folder_path*	The full path to the folder on which you want to switch on or switch off the auto-enabling property. If you omit the on and off switches, the auto-enabling property for a folder will be switched off.
subfolderdelete	Deletes the archive point from each immediate subfolder when you switch off the auto-enabling property for a folder.

If you specify an XML template file, it must have the following format:

<archivePoint xmlns="urn:kvsplc-com:FileSystemFolderArchivePoint">
    <attribute>value</attribute>
    <attribute>value</attribute>
    <attribute>value</attribute>
    ...
</archivePoint>

where each attribute line specifies an archive point attribute and its value.

Note the following:

You must run this utility with Administrator privileges if the computer has User Account Control (UAC) enabled.
See Running the Enterprise Vault command-line utilities with administrator privileges.
If an attribute is not included in the XML template file when you create an archive point, the File System Archiving task uses the default value for that attribute.
If an attribute is not included in the XML template file when you update an archive point, the File System Archiving task does not change the existing value.
You cannot use an XML template file if you create an auto-enabling folder. The archive points associated with an auto-enabling folder must be created with default attribute values.

Table: ArchivePoints template file attributes lists the attributes you can include in the XML template file.

Table: ArchivePoints template file attributes

Attribute	Description	Default value for new archive point
name	Specifies the name of the archive that is associated with this archive point, with any prefix if specified.	The name of the folder on which the archive point resides.
description	Provides a description for the archive if required. The description appears in the list of file system archives under Archives > File System in the Administration Console.	None.
owner	Specifies the account to use when billing archive usage.	None.
indexDisabled	Specifies whether to disable (true) or enable (false) indexing for the files in the archive.	false.
indexingLevel	Specifies the indexing level, which can be either brief or full. brief indexes the metadata of archived items such as the file name and the item date, but not any content. A brief index is smaller than a full index, but users cannot search for any content in the archived items. full indexes the metadata and the content of archived items. Users can search for the content of items.	The setting on the Indexing tab of the Site properties in the Administration Console.
indexSnippetLength	Specifies the preview length in characters. The preview length is the amount of text that Enterprise Vault shows in a search results list, when the indexing level is full. The preview length can only be 128 or 1000. The size of an index increases when you increase the preview length.	The setting on the Indexing tab of the Site properties in the Administration Console.
indexAttachmentSnippet	Specifies whether Enterprise Vault creates previews of attachment content when the indexing level is full. The value can be true (yes) or false (no). These previews cannot be viewed in this release of Enterprise Vault. The size of an index increases when you enable this option.	The setting on the Indexing tab of the Site properties in the Administration Console.
deleteExpiredItems	Specifies whether Enterprise Vault automatically deletes items from the archive when their retention periods expire. The value can be true (delete expired items) or false (do not delete expired items).	false.
prefix	Specifies a prefix that Enterprise Vault prepends to name to make the archive name. A prefix may be useful if you do not specify a name and you use the subfolders option to create an archive point for each immediate subfolder of the target folder.	None.

For example, the following file sets the attribute values for an archive point:

<archivePoint xmlns="urn:kvsplc-com:FileSystemFolderArchivePoint">
    <name>Newton archive</name>
    <description>Isaac Newton's User Archive</description>
    <owner>astronomy\newtoni</owner>
    <indexDisabled>false</indexDisabled>
    <indexingLevel>full</indexingLevel>
    <indexSnippetLength>1000</indexSnippetLength>
    <indexAttachmentSnippet>false</indexAttachmentSnippet>
    <deleteExpiredItems>false</deleteExpiredItems>
    <prefix>User</prefix>
</archivePoint>