次の方法で共有

  • [アーティクル]

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 セッションと会議のトランスクリプト (コピー) を保持すると役に立つことに気が付いています。他の組織にとっては、そのようなトランスクリプトを保持することは必須です。たとえば、金融業界の多くの組織では、自社のすべての電子コミュニケーションのコピーを保持することが法令によって要求されています。

インスタント メッセージをアーカイブするには、少なくとも 1 つのアーカイブ サーバーを設定する必要があります。そしてアーカイブ サーバー を設定したら、さらに 2 つの手順を実行する必要があります。最初に、グローバル スコープでアーカイブを有効にする必要があります (詳細については、「Set-CsArchivingConfiguration」を参照してください)。必要に応じて、別のサイトのカスタム アーカイブ設定を構成することもできます。

次に、アーカイブ ポリシーを使用して、どのユーザーが IM セッションのアーカイブを実行するかを指定する必要があります。IM セッションのアーカイブを求めるポリシーが有効でなければ、IM セッションはアーカイブされません。

Lync Server 2010 をインストールすると、グローバル アーカイブ構成設定のコレクションが作成されます。既定では、この設定は組織全体に適用されます。または、New-CsArchivingConfiguration コマンドレットを使用して、カスタムの構成設定をサイトごとに作成できます。どちらの方法でも、Set-CsArchivingConfiguration コマンドレットを使用することによって、既存のコレクションまたはアーカイブの構成設定のプロパティ値を変更することができます。

このコマンドレットを実行できるユーザー: 既定では、次のグループのメンバーが、Set-CsArchivingConfiguration コマンドレットのローカル実行を承認されています。RTCUniversalServerAdmins。このコマンドレットが割り当てられているすべての役割ベースのアクセス制御 (RBAC) の役割の一覧 (自身が作成したカスタムの RBAC の役割を含む) を戻すには、Windows PowerShell プロンプトから次のコマンドを実行します。

Get-CsAdminRole | Where-Object {$_.Cmdlets –match "Set-CsArchivingConfiguration"}

パラメーター

パラメーター 必須かどうか 型 説明

Identity

省略可能

Xds Identity

変更するアーカイブ構成設定のコレクションの一意の識別子を表します。グローバル設定を変更するには、このパラメーターを省略するか、または次の構文を使用します。-Identity global。サイト スコープの設定を変更するには、サイト名の前にプレフィックス "site:" を使用します。次に例を示します。-Identity "site:Redmond"。

Instance

省略可能

ArchivingSettings オブジェクト

個々のパラメーター値を設定するのではなく、オブジェクトへの参照をコマンドレットに渡せるようにします。

ArchiveDuplicateMessages

省略可能

ブール値

"複数のプールにわたる" インスタント メッセージをアーカイブする方法を指定します。ここで簡単な例を考えてみます。Ken Myer (プール 1 にアカウントを所有) は、インスタント メッセージを、プール 2 にアカウントを所有している Pilar Ackerman に送信します。同様に、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 ～ 2,562 の範囲) です。既定値は 14 です。

このプロパティは、EnablePurging が True に設定されている場合にのみ有効になります。

PurgeExportedArchivesOnly

省略可能

ブール値

True の場合、システムでは、エクスポートされた (その結果、削除のマークが付いた) インスタント メッセージのみが削除されます。エクスポートされていないインスタント メッセージは、KeepArchivingDataForDays プロパティに指定されている値より古い場合であってもデータベースに残ります。

PurgeHourOfDay

省略可能

整数

有効期限が切れた記録がアーカイブ データベースから削除される時刻を指定します。時刻は 24 時間制を使用して指定します。0 は夜中 12 時 (12:00 AM) を、23 は 11:00 PM を表します。指定できるのは時間のみです。つまり、削除の実行を 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 は、値またはオブジェクトを戻しません。代わりに Microsoft.Rtc.Management.WritableConfig.Settings.Archiving.ArchivingSettings オブジェクトのインスタンスが構成されます。

例

-------------------------- 例 1 --------------------------

Set-CsArchivingConfiguration -Identity site:Redmond -ArchiveDuplicateMessages $False -KeepArchivingDataForDays 30

上記の例は、Set-CsArchivingConfiguration を使用して、site:Redmond という ID を持つアーカイブ構成設定の 2 つのプロパティを変更します。このコマンドはまず ArchiveDuplicateMessages プロパティを False に設定します。これにより、サーバーが同じインスタント メッセージのセッションを複数回アーカイブするのを回避します。また、コマンドは、KeepArchivingDataForDays パラメーターを使用して、インスタント メッセージを 30 日間保存するようにサーバーに指示します。

-------------------------- 例 2 --------------------------

Get-CsArchivingConfiguration -Filter "site:*" | Set-CsArchivingConfiguration -ArchiveDuplicateMessages $False -KeepArchivingDataForDays 30

例 2 は例 1 に示したコマンドの変化形です。ただし、この例では、サイト スコープで構成されているすべてのアーカイブ設定に対して ArchiveDuplicateMessages プロパティおよび KeepArchivingDataForDays プロパティの値を変更します。このタスクを実行するには、まず、このコマンドで Get-CsArchivingConfiguration と Filter パラメーターを使用して、サイト スコープで構成されたすべてのアーカイブ設定のコレクションを戻します。フィルター値 "site:*" により、Identity が文字列 "site:" で始まる設定に限定されます。が返されます。次に、フィルター処理されたコレクションを Set-CsArchivingConfiguration にパイプ処理し、コレクション内の各項目に関する 2 つのプロパティ値を変更します。

-------------------------- 例 3 --------------------------

Get-CsArchivingConfiguration | Where-Object {$_.EnableArchiving -eq "ImAndWebConf"} | Set-CsArchivingConfiguration -EnableArchiving "ImOnly"

例 3 では、IM セッションと Web 会議の両方をアーカイブできる、すべてのアーカイブ構成設定を変更します。コマンドが完了すると、設定により、アーカイブできるのは IM セッションのみになります。この処理を行うため、コマンドはまず、Get-CsArchivingConfiguration をパラメーターなしで呼び出し、組織で現在使用されているすべてのアーカイブ構成設定のコレクションを戻します。次に、このコレクションは Where-Object コマンドレットにパイプ処理され、EnableArchiving プロパティが "ImAndWebConf" と等しい (-eq) 設定のみを選び出します。そして、フィルターされたコレクションは Set-CsArchivingConfiguration にパイプ処理され、コレクション内の各項目を取得して、EnableArchiving を "ImOnly" に変更します。