Veritas Enterprise Vault™ PowerShell Cmdlets

-ArchiveId (required)

Specifies the ID of the archive from which to export the items. You can use Get-EVArchive to obtain the required ID.

-OutputDirectory (required)

Specifies the path to the folder in which the cmdlet should place the exported items. Type an absolute, relative, or UNC path that contains up to 200 characters. Enclose the path in quotation marks if it contains space characters.

If the specified folder does not exist, the cmdlet attempts to create it.

-StartDate

Specifies the start of a date range. The cmdlet exports only those messages that were received, or file system items that were created, within the date range. The specified dates apply to top-level messages only, and not to any attachments that they have. For example, if you specify a date range that covers the whole of 2015, the cmdlet ignores messages that were received in 2016 but that have attachments created in 2015.

Type the start date in a format that PowerShell recognizes, such as mm/dd/yyyy, yyyy-mm-dd, or mm.dd.yyyy. Export-EVNARAArchive interprets a date like 04/03/2016 according to the regional settings of the computer where you run it. For example, it typically interprets this date as April 3 2016 on a US English computer and March 4 2016 on a UK English computer.

The cmdlet ignores any time that you append to the date and instead works from the start of the specified date (or the end of the specified date in the case of EndDate).

You do not need to specify both a start date and an end date.

-EndDate

Specifies the end of a date range. The same requirements apply to this parameter as to StartDate.

-SearchString

Specifies a search query with which to identify selected items for export. Those items that match the search criteria but that Enterprise Vault has not marked as permanent records are ignored. Similarly, if you specify a date range with the StartDate and EndDate parameters, the cmdlet first excludes any items that fall outside the range and only then looks for items that match your search query.

You can use the same query syntax as you might use to look for specific items in Enterprise Vault Search. For example, the search query "to:mike_smith" selects for export only those items for which he was a recipient. Enclose the query in quotation marks if it contains space characters.

For more information on the query syntax, see the online Help for Enterprise Vault Search.

-IncludePreviouslyExported

If specified, causes this export run to include the records that you exported in previous runs, as well as those that you have not previously exported.

-Format

Specifies the format in which to export the items. The possible values are EML, NATIVE, and PST, where EML is the default. To export to PST, Microsoft Outlook must be installed and set as the default email client on both the local server and the server hosting the Enterprise Vault Storage service for the specified archive.

The NATIVE value instructs the cmdlet to export each item in its original format: MSG for Microsoft Exchange items, EML for SMTP items, TXT for text files, and so on.

With the PST value, the cmdlet first exports the items as MSG files and then collects them in a PST file. The folder structure within the PST file matches that of the source archive. The cmdlet automatically creates additional PST files to hold all the exported items when either of the following occurs:

If an item is larger than 250 MB, the cmdlet exports it as a standalone EML file that it places alongside the PST file, instead of first exporting the item as an MSG file and then collecting it in the PST file.

-MaxThreads

Specifies the maximum number of threads to use for the export process. Type a value between 1 and 100. The default value is 16.

Reducing the number of threads can help to minimize the load on Enterprise Vault server resources. Alternatively, in distributed or high specification Enterprise Vault environments, increasing the number of threads can improve throughput.

-MaxPSTSizeMB

For exports to PST only, specifies the maximum size in MB of each PST file. After a PST file reaches this limit, the cmdlet automatically creates a new PST file for the remaining items. Type a value between 500 and 51200. The default value is 20480 (20 GB).

-Confirm

Specifies whether the cmdlet requires confirmation before proceeding when it detects that the specified archive has 32-bit index volumes. By default, the cmdlet pauses when it detects an archive like this, and you must confirm that you want to proceed. You can suppress the confirmation prompt by using this exact syntax: -Confirm:$false (the colon is mandatory).