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
Get-EVRecordSettings
Get-EVRecordSettings provides information on the records management settings in one or more archives. To implement Capstone or an equivalent records management system, it is necessary to mark items as records so that you can easily categorize, search for, export, and dispose of them. For guidelines on using Enterprise Vault for records management, see the Administrator's Guide.
Get-EVRecordSettings is provided by the snap-in Symantec.EnterpriseVault.PowerShell.Snapin.dll.
Get-EVRecordSettings [-ArchiveId <String>] [-ArchiveName <String>] [-User <String>] [-RetentionPlan <String>] [-RecordType <String>] [-RetentionCategory <String>] [-SiteId <String>] [<CommonParameters>]
Table: Get-EVRecordSettings parameters
Parameter | Description |
|---|---|
-ArchiveId | Specifies the ID of the archive for which to return the records management settings. You can use Get-EVArchive to obtain the required ID. |
-ArchiveName | Specifies the name of an archive for which to return the records management settings. The cmdlet may return the settings for multiple archives if they all share the same name. |
-User | Specifies the name of a user for whom to return the records management settings for all the archives in which the user has write permissions. Type the name in the form domain\user. |
-RetentionPlan | Specifies the name of a retention plan for which to return the records management settings for all the archives to which you have applied the plan. |
-RecordType | Specifies a record type (Permanent or Temporary) for which to return the records management settings for all the archives in which it is the default type. The retention category specified in the retention plan that you have applied to an archive determines the archive's default record type. |
-RetentionCategory | Specifies a retention category for which to return the records management settings for all the archives to which you have applied a retention plan with this retention category. |
-SiteId | Specifies the ID of the target Enterprise Vault site. This parameter is mandatory if you run the cmdlet on any computer other than an Enterprise Vault server. Do not specify both the ArchiveId and SiteId parameters. You can use Get-EVSite to obtain the site ID. |
Get-EVRecordSettings -ArchiveId 19D...EVServer1
Returns the records management settings for the specified archive.
Get-EVRecordSettings -ArchiveName msmith
Returns the records management settings for all the archives that have the name "msmith".
Get-EVRecordSettings -User "Domain\user"
Returns the records management settings for all the archives in which the user "Domain\user" has write permissions.
Get-EVRecordSettings -RetentionPlan RetPlanForManagers
Returns the records management settings for all the archives to which you have applied the retention plan "RetPlanForManagers".
Get-EVRecordSettings -RecordType Permanent
Returns the records management settings for all the archives to which you have applied a retention plan whose retention category has an associated record type of "Permanent".
Get-EVRecordSettings -RetentionCategory "Default Retention Category"
Returns the records management settings for all the archives to which you have applied a retention plan whose retention category is "Default Retention Category".
Get-EVRecordSettings -ArchiveName msmith -SiteId 13E...EV.example.com
Returns the records management settings for all the archives with the name "msmith" in the specified site.
Get-EVRecordSettings -RetentionPlan RetPlanForManagers | format-table -auto
For all the archives to which you have applied the retention plan "RetPlanForManagers", returns the records management settings in tabular form.
This cmdlet returns an object of type Symantec.EnterpriseVault.PowerShell.Commands.RecordSettings, which has the following properties.
Table: Get-EVRecordSettings properties
Name | Type | Description |
|---|---|---|
ArchiveName | String | The name of the archive. |
RetentionPlan | String | The name of the retention plan that you have applied to the archive. |
RetentionCategory | String | The retention category that you have associated with the retention plan. |
RecordType | String | The record type that you have associated with the retention category. |
ArchiveId | String | The ID of the archive. |
RetentionCategoryId | String | The ID of the retention category. |
See Export-EVArchive.
See Get-EVArchive.
See Export-EVNARAArchive.
See Get-EVSite.