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

Add-EVPstFile

Add-EVPstFile specifies the UNC path and name of a PST file whose contents you want to migrate to Enterprise Vault.

Add-EVPstFile is provided by Symantec.EnterpriseVault.PowerShell.Snapin.dll, which is loaded by the Enterprise Vault Management Shell.

Syntax

Add-EVPstFile -UNCPath <String> [-Mailbox <String>] [-Archive <String>] [-ArchiveType <String>] [-RetentionCategory <String>] [-PasswordProtected] [-Language <String>] [-Priority <String>] [-SiteName <String>] [-DirectoryServer <String>] [<CommonParameters>]

Parameters

Table: Add-EVPstFile parameters

Parameter

Description

-UNCPath (required)

The complete UNC path to the PST file you want to migrate, including the name of the PST file itself.

-Mailbox

The name of the mailbox in which Enterprise Vault places shortcuts for the migrated items. If you do not specify a mailbox, Add-EVPstFile uses the mailbox that the PST file is associated with.

-Archive

The name of the archive to which you want to migrate the contents of the PST file. If you do not specify the archive, Add-EVPstFile migrates items to the archive that is associated with the mailbox that owns the PST file.

-ArchiveType

The type of archive. You can specify either "Exchange Mailbox" or "Internet Mail". If you specify a mailbox, the PST is migrated to the associated Exchange Mailbox archive. If you do not specify a mailbox, Enterprise Vault looks for the archive in both Exchange Mailbox archives and Internet Mail archives. If only one archive is found, Enterprise Vault sets the archive type as that of the found archive and migrates the file to that archive. If multiple entries are found, then Enterprise Vault migrates the file to the Exchange Mailbox archive. Note that you cannot associate a mailbox with an Internet Mail archive.

-RetentionCategory

The retention category that is applied to the migrated items. If you do not specify a retention category, Add-EVPstFile uses the retention category set in the applicable PST migration policy.

-PasswordProtected

Indicates that the PST file is password protected. If you use -PasswordProtected, Add-EVPstFile prompts for the password.

-Language

The language used in the PST file. If you do not specify a language, Add-EVPstFile uses the language set in the applicable PST migration policy.

-Priority

Sets the PST file's migration priority. You can specify any one of the following priorities, or their associated numerical values which are shown in brackets: Critical (1), Important (2), High (3), Medium (4), Low (5), or Lowest (6). The default priority is Medium (4).

-SiteName

If you have more than one Enterprise Vault site in your environment, use -SiteName to specify the site in which you want to migrate the PST file.

-DirectoryServer

If you execute Add-EVPstFile from a server other than an Enterprise Vault server, specify the name of the Enterprise Vault server that Add-EVPstFile should connect to.

Examples
  • Add-EVPstFile -UNCPath \\FileServer1\UserShares\VIPs\JohnDoe\PSTs\2012.pst

    Adds the specified PST file for migration to Enterprise Vault.

  • Add-EVPstFile -UNCPath \\abc.xyz.com\c$\user1.pst -Archive IMAP1 -ArchiveType "Internet Mail"

    Migrates the PST file to the specified Internet Mail archive.

Related cmdlets