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-EVNARAArchive exports from the specified archive only those items that Enterprise Vault has marked as permanent records. You can limit the export to records that fall within the specified date range and/or match the specified search criteria. By default, this cmdlet exports only those permanent records that you have not previously exported. However, you can choose to export the previously-exported records as well as the new ones.
Export-EVNARAArchive is designed for use in environments where you have chosen to implement the Capstone approach to records management. One of the requirements of Capstone is to make periodic transfers of permanent records to the U.S. National Archives. Besides exporting a batch of records, Export-EVNARAArchive also creates a load file in comma-separated value (
.csv) format, which you can send to the National Archives with the items. For each item that the cmdlet has successfully exported, the load file provides the following information:
The file name of the exported item. For exports to PST, the load file shows the name of the PST file.
The record ID.
A title. For messages, this is the subject line; for other items, it is the original file name.
A description, which is derived from the indexed content of the item.
By default, Enterprise Vault indexes the full content of each item and treats the first 128 characters as a preview string for display in search results. It is this string that appears in the load file. However, you can configure the indexing settings at the site or archive level to increase the preview length or switch to brief indexing, which does not index the contents of items at all. Any changes that you make to these settings are reflected in the description that appears in the load file.
The creator of the item.
The date on which the item was created.
For exports to PST only, the location of the item in the PST folder structure.
Export-EVNARAArchive is provided by the snap-in
Export-EVNARAArchive [-ArchiveId] <String> [-OutputDirectory] <String> [[-StartDate] <DateTime>] [[-EndDate] <DateTime>] [[-SearchString] [<String>]] [[-IncludePreviouslyExported] [<SwitchParameter>]] [[-Format] [<ExportFormat>]] [[-MaxThreads] [<Integer>]] [-MaxPSTSizeMB <Integer>] [-Confirm:<Boolean>] [<CommonParameters>]
Table: Export-EVNARAArchive 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 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.
Specifies the end of a date range. The same requirements apply to this parameter as to StartDate.
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.
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.
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.
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.
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).
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).
Export-EVNARAArchive -ArchiveId 19D...EVServer1 -OutputDirectory c:\Temp
Exports all the permanent records from the specified archive to the output folder
Export-EVNARAArchive -ArchiveId 19D...EVServer1 -OutputDirectory "c:\Exported Items" -StartDate 01/01/2010 -EndDate 02/02/2015
Limits the export to those permanent records that fall within the date range of 01/01/2010 and 02/02/2015.
Export-EVNARAArchive -ArchiveId 19D...EVServer1 -OutputDirectory "c:\Exported Items" -StartDate 01/01/2016
Limits the export to those permanent records that fall within the date range of 01/01/2016 and today.
Export-EVNARAArchive -ArchiveId 19D...EVServer1 -OutputDirectory "c:\Exported Items" -SearchString "to:mike_smith"
Exports only those permanent records for which Mike Smith was a recipient.
Export-EVNARAArchive -ArchiveId 19D...EVServer1 -OutputDirectory c:\Temp -IncludePreviouslyExported
Exports the permanent records that you have previously exported as well as those that are new.
Export-EVNARAArchive -ArchiveId 19D...EVServer1 -OutputDirectory c:\Temp -Format PST -MaxPSTSizeMB 51200
Exports all the permanent records to one or more PST files, each of which can be up to 50 GB in size.
Export-EVNARAArchive -ArchiveId 19D...EVServer1 -OutputDirectory c:\Temp -MaxThreads 100
Allocates 100 threads to the process of exporting all the permanent records from the specified archive.
"19D...EVServer1","18F...EVServer2","14C...EVServer3" | Export-EVNARAArchive -OutputDirectory "c:\Exported Items"
Pipes the IDs of three archives from which to export all the permanent records.
There is a confirmation message on completion. In addition, the cmdlet creates the following:
A load file in comma-separated value (
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.