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

Get-EVSkypeForBusinessTarget

Get-EVSkypeForBusinessTarget lists information about the Skype for Business archiving targets that are configured in the Enterprise Vault directory. If you do not specify a site ID using the -SiteId parameter, and Get-EVSkypeForBusinessTarget cannot determine the site, you are prompted to enter the site ID.

To get the details of a specific Skype for Business archiving target, specify the fully qualified domain name of the computer running Skype for Business Server.

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

Syntax

Get-EVSkypeForBusinessTarget [[-SiteId] <String>] [[-TargetComputerFQDN] <String>] [<CommonParameters>]

Parameters

Table: Get-EVSkypeForBusinessTarget parameters

Parameter

Description

-SiteId

The ID of the site that contains the Skype for Business archiving targets.

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

-TargetComputerFQDN

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

Examples
  • Get-EVSkypeForBusinessTarget

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

  • Get-EVSkypeForBusinessTarget -TargetComputerFQDN "skype01.example.com"

    Gets the details of the Skype for Business archiving target skype01.example.com. For example:

    SiteId : 1ABBB8EF1474D034BB2D13C41C1275F591d10000EV01.example.com

    TargetComputerFQDN : skype01.example.com

    EVServer : EVServer.example.com

    SMTPTaskId : 5

    RetentionCategory : Default Retention Category

    RetentionCategoryId : 19851E07EAEAF6442BE05ADC32C0CECED1b10000EV01.example.com

    ArchiveName : SMTP Archive 1

    ArchiveId : 141517FB2DA3BD44CB280E09E9713C8C11110000EV01.example.com

    ArchiveType : SMTP

    ArchiveSamplingReady : True

    VaultStoreName : Express Vault Store

    Enabled : False

    ExportLogOnAccount : SMTP Archiving Task account (Vault Service account)

Output

Get-EVSkypeForBusinessTarget returns an array of objects of type Symantec.EnterpriseVault.Admin.EVSkypeForBusinessTarget, which has the following properties:

Table: Symantec.EnterpriseVault.Admin.SkypeForBusinessTarget properties

Name

Type

Description

SiteId

String

The ID of the site to which the Skype for Business archiving target belongs.

TargetComputerFQDN

String

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

EVServer

String

The Enterprise Vault server that hosts the SMTP Archiving task. This task processes the conversations that are associated with the Skype for Business archiving target.

SMTPTaskId

uint32

The ID of the SMTP Archiving task that archives Skype for Business data.

RetentionCategory

String

The name of the retention category that is associated with the Skype for Business target. If Enterprise Vault appends the words "(From Plan)" to the retention category name, a retention plan has been applied to the archive that is associated with the target. Enterprise Vault applies the retention category that is defined in the plan to the conversations. If you have not assigned a retention plan to the archive, the effective retention category is the one that is defined in the target properties.

RetentionCategoryId

String

The ID of the retention category that is associated with the Skype for Business target.

If the archive that is associated with the target has a retention plan, the retention category that is associated with the plan takes precedence and is applied to the target.

ArchiveName

String

The name of the archive that is associated with the Skype for Business target.

ArchiveId

String

The ID of the archive that is associated with the Skype for Business target.

ArchiveType

Object

The type of archive that is associated with the Skype for Business target.

ArchiveSamplingReady

Boolean

Whether the archive that is associated with the Skype for Business target is compatible with Compliance Accelerator sampling (True) or not (False).

VaultStoreName

String

The name of the vault store that is associated with the Skype for Business target.

Enabled

Boolean

Whether the Skype for Business target is enabled for exporting data to the holding folder (True) or not (False).

ExportLogOnAccount

String

The account that Enterprise Vault uses to access the Skype for Business target. By default, the account that is assigned to the SMTP Archiving task is used. You can specify a different account for each individual target using Set-EVSkypeforBusinessTarget if required.

Related cmdlets