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

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 Symantec.EnterpriseVault.PowerShell.Core.dll, which is not imported automatically by the Enterprise Vault Management Shell. You must import this DLL module.

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 machine "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