Get-CsDiagnosticHeaderConfiguration
トピックの最終更新日: 2012-03-23
組織で現在使用されている診断ヘッダーの構成設定に関する情報を戻します。診断ヘッダーの構成設定では、SIP メッセージにヘッダー情報を付けるかどうかを指定します。この情報は、トラブルシューティングやエラー報告において役立つことがあります。
構文
Get-CsDiagnosticHeaderConfiguration [-Identity <XdsIdentity>] [-LocalStore <SwitchParameter>]
Get-CsDiagnosticHeaderConfiguration [-Filter <String>] [-LocalStore <SwitchParameter>]
解説
セッション開始プロトコル (SIP) メッセージを送信するとき、ms-diagnostics ヘッダーを各メッセージに添付するオプションを使用できます。エンド ユーザーには見えないこのメッセージには、接続の問題のトラブルシューティングやエラーの報告に役立つ可能性のある情報が含まれます。たとえば、診断ヘッダーにはエラー コードが含まれる場合があり、それに従って、特定の状況が発生したときにクライアント アプリケーション (たとえば Microsoft Lync 2010) が、あらかじめ決められた一連のアクションを実行できます。
内部ネットワークで送信される SIP メッセージについては、このような診断ヘッダーを含めるべきでない理由はほとんどありません。診断ヘッダーがメッセージのサイズに与える影響は最小限であり、管理者にとっては、接続の問題をトラブルシューティングしようとする場合に貴重なツールとなるはずです。一方、診断ヘッダーには社内 SIP サーバーの完全修飾ドメイン名 (FQDN) のような情報も含まれているので、社内ネットワークから見て外部にいるユーザーにこのような情報を公開することを希望しない場合もあります。この理由から、診断ヘッダーの構成設定を使用して、外部ネットワークのユーザー (フェデレーション ドメインのユーザーなど) や外部のユーザーへ診断ヘッダーを送信するかどうかを指定することができます (外部のユーザーとは、内部ネットワークの外から接続しており、まだ認証されていないユーザーのことです)。
既定では、ヘッダーは外部ネットワークまたは認証されていないユーザーに送信されるメッセージのどちらにも含まれません。ただし、グローバルの診断ヘッダーの設定を変更して、外部ネットワーク、認証されていないユーザー、またはその両方について、ヘッダーが含まれるようにすることができます。または、(エッジ サーバー またはレジストラー サービス用に) サイト スコープまたはサービス スコープでカスタム設定を作成できます。このようにして、あるサイトから、またはある エッジ サーバー を介して送信されるメッセージに診断ヘッダーを含める一方、その他のサイトから、またはその他のエッジ サーバーを介して送信されるメッセージのヘッダーを許可しないことができます。
Get-CsDiagnosticHeaderConfiguration コマンドレットを使用すると、組織で現在使用されている診断ヘッダーの構成設定に関する情報を取得できます。
このコマンドレットを実行できるユーザー: 既定では、Get-CsDiagnosticHeaderConfiguration コマンドレットをローカルで実行する権限があるのは、RTCUniversalUserAdmins および RTCUniversalServerAdmins グループのメンバーです。このコマンドレットが割り当てられているすべての役割ベースのアクセス制御 (RBAC) の役割の一覧 (自身が作成したカスタムの RBAC の役割を含む) を戻すには、Windows PowerShell プロンプトから次のコマンドを実行します。
Get-CsAdminRole | Where-Object {$_.Cmdlets –match "Get-CsDiagnosticHeaderConfiguration"}
パラメーター
| パラメーター | 必須かどうか | 型 | 説明 |
|---|---|---|---|
Identity |
省略可能 |
Xds Identity |
戻す診断ヘッダーの構成設定を表す一意の識別子です。サイト スコープで構成された設定を戻すには、次のような構文を使用します。-Identity "site:Redmond"。サービス スコープで構成された設定を戻すには、次のような構文を使用します。-Identity "service:EdgeServer:atl-edge-001.litwareinc.com"。グローバル設定を戻すには、次の構文を使用します。-Identity global。 このパラメーターが指定されていない場合は、現在使用されている診断ヘッダーの構成設定がすべて戻されます。 |
Filter |
省略可能 |
文字列 |
ワイルドカード文字を使用して、戻す設定のコレクション (1 つまたは複数) を指定できます。たとえば、次の構文は、サイト スコープで構成されているすべての設定を戻します。-Filter site:* 次の構文を使用すると、サービス スコープで構成されたすべての設定が戻されます。-Filter "service:*"。 Filter パラメーターと Identity パラメーターは、同じコマンドで同時に使用できないことに注意してください。 |
LocalStore |
省略可能 |
スイッチ パラメーター |
診断ヘッダー構成データを、中央管理ストア 本体ではなく、中央管理ストア のローカル レプリカから取得します。 |
入力の種類
なし。Get-CsDiagnosticHeaderConfiguration は、パイプ処理による入力を受け入れません。
戻り値の種類
Get-CsDiagnosticHeaderConfiguration を実行すると、Microsoft.Rtc.Management.WritableConfig.Settings.Diagnostics.DiagnosticHeaderSettings オブジェクトのインスタンスが戻されます。
例
-------------------------- 例 1 ------------------------
Get-CsDiagnosticHeaderConfiguration
上記のコマンドでは、組織で現在使用されているすべての診断ヘッダーの構成設定に関する情報を戻しています。これは、Get-CsDiagnosticHeaderConfiguration をパラメーターなしで呼び出して実行します。
-------------------------- 例 2 ------------------------
Get-CsDiagnosticHeaderConfiguration -Identity site:Redmond
例 2 では、次の診断ヘッダーの構成設定のコレクションを 1 つだけ戻しています。site:Redmond という ID を持つコレクションです。
-------------------------- 例 3 ------------------------
Get-CsDiagnosticHeaderConfiguration -Filter "service:*"
例 3 に示すコマンドでは、サービス スコープで構成されているすべての診断ヘッダーの設定を戻しています。これは、Get-CsDiagnosticHeaderConfiguration と Filter パラメーターを呼び出すことにより実行されます。フィルター値 "service:*" を使用して、文字列 "service:" で始まる ID を持つ設定のみ戻すようにします。
-------------------------- 例 4 ------------------------
Get-CsDiagnosticHeaderConfiguration | Where-Object {$_.SendToExternalNetworks -eq $True}
例 4 では、外部ネットワークへの送信を許可するすべての診断ヘッダーの構成設定を戻しています。このタスクを実行するため、コマンドはまず Get-CsDiagnosticHeaderConfiguration をパラメーターなしで呼び出します。このことにより、現在使用されているすべての診断ヘッダーの設定のコレクションが戻されます。次に、このコレクションを Where-Object コマンドレットにパイプ処理し、SendToExternalNetworks プロパティが True に等しい設定のみを選択します。
-------------------------- 例 5 ------------------------
Get-CsDiagnosticHeaderConfiguration | Where-Object {$_.SendToExternalNetworks -eq $True -or $_.SendToOutsideUnauthenticatedUsers -eq $True}
例 5 に示すコマンドでは、次の条件のうち最低 1 つを満たす診断ヘッダーの構成設定に関する情報を戻しています。その条件は、1) SendToExternalNetworks プロパティが True に等しいこと、または 2) SendToOutsideUnauthenticatedUsers が True に等しいことです。これを実行するため、コマンドはまず Get-CsDiagnosticHeaderConfiguration を使用して、使用されているすべての診断ヘッダーの設定のコレクションを戻します。次に、このコレクションを Where-Object にパイプ処理し、SendToExternalNetworks プロパティか SendToOutsideUnauthenticatedUsers プロパティの一方またはその両方が True に等しい設定を選び出します。
-or 演算子により、指定した条件のうち最低 1 つを満たす設定が戻されることを指定しています。指定した条件を両方満たす必要がある場合は、次のように -and 演算子を代わりに使用します。
Where-Object {$_.SendToExternalNetworks -eq $True -and $_.SendToOutsideUnauthenticatedUsers -eq $True}