Veritas Enterprise Vault™ PowerShell Cmdlets

Last Published:
Product(s): Enterprise Vault (12.1)
  1. Introducing the Enterprise Vault PowerShell cmdlets
    1.  
      What's new in Enterprise Vault 12.1
    2.  
      About the Enterprise Vault Management Shell
    3.  
      Importing modules
    4.  
      Getting Help for Enterprise Vault PowerShell cmdlets
    5.  
      Rules for PowerShell strings
    6. Where to get more information about Enterprise Vault
      1.  
        Enterprise Vault training modules
  2. Archiving: Exchange
    1.  
      Add-EVPstComputer
    2.  
      Add-EVPstFile
    3.  
      Remove-EVExchangeFolderPolicy
  3. Archiving: FSA
    1.  
      Get-EVFSAFileServer
    2.  
      Get-EVFSAFolder
    3.  
      Get-EVFSAVolume
    4.  
      New-EVFSAFileServer
    5.  
      New-EVFSAFolder
    6.  
      New-EVFSAVolume
    7.  
      Remove-EVFSAFileServer
    8.  
      Remove-EVFSAFolder
    9.  
      Remove-EVFSAVolume
    10.  
      Set-EVFSAFileServer
    11.  
      Set-EVFSAFolder
    12.  
      Set-EVFSAVolume
  4. Archiving: SMTP
    1.  
      Get-EVSMTPHoldingFolder
    2.  
      Get-EVSMTPPolicy
    3.  
      Get-EVSMTPServerSettings
    4.  
      Get-EVSMTPTarget
    5.  
      New-EVSMTPPolicy
    6.  
      New-EVSMTPServerSettings
    7.  
      New-EVSMTPTarget
    8.  
      Remove-EVSMTPPolicy
    9.  
      Remove-EVSMTPTarget
    10.  
      Set-EVSMTPPolicy
    11.  
      Set-EVSMTPServerSettings
    12.  
      Set-EVSMTPTarget
    13.  
      Sync-EVSMTPServerSettings
  5. Backup
    1.  
      Clear-IndexLocationBackupMode
    2.  
      Clear-VaultStoreBackupMode
    3.  
      Get-IndexLocationBackupMode
    4.  
      Get-VaultStoreBackupMode
    5.  
      Set-IndexLocationBackupMode
    6.  
      Set-VaultStoreBackupMode
  6. Classification
    1.  
      Get-EVClassificationPolicy
    2.  
      Get-EVClassificationTags
    3.  
      Get-EVClassificationTestMode
    4.  
      Import-EVClassificationRules
    5.  
      New-EVClassificationPolicy
    6.  
      Publish-EVClassificationRules
    7.  
      Remove-EVClassificationPolicy
    8.  
      Set-EVClassificationPolicy
    9.  
      Set-EVClassificationTestMode
  7. Databases
    1.  
      Get-EVDatabase
    2.  
      Get-EVDatabaseDetail
    3.  
      Get-EVDatabaseFileInfo
    4.  
      Get-EVStorageDatabase
    5.  
      Set-EVDatabaseDetail
    6.  
      Start-EVDatabaseUpgrade
  8. IMAP access
    1.  
      Get-EVIMAPUsers
    2.  
      Get-EVIMAPUserSettings
    3.  
      Set-EVIMAPServerDisabled
    4.  
      Set-EVIMAPServerEnabled
  9. Indexing
    1.  
      Get-EVIndexLocation
    2.  
      Get-EVMDSStatus
    3.  
      Get-IndexServerForIndexLocation
    4.  
      New-EVMDSBuildTask
    5.  
      Set-IndexMetadataSyncLevel
  10. Records management
    1.  
      Export-EVNARAArchive
    2.  
      Get-EVRecordSettings
  11. Retention plans
    1.  
      Get-EVRetentionPlan
    2.  
      New-EVRetentionPlan
    3.  
      Remove-EVRetentionPlan
    4.  
      Set-EVRetentionPlan
  12. Roles-based administration
    1.  
      Add-EVRBARoleMember
    2.  
      Get-EVRBAAzStoreXml
    3.  
      Get-EVRBARole
    4.  
      Get-EVRBARoleMember
    5.  
      Remove-EVRBARoleMember
    6.  
      Set-EVRBAAzStoreXml
  13. Sites and servers
    1.  
      Get-EVComputers
    2.  
      Get-EVFileLocation
    3.  
      Get-EVIISWebsite
    4.  
      Get-EVServer
    5.  
      Get-EVSite
  14. Tasks and services
    1.  
      Get-EVDependencyService
    2.  
      Get-EVDependencyServiceState
    3.  
      Get-EVService
    4.  
      Get-EVServiceState
    5.  
      Get-EVTask
    6.  
      Get-EVTaskState
  15. Vault stores and archives
    1.  
      Export-EVArchive
    2.  
      Get-EVArchive
    3.  
      Get-EVVaultStore
    4.  
      Get-EVVaultStorePartition
    5.  
      Set-EVArchive
    6.  
      Start-PartitionRollover

Get-EVClassificationPolicy

Get-EVClassificationPolicy returns a list of all the classification policies that are configured in an Enterprise Vault site. You can also return the properties of a specific classification policy using the -Name parameter.

Get-EVClassificationPolicy is provided by Symantec.EnterpriseVault.PowerShell.AdminAPI.dll, which is loaded by the Enterprise Vault Management Shell.

Syntax

Get-EVClassificationPolicy [[-SiteId] <String>] [[-Name] <String>] [<CommonParameters>]

Parameters

Table: Get-EVClassificationPolicy parameters

Parameter

Description

-SiteId

The ID of the Enterprise Vault site for which to return the 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 classification policy whose properties you want to return.

Examples
  • Get-EVClassificationPolicy

    Returns a list of all the 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 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 classification policy that is named "Classification policy". For example:

    Name                   : Classification policy
    EntryId                : 125...EV.example.com
    IsADefaultPolicy       : True
    DuringIndexing         : True
    DetermineRC            : True
    RCDuringDeletion       : True
    RCDuringExpiry         : True
    PreventRCDuringMove    : True
    AllowRCOnRecTypeChange : True
    Description            : Classification policy
    SiteId                 : 13E...EV.example.com
Output

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 classification policy.

EntryId

String

The directory entry ID of the classification policy.

IsADefaultPolicy

Boolean

Whether the classification policy is a default policy.

DuringIndexing

Boolean

Whether to classify items during indexing, and reclassify them during an index rebuild.

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 move the items from one folder to another folder that has a different retention category.

AllowRCOnRecTypeChange

Boolean

Whether to allow retention category updates for moved items when this will change their record type (for example, from Temporary to Permanent).

Description

String

The description of the classification policy.

SiteId

String

The site ID to which the classification policy belongs.

Identity

Number

The identity number of the classification policy.

Related cmdlets