New-CsDiagnosticHeaderConfiguration
トピックの最終更新日: 2012-03-23
新しい診断ヘッダーの構成設定のコレクションを作成します。診断ヘッダーの構成設定を使用すると、トラブルシューティングやエラーの報告に役立つヘッダー情報を SIP メッセージに付加するかどうかを決定できます。UNRESOLVED_TOKEN_VAL(ps-intro-in-LS2010)
構文
New-CsDiagnosticHeaderConfiguration -Identity <XdsIdentity> [-Confirm [<SwitchParameter>]] [-Force <SwitchParameter>] [-InMemory <SwitchParameter>] [-SendToExternalNetworks <$true | $false>] [-SendToExternalNetworksOnServiceEdge <$true | $false>] [-SendToOutsideUnauthenticatedUsers <$true | $false>] [-WhatIf [<SwitchParameter>]]
例
例 1
例 1 では、Redmond サイト (-Identity site:Redmond) の新しい診断ヘッダーの構成を作成しています。ID を指定するのに加え、コマンドでは、SendToOutsideAuthenticatedUsers パラメーターとパラメーター値 $True も使用しています。このことにより、内部ネットワークの外にいる認証されたユーザーへの情報の送信が可能となります。
New-CsDiagnosticHeaderConfiguration -Identity site:Redmond -SendToOutsideUnauthenticatedUsers $True
例 2
例 2 に示すコマンドでは、作成当初はメモリ内のみに存在する診断ヘッダーの設定のコレクションを作成する方法を示しています。これを実行するため、例の最初のコマンドでは、Identity および InMemorys パラメーターを指定して New-CsDiagnosticHeaderConfiguration コマンドレットを呼び出します。結果のオブジェクトは、変数 $x に保存されます。
仮想の設定が作成されたら、2 番目と 3 番目のコマンドを使用して、SendToOutsideUnauthenticatedUsers および SendToExternalNetworks プロパティの値をそれぞれ変更します。最後に、4 番目のコマンドを使用して、仮想の診断ヘッダーの構成設定を Redmond サイトに適用する実際の設定のコレクションに変更します。この最後のコマンドは必須であることに注意してください。Set-CsDiagnosticHeaderConfiguration コマンドレットを呼び出さない場合、サイトには設定が何も適用されません。また、Windows PowerShell セッションを終了するか、変数 $x を削除するとすぐ、仮想の設定はなくなります。
$x = New-CsDiagnosticHeaderConfiguration -Identity site:Redmond -InMemory
$x.SendToOutsideUnauthenticatedUsers = $True
$x.SendToExternalNetworks = $True
Set-CsDiagnosticHeaderConfiguration -Instance $x
解説
管理者には、組織に送信されてくる各 SIP メッセージに ms-diagnostic ヘッダーを追加するオプションが用意されています。このメッセージ (エンド ユーザーは見ることができません) には、接続の問題のトラブルシューティングやエラー報告に役立つ可能性のある情報が含まれています。たとえば、診断ヘッダーにはエラー コードが含まれる場合があり、それに従って、特定の状況が発生したときにクライアント アプリケーション (たとえば Lync) が、あらかじめ決められた一連のアクションを実行できます。
内部ネットワークで送信される SIP メッセージについては、このような診断ヘッダーを含めるべきでない理由はほとんどありません。診断ヘッダーによるメッセージ サイズへの影響は最小限に抑えられており、管理者にとっては、接続問題をトラブルシューティングしようとする場合の貴重なツールとなり得ます。ただし、診断ヘッダーには社内 SIP サーバーの完全修飾ドメイン名 (FQDN) などの情報も含まれているため、社内ネットワークの外部にいるユーザーに公開することが望ましくない場合もあります。このため、診断ヘッダーの構成設定により、外部ネットワーク上のユーザー (フェデレーション ドメイン内のユーザーなど) や外部ユーザーに診断ヘッダーを送信するかどうかを決定できます (外部ユーザーは、社内ネットワークの外部から接続しており、まだ認証されていないユーザーです)。
既定では、外部ネットワークまたは認証されていないユーザーへ送信するメッセージに診断ヘッダーを含めません。ただし、グローバルの診断ヘッダーの設定を変更して、外部ネットワーク、認証されていないユーザー、またはその両方について、ヘッダーが含まれるようにすることができます。あるいは、サイト スコープやサービス スコープで ( エッジ サーバーやレジストラー サービスのための) カスタム設定を作成することもできます。このようにして、あるサイトから、またはある エッジ サーバー を介して送信されるメッセージに診断ヘッダーを含める一方、その他のサイトから、またはその他のエッジ サーバーを介して送信されるメッセージのヘッダーを許可しないことができます。
カスタムの診断ヘッダーの設定は New-CsDiagnosticHeaderConfiguration コマンドレットを使用して作成します。説明したとおり、新しい設定はサイト スコープまたはサービス スコープのいずれかで作成できます (ただし、エッジ サーバー とレジストラー サービスのみが対象です)。このような設定のコレクションは、1 つのサイトまたはサービスあたり 1 つのみ作成できることに注意してください。たとえば、Redmond サイト用に新しいコレクションを作成しようとしていて、そのサイトでは、診断ヘッダーの設定のコレクションが既にホストされているとします。その場合、コマンドは失敗します。同様に、グローバル スコープで新しいコレクションを作成しようとすると、コマンドは失敗します。
このコマンドレットを実行できるユーザー: 既定では、次のグループのメンバーが New-CsDiagnosticHeaderConfiguration コマンドレットをローカルで実行することを承認されています。RTCUniversalServerAdmins。このコマンドレットが割り当てられているすべての役割ベースのアクセス制御 (RBAC) の役割の一覧 (自身が作成したカスタムの RBAC の役割を含む) を戻すには、Windows PowerShell プロンプトから次のコマンドを実行します。
Get-CsAdminRole | Where-Object {$_.Cmdlets –match "New-CsDiagnosticHeaderConfiguration"}
パラメーター
| パラメーター | 必須かどうか | 型 | 説明 |
|---|---|---|---|
Identity |
必須 |
Microsoft.Rtc.Management.Xds.XdsIdentity |
作成する診断ヘッダーの構成設定を表す一意の識別子です。サイト スコープで新しい設定のコレクションを作成するには、次のような構文を使用します。-Identity "site:Redmond"。サービス スコープで新しい設定のコレクションを作成するには、次のような構文を使用します。-Identity "service:EdgeServer:atl-cs-001.litwareinc.com"。 グローバル スコープで新しい設定を作成することはできません。また、指定したサイトまたはサービス (たとえば、site:Redmond) で設定のコレクションが既にホストされている場合、サイト スコープまたはサービス スコープで新しい設定を作成することはできません。 |
Confirm |
省略可能 |
System.Management.Automation.SwitchParameter |
コマンドの実行前に確認メッセージを表示します。 |
Force |
省略可能 |
System.Management.Automation.SwitchParameter |
コマンド実行中に発生する可能性のある、致命的ではないすべてのエラー メッセージを表示しないようにします。 |
InMemory |
省略可能 |
System.Management.Automation.SwitchParameter |
永続的な変更としてオブジェクトをコミットせずに、オブジェクト参照を作成します。このパラメーターを指定して呼び出したコマンドレットの出力を変数に割り当てる場合、オブジェクト参照のプロパティを変更し、コマンドレットに対応する Set- コマンドレットを呼び出してそれらの変更をコミットできます。 |
SendToExternalNetworks |
省略可能 |
System.Boolean |
True に設定されている場合、外部ネットワークのユーザー (フェデレーション ドメインのユーザーなど) に送信されるメッセージに診断ヘッダーが添付されます。既定値は False です。 |
SendToExternalNetworksOnServiceEdge |
省略可能 |
System.Boolean |
PARAMVALUE: $true | $false |
SendToOutsideUnauthenticatedUsers |
省略可能 |
System.Boolean |
True に設定されている場合、外部ユーザーに送信されるメッセージに診断ヘッダーが添付されます。外部ユーザーは、社内ネットワークの外部から接続しており (たとえば、プロキシ サーバーを経由)、まだ認証されていないユーザーです。 既定値は False です。 |
WhatIf |
省略可能 |
System.Management.Automation.SwitchParameter |
実際にコマンドを実行せずに、コマンドの実行結果がわかります。 |
入力の種類
なし。New-CsDiagnosticHeaderConfiguration コマンドレットは、パイプライン処理された入力を受け入れません。
戻り値の種類
New-CsDiagnosticHeaderConfiguration コマンドレットを実行すると、Microsoft.Rtc.Management.WritableConfig.Settings.Diagnostics.DiagnosticHeaderSettings オブジェクトの新しいインスタンスが作成されます。