Veritas Enterprise Vault™ PowerShell Cmdlets

Last Published:
Product(s): Enterprise Vault (12.2)
  1. Introducing the Enterprise Vault PowerShell cmdlets
    1.  
      About the Enterprise Vault Management Shell
    2.  
      Importing modules
    3.  
      Getting Help for Enterprise Vault PowerShell cmdlets
    4.  
      Rules for PowerShell strings
    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-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: 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-EVVaultStore
    4.  
      Get-EVVaultStorePartition
    5.  
      Set-EVArchive
    6.  
      Start-PartitionRollover

Get-EVDatabaseDetail

Get-EVDatabaseDetail gets Enterprise Vault directory, monitoring, auditing, reporting, vault store, and fingerprint database details for an Enterprise Vault server.

Get-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.

See Importing modules.

Syntax

Get-EVDatabaseDetail [<CommonParameters>]

Parameters

PowerShell common parameters only.

Examples
  • Get-EVDatabaseDetail

    Gets Enterprise Vault directory, monitoring, auditing, reporting, vault store, and fingerprint database details for an Enterprise Vault server.

  • Get-EVDatabaseDetail | Where-Object {$_.Type -eq "Fingerprint" -and ($_.IsInAG -eq 0 -or $_.IsAccessible -eq 0)}

    Gets all Enterprise Vault fingerprint databases that are either not in an availability group (IsInAG=0), or are not accessible (IsAccessible=0). This information can be used to get a list of Enterprise Vault databases that need to be added to an availability group.

  • Get-EVDatabaseDetail | Where-Object {$_.IsCollationOK -eq 0}

    Finds Enterprise Vault databases with collation issues.

Output

Get-EVDatabaseDetail returns an object of type Symantec.EnterpriseVault.PowerShell.Core.Output.DatabaseDetail, which has the following properties.

Table: Get-EVDatabaseDetail properties

Name

Type

Description

DBName

String

The name of the Enterprise Vault database. For example, "EnterpriseVaultDirectory".

SQLInstanceName

String

This is the SQL server instance where the database is located.

SQLServerVersion

String

This is the SQL server product version (SERVERPROPERTY('ProductVersion')).

Type

EVDatabaseType

This is the Enterprise Vault database type enumeration. Possible values are Directory (0), vault store (1), fingerprint (2), audit (3), monitoring (4), and reporting (5).

SQLServerName

String

This is the name of the physical SQL server where the database is located. (SERVERPROPERTY('MachineName')).

IsClustered

Boolean

Indicates whether the SQL server is clustered.

IsInAG

Boolean

Indicates whether the database is in an availability group.

IsAccessible

Boolean

Indicates whether the database is currently accessible.

IsCollationOK

Boolean

False indicates an issue with database collation.

Related cmdlets