Veritas Enterprise Vault™ PowerShell Cmdlets

  • Modified Date: 2017-07-28
  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

What's new in Enterprise Vault 12.1

Table: New PowerShell cmdlets lists the PowerShell cmdlets that are new in Enterprise Vault 12.1.

Table: New PowerShell cmdlets

Cmdlet

Description

Export-EVArchive

Exports items from the specified archive. You can limit the export to items that match the specified search criteria.

See Export-EVArchive.

Export-EVNARAArchive

Exports from the specified archive only those items that Enterprise Vault has marked as permanent records. You can limit the export to records that fall within the specified date range and/or match the specified search criteria.

See Export-EVNARAArchive.

Get-EVFSAFileServer

Retrieves details of all the file servers that are configured in the specified Enterprise Vault site.

See Get-EVFSAFileServer.

Get-EVFSAFolder

Retrieves details of all folders that are set up for File System Archiving for a specified file server and volume in an Enterprise Vault site.

See Get-EVFSAFolder.

Get-EVRecordSettings

Provides information on the records management settings in one or more archives.

See Get-EVRecordSettings.

New-EVFSAFileServer

Adds the specified file server as a File System Archiving target.

See New-EVFSAFileServer.

New-EVFSAFolder

Adds the specified folder as a File System Archiving target.

See New-EVFSAFolder.

Remove-EVFSAFileServer

Removes the specified file server from the Enterprise Vault site.

See Remove-EVFSAFileServer.

Remove-EVFSAFolder

Removes the specified folder from Enterprise Vault configuration.

See Remove-EVFSAFolder.

Set-EVFSAFileServer

Updates the settings of the specified file server.

See Set-EVFSAFileServer.

Set-EVFSAFolder

Adds the specified folder as a File System Archiving target.

See Set-EVFSAFolder.

Table: Enhanced PowerShell cmdlets lists the enhancements to existing PowerShell cmdlets.

Table: Enhanced PowerShell cmdlets

Cmdlet

Change

Get-EVArchive

Can now return a list of all the archives in the Enterprise Vault site, and not just those in which a specified user has various permissions or whose name exactly matches a specified name.

See Get-EVArchive.

New-EVSMTPTarget

Can now associate a retention plan with the SMTP target.

Now accepts the value of ArchiveType that is output by the Get-EVArchive cmdlet. You can pipe the output from the Get-EVArchive cmdlet directly into the New-EVSMTPTarget cmdlet.

See New-EVSMTPTarget.

Set-EVSMTPTarget

Can now associate a retention plan with the SMTP target.

Now accepts the value of ArchiveType that is output by the Get-EVArchive cmdlet. You can pipe the output from the Get-EVArchive cmdlet directly into the Set-EVSMTPTarget cmdlet.

See Set-EVSMTPTarget.

Table of Contents

  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

What's new in Enterprise Vault 12.1

Table: New PowerShell cmdlets lists the PowerShell cmdlets that are new in Enterprise Vault 12.1.

Table: New PowerShell cmdlets

Cmdlet

Description

Export-EVArchive

Exports items from the specified archive. You can limit the export to items that match the specified search criteria.

See Export-EVArchive.

Export-EVNARAArchive

Exports from the specified archive only those items that Enterprise Vault has marked as permanent records. You can limit the export to records that fall within the specified date range and/or match the specified search criteria.

See Export-EVNARAArchive.

Get-EVFSAFileServer

Retrieves details of all the file servers that are configured in the specified Enterprise Vault site.

See Get-EVFSAFileServer.

Get-EVFSAFolder

Retrieves details of all folders that are set up for File System Archiving for a specified file server and volume in an Enterprise Vault site.

See Get-EVFSAFolder.

Get-EVRecordSettings

Provides information on the records management settings in one or more archives.

See Get-EVRecordSettings.

New-EVFSAFileServer

Adds the specified file server as a File System Archiving target.

See New-EVFSAFileServer.

New-EVFSAFolder

Adds the specified folder as a File System Archiving target.

See New-EVFSAFolder.

Remove-EVFSAFileServer

Removes the specified file server from the Enterprise Vault site.

See Remove-EVFSAFileServer.

Remove-EVFSAFolder

Removes the specified folder from Enterprise Vault configuration.

See Remove-EVFSAFolder.

Set-EVFSAFileServer

Updates the settings of the specified file server.

See Set-EVFSAFileServer.

Set-EVFSAFolder

Adds the specified folder as a File System Archiving target.

See Set-EVFSAFolder.

Table: Enhanced PowerShell cmdlets lists the enhancements to existing PowerShell cmdlets.

Table: Enhanced PowerShell cmdlets

Cmdlet

Change

Get-EVArchive

Can now return a list of all the archives in the Enterprise Vault site, and not just those in which a specified user has various permissions or whose name exactly matches a specified name.

See Get-EVArchive.

New-EVSMTPTarget

Can now associate a retention plan with the SMTP target.

Now accepts the value of ArchiveType that is output by the Get-EVArchive cmdlet. You can pipe the output from the Get-EVArchive cmdlet directly into the New-EVSMTPTarget cmdlet.

See New-EVSMTPTarget.

Set-EVSMTPTarget

Can now associate a retention plan with the SMTP target.

Now accepts the value of ArchiveType that is output by the Get-EVArchive cmdlet. You can pipe the output from the Get-EVArchive cmdlet directly into the Set-EVSMTPTarget cmdlet.

See Set-EVSMTPTarget.

Get Support