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

Get-IndexLocationBackupMode

Get-IndexLocationBackupMode reports the current backup mode settings of one indexing location, of all the indexing locations associated with a server, or of all the indexing locations in a site.

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

Syntax

Get-IndexLocationBackupMode [-EVServerName] <String> [[-IndexRootPath] <String>] [-EVSiteName <String>] [<CommonParameters>]

Get-IndexLocationBackupMode [-EntryId <String>] [<CommonParameters>]

Parameters

Table: Get-IndexLocationBackupMode parameters

Parameter

Description

-EVServerName (required)

The Enterprise Vault server that owns the indexing locations. You must provide this parameter if you specify a site or indexing location by name rather than ID. This allows Get-IndexLocationBackupMode to find the ID of the site or indexing location.

-IndexRootPath

The root path of an indexing location.

-EVSiteName

The name of the site.

-EntryId

The ID of the indexing location, service, server, or site.

Examples

  • Get-IndexLocationBackupMode EVServer-Win2k3

    Reports the current backup mode settings of all the indexing locations associated with server EVServer-Win2k3.

  • Get-IndexLocationBackupMode EVServer-Win2k3 -IndexRootPath f:\indexing\index0

    Reports the current backup mode setting of indexing location f:\indexing\index0.

  • Get-IndexLocationBackupMode EVServer-Win2k3 -EVSiteName Site1

    Reports the current backup mode settings of all indexing locations in Site1.

  • Get-IndexLocationBackupMode -EntryId 1F3...Domain.local

    Reports the current backup mode settings of the object that has the specified ID. The ID can be that of an indexing location, a service, a server, or a site.

    If you specify the ID of an indexing location, the current backup mode setting of that indexing location is reported.

    If you specify the ID of a service, server or a site, the current backup mode settings of the indexing locations associated with the server or site are reported.

Output

Table: Get-IndexLocationBackupMode properties lists the properties that are available.

Table: Get-IndexLocationBackupMode properties

Name

Type

Description

BackupMode

Boolean

Indicates whether the index location is in backup mode. Possible values: $true (index location is in backup mode), $false (index location is not in backup mode).

IndexingServiceId

String

The IndexingServiceId.

IndexRootPath

String

The IndexRootPath.

IndexRootPathId

String

The IndexRootPathId.

Related cmdlets