New-CsArchivingConfiguration
トピックの最終更新日: 2012-03-23
インスタント メッセージング (IM) アーカイブ設定の新しいセットを作成します。これらの設定を使用すると、IM セッションの自動保存を有効または無効にすることができます。また、アーカイブできないインスタント メッセージをブロックすることもできます。
構文
New-CsArchivingConfiguration -Identity <XdsIdentity> [-ArchiveDuplicateMessages <$true | $false>] [-BlockOnArchiveFailure <$true | $false>] [-CachePurgingInterval <UInt32>] [-Confirm [<SwitchParameter>]] [-EnableArchiving <None | ImOnly | ImAndWebConf>] [-EnablePurging <$true | $false>] [-Force <SwitchParameter>] [-InMemory <SwitchParameter>] [-KeepArchivingDataForDays <UInt32>] [-PurgeExportedArchivesOnly <$true | $false>] [-PurgeHourOfDay <UInt32>] [-WhatIf [<SwitchParameter>]]
解説
多くの組織は、ユーザーが実行したすべての IM セッションのトランスクリプトを保持することは有益なことだと考えています。一部の組織では、そのようなトランスクリプトを保持することは義務とみなされています。たとえば、金融界の多数の組織は法律により、電子通信のすべてのコピーを保持するように義務付けられています。
Microsoft Lync Server 2010 では、IM および Web 会議セッションのアーカイブを柔軟に行うことができます。アーカイブ サーバーを展開済みの場合は、さまざまな CsArchivingConfiguration コマンドレットを使用して IM セッションのアーカイブを有効化および無効化し、アーカイブ データベースを管理することができます。また、アーカイブ失敗時に IM を一時停止することもできます。これによって、すべての電子通信の記録を確実に保持できます。
Lync Server 2010 をインストールすると、グローバル アーカイブ設定のコレクションが作成されます。既定では、この設定は組織全体に適用されます。または、New-CsArchivingConfiguration コマンドレットを使用して、カスタムの構成設定をサイトごとに作成できます。
このコマンドレットを実行できるユーザー:既定では、次のグループのメンバーが New-CsArchivingConfiguration コマンドレットをローカルで実行することを承認されています。RTCUniversalServerAdmins。このコマンドレットが割り当てられているすべての役割ベースのアクセス制御 (RBAC) の役割の一覧 (自身が作成したカスタムの RBAC の役割を含む) を戻すには、Windows PowerShell プロンプトから次のコマンドを実行します。
Get-CsAdminRole | Where-Object {$_.Cmdlets –match "New-CsArchivingConfiguration"}
パラメーター
パラメーター | 必須かどうか | 型 | 説明 |
---|---|---|---|
Identity |
必須 |
Xds Identity |
アーカイブ構成設定の新しいコレクションに割り当てる一意の識別子です。新しいコレクションはサイト スコープのみで作成できるので、Identity には常に "site:" のプレフィックスが付きます。その後にサイト名が続きます。たとえば、"site:Redmond" です。 |
ArchiveDuplicateMessages |
省略可能 |
ブール値 |
クロスプール インスタント メッセージのアーカイブ方法を指定します。たとえば、Ken Myer (アカウントは Pool 1 に存在) が Pilar Ackerman (アカウントは Pool 2 に存在) にインスタント メッセージを送信すると、Pilar は Ken のインスタント メッセージに返信します。ArchiveDuplicateMessages が False に設定されている場合、(組み込みのアルゴリズムに基づいて) セッションのトランスクリプトのログはプール 1 または プール 2 のどちらかに記録されますが、両方には記録されません。ArchiveDuplicateMessages が True (既定値) に設定されている場合、トランスクリプトのログは両方のプールに記録されます。 |
BlockOnArchiveFailure |
省略可能 |
ブール値 |
True の場合、インスタント メッセージ セッションをアーカイブできなくなると、IM サービスは停止します。False (既定値) に設定すると、セッションをアーカイブできなくても、インスタント メッセージングは続行します。 |
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 |
省略可能 |
SwitchParameter |
コマンド実行中に発生する可能性のある、致命的ではないすべてのエラー メッセージを表示しないようにします。 |
InMemory |
省略可能 |
SwitchParameter |
永続的な変更としてオブジェクトをコミットせずに、オブジェクト参照を作成します。このパラメーターを指定して呼び出したコマンドレットの出力を変数に割り当てる場合、オブジェクト参照のプロパティを変更し、コマンドレットに対応する Set- コマンドレットを呼び出してそれらの変更をコミットできます。 |
WhatIf |
省略可能 |
SwitchParameter |
実際にコマンドを実行せずに、コマンドの実行結果がわかります。 |
Confirm |
省略可能 |
SwitchParameter |
コマンドの実行前に確認メッセージを表示します。 |
入力の種類
なし。New-CsArchivingConfiguration は、パイプライン処理された入力を受け入れません。
戻り値の種類
New-CsArchivingConfiguration は、Microsoft.Rtc.Management.WritableConfig.Settings.Archiving.ArchivingSettings オブジェクトの新しいインスタンスを作成します。
例
-------------------------- 例 1 --------------------------
New-CsArchivingConfiguration -Identity site:Redmond -EnableArchiving "ImOnly"
例 1 に示すコマンドは、アーカイブ構成設定の新しいコレクションを作成して、Redmond サイトに適用します。EnableArchiving パラメーターを追加し、パラメーター値を "ImOnly" に設定することで、Redmond サイトでは IM セッションのアーカイブも有効になります (ただし、Web 会議のアーカイブは有効になりません)。
-------------------------- 例 2 --------------------------
$x = New-CsArchivingConfiguration -Identity site:Redmond -InMemory
$x.EnableArchiving = "ImOnly"
Set-CsArchivingConfiguration -Instance $x
上記の例では、InMemory パラメーターを使用して、最初にメモリ内のみに保存するアーカイブ構成設定のコレクションを作成します。このタスクを実行するため、設定の新しいコレクション (Identity は site:Redmond) を作成し、このコレクションを $x という名前の変数に格納します。最初のコマンドを実行した後、コレクションはメモリ内にのみ存在しています。コマンド Get-CsArchivingConfiguration を実行しても、site:Redmond のエントリは表示されません。
2 番目のコマンドでは、この設定の仮想コレクションのプロパティ EnableArchiving を "ImOnly" に設定し、これにより IM セッションのアーカイブを有効にしています。最後のコマンドで Set-CsArchivingConfiguration を使用して、仮想アーカイブ設定を実際の設定コレクションに変換し、Redmond サイトに適用します。Set-CsArchivingConfiguration を呼び出さない場合、これらの設定はメモリ内のみに存在し続け、Windows PowerShell セッションを終了するか、変数 $x を削除すると削除されます。