Remove-CsDiagnosticHeaderConfiguration
トピックの最終更新日: 2012-03-27
現在組織で使用している診断ヘッダーの構成設定コレクションを 1 つまたは複数削除します。診断ヘッダーの構成設定によって、SIP メッセージに対して、トラブルシューティングとエラー報告に役立つ可能性のあるヘッダー情報が付属するかどうかが決まります。
構文
Remove-CsDiagnosticHeaderConfiguration -Identity <XdsIdentity> [-Confirm [<SwitchParameter>]] [-Force <SwitchParameter>] [-WhatIf [<SwitchParameter>]]
解説
管理者は、組織内で送信される各 SIP メッセージへの ms-diagnostic ヘッダーの添付に関するオプションを選択できます。このメッセージ (エンド ユーザーに対して表示されない) には、接続の問題のトラブルシューティングまたはエラーの報告に役立つ可能性のある情報が含まれています。たとえば、診断ヘッダーにはエラー コードが含まれていて、特定の状況が発生したときにクライアント アプリケーションはそのコードに基づいて事前に設定した特定のアクションを実行できる可能性があります。
社内ネットワークの中で送信される SIP メッセージの場合は、このような診断ヘッダーを含めない理由はほとんどありません。これらの診断ヘッダーはメッセージのサイズに最小限の影響を及ぼすのみであり、管理者が接続の問題のトラブルシューティングを行おうとするときに重要なツールになる可能性があるからです。一方、診断ヘッダーには社内 SIP サーバーの完全修飾ドメイン名 (FQDN) のような情報も含まれているので、社内ネットワークから見て外部にいるユーザーにこのような情報を公開することを希望しない場合もあります。このことが原因で、診断ヘッダーの構成設定では、外部ネットワーク上のユーザー (フェデレーション ドメイン内のユーザーなど)、または社外ユーザーに診断ヘッダーを送信するかどうかを決定できます (社外ユーザーとは、外部から社内ネットワークに接続し、まだ認証されていないユーザーのことです)。
代わりに、サイト スコープまたはサービス スコープ (エッジ サーバー または レジストラー サービスの場合) でカスタム設定を作成することができます。この方法で、あるサイトから送信されるメッセージや 1 台の エッジ サーバー を経由するメッセージに診断ヘッダーを含める一方で、他のサイトから送信されるメッセージや他のエッジ サーバーを経由するメッセージにヘッダーを許可しない方針を選択できます。
(サイト スコープまたはサービス スコープのどちらかで) 作成したすべての新しいコレクションは、後で Remove-CsDiagnosticHeaderConfiguration コマンドレットを使用して削除できます。グローバル コレクションに対してこのコマンドレットを実行することもできます。ただし、その場合は、グローバル コレクションは削除されません。グローバル コレクションを削除することはできないからです。代わりに、グローバル コレクションの中に含まれている 2 つのプロパティ、つまり SendToExternalNetworks と SendToOutsideUnauthenticatedUsers は既定値 (この場合は False) にリセットされます。
このコマンドレットを実行できるメンバー。既定では、次のグループのメンバーは Remove-CsDiagnosticHeaderConfiguration コマンドレットのローカル実行を承認されています。RTCUniversalServerAdmins。このコマンドレットが割り当てられているすべての役割ベースのアクセス制御 (RBAC) の役割の一覧 (自身が作成したカスタムの RBAC の役割を含む) を戻すには、Windows PowerShell プロンプトから次のコマンドを実行します。
Get-CsAdminRole | Where-Object {$_.Cmdlets –match "Remove-CsDiagnosticHeaderConfiguration"}
パラメーター
| パラメーター | 必須かどうか | 型 | 説明 |
|---|---|---|---|
Identity |
必須 |
Xds Identity |
削除する診断ヘッダーの構成設定に対応する一意の識別子です。サイト スコープで構成されている設定を削除するには、次のような構文を使用します。-Identity "site:Redmond"。サービス スコープで構成されている設定を削除するには、次のような構文を使用します。-Identity "service:EdgeServer:atl-edge-001.litwareinc.com"。 Remove-CsDiagnosticHeaderConfiguration は、グローバル構成設定に対して実行することもできます。その場合は、-Identity global という構文を使用します。ただし、この場合は、グローバル設定が実際に削除されるのではなく、グローバル設定の中で見つかるプロパティがそれぞれの既定値にリセットされることに注意してください。 |
Force |
省略可能 |
スイッチ パラメーター |
コマンド実行中に発生する可能性のある、致命的ではないすべてのエラー メッセージを表示しないようにします。 |
WhatIf |
省略可能 |
スイッチ パラメーター |
実際にコマンドを実行せずに、コマンドの実行結果がわかります。 |
Confirm |
省略可能 |
スイッチ パラメーター |
コマンドの実行前に確認メッセージを表示します。 |
入力の種類
Microsoft.Rtc.Management.WritableConfig.Settings.Diagnostics.DiagnosticHeaderSettings オブジェクト。Remove-CsDiagnosticHeaderConfiguration は、診断ヘッダー設定オブジェクトに関する、パイプ処理されたインスタンスを受け入れます。
戻り値の種類
なし。代わりに、Remove-CsDiagnosticHeaderConfiguration を実行すると、Microsoft.Rtc.Management.WritableConfig.Settings.Diagnostics.DiagnosticHeaderSettings オブジェクトの既存のインスタンスが削除されます。
例
-------------------------- 例 1 ------------------------
Remove-CsDiagnosticHeaderConfiguration -Identity site:Redmond
例 1 では、site:Redmond という Identity を持つ診断ヘッダーの構成設定が削除されます。
-------------------------- 例 2 ------------------------
Get-CsDiagnosticHeaderConfiguration -Filter service:* | Remove-CsDiagnosticHeaderConfiguration
例 2 のコマンドでは、サービス スコープで既に適用されたすべての診断ヘッダーの構成設定が削除されます。この処理を行うため、コマンドは最初に Get-CsDiagnosticHeaderConfiguration を Filter パラメーターと共に呼び出します。フィルターの値 "service:*" は、Identity が "service:" という文字列で始まる設定に関するデータのみを戻すように制限を加えます。次に、フィルターしたコレクションを Remove-CsDiagnosticHeaderConfiguration にパイプ処理し、コレクション内の各項目を削除します。
-------------------------- 例 3 ------------------------
Get-CsDiagnosticHeaderConfiguration | Where-Object {$_.SendToExternalNetworks -eq $True} | Remove-CsDiagnosticHeaderConfiguration
上記のコマンドでは、外部ネットワークへの送信を許可するすべての診断ヘッダーの構成設定が削除されます。これを実行するため、まず Get-CsDiagnosticHeaderConfiguration を使用して現在使用中のすべての診断ヘッダーの設定のコレクションを戻しています。次に、このコレクションは Where-Object コマンドレットにパイプ処理され、SendToExternalNetworks プロパティが True と等しい設定のみを選択します。これらの設定を Remove-CsDiagnosticHeaderConfiguration にパイプ処理します。これにより外部ネットワークへの送信を許可するすべての設定が削除されます。