Enterprise Vault™ Administrator's Guide
- About this guide
- Managing administrator security
- Roles-based administration
- Working with predefined RBA roles
- Customizing RBA roles
- Day-to-day administration
- About Exchange mailbox archiving reports
- About starting or stopping tasks or services
- Monitoring journal mailboxes
- About monitoring disks
- About maintaining the SQL databases
- Using SQL Always On availability groups
- About managing vault store groups and sharing
- About managing safety copies
- About managing partition rollover
- About expiry and deletion
- Working with retention categories and retention plans
- Setting up retention folders
- Enabling archiving for new mailboxes
- About moving archives
- How Move Archive works
- About moving mailbox archives within a site
- About moving mailbox archives between sites
- About configuring Move Archive
- Running Move Archive
- Monitoring Move Archive
- PowerShell cmdlets for managing archives
- PowerShell cmdlets for managing archive permissions
- Using Enterprise Vault for records management
- Setting the default record type for users
- Common configuration scenarios
- Searching archives for items marked as records
- Automatically filtering events
- Managing indexes
- About the indexing wizards
- Managing indexing exclusions
- About the indexing PowerShell cmdlets
- Advanced Domino mailbox and desktop policy settings
- Editing the advanced settings for Domino mailbox and desktop policy
- Domino mailbox policy advanced settings
- Archiving General: Domino mailbox policy
- Archiving General: Domino mailbox policy
- Domino desktop policy advanced settings
- Advanced Exchange mailbox and desktop policy settings
- Editing the advanced Exchange mailbox and desktop settings
- Exchange mailbox policy advanced settings
- Archiving General (Exchange mailbox policy advanced settings)
- Archiving General (Exchange mailbox policy advanced settings)
- Exchange desktop policy advanced settings
- Office Mail App (Exchange desktop policy advanced settings)
- Outlook (Exchange desktop policy advanced settings)
- Vault Cache (Exchange desktop policy advanced settings)
- Virtual Vault (Exchange desktop policy advanced settings)
- Advanced Exchange journal policy settings
- Archiving General (Exchange journal policy advanced settings)
- Advanced Exchange public folder policy settings
- Archiving General (Exchange public folder policy advanced settings)
- Advanced SMTP policy settings
- Site properties advanced settings
- Editing site properties advanced settings
- Site properties advanced settings
- Classification (site properties advanced settings)
- Content Conversion (site properties advanced settings)
- File System Archiving (site properties advanced settings)
- IMAP (site properties advanced settings)
- Indexing (site properties advanced settings)
- Skype for Business (site properties advanced settings)
- SQL Server (site properties advanced settings)
- SMTP (site properties advanced settings)
- Storage (site properties advanced settings)
- Computer properties advanced settings
- Editing computer properties advanced settings
- Computer properties advanced settings
- Agents (computer properties advanced settings)
- File System Archiving (computer properties advanced settings)
- IMAP (computer properties advanced settings)
- Indexing (computer properties advanced settings)
- Storage (computer properties advanced settings)
- Teams (computer properties advanced setting)
- Task properties advanced settings
- Advanced Personal Store Management properties
- Classification policy advanced settings
- Managing the Storage queue
- Automatic monitoring
- About monitoring using Enterprise Vault Operations Manager
- About monitoring using MOM
- About monitoring using SCOM
- Managing extension content providers
- Exporting archives
- Enterprise Vault message queues
- Customizations and best practice
- Mailbox archiving strategies
- About performance tuning
- Failover in a building blocks configuration
- Appendix A. Ports used by Enterprise Vault
- Appendix B. Useful SQL queries
- Appendix C. Troubleshooting
- Installation problems
- Microsoft SQL Server problems
- Server problems
- Client problems
- Problems enabling or processing mailboxes
- Problems with Vault Cache synchronization
- Identifying and resolving Vault Cache issues on the Enterprise Vault server
- Identifying and resolving Vault Cache issues on an end-user computer
- Problems with Enterprise Vault components
- Troubleshooting: All tasks and services
- Troubleshooting: Directory service
- Troubleshooting: Exchange archiving or Journaling tasks
- Troubleshooting: Storage service
- Troubleshooting: Shopping service
- Troubleshooting: Web Access application
- Troubleshooting: All tasks and services
- Techniques to aid troubleshooting
- How to modify registry settings
- About moving an Indexing service
- Appendix D. Enterprise Vault accounts and permissions
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. You can also specify a retention plan to apply to the archive. If you specify the value of -RetentionPlanName as an empty string, Set-EVArchive removes the existing retention plan from the archive.
Set-EVArchive is provided by the snap-in Symantec.EnterpriseVault.PowerShell.Snapin.dll
.
Set-EVArchive [[-ArchiveID] <String>] [-DeleteProtected [<Boolean>]] [-DeleteExpiredItems [<Boolean>]] [-Description [<String>]] [-AdminNote [<String>]] [-RetentionPlanName [<String>]] [-Force [<Boolean>]] [<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 to delete the archived items automatically 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. If the archive is associated with one or more targets that are associated with other archives, the command updates the retention plan of all affected archives. If you specify the value of -RetentionPlanName as an empty string, Set-EVArchive removes the existing retention plan from the archive. In an Exchange or Internet Mail archive, Set-EVArchive creates or updates any retention folders that you have defined with the retention plan. The cmdlet first determines the preferred language of the archive and then, if you have supplied the retention folder names in this language, names the folders accordingly. If the preferred language is one that Enterprise Vault does not support, or Enterprise Vault does support the language but you have not supplied the folder names in it, then the folder names in Enterprise Vault's default language are used. 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. |
-Force | Applies the retention plan specified in -RetentionPlanName without prompting for confirmation. |
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
WARNING: This archive is associated with one or more targets that are associated with other archives. Changing the retention settings of this archive will change the retention settings of the listed archives.
Express Vault Store\A1
Express Vault Store\A2
Express Vault Store\A3
Confirm Do you want to continue? [Y] Yes [N] No [S] Suspend [?] Help (default is "Y"): Y
Applies the retention plan "RPForManagers" to the nominated archive. If this archive is associated with one or more targets that are associated with other archives, this command first displays the list of archives and prompts for confirmation to proceed. If you choose 'Yes', the command applies the retention plan called "RPForManagers" to the listed archives. Choose 'N' or 'S' to exit the command without applying any changes.
Set-EVArchive 14B...EVSERVER.LOCAL -RetentionPlanName RPForManagers -Force
Applies the retention plan called "RPForManagers" to the nominated archive. If this archive is associated with one or more targets that are associated with other archives, this command does not show the confirmation prompt and proceeds to update the retention plan of all impacted archives.
Set-EVArchive 14B...EVSERVER.LOCAL -RetentionPlanName ""
Removes any retention plan that was previously applied to the nominated archive. When you remove a retention plan, the effective retention category for the archiving target is used.
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.
See Remove-EVArchive.