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

Set-EVRBAAzStoreXml uploads the RBA store from the specified folder to the Enterprise Vault Directory database. Set-EVRBAAzStoreXml requires that the RBA store is in a file called EvAzStore.xml, and that it is in the folder you specify.

Specify the Enterprise Vault Directory using the -EVDirectoryServer parameter.

Permission to execute this cmdlet is restricted to the Vault Service Account.

If you execute the cmdlet from a server other than an Enterprise Vault server, the cmdlet prompts for the -EVDirectoryServer parameter, unless -EVDirectoryServer is already specified as a parameter.

You can only upload changes to latest version of EvAzStore.xml. If Enterprise Vault has a newer version of EvAzStore.xml, you must get the latest RBA store using Get-EVRBAAzStoreXml, make the changes and upload EvAzStore.xml again.

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

Syntax

Set-EVRBAAzStoreXml [-FolderPath] <string> -EVDirectoryServer <string> [<CommonParameters>]

Parameters

Table: Set-EVRBAAzStoreXml parameters

Parameter

Description

-FolderPath (required)

Specifies the folder from which EvAzStore.xml will be uploaded.

-EVDirectoryServer (required)

Specifies the host name, fully qualified domain name, or DNS alias of an Enterprise Vault Directory server. Note that although this parameter is required, the cmdlet determines it automatically if it can.

Examples

  • Set-EVRBAAzStoreXml "C:\EvAzStoreXmlLocation"

    Uploads EvAzStore.xml from C:\EvAzStoreXmlLocation to the locally installed Enterprise Vault server.

  • Set-EVRBAAzStoreXml "C:\EvAzStoreXmlLocation" -EVDirectoryServer "evserver.example.com"

    Uploads EvAzStore.xml from C:\EvAzStoreXmlLocation to evserver.example.com.

  • Set-EVRBAAzStoreXml - FolderPath "C:\EvAzStoreXmlLocation" -EVDirectoryServer "evserver.example.com"

    Uploads EvAzStore.xml from C:\EvAzStoreXmlLocation to evserver.example.com. Note the use of named parameters.

Output

None.

Related cmdlets