Enterprise Vault™ PowerShell Cmdlet
- Enterprise Vault PowerShell Cmdlet 简介
- 归档:Exchange
- 归档:FSA
- 归档:Skype for Business
- 归档:SMTP
- 备份
- 分类
- 数据库
- IMAP 访问
- 索引
- 记录管理
- 保留计划
- 基于角色的管理
- 站点和服务器
- 任务和服务
- 保管库存储和归档
Set-EVSkypeForBusinessTarget
Set-EVSkypeForBusinessTarget 可设置或更新 Skype for Business 归档目标的属性。如果不使用 -SiteId 参数指定站点 ID,且 Set-EVSkypeForBusinessTarget 无法确定站点,则将提示您输入站点 ID。
Set-EVSkypeForBusinessTarget 可设置或更新 Enterprise Vault 目录中的 Skype for Business 归档目标信息。
要设置或更新 Skype for Business 目标的属性,请指定运行 Skype for Business 服务器的计算机的完全限定域名。使用 -TargetComputerFQDN。
注意:
您必须指定单个 Skype for Business 计算机的完全限定域名,而不是前端池。
此外,还可指定任何新设置或替换设置。这些设置包括:
Enterprise Vault 服务器。使用 -EVServer。
要与 Skype for Business 归档目标关联的保留类别或保留计划。
对于保留类别,使用 -RetentionCategory 或 -RetentionCategoryId。对于保留计划,使用 -RetentionPlan。
要与 Skype for Business 目标关联的归档。将 -ArchiveId 或 -ArchiveName 与 -ArchiveType 一起使用。
-Enabled 参数。使用 $True 立即开始从 Skype for Business 目标导出到保留文件夹。使用 $False 停止导出。
用于访问 Skype for Business 目标的帐户详细信息。使用 -ExportLogOnCredential 将帐户详细信息指定为 PSCredential 对象。使用 -ExportLogonAccount 和 -Password 将用户名指定为字符串,将密码指定为安全字符串。
-RemoveExportLogonAccount 参数。指定此参数后,Enterprise Vault 会停止使用分配给目标的帐户访问 Skype for Business 目标。Enterprise Vault 开始使用分配给 SMTP 归档任务的帐户。
如果指定的 Skype for Business 归档目标不存在,则 Set-EVSkypeForBusinessTarget 将失败。
如果您指定 -Enabled 参数以立即开始归档,且 SMTP 归档任务已停止,则 Set-EVSkypeForBusinessTarget 将失败。
如果使用 -EVServer 参数指定新 Enterprise Vault 服务器且满足以下任何条件,则 Set-EVSkypeForBusinessTarget 将失败:
新 Enterprise Vault 服务器已承载 Skype for Business 目标。
SMTP 归档任务未安装在新 Enterprise Vault 服务器上。
如果您指定的归档与 Compliance Accelerator 取样不兼容,则 Set-EVSkypeForBusinessTarget 将显示警告。如果要将 Compliance Accelerator 与 Skype for Business 一起使用,我们建议您使用 SMTP 归档。
Set-EVSkypeForBusinessTarget 由管理单元 Symantec.EnterpriseVault.PowerShell.AdminAPI.dll
提供。
Set-EVSkypeForBusinessTarget [[-SiteId] <String>] [-TargetComputerFQDN] <String> [-Enabled <Boolean>] [-EVServer <String>] [-RetentionCategory <String>] [-RetentionCategoryId <String>] [-RetentionPlan <String>] [-ArchiveName <String>] [-ArchiveId <String>] [-ArchiveType <Object>] [-ExportLogOnCredential <PSCredential>] [-ExportLogonAccount <String> [-Password <SecureString>]] [-RemoveExportLogonAccount] [-AssignPermission <Boolean>] [-RevokePermission <Boolean>] [-WhatIf] [-Confirm] [<CommonParameters>]
表:Set-EVSkypeForBusinessTarget 参数
参数 |
说明 |
---|---|
-SiteId |
Skype for Business 归档目标所属的站点的 ID。 您可以使用 Get-EVSite 获取站点 ID。 |
-TargetComputerFQDN(必需) |
运行 Skype for Business 服务器的计算机的完全限定域名。 |
-Enabled |
是否开始从 Skype for Business 目标导出到保留文件夹:($True) 或 ($False)。 如果 SMTP 归档任务正在运行,并且启用目标,Enterprise Vault 将立即开始从目标导出数据。但是,如果您随后禁用目标,Enterprise Vault 将停止从目标中导出新数据,但会继续归档保留文件夹中的任何剩余数据。 |
-EVServer |
承载 SMTP 归档任务的 Enterprise Vault 服务器。此任务处理与 Skype for Business 归档目标关联的对话。 默认情况下,Enterprise Vault 使用为 SMTP 归档任务指定的用户帐户访问正在运行 Skype for Business Server 的计算机。如果要使用其他用户帐户,请使用 -ExportLogOnCredential 参数或 -ExportLogonAccount 参数指定该帐户。 如果更新目标以使用新 Enterprise Vault 服务器,Enterprise Vault 将使用与新服务器上相同名称的用户帐户访问 Skype for Business。因此,新服务器上的此用户帐户需要相应的权限。 |
-RetentionCategory |
要与 Skype for Business 目标关联的现有保留类别的名称。如果指定保留类别,则可使用任何归档类型。但是,如果指定保留计划,则只能使用 SMTP 归档。 如果与目标关联的归档具有保留计划,则与计划关联的保留类别优先并将应用于目标。 您可以指定 RetentionCategoryId 参数而不是此参数。 |
-RetentionCategoryId |
要与 Skype for Business 目标关联的现有保留类别的 ID。如果指定保留类别,则可使用任何归档类型。但是,如果指定保留计划,则只能使用 SMTP 归档。 如果与目标关联的归档具有保留计划,则与计划关联的保留类别优先并将应用于目标。 您可以指定 RetentionCategory 参数而不是此参数。 |
-RetentionPlan |
要与目标关联的现有保留计划的名称。将计划中定义的保留类别分配到目标的对话以及 Enterprise Vault 用于存储保留类别的归档。如果此归档已经具有保留计划,则 Set-EVSkypeForBusinessTarget 无法将新计划与目标关联。 请注意,您不能执行以下任一操作 :
|
-ArchiveName |
Enterprise Vault 用于归档目标中的对话的归档的名称。 您必须指定 ArchiveType 参数和此参数。 您可以指定 ArchiveId 参数,而不是 ArchiveName 参数和 ArchiveType 参数。 |
-ArchiveId |
Enterprise Vault 用于归档目标中的对话的归档的 ID。 您可以指定 ArchiveName 参数和 ArchiveType 参数,而不是此参数。 |
-ArchiveType |
Enterprise Vault 用于归档目标中的对话的归档的类型。有效归档类型包括:
此外,Get-EVArchive cmdlet 返回的归档类型也有效:
如果要将 Compliance Accelerator 与 Skype for Business 一起使用,我们建议您使用 SMTP 归档。 您必须指定 ArchiveName 参数和此参数。 您可以指定 ArchiveId 参数,而不是 ArchiveName 参数和 ArchiveType 参数。 |
-ExportLogOnCredential |
一个 PowerShell PSCredential 对象,其中包含用于访问 Skype for Business 目标的登录凭据。 您可以使用 Get-Credential cmdlet 创建 PSCredential 对象。 |
-ExportLogonAccount |
一个字符串,其中包含用于访问 Skype for Business 目标的用户名。如果指定此参数,则还必须指定 -Password 参数。 |
-Password |
一个安全字符串,其中包含用于访问 Skype for Business 目标的密码。将此参数与 -ExportLogonAccount 参数一起使用。 |
-RemoveExportLogonAccount |
如果指定此参数,Enterprise Vault 会停止使用分配给目标的帐户访问 Skype for Business 目标。Enterprise Vault 会使用分配给 SMTP 归档任务的帐户。默认情况下,这是 Vault Service 帐户。 |
-AssignPermission |
Enterprise Vault 可以向与目标关联的 Enterprise Vault 服务器上的帐户添加所需权限:
将此参数设置为 $True 时,Enterprise Vault 会自动添加权限。将其设置为 $False 时,Enterprise Vault 不会添加权限。必须手动进行添加。 设置此参数将阻止 cmdlet 提示您添加权限。如果省略此参数,Enterprise Vault 会提示您添加权限。 将此参数与 -ExportLogOnCredential、-ExportLogonAccount 或 -EVServer 一起使用。 |
-RevokePermission |
Enterprise Vault 可以从与目标关联的 Enterprise Vault 服务器上的帐户中删除所需权限:
将此参数设置为 $True 时,Enterprise Vault 会自动删除权限。将其设置为 $False 时,Enterprise Vault 不会删除权限。必须手动将其删除。 设置此参数将阻止 cmdlet 提示您删除权限。如果省略此参数,Enterprise Vault 将提示您删除权限。 将此参数与 -ExportLogOnCredential、-ExportLogonAccount、-RemoveExportLogonAccount 或 -EVServer 一起使用。 |
-WhatIf |
如果已指定,WhatIf 将在测试模式下运行该命令。可以在不执行预期更改的情况下查看这些更改。 |
-Confirm |
运行 cmdlet 之前,系统会提示您进行确认。 |
Set-EVSkypeForBusinessTarget -TargetComputerFQDN "skype01.example.com" -ArchiveName SFBLocal -ArchiveType SMTP
更新 Skype for Business 目标 "skype01.example.com" 的归档。
Set-EVSkypeForBusinessTarget -TargetComputerFQDN "skype01.example.com" -Enabled $True
更新 Skype for Business 目标 "skype01.example.com",以使其能够将数据导出到保留文件夹。
Set-EVSkypeForBusinessTarget -TargetComputerFQDN "skype01.example.com" -EVServer 'EVServer.example.com'
更新 Skype for Business 目标 "skype01.example.com” 的 Enterprise Vault 服务器。
Set-EVSkypeForBusinessTarget -TargetComputerFQDN "skype01.example.com" -RetentionCategory 'Standard retention' -ArchiveName SFBLocal -ArchiveType SMTP
使用新设置更新 skype01.example.com Skype for Business 归档目标。
Set-EVSkypeForBusinessTarget -TargetComputerFQDN "skype01.example.com" -RetentionCategoryId 11B6...EV1004.example.com
更新 Skype for Business 目标 "skype01.example.com" 的保留类别。
Set-EVSkypeForBusinessTarget -TargetComputerFQDN "skype01.example.com" -RetentionCategoryId 11B6...EV1004.example.com -ArchiveName SFBLocal -ArchiveType SMTP
更新 Skype for Business 目标 skype01.example.com 的保留类别和归档。
$archiveType = (Get-EVArchive -ArchiveName "SkypeForBusiness Archive 2015_Target").ArchiveType;
Set-EVSkypeForBusinessTarget -TargetComputerFQDN "skype01.example.com" -RetentionCategory "SkypeForBusiness Retention" -ArchiveName "SkypeForBusiness Archive 2015_Target" -ArchiveType $archiveType
使用 Get-EVArchive 检索归档类型,然后将值存储在变量中。使用存储的归档类型值更新 Skype for Business 归档目标的设置。
$cred = Get-Credential
Set-EVSkypeForBusinessTarget -TargetComputerFQDN "skype01.example.com" -ExportLogOnCredential $cred
会显示“Windows PowerShell 凭据”对话框并将用户名和密码存储在 $cred 变量中。更新 Skype for Business 归档目标,以便在 Enterprise Vault 连接到 Skype for Business 目标时可使用存储的凭据。
$pwd = ConvertTo-SecureString "mypassword" -AsPlainText -Force
Set-EVSkypeForBusinessTarget -TargetComputerFQDN "skype01.example.com" -ExportLogOnAccount example\sfbadmin -Password $pwd
将密码存储在安全字符串中。更新 Skype for Business 归档目标,以便在 Enterprise Vault 连接到 Skype for Business 目标时可使用指定的用户名和密码。
Set-EVSkypeForBusinessTarget -TargetComputerFQDN "skype01.example.com" -RemoveExportLogonAccount
停止使用分配给目标的帐户访问 Skype for Business 目标。Enterprise Vault 会使用分配给 SMTP 归档任务的帐户。默认情况下,这是 Vault Service 帐户。
$cred = Get-Credential
Set-EVSkypeForBusinessTarget -TargetComputerFQDN "skype01.example.com" -ExportLogOnCredential $cred -AssignPermission $true
更新 Skype for Business 归档目标,以便在 Enterprise Vault 连接到 Skype for Business 目标时可使用存储的凭据。Enterprise Vault 自动向 Enterprise Vault 服务器上的帐户添加所需权限。Enterprise Vault 不显示关于将权限分配给新帐户的提示,但它会显示关于从以前与目标关联的旧帐户中删除权限的提示。
$cred = Get-Credential
Set-EVSkypeForBusinessTarget -TargetComputerFQDN "skype01.example.com" -ExportLogOnCredential $cred -RevokePermission $false
更新 Skype for Business 归档目标,以便在 Enterprise Vault 连接到 Skype for Business 目标时可使用存储的凭据。Enterprise Vault 不会从以前与目标关联的 Enterprise Vault 服务器上的帐户中删除所需权限。Enterprise Vault 显示关于将权限分配给新帐户的提示,但它不显示关于从旧帐户中删除权限的提示。
$cred = Get-Credential
Set-EVSkypeForBusinessTarget -TargetComputerFQDN "skype01.example.com" -ExportLogOnCredential $cred -AssignPermission $false -RevokePermission $true
更新 Skype for Business 归档目标,以便在 Enterprise Vault 连接到 Skype for Business 目标时可使用存储的凭据。Enterprise Vault 不向 Enterprise Vault 服务器上的帐户添加所需权限。Enterprise Vault 从以前与目标关联的 Enterprise Vault 服务器上的帐户中删除所需权限。Enterprise Vault 不显示关于添加或删除权限的提示。
Set-EVSkypeForBusinessTarget -TargetComputerFQDN "skype01.example.com" -EVServer 'EVServer.example.com' -AssignPermission $false -RevokePermission $true
更新 Skype for Business 归档目标,以便其使用新的 Enterprise Vault 服务器。Enterprise Vault 在连接到 Skype for Business 目标时使用存储的凭据。它还会从以前与目标关联的 Enterprise Vault 服务器上的帐户中删除所需权限。它不向新 Enterprise Vault 服务器上的帐户添加所需权限,也不显示关于添加或删除权限的提示。
Set-EVSkypeForBusinessTarget 返回一个 Symantec.EnterpriseVault.Admin.EVSkypeForBusinessTarget 类型的对象,其中包含以下属性。
表:Symantec.EnterpriseVault.Admin.SkypeForBusinessTarget 属性
名称 |
类型 |
说明 |
---|---|---|
SiteId |
字符串 |
Skype for Business 归档目标所属的站点的 ID。 |
TargetComputerFQDN |
字符串 |
运行 Skype for Business 服务器的计算机的完全限定域名。 |
EVServer |
字符串 |
承载 SMTP 归档任务的 Enterprise Vault 服务器。此任务处理与 Skype for Business 归档关联的对话。 |
SMTPTaskId |
字符串 |
要对 Skype for Business 数据进行归档的 SMTP 归档任务的 ID。 |
RetentionCategory |
字符串 |
与 Skype for Business 目标关联的保留类别的名称。如果 Enterprise Vault 将词语“(From Plan)”附加到保留类别名称,则已将保留计划应用于与目标关联的归档。Enterprise Vault 将在计划中定义的保留类别应用到对话。如果未向归档分配保留计划,则在目标属性中定义的保留类别将生效。 |
RetentionCategoryId |
字符串 |
与 Skype for Business 目标关联的保留类别的 ID。 如果与目标关联的归档具有保留计划,则与计划关联的保留类别优先并将应用于目标。 |
ArchiveName |
字符串 |
与 Skype for Business 目标关联的归档的名称。 |
ArchiveId |
字符串 |
与 Skype for Business 目标关联的归档的 ID。 |
ArchiveType |
对象 |
与 Skype for Business 目标关联的归档的类型。 |
ArchiveSamplingReady |
布尔值 |
与 Skype for Business 目标关联的归档是否与 Compliance Accelerator 取样兼容:(True) 或 (False)。 |
VaultStoreName |
字符串 |
与 Skype for Business 目标关联的保管库存储的名称。 |
Enabled |
布尔值 |
是否启用 Skype for Business 目标来将数据导出到保留文件夹:(True) 或 (False)。 |
ExportLogOnAccount |
字符串 |
Enterprise Vault 用于访问 Skype for Business 目标的帐户。默认情况下,会使用分配给 SMTP 归档任务的帐户。如果需要,您可以使用 Set-EVSkypeforBusinessTarget 为每个单个目标指定不同的帐户。 |