Enterprise Vault™ PowerShell Cmdlets

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

Initialize-EVClassificationVIC

Note:

This cmdlet is only for use with the Veritas Information Classifier in Enterprise Vault 12.2 and later. It is not designed for use with the classification features in earlier versions of Enterprise Vault, such as classification using the Microsoft File Classification Infrastructure (FCI).

Initialize-EVClassificationVIC enables the Veritas Information Classifier on all the Enterprise Vault servers in the specified site. For each of these servers, the cmdlet also configures the Veritas Information Classifier website in Microsoft Internet Information Services (IIS).

Permission to run Initialize-EVClassificationVIC is restricted to the Vault Service account. Run this cmdlet on an Enterprise Vault server rather than, for example, a separate computer on which you have installed a standalone Vault Administration Console.

Before you run the cmdlet for the first time, do the following:

  • In the Vault Administration Console, in the properties of the Enterprise Vault Directory, set up the Data Access account. Enterprise Vault uses this account to access the Veritas Information Classifier system.

  • On a shared network drive to which all the Enterprise Vault servers have access, create a folder in which the Veritas Information Classifier can keep policy information. Both the Vault Service account and the Data Access account must have read/write access to the folder.

  • If a self-signed SSL certificate for Enterprise Vault has been installed in IIS, replace it as soon as possible with a certificate that you have obtained from a trusted authority. Otherwise, this cmdlet may not work.

After you have run the cmdlet, we recommend that you do the following:

  • If you have not already done so, import the SSL certificate that you have installed in IIS into the Java Runtime Environment (JRE) keystore in the Enterprise Vault installation folder.

  • Enable at least one Veritas Information Classifier policy.

  • Take regular backups of the policy information folder. In the event of a system failure, you can then recover any custom policies that you have created and any changes that you have made to the built-in policies, such as enabling or disabling those policies.

Initialize-EVClassificationVIC is provided by the snap-in Symantec.EnterpriseVault.PowerShell.Snapin.dll.

Syntax

Initialize-EVClassificationVIC [-PoliciesPath <String>] [-SiteId <String>] [<CommonParameters>]

Parameters

Table: Initialize-EVClassificationVIC parameters

Parameter

Description

-PoliciesPath

Specifies the UNC path to the folder in which the Veritas Information Classifier should keep policy information. The folder must already exist; the cmdlet does not create it.

It is mandatory to specify this parameter when you run Initialize-EVClassificationVIC for the first time. For subsequent runs, you can omit the parameter if you want the cmdlet to use the folder path that you previously specified.

Alternatively, you can specify the parameter again to nominate a different folder path. If you do nominate a different path, move the contents of the old policy folder to the new one before you use the Veritas Information Classifier again.

-SiteId

Specifies the ID of the Enterprise Vault site for which to configure the Veritas Information Classifier. If you omit this parameter, Initialize-EVClassificationVIC checks the registry to determine the ID of the current site. The cmdlet displays an error message if this check fails for any reason.

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

Examples
  • Initialize-EVClassificationVIC -PoliciesPath \\server1\VicPolicies

    Runs the cmdlet with the specified policy folder path on the current Enterprise Vault server. As no site ID is specified, the cmdlet checks the registry to determine the ID of the current site.

  • Initialize-EVClassificationVIC -Verbose -PoliciesPath \\server1\VicPolicies -SiteId 198...example.com

    Runs the cmdlet in verbose mode with the specified policy folder path and Enterprise Vault site.

  • Initialize-EVClassificationVIC -Verbose

    Runs the cmdlet in verbose mode with the existing policy folder path on the current Enterprise Vault server. If you have not previously specified the folder path, the cmdlet displays an error message.

Output

None.