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

Set-EVDatabaseDetail

Set-EVDatabaseDetail updates the SQL server connection information for an Enterprise Vault database to a new SQL server name. You can update to use either a server name, instance name, listener or a virtual network name.

Set-EVDatabaseDetail takes the following mandatory input parameters:

  • -ServerName: This can be an instance, listener, server or virtual network name and must be a valid accessible server.

  • -InputObject: This is a DatabaseDetail object of type Symantec.EnterpriseVault.PowerShell.Core.Output.DatabaseDetail.

Set-EVDatabaseDetail is provided by the snap-in Symantec.EnterpriseVault.PowerShell.Core.dll.

Syntax

Set-EVDatabaseDetail -ServerName <String> -InputObject <String> [<CommonParameters>]

Parameters

Table: Set-EVDatabaseDetail parameters

Parameter

Description

-ServerName (required)

The name of the SQL server you are migrating to. This can be a listener, instance, server or virtual network name.

-InputObject (required)

A valid DatabaseDetail object of type Symantec.EnterpriseVault.PowerShell.Core.Output.DatabaseDetail.

See the help for Get-EVDatabaseDetail for a description of the properties of this object.

Examples

  • Get-EVDatabaseDetail | where {$_.SQLInstanceName -eq 'SVR55\SQL1' } | Set-EVDatabaseDetail -ServerName AGlistener

    Updates SQL server connection details for all databases on a specific SQL server instance "SVR55\SQL1" to use "AGlistener" listener. This example uses the Get-EVDatabaseDetail cmdlet as the pipeline input to the Set-EVDatabaseDetail cmdlet.

  • Get-EVDatabaseDetail | where {$_.type -eq 'directory'} | Set-EVDatabaseDetail -ServerName AGlistener

    Updates the "SQLServer Name" for the "HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\KVS\Enterprise Vault\Directory\DirectoryService" key on all Enterprise Vault servers to "AGlistener". This example uses the Get-EVDatabaseDetail cmdlet as the pipeline input to the Set-EVDatabaseDetail cmdlet.

  • New-Object -TypeName Symantec.EnterpriseVault.PowerShell.Core.Output.DatabaseDetail("SVR33", "EnterpriseVaultDirectory", 0) | Set-EVDatabaseDetail -ServerName AGlistener

    Updates the "SQLServer Name" for the "HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\KVS\Enterprise Vault\Directory\DirectoryService" key on all Enterprise Vault servers from "SVR33" to "AGlistener". In this example we create a new object of type Symantec.EnterpriseVault.PowerShell.Core.Output.DatabaseDetail, setting the SQLInstanceName, DBName and Type mandatory properties as the pipeline input. Use this method for updating connection details if your EnterpriseVaultDirectory database server is no longer accessible.

  • Get-EVDatabaseDetail | where {$_.sqlservername -eq 'sql-svr1' -and $_.SQLInstanceName -ne 'AGlistener' -and $_.IsAccessible -eq 'true' } | Set-EVDatabaseDetail -ServerName AGlistener

    Updates SQL Server connection details for all accessible databases on a specific SQL Server computer "sql-svr1" that do not currently use a listener to use "AGlistener" listener. This example uses the Get-EVDatabaseDetail cmdlet as the pipeline input to the Set-EVDatabaseDetail cmdlet.

Output

None.

Related cmdlets

More Information

Get-EVDatabaseDetail