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

New-EVSkypeForBusinessTarget

New-EVSkypeForBusinessTarget adds a new Skype for Business archiving target. If you do not specify a site ID using the -SiteId parameter and New-EVSkypeForBusinessTarget cannot determine the site, you are prompted to enter the site ID.

New-EVSkypeForBusinessTarget adds information about the Skype for Business archiving target to the Enterprise Vault directory.

To add a new Skype for Business target, specify the following:

  • The fully qualified domain name of the computer running Skype for Business Server. Use -TargetComputerFQDN.

    Note:

    You must specify the fully qualified domain name of an individual Skype for Business computer, and not a Front End pool.

  • Whether to start exporting from the Skype for Business target to the holding folder immediately. Use -Enabled.

  • The Enterprise Vault server that processes the target. Use -EVServer.

  • The retention category or retention plan to associate with the Skype for Business archiving target.

    For the retention category, use -RetentionCategory or -RetentionCategoryId. For the retention plan, use -RetentionPlan.

  • The archive to associate with the Skype for Business target. Use -ArchiveId, or -ArchiveName with -ArchiveType.

New-EVSkypeForBusinessTarget fails if you specify a Skype for Business archiving target that already exists.

New-EVSkypeForBusinessTarget fails if you specify the -Enabled parameter to start archiving immediately, and the SMTP Archiving task is stopped.

New-EVSkypeForBusinessTarget displays a warning if you specify an archive that is incompatible with Compliance Accelerator sampling.

New-EVSkypeForBusinessTarget is provided by Symantec.EnterpriseVault.PowerShell.AdminAPI.dll, which is loaded by the Enterprise Vault Management Shell.

Syntax

New-EVSkypeForBusinessTarget [[-SiteId] <String>] [-TargetComputerFQDN] <String> [-Enabled <Boolean>] [-EVServer <String>] [-RetentionCategory <String>] [-RetentionCategoryId <String>] [-RetentionPlan <String>] [-ArchiveName <String>] [-ArchiveId <String>] [-ArchiveType <Object>] [-WhatIf] [-Confirm] [<CommonParameters>]

Parameters

Table: New-EVSkypeForBusinessTarget parameters

Parameter

Description

-SiteId

The ID of the site to which you want to add the Skype for Business archiving target.

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.

-Enabled (required)

Whether to start exporting from the Skype for Business target to the holding folder immediately ($True) or not ($False).

If you create the target with the -Enabled parameter set to $False, you must set the parameter to $True using Set-EVSkypeForBusinessTarget before export begins.

-EVServer

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

-RetentionCategory

The name of an existing retention category to be associated with the Skype for Business target. If you specify a retention category, you can use any archive type. However, if you specify a retention plan, you can only use an SMTP archive.

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.

You can specify the RetentionCategoryId parameter instead of this parameter.

-RetentionCategoryId

The ID of the retention category to be associated with the Skype for Business target. If you specify a retention category, you can use any archive type. However, if you specify a retention plan, you can only use an SMTP archive.

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.

You can specify the RetentionCategory parameter instead of this parameter.

-RetentionPlan

The name of an existing retention plan to be associated with the target. The retention category that you have defined in the plan is assigned to the target's conversations and to the archive in which Enterprise Vault stores them. If this archive already has a retention plan, New-EVSkypeForBusinessTarget cannot associate a new plan with the target.

Note that you cannot do either of the following:

  • Specify both a retention category and a retention plan.

  • Assign a retention plan to a non-SMTP archive.

-ArchiveName

The name of the archive in which Enterprise Vault archives the conversations from the target.

You must specify the ArchiveType parameter with this parameter.

You can specify the ArchiveId parameter instead of the ArchiveName parameter and the ArchiveType parameter.

-ArchiveId

The ID of the archive in which Enterprise Vault archives the conversations from the target.

You can specify the ArchiveName parameter and the ArchiveType parameter instead of this parameter.

-ArchiveType

The type of archive in which Enterprise Vault archives the conversations from the target.

The valid archive types are:

  • DominoJournal

  • DominoMailbox

  • ExchangeJournal

  • ExchangeMailbox

  • ExchangePublicFolder

  • FileSystem

  • InternetMail

  • Shared

  • SharePoint

  • SharePointStructured

  • SMTP

In addition, the archive types that the Get-EVArchive cmdlet returns are also valid:

  • ARCHIVE_TYPE_DOMINO_JOURNAL

  • ARCHIVE_TYPE_DOMINO_MAILBOX

  • ARCHIVE_TYPE_FILE_SYSTEM

  • ARCHIVE_TYPE_INTERNETMAIL

  • ARCHIVE_TYPE_JOURNAL

  • ARCHIVE_TYPE_MAILBOX

  • ARCHIVE_TYPE_PUBLIC_FOLDER

  • ARCHIVE_TYPE_SHARED

  • ARCHIVE_TYPE_SHAREPOINT

  • ARCHIVE_TYPE_SMTP

If you intend to use Compliance Accelerator with Skype for Business, we recommend that you use an SMTP archive.

You must specify the ArchiveName parameter with this parameter.

You can specify the ArchiveId parameter instead of the ArchiveName parameter and the ArchiveType parameter.

-WhatIf

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

-Confirm

Prompts you for confirmation before running the cmdlet.

Examples
  • New-EVSkypeForBusinessTarget -TargetComputerFQDN "skype01.example.com" -Enabled $True -EVServer 'EVServer.example.com' -RetentionCategory 'Standard retention' -ArchiveName SFBLocal -ArchiveType SMTP

    Adds skype01.example.com as a new Skype for Business archiving target.

  • $archiveType = (Get-EVArchive -ArchiveName "SkypeForBusiness Archive 2015_Target").ArchiveType;

    New-EVSkypeForBusinessTarget -TargetComputerFQDN "skype01.example.com" -Enabled $True -EVServer 'EVServer.example.com' -RetentionCategory "SkypeForBusiness Retention" -ArchiveName "SkypeForBusiness Archive 2015_Target" -ArchiveType $archiveType

    Uses Get-EVArchive to retrieve the archive type, and then stores the value in a variable. Adds a new Skype for Business archiving target using the stored archive type value.

Output

New-EVSkypeForBusinessTarget returns an object of type Symantec.EnterpriseVault.Admin.EVSkypeForBusinessTarget, which comprises 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 conversations that are associated with the Skype for Business archiving target.

SMTPTaskId

String

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