New-CsCdrConfiguration
トピックの最終更新日: 2012-03-23
新しい通話詳細記録 (CDR) 設定を作成します。CDR を使用すると、ピアツーピア インスタント メッセージング セッション、ボイス オーバー IP (VoIP) 電話での通話、電話会議の通話などの使用状況を追跡できます。この使用状況データには、誰が誰といつ通話したか、通話時間はどれほどの長さだったかに関する情報が含まれています。
構文
New-CsCdrConfiguration -Identity <XdsIdentity> [-Confirm [<SwitchParameter>]] [-EnableCDR <$true | $false>] [-EnablePurging <$true | $false>] [-Force <SwitchParameter>] [-InMemory <SwitchParameter>] [-KeepCallDetailForDays <UInt32>] [-KeepErrorReportForDays <UInt32>] [-PurgeHourOfDay <UInt32>] [-WhatIf [<SwitchParameter>]]
解説
通話詳細記録 (CDR) を使用すると、Microsoft Lync Server 2010 の機能 (ボイス オーバー IP (VoIP) 電話での通話、インスタント メッセージ (IM)、ファイル転送、音声またはビデオ (A/V) 会議、アプリケーション共有セッションなど) の使用状況を追跡できます。CDR (監視サービスを展開している場合のみ利用できます) は使用状況の追跡情報を保持し、通話の関係者、通話の長さ、ファイル転送の有無などの情報を記録します (ただし、CDR では通話内容そのものは記録されません)。
また、CDR は通話エラーの情報の追跡も行い、ピアツーピア セッションと電話会議の通話の両方の詳細な診断データを追跡します。
管理者として、組織で CDR を使用するかどうかを決定できます。監視サービスが展開されていれば、容易に CDR を有効または無効にできます。さらに、この決定をグローバル (その場合、CDR は組織全体で有効または無効のいずれかになります) またはサイトごとに行うことができます。たとえば、CDR を Redmond サイトでは使用可能にして、Paris サイトでは CDR を使用不可能にすることができます。
New-CsCdrConfiguration コマンドレットを使用して、サイト スコープで新しい CDR 設定コレクションを作成できます (グローバル スコープで新しい設定を作成することはできません)。各サイトがホストできるのは 1 つの CDR 設定コレクションだけであることに注意してください。つまり、Redmond サイトに既に CDR 構成設定がある場合、このサイトに新しいコレクションを作成することはできません。作成しようとすると、コマンドは失敗します。
このコマンドレットを実行できるユーザー: 既定では、次のグループのメンバーは New-CsCdrConfiguration コマンドレットのローカル実行を承認されています。RTCUniversalServerAdmins。このコマンドレットが割り当てられているすべての役割ベースのアクセス制御 (RBAC) の役割の一覧 (自身が作成したカスタムの RBAC の役割を含む) を戻すには、Windows PowerShell プロンプトから次のコマンドを実行します。
Get-CsAdminRole | Where-Object {$_.Cmdlets –match "New-CsCdrConfiguration"}
パラメーター
| パラメーター | 必須かどうか | 型 | 説明 |
|---|---|---|---|
Identity |
省略可能 |
Xds Identity |
新しい CDR 構成設定コレクションに割り当てる一意の識別子を表します。新しいコレクションはサイト スコープのみで作成できるので、Identity には常に "site:" のプレフィックスが付きます。その後にサイト名が続きます。たとえば、"site:Redmond" です。 |
EnableCDR |
省略可能 |
ブール値 |
CDR が有効かどうかを示します。既定値は True です。 |
EnablePurging |
省略可能 |
ブール値 |
CDR の記録を CDR データベースから定期的に削除するかどうかを示します。True (既定値) の場合、KeepCallDetailForDays プロパティ (CDR の場合) と KeepErrorReportForDays プロパティ (CDR エラーの場合) により指定された期間を過ぎると記録が削除されます。False の場合、CDR の記録は無期限に保持されます。 |
KeepCallDetailForDays |
省略可能 |
整数 |
CDR の記録を CDR データベースに保持する日数を示します。指定した日数より古い記録は自動的に削除されます (ただし、この削除が実行されるのは EnablePurging プロパティが True に設定されている場合のみです)。 KeepCallDetailForDays には、1 ～ 2,562 日 (約 7 年間) の間の整数値を設定できます。既定値は 60 です。 |
KeepErrorReportForDays |
省略可能 |
整数 |
CDR エラー報告を保持する日数を示します。指定した日数より古い報告は自動的に削除されます。CDR エラー報告は、Microsoft Lync 2010 などのクライアント アプリケーションによってアップロードされる診断レポートです。 このプロパティには、1 ～ 2,562 日 (約 7 年間) の間の整数値を設定できます。既定値は 60 です。 |
PurgeHourOfDay |
省略可能 |
整数 |
CDR データベースの期限切れの記録の削除を実行するローカル時刻を示します。時刻は 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 |
省略可能 |
スイッチ パラメーター |
コマンド実行中に発生する可能性のある、致命的ではないすべてのエラー メッセージを表示しないようにします。 |
InMemory |
省略可能 |
SwitchParameter |
永続的な変更としてオブジェクトをコミットせずに、オブジェクト参照を作成します。このパラメーターを指定して呼び出したコマンドレットの出力を変数に割り当てる場合、オブジェクト参照のプロパティを変更し、コマンドレットに対応する Set- コマンドレットを呼び出してそれらの変更をコミットできます。 |
WhatIf |
省略可能 |
SwitchParameter |
実際にコマンドを実行せずに、コマンドの実行結果がわかります。 |
Confirm |
省略可能 |
SwitchParameter |
コマンドの実行前に確認メッセージを表示します。 |
入力の種類
なし。New-CsCdrConfiguration はパイプライン入力を受け入れません。
戻り値の種類
Microsoft.Rtc.Management.WritableConfig.Settings.CallDetailRecording.CdrSettings オブジェクトのインスタンスを作成します。
例
-------------------------- 例 1 --------------------------
New-CsCdrConfiguration -Identity site:Redmond -EnableCDR $False
例 1 のコマンドでは、New-CsCdrConfiguration コマンドレットを使用して、Identity が site:Redmond の新しい CDR 設定を作成しています。この新しい設定に Identity site:Redmond のほか、EnableCDR プロパティ False も設定しています。サイト設定はグローバル設定よりも優先されるため、グローバル スコープで CDR が有効になっているかどうかにかかわらず、Redmond サイトでは CDR を使用しません。
-------------------------- 例 2 --------------------------
$x = New-CsCdrConfiguration -Identity site:Redmond -InMemory
$x.EnableCDR = $False
Set-CsCdrConfiguration -Instance $x
例 2 では、InMemory パラメーターを使用して、最初にメモリ内だけに存在する新しい CDR 構成設定コレクションを作成する方法を示しています。これを行うため、例ではまず New-CsCdrConfiguration に InMemory パラメーターを指定して Identity が site:Redmond の設定の仮想コレクションを作成し、この仮想コレクションを変数 $x に格納しています。このコレクションは、変数に格納しないと作成後すぐに消滅します。
仮想コレクションを作成した後、2 行目のコマンドで EnableCDR プロパティの値を False ($False) に設定しています。次に、3 行目で Set-CsCdrConfiguration を使用して、仮想コレクション $x を Redmond サイトに適用する実際の CDR 構成設定コレクションに変換しています。Set-CsCdrConfiguration を呼び出さなければ、この仮想コレクションは Windows PowerShell セッションが終了したとき、または変数 $x が削除されたときにすぐ消滅します。