Enterprise Vault™ PowerShell Cmdlets

Last Published:
Product(s): Enterprise Vault (14.3)
  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.  
      About the imported Boolean value while using the Import-Csv cmdlet
    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-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.  
      Get-EVIndexSnapshotLocationBackupMode
    2.  
      Set-EVIndexSnapshotLocationBackupMode
    3.  
      Clear-EVIndexSnapshotLocationBackupMode
    4.  
      Get-IndexLocationBackupMode
    5.  
      Set-IndexLocationBackupMode
    6.  
      Clear-IndexLocationBackUpMode
    7.  
      Get-VaultStoreBackupMode
    8.  
      Set-VaultStoreBackupMode
    9.  
      Clear-VaultStoreBackupMode
    10.  
      Set-EVIndexSnapshotLocation
    11.  
      Get-EVIndexSnapshotLocation
    12.  
      Remove-EVIndexSnapshotLocation
    13.  
      New-EVIndexSnapshot
    14.  
      Get-EVIndexSnapshot
    15.  
      Remove-EVIndexSnapshot
    16.  
      Restore-EVIndexSnapshot
    17.  
      Get-EVIndexSnapshotRepository
    18.  
      Remove-EVIndexSnapshotRepository
  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.  
      Set-EVClassificationVICFIPSMode
    10.  
      New-EVClassificationPolicy
    11.  
      Publish-EVClassificationFCIRules
    12.  
      Remove-EVClassificationPolicy
    13.  
      Set-EVClassificationPolicy
    14.  
      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
    6.  
      Submit-EVIndexingSubTask
    7.  
      Get-EVIndexVolume
    8.  
      Get-EVElasticsearchIndex
  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.  
      New-EVArchive
    8.  
      Remove-EVArchivePermission
    9.  
      Set-EVArchive
    10.  
      Set-EVArchivePermission
    11.  
      Start-PartitionRollover

Remove-EVIndexSnapshotRepository

Remove-EVIndexSnapshotRepository removes the specified index snapshot repository that was created on the specified Enterprise Vault index server in the specified Enterprise Vault site.

Syntax

Remove-EVIndexSnapshotRepository -Name <String> [-EVServerName <String>] [-ForceDelete <SwitchParameter>] [-Confirm <SwitchParameter>] [-WhatIf <SwitchParameter>] [<CommonParameters>]

Remove-EVIndexSnapshotRepository -Name <String> -SiteId <String> [-EVServerName <String>] [-ForceDelete <SwitchParameter>] [-Confirm <SwitchParameter>] [-WhatIf <SwitchParameter>] [<CommonParameters>]

Remove-EVIndexSnapshotRepository removes the specified index snapshot repository that was created on the specified Enterprise Vault index server in the specified Enterprise Vault site.

Remove-EVIndexSnapshotRepository is provided by Symantec.EnterpriseVault.PowerShell.AdminAPI.dll, which the Enterprise Vault Management Shell loads.

Parameters

Table: Remove-EVIndexSnapshotRepository parameters

Parameter

Description

-Name

Name of the index snapshot repository that you want to remove.

-SiteId

The ID of the Enterprise Vault site from which you want to remove the specified index snapshot repository.

If you omit this parameter, Remove-EVIndexSnapshotRepository retrieves the SiteId from the Enterprise Vault index server specified as EVServerName parameter; otherwise, it uses the ID of the site of the Enterprise Vault index server where the command is running. You can use the Get-EVSite command to obtain the SiteId.

-EVServerName

The name of the Enterprise Vault index server from which you want to remove the specified index snapshot repository.

If you omit this parameter, Remove-EVIndexSnapshotRepository uses the host name of the Enterprise Vault index server where the command is running.

You can use the Get-EVComputers command to obtain the Enterprise Vault index server name.

-ForceDelete [<SwitchParameter>]

You can use this switch to forcefully delete a repository. This will bypass all the validations.

-Confirm [<SwitchParameter>]

You can use the Confirm switch to suppress the confirmation prompt that appears by default when this cmdlet is run. To suppress the confirmation prompt, use the syntax -Confirm:$False. You must include a colon ( : ) in the syntax.

-WhatIf [<SwitchParameter>]

The WhatIf switch instructs the command to simulate the actions that it would take on the object. By using the WhatIf switch, you can preview the changes that would occur without applying any of those changes. You do not need to specify a value with the WhatIf switch.

Outputs

Remove-EVIndexSnapshotRepository returns no output.

Examples
  • C:\PS> Remove-EVIndexSnapshotRepository -Name 1afcfcef-2502-4ff4-a066-f3fb165c7f08

    Removes the index snapshot repository with name 1afcfcef-2502-4ff4-a066-f3fb165c7f08 from the Enterprise Vault index server on which this command is executed.

  • C:\PS> Remove-EVIndexSnapshotRepository -Name 1afcfcef-2502-4ff4-a066-f3fb165c7f08 -ServerName win12r2.domain.local

    Removes the index snapshot repository with name 1afcfcef-2502-4ff4-a066-f3fb165c7f08 from the Enterprise Vault index server win12r2.domain.local.

  • C:\PS> Remove-EVIndexSnapshotRepository -Name 1afcfcef-2502-4ff4-a066-f3fb165c7f08 -SiteId 1400222F70EEFC04AA6B63C233696BB491d10000Win12R2.domain.local -ServerName win12r2.domain.local

    Removes the index snapshot repository with name 1afcfcef-2502-4ff4-a066-f3fb165c7f08 from the Enterprise Vault index server win12r2.domain.local in the Enterprise Vault site 1400222F70EEFC04AA6B63C233696BB491d10000Win12R2.domain.local.

  • C:\PS> Get-EVIndexSnapshotRepository | Remove-EVIndexSnapshotRepository

    Removes all index snapshot repositories returned by the Get-EVIndexSnapshotRepository command.

  • C:\PS> Get-EVIndexSnapshotLocation -OnlyActive | Get-EVIndexSnapshotRepository | Remove-EVIndexSnapshotRepository

    Removes all index snapshot repositories for the active index snapshot location returned by the Get-EVIndexSnapshotLocation command.

Related cmdlets