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

Get-EVMDSStatus gets the current status of the metadata store for an archive. The cmdlet can also be used to get the number of items that are missing from the metadata store for an archive.

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

Syntax

Get-EVMDSStatus [[-ArchiveId] <String>] [[-VaultStoreId] <String>] [[-SiteId] <String>] [-IncludeMissingItems [<SwitchParameter>]] [<CommonParameters>]

Parameters

Table: Get-EVMDSStatus parameters

Parameter

Description

-ArchiveId (required)

Identifies an archive. This is the default operation.

-VaultStoreId (required)

Identifies a vault store. If this parameter is used instead of ArchiveId, the cmdlet operates on all applicable archives in the specified vault store.

-SiteId (required)

Identifies a site. If this parameter is used the cmdlet operates on all appropriate archives in the specified site.

-IncludeMissingItems

Whether the cmdlet should return the count of items that are present in the archive but are missing from the metadata store. This option can be slow if you have specified thousands of archives.

Examples

  • Get-EVMDSStatus -ArchiveId 14B...EVSERVER.LOCAL

    Gets the current status of the metadata store for the specified archive.

  • Get-EVMDSStatus -IncludeMissingItems -VaultStoreId 14B...EVSERVER.LOCAL

    Gets the current status of the metadata store for all archives supported by metadata store in the specified vault store. Also includes a count of the number of items that are present in the archive but are missing from the metadata store.

  • Import-CSV example.csv | Get-EVMDSStatus

    Gets the current status of the metadata store for each archive that is specified in a CSV file.

  • Import-CSV example.csv | Select VaultStoreEntryId | Get-EVMDSStatus

    Imports a record set from a CSV file and, for each value in the VaultStoreEntryId column, returns the current status of the metadata store for each archive that is supported by metadata store.

  • Get-EVMDSStatus -VaultStoreId 14B...EVSERVER.LOCAL -IncludeMissingItems | Where-Object {$_.MDSStatus - ne 'EV_MDS_DISABLED' -and $_.MDSMissingItems -gt 0} | New-EVMDSBuildTask -Mode Build -Force

    Creates a metadata store build task for each Fast Browsing or IMAP enabled archive in the specified vault store, if there are items missing from that archive's metadata store.

Output

MDSStatus

MDSMissingItems

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

Table: Get-EVMDSStatus properties

Name

Type

Description

ArchiveId

String

The ArchiveId.

MDSStatus

MDSStatus

The current status of the metadata store. Possible values: "EV_MDS_DISABLED", "EV_MDS_BUILD_PENDING", "EV_MDS_BUILDING", "EV_MDS_READY", "EV_MDS_BUILD_FAILED".

Related cmdlets