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-EVRetentionPlan

Get-EVRetentionPlan returns a list of all the retention plans that are configured in an Enterprise Vault site. You can filter the list of returned retention plans by description, retention category, override retention flag, and classification policy. You can also return the properties of a specific retention plan.

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

Syntax

Get-EVRetentionPlan [-SiteId <String>] [-Name <String>] [-Description <String>] [-RetentionCategory <String>] [-OverrideRetention [<SwitchParameter>]] [-ClassificationPolicy <String>] [<CommonParameters>]

Parameters

Table: Get-EVRetentionPlan parameters

Parameter

Description

-SiteId (required)

The ID of the Enterprise Vault site for which to return the retention plan details. If you omit this parameter, and the cmdlet cannot determine the ID by looking in the registry, then Get-EVRetentionPlan prompts you to enter the required ID.

You can use Get-EVSite to obtain the site ID.

-Name

The name of a specific retention plan whose properties you want to return.

-Description

The retention plan description with which to filter the list of returned plans.

-RetentionCategory

The name of a retention category with which to filter the list of returned retention plans.

-OverrideRetention

If specified, return only those retention plans for which you have set the override retention flag. This flag instructs Enterprise Vault to expire each item according to the retention category that you have set with the retention plan. This retention category overrides the item's individual retention category.

Note:

The override retention flag does not take effect if there is an associated classification policy that allows the classification rules to update the retention category of items. In this case, Enterprise Vault expires the items according to the retention categories that the classification rules apply to them.

-ClassificationPolicy

The name of a classification policy with which to filter the list of returned retention plans.

Examples

  • Get-EVRetentionPlan

    Returns a list of all the retention plans 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-EVRetentionPlan -SiteId 13E...localdomain.com

    Returns a list of all the retention plans that are configured in the specified Enterprise Vault site.

  • Get-EVRetentionPlan -SiteId 13E...localdomain.com -Name ManagersPlan

    Returns the properties of the retention plan that is named "ManagersPlan".

  • Get-EVRetentionPlan -SiteId 13E...localdomain.com -Description RetentionPlanForManagers

    Restricts the list of returned retention plans to those that have a description of "RetentionPlanForManagers".

  • Get-EVRetentionPlan -SiteId 13E...localdomain.com -RetentionCategory 3years

    Restricts the list of returned retention plans to those that have a retention category of "3years".

  • Get-EVRetentionPlan -OverrideRetention

    Restricts the list of returned retention plans to those for which you have set the override retention flag.

  • Get-EVRetentionPlan -ClassificationPolicy "Managers CP"

    Restricts the list of returned retention plans to those that have a classification policy name of "Managers CP".

  • Get-EVRetentionPlan -ClassificationPolicy ""

    Restricts the list of returned retention plans to those for which no classification policy has been specified.

Output

Table: Get-EVRetentionPlan properties lists the properties that are available.

Table: Get-EVRetentionPlan properties

Name

Type

Description

Name

String

The name of the retention plan.

Description

String

The description of the retention plan.

RetentionCategory

String

The name of the retention category that is associated with the retention plan.

OverrideRetention

SwitchParameter

Whether you have specified the override retention flag for this retention plan.

Note that this flag does not take effect if there is an associated classification policy that allows the classification rules to update the retention categories of items.

ClassificationPolicy

String

The name of the classification policy that is associated with the retention plan. If specified, Enterprise Vault sends for classification all the archived items that have this retention plan and tags them according to the rules specified in the classification policy.

If no retention plans are available, or if the cmdlet cannot find any plans that match the specified criteria, then it outputs a suitable error message.

Related cmdlets