Enterprise Vault™ PowerShell Cmdlets

Last Published:
Product(s): Enterprise Vault (12.4)
  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. 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.  
      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-EVArchivePermission
    4.  
      Get-EVVaultStore
    5.  
      Get-EVVaultStorePartition
    6.  
      Remove-EVArchive
    7.  
      Remove-EVArchivePermission
    8.  
      Set-EVArchive
    9.  
      Set-EVArchivePermission
    10.  
      Start-PartitionRollover

Remove-EVSkypeForBusinessTarget

Remove-EVSkypeForBusinessTarget removes a Skype for Business archiving target from the Enterprise Vault directory. If you do not specify a site ID using the -SiteId parameter and Remove-EVSkypeForBusinessTarget cannot determine the site, you are prompted to enter the site ID.

To remove a Skype for Business archiving target, you must specify the fully qualified domain name of the computer running Skype for Business Server.

When you create a target, you associate it with an account on the Enterprise Vault server. This account requires the following permissions on the server that processes the Skype for Business target:

  • Membership of the local Administrators group.

  • The Log On As a Service right.

  • Full access to the SMTP holding folder.

By default, the Remove-EVSkypeForBusinessTarget cmdlet prompts you to revoke the permissions. Include the -RevokePermission parameter to suppress this prompt when you run the cmdlet as part of a PowerShell script.

Warning:

Before you remove a target, you must disable it and wait for the holding folder to empty. If you do not disable the target, Enterprise Vault stops you from deleting it. After you have deleted the target, you must restart the SMTP Archiving task. If you do not complete these activities in this order, you may lose data.

Remove-EVSkypeForBusinessTarget fails if you specify a Skype for Business archiving target that does not exist.

Remove-EVSkypeForBusinessTarget is provided by the snap-in Symantec.EnterpriseVault.PowerShell.AdminAPI.dll.

Syntax

Remove-EVSkypeForBusinessTarget [[-SiteId] <String>] [-TargetComputerFQDN] <String> [-RevokePermission <Boolean>] [-WhatIf] [-Confirm] [<CommonParameters>]

Parameters

Table: Remove-EVSkypeForBusinessTarget parameters

Parameter

Description

-SiteId

The ID of the site that contains the Skype for Business archiving target that you want to remove.

You can use Get-EVSite to obtain the site ID.

-TargetComputerFQDN (required)

The fully qualified domain name of the computer running Skype for Business Server.

-RevokePermission

Enterprise Vault can remove the required permissions from the account on the Enterprise Vault server that is associated with the target:

  • Membership of the local Administrators group.

  • The Log On As a Service right.

  • Full access to the SMTP holding folder.

When you set this parameter to $True, Enterprise Vault removes the permissions automatically. When you set it to $False, Enterprise Vault does not remove the permissions. You must remove them manually.

Setting this parameter stops the cmdlet from prompting you to remove the permissions. If you omit this parameter, Enterprise Vault prompts you to remove the permissions.

-WhatIf

If specified, WhatIf runs the command in test mode. You can see the expected changes without implementing them.

-Confirm

By default, you are prompted before the delete operation is actioned. To avoid the confirmation prompt, use -Confirm:$False.

Examples
  • Remove-EVSkypeForBusinessTarget -TargetComputerFQDN "skype01.example.com"

    Removes the Skype for Business archiving target that is associated with the target computer skype01.example.com.

  • Get-EVSkypeForBusinessTarget | Remove-EVSkypeForBusinessTarget

    Removes all Skype for Business archiving targets for the current site.

  • Remove-EVSkypeForBusinessTarget -TargetComputerFQDN "skype01.example.com" -RevokePermission $false

    Removes the Skype for Business archiving target that is associated with the target computer skype01.example.com, without removing the permissions from the account that is associated with the target.

Related cmdlets