Enterprise Vault™ PowerShell Cmdlets

Last Published:
Product(s): Enterprise Vault (15.0)
  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.  
      About the imported Boolean value while using the Import-Csv cmdlet
    5. 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.  
      Get-EVIndexSnapshotLocationBackupMode
    2.  
      Set-EVIndexSnapshotLocationBackupMode
    3.  
      Clear-EVIndexSnapshotLocationBackupMode
    4.  
      Get-IndexLocationBackupMode
    5.  
      Set-IndexLocationBackupMode
    6.  
      Clear-IndexLocationBackUpMode
    7.  
      Get-VaultStoreBackupMode
    8.  
      Set-VaultStoreBackupMode
    9.  
      Clear-VaultStoreBackupMode
    10.  
      Set-EVIndexSnapshotLocation
    11.  
      Get-EVIndexSnapshotLocation
    12.  
      Remove-EVIndexSnapshotLocation
    13.  
      New-EVIndexSnapshot
    14.  
      Get-EVIndexSnapshot
    15.  
      Remove-EVIndexSnapshot
    16.  
      Restore-EVIndexSnapshot
    17.  
      Get-EVIndexSnapshotRepository
    18.  
      Remove-EVIndexSnapshotRepository
    19.  
      Export-EVIndexData
    20.  
      Import-EVIndexData
  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.  
      Set-EVClassificationVICFIPSMode
    10.  
      New-EVClassificationPolicy
    11.  
      Publish-EVClassificationFCIRules
    12.  
      Remove-EVClassificationPolicy
    13.  
      Set-EVClassificationPolicy
    14.  
      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
    6.  
      Submit-EVIndexingSubTask
    7.  
      Get-EVIndexVolume
    8.  
      Get-EVElasticsearchIndex
  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
    7.  
      Set-EVServiceAccountPassword
  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.  
      New-EVArchive
    8.  
      Remove-EVArchivePermission
    9.  
      Set-EVArchive
    10.  
      Set-EVArchivePermission
    11.  
      Start-PartitionRollover

Import-EVIndexData

Note:

Starting from Enterprise Vault 15.0, the Import-EVIndexData cmdlet does not function when multiple index locations support for Elasticsearch index volumes feature is enabled. For details about disabling this feature, see https://www.veritas.com/support/en_US/article.100061711.

Import-EVIndexData imports the Index data exported from one Index server to another.

Syntax

Import-EVIndexData [-WhatIf <SwitchParameter>] [-Confirm <SwitchParameter>] -RepositoryName <String> -SourceEVServerName <String> [-EVServerName <String>] [<CommonParameters>]

Import-EVIndexData [-WhatIf <SwitchParameter>] [-Confirm <SwitchParameter>] -NonElastic <SwitchParameter> -IndexLocation <String> -SourceEVServerName <String> [-EVServerName <String>] [<CommonParameters>]

Import-EVIndexData imports the index data from one index server to another. This cmdlet assumes that the index data from the source server is already copied to the destination server. For the Elasticsearch index volumes, the snapshot repository created by Export-EVIndexData should be copied at the configured snapshot location of the destination server. For the non-Elasticsearch volumes, the index data folder on the source Enterprise Vault index server should be copied to a folder on the destination Enterprise Vault index server. After the import operation, all the indexing functionality of imported index volumes will be performed by the destination Enterprise Vault index server.

Before executing the Import-EVIndexData cmdlet, ensure the following:

  • Copy the snapshot repository folder to the destination Enterprise Vault index server's snapshot location path \<ESVersionFolder>. For example, <ES snapshot location path>\<7.x>.

  • The snapshot location path is identical for both the source and destination Enterprise Vault Index servers.

  • The source and destination Enterprise Vault servers must belong to the same Enterprise Vault site. If the source server is part of an index server group, the destination index server must also be in the same group.

After executing the Import-EVIndexData cmdlet, perform the following steps:

  • If the source Enterprise Vault index server is not a part of an Index server group, the Vaultstores, and Vaultstore partitions within the server must be moved to the destination Enterprise Vault index server. For details about moving the Vaultstore to the destination Enterprise Vault server, see https://www.veritas.com/support/en_US/article.100017529.

  • If the index volumes are marked offline after the export operation, they can be marked online again after Import-EVIndexData is completed.

Parameters

Table: Import-EVIndexData parameters

Parameter

Type

Description

-WhatIf

SwitchParameter

Instructs the command to simulate its actions on the object. Using the WhatIf switch, you can preview the impending changes without executing them. You do not need to specify a value when using WhatIf.

-Confirm

String

Suppresses the confirmation prompt that appears by default when this cmdlet is run. To suppress the confirmation prompt, use the syntax -Confirm:$False. You must include a colon ( : ) in the syntax.

-RepositoryName

String

The name of the repository that contains the exported index data from the source Enterprise Vault index server.

-SourceEVServerName

String

The source server of the exported index data in the snapshot. You can use the Get-EVComputers command to obtain the Enterprise Vault index server name. For the non-Elasticsearch index volumes, it is the source Enterprise Vault index server from which index data is copied to the destination server.

-EVServerName

String

The name of the Enterprise Vault index server on which you want to import the index data. If you omit this parameter, Import-EVIndexData uses the hostname of the Enterprise Vault index server where the command is running. You can use the Get-EVComputers command to obtain the Enterprise Vault index server name.

-NonElastic

SwitchParameter

Non-Elastic switch instructs the cmdlet to perform import index operation for the non-Elasticsearch index volumes.

-IndexLocation

String

Specifies the path at which the non-Elasticsearch index data is copied on the destination Enterprise Vault index server.

Examples
  • Import-EVIndexData -RepositoryName MySnapshotRepository -SnapshotServerName myevsourceserver.domain.com

    This command imports the index data exported in the snapshot repository MySnapshotRepository from the source server myevsourceserver.domain.com to the server where this command is running. The snapshot repository folder from the source server must be copied to the active snapshot location of the local Enterprise Vault index server before running this command.

  • Import-EVIndexData -RepositoryName MySnapshotRepository -SnapshotServerName myevsourceserver.domain.com-EVServerName mydestinationev.domain.com

    This command imports the index data exported in the snapshot repository MySnapshotRepository from the source server myevsourceserver.domain.com to the server mydestinationev.domain.com.

    The snapshot repository folder from the source server must be copied to the active snapshot location of the destination Enterprise Vault server before running this command.

  • Import-EVIndexData -NonElastic -SourceEVServerName myevsourceserver.domain.com -EVServerName mydestinationserver.domain.com -IndexLocation C:\EVStorage\Index

    Imports the non-Elasticsearch Enterprise Vault index data from the Enterprise Vault index server myevsourceserver.domain.com into the server mydestinationserver.domain.com. The index data must be copied to the path C:\EVStorage\Index on the destination Enterprise Vault index server before execution of this command.

  • Import-EVIndexData -NonElastic -SourceEVServerName myevsourceserver.domain.com -IndexLocation C:\EVStorage\Index

    Imports the non-Elasticsearch Enterprise Vault index data from the Enterprise Vault index server myevsourceserver.domain.com. The index data must be copied at path C:\EVStorage\Index on the destination Enterprise Vault index server before executing this command. The destination Enterprise Vault index server is assumed to be the local server where this command is executed.

  • Import-EVIndexData -NonElastic -SourceEVServerName myevsourceserver.domain.com -IndexLocation \\Servername\MyIndexShare

    Imports the non-Elasticsearch Enterprise Vault index data from the server myevsourceserver.domain.com. The index data must be present at the path \\Servername\MyIndexShare before the execution of this command. The path must be accessible from the destination Enterprise Vault index server. The destination Enterprise Vault index server is assumed to be the local server where this command executes.

Remarks
  • To see examples of Import-EVIndexData, type get-help Import-EVIndexData -examples.

  • For more information about Import-EVIndexData, type get-help Import-EVIndexData -detailed.

  • For more technical information about Import-EVIndexData, type get-help Import-EVIndexData -full.

Related cmdlets