Veritas Enterprise Vault™ Utilities

Last Published:
Product(s): Enterprise Vault (12.1)
  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.  
          Risk of data loss when you run certain EVSVR Repair operations
        2.  
          Choosing a suitable EVSVR Repair operation
        3.  
          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 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
      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
        1.  
          Disable method for Provisioning API Interface for Policy Manager scripts
        2.  
          Enable method for Provisioning API Interface for Policy Manager scripts
        3.  
          ExecuteScript method for Provisioning API Interface for Policy Manager scripts
        4.  
          SetScriptFile method for Provisioning API Interface for Policy Manager scripts
        5.  
          SetScriptText method for Provisioning API Interface 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

Provisioning API error handling for Policy Manager scripts

When setting object properties, HRESULT errors are returned if the property is invalid. If Policy Manager returns an error when calling EnableScript, DisableScript, or ExecuteScript, you can use the two properties available to help with tracing problems with the Provisioning API.

These properties are as follows:

ReportText

Returns the report text from the previous run.

LastScript

Returns the script from the previous run.

Table: Provisioning API error codes describes the standard set of errors that the API returns.

Table: Provisioning API error codes

Error code

Error type

Message text

0xC004C000

PROV_DIRECTORY_INVALID

The Directory Service name is invalid or the Directory Service is not running.

0xC004C001

PROV_MUST_SET_DIRECTORY _FIRST

The Directory property must be set first.

0xC004C002L

PROV_COULD_NOT_CREATE_ DIRECTORYCONNECTION

Could not create the Enterprise Vault Directory Connection object.

0xC004C003

PROV_ENTRYID_INVALID

The Entry Id is not valid.

0xC004C004

PROV_INVALID_TABLE_ID

Invalid table ID.

0xC004C005

PROV_ERROR_INSERTING_ PARAMETERS

An error occurred replacing the script parameters.

0xC004C006

PROV_INVALID_ARG_ PARAMETER

One of the arguments supplied in the arguments array could not be converted to a string.

0xC004C007

PROV_MUST_SET_SITE_FIRST

The Site property must be set before this property.

0xC004C008

PROV_NAME_INVALID

Invalid property value.

0xC004C009

PROV_INDEXING_SVC_NOT_FOUND

The Indexing Service could not be found.

0xC004C00A

PROV_NOT_ENOUGH_PROPERTIES_SET

The following properties must be set before Enable/Disable can be called: %n%nDirectory, Site, ExchangeServer, SystemMailbox, (MailboxDN or LDAPQuery).

0xC004C00B

PROV_FAILED_CREATE_STDIN_PIPE

Failed to create a StdIn pipe.

0xC004C00C

PROV_FAILED_CREATE_STDOUTERR_PIPE

Failed to create the StdOut pipe.

0xC004C00D

PROV_FAILED_DUPLICATE_HANDLE

Failed to duplicate the std handle.

0xC004C00E

PROV_FAILED_CLOSE_TEMP_HANDLE

Failed to close the temporary handle.

0xC004C00F

PROV_NO_PASSWORD_FOR_USER

The password for the Logon details was not set.

0xC004C010

PROV_CREATE_PROCESS_FAILED

Failed to create the policy manager process.

0xC004C011

PROV_CREATE_PROCESS_AS_USER_FAILED

Failed to create the policy manager process under the specified account.

0xC004C012

PROV_LOGON_USER_FAILED

Could not log the user on for the policy manager process.

0xC004C013

PROV_WAIT_SINGLE_OBJECT_FAILED

Failed to wait for the process to complete.

0xC004C014

PROV_GETEXITPROCESS_FAILED

Could not get the exit code from the policy manager process.

0xC004C015

PROV_FAILED_GET_TEMP_PATH

Could not get the temp file path.

0xC004C016

PROV_FAILED_GET_TEMP_FILE_NAME

Could not get the temp file name.

0xC004C017

PROV_FAILED_CREATE_INI_FILE

Could not create the provisioning initialization file.

0xC004C018

PROV_WRITE_WRITE_INI_FILE

Could not write the provisioning initialization file.

0xC004C019

PROV_FAILED_CLOSE_INI_FILE

Could not close the provisioning initialization file.

0xC004C01A

PROV_FAILED_COCREATE_POLICYINVOKER

Failed to connect to the Admin Service.

0xC004C01B

PROV_PARAMS_NOT_ARRAY

The second argument must be an array.

0xC004C01C

PROV_SCRIPT_FILE_NOT_FOUND

The Script file could not be found.

0xC004C01D

PROV_INPUT_FILE_NOT_UNICODE

Script file is not unicode.

0xC004C01E

PROV_FAILED_OPEN_REGISTRY

Could not open the Enterprise Vault Registry Key.

0xC004C01F

PROV_FAILED_READ_REGISTRY

Could not read the Installation directory from the registry.

0xC004C020

PROV_FAILED_EXECUTE

The script returned errors, check the report for details.

0xC004C021

PROV_SCRIPT_TIMED_OUT

The script timed out.

0xC004C022

PROV_FAILED_READ_LOGON_DETAILS

Failed to read the Logon Details.