Set-CsArchivingConfiguration
上一次修改主题： 2012-03-27
修改即时消息 (IM) 存档设置的现有集合。
语法
Set-CsArchivingConfiguration [-Identity <XdsIdentity>] [-ArchiveDuplicateMessages <$true | $false>] [-BlockOnArchiveFailure <$true | $false>] [-CachePurgingInterval <UInt32>] [-Confirm [<SwitchParameter>]] [-EnableArchiving <None | ImOnly | ImAndWebConf>] [-EnablePurging <$true | $false>] [-Force <SwitchParameter>] [-KeepArchivingDataForDays <UInt32>] [-PurgeExportedArchivesOnly <$true | $false>] [-PurgeHourOfDay <UInt32>] [-WhatIf [<SwitchParameter>]]
Set-CsArchivingConfiguration [-ArchiveDuplicateMessages <$true | $false>] [-BlockOnArchiveFailure <$true | $false>] [-CachePurgingInterval <UInt32>] [-Confirm [<SwitchParameter>]] [-EnableArchiving <None | ImOnly | ImAndWebConf>] [-EnablePurging <$true | $false>] [-Force <SwitchParameter>] [-Instance <PSObject>] [-KeepArchivingDataForDays <UInt32>] [-PurgeExportedArchivesOnly <$true | $false>] [-PurgeHourOfDay <UInt32>] [-WhatIf [<SwitchParameter>]]
详细说明
对许多组织而言，保存其用户参与的所有 IM 会话和会议的脚本很有用处。而某些组织必须保存此类脚本，例如，法律要求许多金融组织保留其所有电子通信的副本。
为了存档即时消息，必须至少设置一个存档服务器。设置 存档服务器 之后，必须执行两个额外步骤。首先，需要在 global 作用域启用存档（有关详细信息，请参阅 Set-CsArchivingConfiguration 主题）。（可选）还可以为不同的站点配置自定义存档设置。
第二步，必须使用存档策略指示哪些用户将能对其 IM 会话存档。如果要求对 IM 会话存档的策略未生效，将不会对 IM 会话存档。
安装 Lync Server 2010 时，将为您创建全局存档配置设置的集合，默认情况下，这些设置将应用于您的整个组织。此外，可以使用 New-CsArchivingConfiguration cmdlet 创建基于点对点的自定义配置设置。无论使用哪种方式，都可以使用 Set-CsArchivingConfiguration cmdlet 修改现有集合或存档配置设置的属性值。
谁能运行此 cmdlet：默认情况下，以下各组的成员有权在本地运行 Set-CsArchivingConfiguration cmdlet：RTCUniversalServerAdmins。要返回分配了此 cmdlet 的所有基于角色的访问控制 (RBAC) 角色列表（包括您自己创建的任何自定义 RBAC 角色），请从 Windows PowerShell 提示符处运行以下命令：
Get-CsAdminRole | Where-Object {$_.Cmdlets –match "Set-CsArchivingConfiguration"}
参数
| 参数 | 必需 | 类型 | 描述 |
|---|---|---|---|
Identity |
可选 |
Xds 标识 |
代表要修改的存档配置设置的集合的唯一标识符。要修改全局设置，请省略此参数或使用以下语法：-Identity global。要在 site 作用域修改设置，请使用前缀“site:”，后跟站点名称。例如：-Identity "site:Redmond"。 |
Instance |
可选 |
ArchivingSettings 对象 |
允许您将对对象的引用传递到 cmdlet，而不是设置单个参数值。 |
ArchiveDuplicateMessages |
可选 |
布尔值 |
指定应如何存档“跨池”即时消息。考虑一个简单的示例：Ken Myer（具有池 1 中的帐户）向 Pilar Ackerman（具有池 2 中的帐户）发送了一条即时消息；然后 Pilar 回复了 Ken 发送的即时消息。如果将 ArchiveDuplicateMessages 设置为 False，则将（基于内置算法）在池 1 或池 2 中记录会话脚本，但不会在两个池中都记录。如果将 ArchiveDuplicateMessages 设置为 True（默认值），则将在两个池中都记录会话脚本。 |
BlockOnArchiveFailure |
可选 |
布尔值 |
如果设置为 True，将在无法存档即时消息时暂停 IM 服务。如果设置为 False（默认值），即使无法存档即时消息，也将继续提供 IM 服务。 |
CachePurgingInterval |
可选 |
整数 |
指示清除系统中所有参与者都未启用存档的脚本的频率（以小时为单位）。根据设计，将记录所有组 IM 会话和会议会话。系统会按照指定的间隔确定这些会话中的任何参与者是否启用了存档。如果系统发现某个会话中的所有参与者均未启用存档，则将从数据库中删除该脚本。 可以将 CachePurgeInterval 属性设置为介于 4 到 168 之间（包含边界值）的任意整数。默认值为 24。 |
EnableArchiving |
可选 |
字符串 |
指示保存到存档数据库的项（如果有）。有效值是： None。不向数据库中存档任何项。此值为默认值。 ImOnly。将 IM 会话存档到数据库中。 ImAndWebConf。将 IM 会话和 Web 会议会话都存档到数据库中。 |
EnablePurging |
可选 |
布尔值 |
如果设置为 True，将定期从数据库中删除满足以下条件的存档即时消息：1) 存档时间超过 KeepArchivingDataForDays 属性指定的值；或 2) 已导出并标记为删除。 如果设置为 False，将不会从数据库中自动删除即时消息。 |
KeepArchivingDataForDays |
可选 |
整数 |
自动删除之前，存档即时消息在数据库中保存的天数（介于 1 和 2562 之间）。默认值为 14。 只有将 EnablePurging 设置为 True 时，此属性才会生效。 |
PurgeExportedArchivesOnly |
可选 |
布尔值 |
如果设置为 True，系统将只清除已导出（因而标记为删除）的即时消息。对于未导出的即时消息，即使其保留时间超过 KeepArchivingDataForDays 属性指定的值，仍将保留在数据库中。 |
PurgeHourOfDay |
可选 |
整数 |
指示从存档数据库中删除过期记录的时间。该时间使用 24 小时制格式指定，0 表示午夜（晚上 12:00），23 表示晚上 11:00。请注意，只能指定整点时间。这意味着，可以将清除安排在 4:00 AM 进行，但不能将其安排在 4:30 AM 或 4:15 AM 进行。默认值为 2 (2:00 AM)。 只有 EnablePurging 属性设置为 True 时，才可进行数据库清除。 |
Force |
可选 |
开关参数 |
禁止显示运行此命令时可能出现的任何非严重错误消息。 |
WhatIf |
可选 |
开关参数 |
描述如果执行命令会发生什么情况（无需实际执行命令）。 |
Confirm |
可选 |
开关参数 |
在执行命令之前提示您进行确认。 |
输入类型
Microsoft.Rtc.Management.WritableConfig.Settings.Archiving.ArchivingSettings 对象。Set-CsArchivingConfiguration 接受通过管道传递的存档配置对象的输入。
返回类型
Set-CsArchivingConfiguration 不会返回值或对象。此 cmdlet 会配置 Microsoft.Rtc.Management.WritableConfig.Settings.Archiving.ArchivingSettings 对象的实例。
示例
-------------------------- 示例 1 --------------------------
Set-CsArchivingConfiguration -Identity site:Redmond -ArchiveDuplicateMessages $False -KeepArchivingDataForDays 30
在上述示例中，使用 Set-CsArchivingConfiguration 修改 Identity 为 site:Redmond 的存档配置设置的两个属性。首先，该命令将 ArchiveDuplicateMessages 属性设置为 False，从而防止服务器多次存档同一个即时消息会话。该命令还使用 KeepArchivingDataForDays 参数指示服务器将即时消息保留 30 天。
-------------------------- 示例 2 --------------------------
Get-CsArchivingConfiguration -Filter "site:*" | Set-CsArchivingConfiguration -ArchiveDuplicateMessages $False -KeepArchivingDataForDays 30
示例 2 是示例 1 中显示的命令的变体。但在此示例中，将修改所有在 site 作用域配置的存档设置的 ArchiveDuplicateMessages 和 KeepArchivingDataForDays 属性的值。为执行此任务，该命令首先使用 Get-CsArchivingConfiguration 和 Filter 参数返回在 site 作用域配置的所有存档设置的集合；筛选器值“site:*”确保仅返回 Identity 以字符“site:”开头。然后，将筛选出的集合通过管道传递到 Set-CsArchivingConfiguration，后者将修改集合中的每一项的两个属性值。
-------------------------- 示例 3 --------------------------
Get-CsArchivingConfiguration | Where-Object {$_.EnableArchiving -eq "ImAndWebConf"} | Set-CsArchivingConfiguration -EnableArchiving "ImOnly"
在示例 3 中，修改允许存档 IM 会话和 Web 会议的存档配置设置；命令完成后，这些设置将只允许存档 IM 会话。为执行此操作，该命令首先调用不带任何参数的 Get-CsArchivingConfiguration 以返回当前在组织内使用的所有存档配置设置的集合。将该集合通过管道传递到 Where-Object cmdle，后者将仅挑选出 EnableArchiving 属性等于 (-eq)“ImAndWebConf”的设置。然后，将筛选出的集合通过管道传递到 Set-CsArchivingConfiguration，后者将选取集合中的每一项，并将 EnableArchiving 的值更改为“ImOnly”。