Veritas Enterprise Vault™ PowerShell Cmdlets
Get-EVArchive
Get-EVArchive returns a list of some or all of the archives in the Enterprise Vault site. You can filter this list to show the following:
Archives in which a specified user has various permissions, either directly or through membership of an Active Directory group.
Archives whose name exactly matches the specified name.
You can further filter the list by a number of archive properties. For example, you can choose to list only those archives in which a specified user has permission to delete the archived items, or only those archives that are on legal hold.
Get-EVArchive is provided by Symantec.EnterpriseVault.PowerShell.Snapin.dll, which is loaded by the Enterprise Vault Management Shell.
Get-EVArchive [-User] <String> [[-Server] <String>] [-DeleteProtected [<Boolean>]] [-DeleteExpiredItems [<Boolean>]] [-OnHold [<Boolean>]] [-Permissions [<String>]] [<CommonParameters>]
Get-EVArchive [[-ArchiveName] <String>] [[-Server] <String>] [-DeleteProtected [<Boolean>]] [-DeleteExpiredItems [<Boolean>]] [-OnHold [<Boolean>]] [<CommonParameters>]
Table: Get-EVArchive parameters
Parameter | Description |
|---|---|
-User (required if you use the first parameter set in the Syntax section) | Identifies the user for which to retrieve the archive list. Type the user's Windows logon name, user principal name, or Domino user ID. For example: user@domain.com, domain\user. |
-ArchiveName | Specifies the name of an archive for which to retrieve the details. |
-Server | Identifies the Enterprise Vault server for which to retrieve the archive list. For example: localhost, evserver.domain.com. If you omit this parameter, the cmdlet looks in the registry to identify the Enterprise Vault Directory service computer. |
-DeleteProtected | Filters the archive list according to whether the user can manually delete the items in the archives. Set to $false to list the archives in which the user can manually delete items, or $true to list the archives in which the user cannot delete items. |
-DeleteExpiredItems | Filters the archive list according to whether Enterprise Vault can automatically delete the archived items whose retention periods have expired. Set to $false to list the archives in which Enterprise Vault does not delete expired items, or $true to list the archives in which it does. |
-OnHold | Filters the archive list according to the legal hold status of the archives. Set to $false to list the archives in which either the user or Enterprise Vault (or both) can delete items, or $true to list the archives that are on legal hold. Legal hold is equivalent to DeleteProtected set to $true and DeleteExpiredItems set to $false. |
-Permissions | Filters the archive list according to the permissions that the user has on the archives. Specify the permissions as a combination of r (for read), w (for write), and d (for delete); for example, rw and rwd. A blank value () denotes any permission. The default permission if not specified is d (delete). You can only set this parameter if you have also specified the -User parameter. |
Get-EVArchive
Lists all the archives in the Enterprise Vault site.
Get-EVArchive -DeleteProtected $false
Filters the list of archives in the Enterprise Vault site to show only those in which users can manually delete items.
Get-EVArchive -User Domain\User
Lists the archives in which the user Domain\User has delete permissions.
Get-EVArchive -User user@domain -DeleteProtected $false -DeleteExpiredItems $false -Permissions rw
Lists the archives in which the user user@domain.com has both read and write permissions. Get-EVArchive filters the list to show only those archives in which the user can manually delete items but in which Enterprise Vault cannot automatically delete expired items.
Get-EVArchive -User Domain\User -OnHold $false | format-table -auto
Lists the archives in which the user Domain\User has delete permissions. Get-EVArchive excludes from the list all the archives that are on legal hold and writes the output to format-table.
Get-EVArchive -ArchiveName msmith | format-table -auto
Lists the archives that have the name "msmith".
Get-EVArchive | where-object {$_.ArchiveName -ilike "*journal*"}
Lists the archives whose names contain the case-insensitive string "journal".
Table: Get-EVArchive properties lists the properties that are available.
Table: Get-EVArchive properties
Name | Type | Description |
|---|---|---|
ArchiveId | String | The ID of an archive to which the specified user has access. |
ArchiveName | String | The name of an archive to which the specified user has access. |
ArchiveType | EV_STG_API_ARCHIVE_TYPE | The Enterprise Vault archive type enumeration. The possible values are as follows:
|
DeleteExpiredItems | EV_STG_API_EXPIRE_ITEMS | The Enterprise Vault expire items enumeration. The possible values are as follows:
|
DeleteProtected | Boolean | Indicates whether the user can manually delete items from the archive ($false) or not ($true). |
OnHold | Boolean | Indicates whether the archive contains items that are on legal hold ($true) or not ($false). |
Status | EV_STG_API_STATUS | The Enterprise Vault archive status enumeration. The possible values are as follows:
|
RetentionPlanName | String | The name of the retention plan that you have applied to the archive. |
See Set-EVArchive.