Search <book_title>...

Enterprise Vault™ PowerShell Cmdlets

Last Published: 2022-09-04

Product(s): Enterprise Vault (14.3)

New-EVArchive

New-EVArchive creates an archive of the specified type. You must specify ArchiveName, ArchiveType, VaultStoreName, and BillUsageTo for creating an archive.

You can create new archives only of the following supported types:

Domino Journal
Exchange Journal
Exchange Public Folder
Shared
SMTP

Optionally, you can specify a Description, AdminNote, RetentionPlanName and indexing settings.

New-EVArchive is provided by the snap-in Symantec.EnterpriseVault.PowerShell.Snapin.dll.

Syntax

New-EVArchive [-ArchiveName] <String> [-ArchiveType] { DominoJournal | ExchangeJournal | PublicFolder | Shared | SMTP} [-VaultStoreName] <String> [-BillUsageTo] <String> [-SiteId <string>] [-Description <String>] [-AdminNote <String>] [-RetentionPlanName <String>] [-IndexLevel {Brief | Full}] [-IndexPreviewLength {128 | 1000}] [-CreateAttachmentPreview <Boolean>] [<CommonParameters>]

Parameters

Table: New-EVArchive parameters

Parameter	Description
-SiteId	The ID of the Enterprise Vault site on which the archive will be created. If you omit this parameter, and the cmdlet cannot determine the ID by looking in the registry, then the New-EVArchive cmdlet prompts you to enter the required site ID. You can use Get-EVSite to obtain the site ID.
-ArchiveName (required)	The name of the archive. The name can contain up to 255 characters.
-ArchiveType (required)	The type of the archive. The possible values are: DominoJournal ExchangeJournal PublicFolder Shared SMTP
-VaultStoreName (required)	The name of the vault store which will be used for archiving. The vault store must have at least one partition. You can obtain the required vault store name with the Get-EVVaultStore cmdlet.
-BillUsageTo (required)	Specifies the Windows account name that will own this archive for billing purposes. The account name of the Windows Active Directory user or group. Type the value in any of the following formats: domain\user domain\group hostname\localuser hostname\localgroup
-Description	Provides a short description for display in the archive properties in the Administration Console. The description can contain up to 127 characters.
-AdminNote	Provides an administrative note for display in the archive properties in the Administration Console. The value can contain up to 127 characters.
-RetentionPlanName	Specifies the name of a retention plan to apply to the archive. A retention plan can be specified only for the following archive types: DominoJournal ExchangeJournal SMTP
-IndexLevel	The indexing level to assign to the archive index. The enumeration values are as follows: Brief or 0: Enterprise Vault indexes the metadata of archived items but not the content. For example, Enterprise Vault indexes the sender and the item date. Users cannot search for any content in these items. Full or 2: Enterprise Vault indexes the metadata and content of archived items and their attachments. Users can search for the content of items and attachments. If this parameter is not specified, its value will be used from the site settings.
-IndexPreviewLength	The amount of text that Enterprise Vault shows for each item in search results. The possible values are 128 and 1000. This parameter cannot be specified if IndexLevel is specified as Brief or 0. If it is not specified, its value will be used from the site settings.
-CreateAttachmentPreview	Specifies whether Enterprise Vault creates previews of attachment content. This parameter cannot be specified if IndexLevel is specified as Brief or 0. If it is not specified, its value will be used from the site settings.

Examples

New-EVArchive myArchive SMTP myVaultStore example\john
Creates an archive with the name 'myArchive' of type SMTP with 'myVaultStore' being the vault store to be used and 'example\john' being the Windows account to be used for billing.
New-EVArchive myArchive Shared myVaultStore example\john -Description "Shared Archive" -AdminNote "Administrator Note"
Creates an archive with the name 'myArchive' of type Shared with 'myVaultStore' being the vault store to be used and 'example\john' being the billing account. It also sets the description as 'Shared Archive' and admin note as 'Administrator Note'.
New-EVArchive myArchive SMTP myVaultStore example\john -Description "SMTP Archive for managers" -RetentionPlanName RetPlanForArchiveManagers
Creates an archive with the description as 'SMTP Archive for managers' and the retention plan as 'RetPlanForArchiveManagers'.
New-EVArchive myArchive SMTP myVaultStore example\john -IndexLevel Brief
Creates an archive and assigns the Brief indexing level for the archive index.
New-EVArchive myArchive DominoJournal myVaultStore example\john -IndexLevel Full -IndexPreviewLength 1000 -CreateAttachmentPreview $true
Creates an archive with the Full indexing level, index preview length as 1000. It also enables the creation of attachment previews.
Import-Csv archives.csv | New-EVArchive
Creates a bunch of archives using a CSV file. The CSV file must have headers, such as ArchiveName, ArchiveType, VaultStoreName, and BillUsageTo. Optionally, the CSV file can also have other properties like Description, AdminNote, RetentionPlanName, and so on.
Note:
Due to a known limitation of the Import-Csv cmdlet, if you use the Import-Csv cmdlet with pipelining, the Boolean values do not get pipelined and are specified as $false. To resolve this issue, after you import the string value, convert it to a Boolean before piping it to the next cmdlet in the pipeline. See About the imported Boolean value while using the Import-Csv cmdlet.
Import-Csv archives.csv | New-EVArchive | Set-EVArchivePermission -Trustee example\john -Grant Delete
Creates a bunch of archives using a CSV file and then grants delete permissions to Windows account 'example\john' on all of them.
Get-EVArchive -ArchiveName 'existing archive' -IncludeDetails $true | New-EVArchive -ArchiveName 'new archive' -BillUsageTo example\john
Clones an existing archive and overrides the billing user with 'example\john'.

Output

New-EVArchive returns an object of the type Symantec.EnterpriseVault.PowerShell.Commands.NewArchive, which has the following properties:

Table: New-EVArchive properties

Name	Type	Description
ArchiveName	String	The name of the archive which has been created.
ArchiveDescription	String	The description of the archive which has been created.
ArchiveType	EV_STG_API_ARCHIVE_TYPE	The type of the archive which has been created.
ArchiveId	String	The ID of the archive which has been created.
VaultStoreName	String	Name of the vault store which will be used for archiving.
VaultStoreId	String	The ID of the vault store which will be used for archiving.
StorageServerName	String	Name of the storage server which will be used for archiving.
IndexerName	String	Name of the index server which will be used for indexing.
IndexServerGroup	String	Name of the index server group to which the archive belongs
RetentionPlanName	String	The name of the retention plan that you have applied to the archive.
BillUsageTo	String	The Windows Active Directory account will own this archive for billing purposes.
AdminNote	String	The Administrator note of the archive which has been created.
IndexLevel	EV_STG_API_INDEX_LEVEL	The indexing level set for the user archive.
IndexPreviewLength	Integer	The amount of text that Enterprise Vault will show for each item in the search results.
CreateAttachmentPreview	Boolean	Specifies whether Enterprise Vault will create previews of attachment content.

Related cmdlets