Set-CsCdrConfiguration
トピックの最終更新日: 2012-03-26
既存の通話詳細記録 (CDR) 設定のコレクションを変更します。CDR では、ピアツーピアのインスタント メッセージング セッション、ボイス オーバー IP (VoIP) 電話の通話、電話会議などの使用状況を追跡できます。この使用状況データの中には、通話の発信者と受信者、通話時刻、通話時間の情報が含まれます。
構文
Set-CsCdrConfiguration [-Identity <XdsIdentity>] [-Confirm [<SwitchParameter>]] [-EnableCDR <$true | $false>] [-EnablePurging <$true | $false>] [-Force <SwitchParameter>] [-KeepCallDetailForDays <UInt32>] [-KeepErrorReportForDays <UInt32>] [-PurgeHourOfDay <UInt32>] [-WhatIf [<SwitchParameter>]]
Set-CsCdrConfiguration [-Confirm [<SwitchParameter>]] [-EnableCDR <$true | $false>] [-EnablePurging <$true | $false>] [-Force <SwitchParameter>] [-Instance <PSObject>] [-KeepCallDetailForDays <UInt32>] [-KeepErrorReportForDays <UInt32>] [-PurgeHourOfDay <UInt32>] [-WhatIf [<SwitchParameter>]]
解説
通話詳細記録 (CDR) では、ボイス オーバー IP (VoIP) 電話の通話、インスタント メッセージング (IM)、ファイル転送、音声ビデオ (A/V) 会議、アプリケーション共有セッションなどの Microsoft Lync Server 2010 機能の使用状況を追跡できます。CDR (監視サービスを展開した場合にのみ使用可能) は利用状況に関する情報を保持します。通話者、通話時間、ファイル転送の有無などの情報を記録します。ただし、CDR では通話の内容自体は記録されません。
また、CDR は通話エラーの情報の追跡も行い、ピアツーピア セッションと電話会議の通話の両方の詳細な診断データを追跡します。
CDR を組織内で使用するかどうかは、管理者として決定できます。CDR は、監視サービスが展開されていれば簡単に有効または無効にできます。また、これをグローバルに適用するか (この場合、組織全体で CDR を有効または無効にします)、サイトごとに適用するかも決定できます。たとえば、Redmond サイトでは CDR を使用するが、Paris サイトでは CDR を使用しないようにすることもできます。
管理者は CDR データベースの管理も行うことができます。たとえば、CDR レコードがデータベースから削除されるまでの保持日数を指定できます。このような変更は、Set-CsCdrConfiguration コマンドレットを使用して行うことができます。
このコマンドレットを実行できるユーザー: 既定では、Set-CsCdrConfiguration コマンドレットをローカルで実行する権限があるのは、RTCUniversalServerAdmins グループのメンバーです。このコマンドレットが割り当てられているすべての役割ベースのアクセス制御 (RBAC) の役割の一覧 (自身が作成したカスタムの RBAC の役割を含む) を戻すには、Windows PowerShell プロンプトから次のコマンドを実行します。
Get-CsAdminRole | Where-Object {$_.Cmdlets –match "Set-CsCdrConfiguration"}
パラメーター
パラメーター | 必須かどうか | 型 | 説明 |
---|---|---|---|
Identity |
省略可能 |
Xds Identity |
CDR 構成設定のコレクションに割り当てられた一意の識別子です。グローバル設定を参照するには、次の構文を使用します。-Identity global。サイト スコープで構成されるコレクションを参照するには、次のような構文を使用します。-Identity site:Redmond。Identity を指定するときに、ワイルドカード文字を使用することはできません。 このパラメーターを省略すると、Set-CsCdrConfiguration はグローバル設定を変更します。 |
Instance |
省略可能 |
CdrSettings オブジェクト |
個々のパラメーター値を設定するのではなく、オブジェクトへの参照をコマンドレットに渡せるようにします。 |
EnableCDR |
省略可能 |
ブール値 |
CDR が有効か無効かを示します。既定値は True です。 |
EnablePurging |
省略可能 |
ブール値 |
CDR データベースから CDR レコードを定期的に削除するかどうかを示します。True (既定値) の場合、KeepCallDetailForDays プロパティ (CDR レコードの場合) および KeepErrorReportForDays プロパティ (CDR エラーの場合) で指定されている期間を過ぎると、レコードが削除されます。False の場合、CDR レコードは無期限に保持されます。 |
KeepCallDetailForDays |
省略可能 |
整数 |
CDR データベースに CDR レコードを保持する日数を示します。指定された日数より古いレコードは、自動的に削除されます (削除が実行されるのは、EnablePurging プロパティが True に設定されている場合のみです)。 このプロパティに設定できる値は、1 ~ 2,562 日 (約 7 年) の整数値です。既定値は 60 です。 |
KeepErrorReportForDays |
省略可能 |
整数 |
CDR エラー報告を保持する日数を示します。指定された日数より古い報告は、自動的に削除されます。CDR エラー報告は、Microsoft Lync 2010 などのクライアント アプリケーションがアップロードする診断レポートです。 このプロパティに設定できる値は、1 ~ 2,562 日 (約 7 年) の整数値です。既定値は 60 です。 |
PurgeHourOfDay |
省略可能 |
整数 |
期限切れのレコードが CDR データベースから削除されるときのローカル時刻を示します。この時刻は 24 時間制で指定します。0 は深夜 0 時を表し、23 は午後 11 時を表します。なお、時刻は 1 時間刻みでのみ指定できます。つまり、午前 4:00 に削除が実行されるようにスケジュールすることはできますが、午前 4:30 や午前 4:15 に実行されるようにスケジュールすることはできません。既定値は 2 です (午前 2:00)。削除は業務時間外に実行することをお勧めします。 データベースの削除は、EnablePurging プロパティが True に設定されている場合にのみ実行されます。 |
Force |
省略可能 |
スイッチ パラメーター |
コマンド実行中に発生する可能性のある、致命的ではないすべてのエラー メッセージを表示しないようにします。 |
WhatIf |
省略可能 |
スイッチ パラメーター |
実際にコマンドを実行せずに、コマンドの実行結果がわかります。 |
Confirm |
省略可能 |
スイッチ パラメーター |
コマンドの実行前に確認メッセージを表示します。 |
入力の種類
Microsoft.Rtc.Management.WritableConfig.Settings.CallDetailRecording.CdrSettings です。Set-CsCdrConfiguration は、通話詳細記録構成オブジェクトのパイプ処理による入力を受け入れます。
戻り値の種類
Set-CsCdrConfiguration は、値またはオブジェクトを戻しません。代わりに、Microsoft.Rtc.Management.WritableConfig.Settings.CallDetailRecording.CDRSettings オブジェクトのインスタンスを構成します。
例
-------------------------- 例 1 --------------------------
Set-CsCdrConfiguration -Identity site:Redmond -PurgeHourOfDay 23
この例は、古いレコードを削除する時刻を設定します。この例では、時刻を 23 (11:00 P.M. の 24 時間表記) に設定します。Identity パラメーターを使用して、Identity が site:Redmond の CDR 設定に対してのみ、この変更が適用されるようにします。
-------------------------- 例 2 --------------------------
Get-CsCdrConfiguration | Set-CsCdrConfiguration -PurgeHourOfDay 23
例 2 は、例 1 に示したコマンドの変化形です。この例では、組織内で現在使用されている各 CDR 構成設定コレクションの PurgeHourOfDay プロパティを変更します。これを行うため、まず Get-CsCdrConfiguration をパラメーターを指定せずに呼び出し、現在使用されているすべての CDR 設定のコレクションを戻します。次に、このコレクションを Set-CsCdrConfiguration へパイプ処理し、コレクション内の各項目を取得して、PurgeHourOfDay プロパティの値を 11:00 PM (23) に変更します。
-------------------------- 例 3 --------------------------
Get-CsCdrConfiguration -Filter "site:*"| Set-CsCdrConfiguration -PurgeHourOfDay 23
例 3 では、例 1 で使ったコマンドのもう 1 つの変化形を示しています。この例では、サイト スコープで構成されているすべての CDR 設定について、PurgeHourOfDay プロパティを変更します。これを行うため、まず Get-CsCdrConfiguration に Filter パラメーターを指定して呼び出します。フィルター値 "site:*" により、Identity が文字列値 "site:" で始まる CDR 設定のみが返されます。次に、フィルター後のコレクションを Set-CsCdrConfiguration へパイプ処理し、コレクション内の各項目の PurgeHourOfDay プロパティを変更します。