Veritas Enterprise Vault™ PowerShell Cmdlets
- Introducing the Enterprise Vault PowerShell cmdlets
- Archiving: Exchange
- Archiving: FSA
- Archiving: Skype for Business
- Archiving: SMTP
- Get-EVSMTPHoldingFolder
- Get-EVSMTPMessageTrackingLogLocation
- Get-EVSMTPPolicy
- Get-EVSMTPServerSettings
- Get-EVSMTPTarget
- New-EVSMTPPolicy
- New-EVSMTPServerSettings
- New-EVSMTPTarget
- Remove-EVSMTPPolicy
- Remove-EVSMTPTarget
- Set-EVSMTPMessageTrackingLogLocation
- Set-EVSMTPPolicy
- Set-EVSMTPServerSettings
- Set-EVSMTPTarget
- Sync-EVSMTPServerSettings
- Backup
- Classification
- Disable-EVClassification
- Get-EVClassificationFCITags
- Get-EVClassificationPolicy
- Get-EVClassificationStatus
- Get-EVClassificationTestMode
- Get-EVClassificationVICTags
- Import-EVClassificationFCIRules
- Initialize-EVClassificationVIC
- New-EVClassificationPolicy
- Publish-EVClassificationFCIRules
- Remove-EVClassificationPolicy
- Set-EVClassificationPolicy
- Set-EVClassificationTestMode
- Databases
- IMAP access
- Indexing
- Records management
- Retention plans
- Roles-based administration
- Sites and servers
- Tasks and services
- Vault stores and archives
Set-EVArchive
Set-EVArchive sets a number of properties of the nominated archive, including whether users can manually delete the items in the archive and whether Enterprise Vault can automatically delete the archived items when their retention period has expired. You can also specify a description and administrative note for the archive for display in the Administration Console.
Set-EVArchive is provided by Symantec.EnterpriseVault.PowerShell.Snapin.dll, which is loaded by the Enterprise Vault Management Shell.
Set-EVArchive [[-ArchiveID] <String>] [-DeleteProtected [<Boolean>]] [-DeleteExpiredItems [<Boolean>]] [-Description [<String>]] [-AdminNote [<String>]] [-RetentionPlanName [<String>]] [<CommonParameters>]
Table: Set-EVArchive parameters
Parameter | Description |
|---|---|
-ArchiveID (required) | Specifies the ID of the archive for which to set the properties. You can obtain the required ID with the Get-EVArchive cmdlet. |
-DeleteProtected | Specifies whether to permit users manually to delete the items in the archive. Set to $false to permit users to delete items, or $true to prevent deletion. |
-DeleteExpiredItem | Specifies whether to permit Enterprise Vault automatically to delete the archived items when their retention period has expired. Set to $false to prevent deletion, or $true to permit Enterprise Vault to delete the expired items. |
-Description | Provides a short description for display in the archive properties in the Administration Console. |
-AdminNote | Provides an administrative note for display in the archive properties in the Administration Console. |
-RetentionPlanName | Specifies the name of a retention plan to apply to the archive. Note that when the archiving task next performs mailbox synchronization, it may overwrite the specified retention plan with the retention settings of the appropriate provisioning group. For an Exchange mailbox archive, this is only the case if you have cleared the option in the Exchange mailbox policy settings. |
Set-EVArchive 14B...EVSERVER.LOCAL -DeleteProtected:$true -DeleteExpiredItems:$false
Stops both users and Enterprise Vault from deleting the items in the nominated archive, and so places it on legal hold.
Set-EVArchive 14B...EVSERVER.LOCAL -DeleteProtected:$false -AdminNote "Item deletion allowed $(get-date) by $(gc env:username)"
Allows users manually to delete the items in the nominated archive, and modifies its administrative note.
Get-EVArchive localhost Domain\User -OnHold:$false | Set-EVArchive -DeleteProtected:$true -DeleteExpiredItems:$false -Description "Archive placed on legal hold $(get-date) by $(gc env:username) from $(gc env:computername)"
With Get-EVArchive, generates a list of the archives on the local Enterprise Vault server which are not on legal hold and in which the user Domain\User has delete permissions. Get-EVArchive passes the list to Set-EVArchive, which places the archives on hold and sets the archive description accordingly.
Set-EVArchive 14B...EVSERVER.LOCAL -RetentionPlanName RPForManagers
Applies the retention plan "RPForManagers" to the nominated archive.
Set-EVArchive 14B...EVSERVER.LOCAL -RetentionPlanName ""
Removes any retention plan that was previously applied to the nominated archive.
Table: Set-EVArchive properties lists the properties that are available.
Table: Set-EVArchive properties
Name | Type | Description |
|---|---|---|
ArchiveId | String | The ArchiveId of the archive to modify. |
ArchiveName | String | The name of the archive to modify. |
Updated | Boolean | Indicates whether the archive was updated by the cmdlet. Possible values are: $true (archive was updated), $false (archive was not updated). |
See Get-EVArchive.