Enterprise Vault™ PowerShell Cmdlets
- Introducing the Enterprise Vault PowerShell cmdlets
- Archiving: Exchange
- Archiving: FSA
- Get-EVFSAComputerSettings
- Get-EVFSAFileServer
- Get-EVFSAFolder
- Get-EVFSASiteSettings
- Get-EVFSAVolume
- New-EVFSAFileServer
- New-EVFSAFolder
- New-EVFSAVolume
- Remove-EVFSAFileServer
- Remove-EVFSAFolder
- Remove-EVFSAVolume
- Set-EVFSAComputerSettings
- Set-EVFSAFileServer
- Set-EVFSAFolder
- Set-EVFSASiteSettings
- Set-EVFSAVolume
- 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-EVClassificationPolicy
Get-EVClassificationPolicy returns a list of all the Enterprise Vault classification policies that are configured in a site. You can also return the properties of a specific classification policy using the -Name parameter.
Get-EVClassificationPolicy is provided by the snap-in Symantec.EnterpriseVault.PowerShell.AdminAPI.dll.
Get-EVClassificationPolicy [[-SiteId] <String>] [[-Name] <String>] [<CommonParameters>]
Table: Get-EVClassificationPolicy parameters
Parameter | Description |
|---|---|
-SiteId | The ID of the site for which to return the Enterprise Vault classification policy details. If you omit this parameter, and the cmdlet cannot determine the ID by looking in the registry, then Get-EVClassificationPolicy prompts you to enter the required ID. You can use Get-EVSite to obtain the site ID. |
-Name | The name of a specific Enterprise Vault classification policy whose properties you want to return. |
Get-EVClassificationPolicy
Returns a list of all the Enterprise Vault classification policies that are configured in the Enterprise Vault site. As no site ID is specified, the cmdlet first looks for it in the registry and then, if it cannot find the ID there, prompts you for it.
Get-EVClassificationPolicy -SiteId 13E...EV.example.com
Returns a list of all the Enterprise Vault classification policies that are configured in the specified Enterprise Vault site.
Get-EVClassificationPolicy -SiteId 13E...EV.example.com -Name "Classification policy"
Returns the properties of the Enterprise Vault classification policy that is named "Classification policy". For example:
Name : Classification policy EntryId : 125...EV.example.com IsADefaultPolicy : True DuringArchivingIndexing : True DetermineRC : True RCDuringDeletion : True RCDuringExpiry : True PreventRCDuringMove : True AllowRCOnRecTypeChange : True Description : Classification policy SiteId : 13E...EV.example.com
This cmdlet returns an object of type Symantec.EnterpriseVault.Admin.ClassificationPolicy, which has the following properties.
Table: Get-EVClassificationPolicy properties
Name | Type | Description |
|---|---|---|
Name | String | The name of the Enterprise Vault classification policy. |
EntryId | String | The directory entry ID of the Enterprise Vault classification policy. |
IsADefaultPolicy | Boolean | Whether the Enterprise Vault classification policy is a default policy. |
DuringArchivingIndexing | Boolean | Whether to classify items during archiving/indexing. |
DetermineRC | Boolean | Whether classification is used to determine the retention category. |
RCDuringDeletion | Boolean | Whether items are classified during user deletion. |
RCDuringExpiry | Boolean | Whether items are classified during automatic expiry. |
PreventRCDuringMove | Boolean | Whether to prevent Enterprise Vault from updating the retention categories of archived items when users perform actions that could potentially update these retention categories. For example, users may move archived items between folders to which you have applied different retention categories, or change the retention categories of items in Enterprise Vault Search, if permitted. Both actions can cause the retention categories of the items to change. |
AllowRCOnRecTypeChange | Boolean | Whether to allow user actions to update retention categories in instances where this also causes the record types of the items to change (for example, from Temporary to Permanent). |
Description | String | The description of the Enterprise Vault classification policy. |
SiteId | String | The site ID to which the Enterprise Vault classification policy belongs. |
Identity | Number | The identity number of the Enterprise Vault classification policy. |