Enterprise Vault™ PowerShell Cmdlets
- Introducing the Enterprise Vault PowerShell cmdlets
- Archiving: Exchange
- Archiving: FSA
- Archiving: Skype for Business
- Archiving: SMTP
- IMAP access
- Records management
- Retention plans
- Roles-based administration
- Sites and servers
- Tasks and services
- Vault stores and archives
Export-EVArchive exports items from the specified archive. You can limit the export to items that match the specified search criteria.
If you want to export items to fulfil the requirements of the Capstone records management system, you may prefer to run the Export-EVNARAArchive cmdlet. Export-EVNARAArchive has many of the same features as Export-EVArchive but limits the export to items that Enterprise Vault has marked as permanent records.
Export-EVArchive is provided by the snap-in
Export-EVArchive [-ArchiveId] <String> [-OutputDirectory] <String> [[-SearchString] [<String>]] [[-Format] [<ExportFormat>]] [[-MaxThreads] [<Integer>]] [-Retry <SwitchParameter>] [-MaxPSTSizeMB <Integer>] [<CommonParameters>]
Table: Export-EVArchive parameters
Specifies the ID of the archive from which to export the items. You can use Get-EVArchive to obtain the required ID.
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.
Specifies a search query with which to identify selected items for export. 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.
Specifies the format in which to export the items. The possible values are EML, NATIVE, and PST, where NATIVE 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. However, if a source folder contains more than 100,000 items then the cmdlet automatically creates additional folders in the PST file to hold the excess items.
If an exported item is larger than 250 MB, the cmdlet leaves it outside the PST file instead of collecting it in the file. If the item exceeds 2 GB, the cmdlet exports it in its native format rather than as MSG.
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.
If specified, runs the cmdlet again to export items that it did not export during a previous run. For example, this may be necessary if the previous run stopped for some reason before it completed, or the run completed but failed to export certain items.
Take care to specify the same ArchiveId and OutputDirectory parameter values as you specified for the previous run. You do not need to specify the SearchString and Format parameter values again, as the cmdlet automatically uses the values that you previously specified.
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 file for the remaining items. Type a value between 500 and 51200. The default value is 20480 (20 GB).
Export-EVArchive -ArchiveId 19D...EVServer1 -OutputDirectory c:\Temp
Exports all the items from the specified archive to the output folder
Export-EVArchive -ArchiveId 19D...EVServer1 -OutputDirectory "c:\Exported Items" -SearchString "to:mike_smith"
Exports only those items for which Mike Smith was a recipient.
Export-EVArchive -ArchiveId 19D...EVServer1 -OutputDirectory c:\Temp -Format PST -MaxPSTSizeMB 51200
Exports all the items to one or more PST files, each of which can be up to 50 GB in size.
Export-EVArchive -ArchiveId 19D...EVServer1 -OutputDirectory c:\Temp -MaxThreads 100
Allocates 100 threads to the process of exporting all the items from the specified archive.
Export-EVArchive -ArchiveId 19D...EVServer1 -OutputDirectory c:\Temp -Retry
For the specified archive, retries an export run that previously failed to export all the required items. The specified output folder is the same as that for the previous run. The cmdlet automatically uses the same search string and format values as those specified for the previous run.
"19D...EVServer1","18F...EVServer2","14C...EVServer3" | Export-EVArchive -OutputDirectory "c:\Exported Items"
Pipes the IDs of three archives from which to export all the items.
There is a confirmation message on completion.
In addition, the cmdlet creates a report file called
ExportReport_datetime.txt; for example,
ExportReport_20160311125651.txt. This file shows the number of exported items and identifies any that the cmdlet failed to export. If the export failed altogether for some reason, the report indicates the probable cause.