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

Restoring archived files

You can use FSAUtility with the -t parameter to restore some or all of the archived files to their original location or a new location.

To make sure that any file recalls do not exceed the recall limits, create an Enterprise Vault Backup Operators group in Active Directory, and include in that group the account that is to perform the restore.

By default, FSAUtility restores the files in asynchronous mode. You can choose instead to restore files synchronously if you want. With a synchronous restore you can set a timeout for file restores, and see the progress of each file restore operation. To restore files synchronously and to set a timeout for file restores, create a DWORD entry called FileDownloadTimeOut under the following registry key on the Enterprise Vault server:

HKEY_LOCAL_MACHINE
 \SOFTWARE
  \Wow6432Node
   \KVS
    \Enterprise Vault
     \FSARestore

If FileDownloadTimeOut is set to 0, FSAUtility restores files asynchronously. Any value greater than 0 denotes the timeout, in seconds, for each file recall.

Syntax

FSAUtility -t -s UNC_path [-DA mm-dd-yyyy] [-DB mm-dd-yyyy] -d UNC_path [-e ext_list] [-f] [-l log_level] [-r]

Where:

-s UNC_path specifies the path to the required folder, volume, or file server.
-DA mm-dd-yyyy specifies an archive date. FSAUtility restores files archived after the specified date.
-DB mm-dd-yyyy specifies an archive date. FSAUtility restores files archived before the specified date.
-d UNC_path specifies the path to the destination folder.
[-e ext_list] specifies the file types to restore as a comma-separated list of file name extensions. For example:
*.xls,*.doc,*.txt
By default, the utility restores all file types.
-f forces FSAUtility to restore the files when placeholders or files of the same name already exist. The utility first deletes the existing placeholders or files and then restores the files.
-l log_level specifies whether to log both successful operations and failed operations (0) or failed operations only (1). By default, FSAUtility logs failed operations only.
-r specifies report mode. FSAUtility generates a report that outlines the activities that it would perform if you were to run it in normal mode, but without performing those activities.
FSAUtility generates a report named EV_FILESYSTEM_UTILITY_REPORT_DateTime.txt, in the folder installpath\Reports\FSAUtility.
If you run -t in normal mode, FSAUtility generates a report named EV_FILESYSTEM_UTILITY_REPORT_DateTime.xml.

Examples

The following command restores the Word and Excel files in the folder \\myserver\users. It also generates a log file that lists both successful operations and failed operations.

FSAUtility -t -s \\myserver\users -e *.doc,*.xls -l 0

The following command restores the Word and Excel files for an entire file server.

FSAUtility -t -s \\myserver -e *.doc,*.xls -l 0

The following command restores the files that are archived after June 28 2018.

FSAUtility.exe -t -s \\myserver\users -DA 06-28-2018

If multiple versions of the same file exist in the archive, this command restores the latest version only.

The following command restores the files that are archived before June 28 2018.

FSAUtility.exe -t -s \\myserver\users -DB 06-28-2018

If multiple versions of the same file exist in the archive, this command restores the version of the file that was archived before the specified date. For example, if a file was archived on the following dates:

July 1 2018 14:00

June 29 2018 15:25

June 22 2018 11:00

June 22 2018 13:15

This command restores the version of the file that was archived on June 22 2018 13:15.

Notes

FSAUtility does not support "hard link" files (directory references to files). You cannot restore an archived file if that file has the same name as a hard link file in the destination folder. When you perform a restore operation, FSAUtility recalls any placeholders that are hard link files.
When you recall files to a Dell EMC Celerra/VNX device, FSAUtility applies only the folder permissions to the files. If there are placeholders with file-specific permissions, the file permissions are lost and you must reapply them manually.
Due to a NetApp restriction, FSAUtility does not restore archived files if the path to the folder exceeds 512 characters.