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

New-EVMDSBuildTask

New-EVMDSBuildTask creates an indexing task that builds (or rebuilds) a Metadata Store for an archive. The cmdlet must be run by a user with permission to manage indexes.

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

Syntax

New-EVMDSBuildTask [-ArchiveId] <String> -Mode <MDSBuildTaskMode> [-VerifyIndex [<MDSBuildTaskVerifyIndex>]] [-Force [<SwitchParameter>]] [-WhatIf [<SwitchParameter>]] [<CommonParameters>]

Parameters

Table: New-EVMDSBuildTask parameters

Parameter

Description

-ArchiveId (required)

Identifies an Enterprise Vault archive.

-Mode (required)

Build, Rebuild. Use Build to create a new Metadata Store for the archive, or fill in gaps in the existing one. Use Rebuild to recreate the entire Metadata Store for the archive, overwriting any existing data.

-VerifyIndex

Default, Verify, NoVerify. In some cases the Metadata Store build task triggers an index verify task to ensure the Metadata Store is complete. This parameter can be used to enable or disable this behavior, overriding any default.

-Force

Creates the Metadata Store build task without prompting for confirmation.

-WhatIf

Describes what would happen if you executed the cmdlet without actually executing the cmdlet.

Examples

  • New-EVMDSBuildTask -Mode Build -ArchiveId 14B...EVSERVER.LOCAL

    Creates an indexing task that builds the Metadata Store for the specified archive. If the archive already has a Metadata Store, any missing items will be added where possible, but existing data will not be recreated.

  • New-EVMDSBuildTask -Mode Rebuild -ArchiveId 14B...EVSERVER.LOCAL

    Creates an indexing task that rebuilds the Metadata Store for the specified archive. Any existing data in the archive's Metadata Store will be overwritten.

  • New-EVMDSBuildTask -Mode Build -VerifyIndex NoVerify -ArchiveId 14B...EVSERVER.LOCAL

    Creates an indexing task that builds the Metadata Store for the specified archive, but will NOT allow the task to trigger a verification of the archive's index.

  • Import-Csv c:\archives.csv | New-EVMDSBuildTask -Mode Build

    Reads a list of archives from a CSV file, and creates a Metadata Store build task for each archive. One of the columns in the CSV file must be called 'ArchiveId'.

  • Get-Content c:\archives.txt | New-EVMDSBuildTask -Mode Build

    Reads a list of archive IDs from a text file (one per line), and creates a Metadata Store build task for each archive.

  • New-EVMDSBuildTask -Force -Mode Build -ArchiveId 14B...EVSERVER.LOCAL

    Uses the -Force parameter to suppress confirmation prompting.

  • New-EVMDSBuildTask -WhatIf -Mode Build -ArchiveId 14B...EVSERVER.LOCAL

    Uses the -WhatIf parameter to display the Metadata Store build tasks that would be created by the cmdlet, without actually creating the tasks.

Output

NewMDSBuildTaskResult

Table: New-EVMDSBuildTask properties lists the properties that are available.

Table: New-EVMDSBuildTask properties

Name

Type

Description

ArchiveId

String

The ArchiveId of the archive for which a task has been created.

ArchiveName

String

The name of the archive for which a task has been created.

Mode

MDSBuildTaskMode

The mode that is being used when building the archive. Possible values:"Build", "Rebuild".

VerifyIndex

MDSBuildTaskVerifyIndex

Indicates whether an index verify task will be created to verify that the Metadata Store is complete. Possible values: "Default", "Verify", "NoVerify".

Related cmdlets