次の方法で共有

  • [アーティクル]

Set-CsDiagnosticHeaderConfiguration

 

トピックの最終更新日: 2012-03-26

組織で現在使用されている既存の診断ヘッダー構成設定を変更します。診断ヘッダーの構成設定により、トラブルシューティングやエラー報告に役立つ可能性のあるヘッダー情報が SIP メッセージに付与されるかどうかが決定されます。UNRESOLVED_TOKEN_VAL(ps-intro-in-LS2010)

構文

Set-CsDiagnosticHeaderConfiguration [-Identity <XdsIdentity>] <COMMON PARAMETERS>

Set-CsDiagnosticHeaderConfiguration [-Instance <PSObject>] <COMMON PARAMETERS>

COMMON PARAMETERS: [-Confirm [<SwitchParameter>]] [-Force <SwitchParameter>] [-SendToExternalNetworks <$true | $false>] [-SendToExternalNetworksOnServiceEdge <$true | $false>] [-SendToOutsideUnauthenticatedUsers <$true | $false>] [-WhatIf [<SwitchParameter>]]

例

例 1

例 1 のコマンドは、site:Redmond という ID を持つ診断ヘッダー構成設定を変更します。この例では、SendToOutsideUnauthenticatedUsers プロパティの値を True に設定しています。

Set-CsDiagnosticHeaderConfiguration -Identity site:Redmond -SendToOutsideUnauthenticatedUsers $True

例 2

例 2 に示すコマンドは 例 1 に示したコマンドの変化形です。ただしこの場合は、使用されているすべての診断ヘッダー構成設定について、SendToOutsideUnauthenticatedUsers プロパティを更新します。これを行うため、まず Get-CsDiagnosticHeaderConfiguration コマンドレットをパラメーターなしで呼び出しています。これによって、現在使用されているすべての診断ヘッダー設定のコレクションを戻しています。次に、このコレクションを Set-CsDiagnosticHeaderConfiguration コマンドレットにパイプ処理し、コレクション内の各項目の SendToOutsideUnauthenticatedUsers プロパティを True に設定しています。

Get-CsDiagnosticHeaderConfiguration | Set-CsDiagnosticHeaderConfiguration -SendToOutsideUnauthenticatedUsers $True

例 3

例 3 は、SendToOutsideUnauthenticatedUsers プロパティをもう一度変更していますが、今度は SendToExternalNetworks プロパティが True の診断ヘッダー設定についてのみ変更します。このタスクを実行するため、まず Get-CsDiagnosticHeaderConfiguration コマンドレットを使用して、現在使用されているすべての診断ヘッダー構成設定のコレクションを戻しています。このコレクションは Where-Object コマンドレットにパイプ処理され、SendToExternalNetworks プロパティが True と等しい設定のみを選択します。次に、このフィルター後のコレクションを Set-CsDiagnosticHeaderConfiguration コマンドレットにパイプ処理し、コレクション内の各項目に関する SendToOutsideUnauthenticatedUsers プロパティの値を True に設定しています。

Get-CsDiagnosticHeaderConfiguration | Where-Object {$_.SendToExternalNetworks -eq $True} | Set-CsDiagnosticHeaderConfiguration -SendToOutsideUnauthenticatedUsers $True

解説

管理者は、組織内で送信される各 SIP メッセージに ms-diagnostic ヘッダーを添付できます。こうしたメッセージ (エンド ユーザーは見ることができません) には、接続の問題のトラブルシューティングやエラー報告に役立つ可能性のある情報が含まれています。たとえば、診断ヘッダーには、特定の状況が発生したときにクライアント アプリケーション ( Lync Server など) があらかじめ決められた一連のアクションを実行できるようにするためのエラー コードが含まれる場合があります。

内部ネットワーク内で SIP メッセージを送信する場合、これらの診断ヘッダーを含めないようにする理由はほとんどありません。診断ヘッダーはメッセージ サイズを最小限増加させるだけであり、管理者が接続の問題のトラブルシューティングを試行する際にたいへん重要なツールになるからです。一方、診断ヘッダーには社内 SIP サーバーの完全修飾ドメイン名 (FQDN) のような情報も含まれているので、内部ネットワークから見て外部にいるユーザーにこのような情報を公開することを希望しない場合もあります。この理由から、診断ヘッダーの構成設定では、外部ネットワーク上のユーザー (フェデレーション ドメイン内のユーザーなど)、または社外ユーザーに診断ヘッダーを送信するかどうかを決定できます (社外ユーザーとは、外部から内部ネットワークに接続し、まだ認証されていないユーザーのことです)。

既定では、外部ネットワークまたは認証されていないユーザーへ送信するメッセージにはヘッダーを含めませんが、ただし、外部ネットワークや認証されていないユーザーに対してもヘッダーを含めるようにグローバル診断ヘッダーの設定を変更することもできます。また、サイト スコープやサービス スコープで (エッジ サーバーやレジストラー サービスのための) カスタム設定を作成することもできます。この方法で、あるサイトから送信されるメッセージや 1 台の エッジ サーバー を経由するメッセージに診断ヘッダーを含める一方で、他のサイトから送信されるメッセージや他のエッジ サーバーを経由するメッセージにヘッダーを許可しない方針を選択できます。

Set-CsDiagnosticHeaderConfiguration コマンドレットを使用して、既存の診断ヘッダー構成設定コレクションを変更できます。このコマンドレットを使用して、外部ネットワークや社外ユーザーへの診断ヘッダーの送信を有効 (または無効) にできます。

このコマンドレットを実行できるユーザー: 既定では、次のグループのメンバーは Set-CsDiagnosticHeaderConfiguration コマンドレットのローカル実行を承認されています。RTCUniversalServerAdmins。このコマンドレットが割り当てられているすべての役割ベースのアクセス制御 (RBAC) の役割の一覧 (自身が作成したカスタムの RBAC の役割を含む) を戻すには、Windows PowerShell プロンプトから次のコマンドを実行します。

Get-CsAdminRole | Where-Object {$_.Cmdlets -match "Set-CsDiagnosticHeaderConfiguration"}

パラメーター

パラメーター 必須かどうか 型 説明

Confirm

省略可能

System.Management.Automation.SwitchParameter

コマンドの実行前に確認メッセージを表示します。

Force

省略可能

System.Management.Automation.SwitchParameter

コマンド実行中に発生する可能性のある、致命的ではないすべてのエラー メッセージを表示しないようにします。

Identity

省略可能

Microsoft.Rtc.Management.Xds.XdsIdentity

変更する診断ヘッダー構成設定の一意の識別子です。サイト スコープで構成された設定を変更するには、次のような構文を使用します。-Identity "site:Redmond" です。サービス スコープで構成された設定を変更するには、次のような構文を使用します。-Identity "service:EdgeServer:atl-cs-001.litwareinc.com" です。グローバル設定を変更するには、次の構文を使用します。-Identity global です。

このパラメーターが指定されていない場合、Set-CsDiagnosticHeaderConfiguration コマンドレットは自動的にグローバル設定を変更します。

Instance

省略可能

DiagnosticHeaderSettings オブジェクト

個々のパラメーター値を設定するのではなく、オブジェクトへの参照をコマンドレットに渡せるようにします。

SendToExternalNetworks

省略可能

System.Boolean

True に設定されている場合、外部ネットワークのユーザー (フェデレーション ドメインのユーザーなど) に送信されるメッセージに診断ヘッダーが添付されます。既定値は False です。

SendToExternalNetworksOnServiceEdge

省略可能

System.Boolean

PARAMVALUE: $true | $false

SendToOutsideUnauthenticatedUsers

省略可能

System.Boolean

True に設定されている場合、社外ユーザーに送信されるメッセージに診断ヘッダーが添付されます。社外ユーザーとは、外部から社内ネットワークに接続し (たとえば、プロキシ サーバー経由で)、まだ認証されていないユーザーのことです。

既定値は False です。

WhatIf

省略可能

System.Management.Automation.SwitchParameter

実際にコマンドを実行せずに、コマンドの実行結果がわかります。

入力の種類

Microsoft.Rtc.Management.WritableConfig.Settings.Diagnostics.DiagnosticHeaderSettings オブジェクト。Set-CsDiagnosticHeaderConfiguration コマンドレットは、診断ヘッダー設定オブジェクトに関する、パイプ処理されたインスタンスを受け入れます。

戻り値の種類

Set-CsDiagnosticHeaderConfiguration コマンドレットを実行しても、オブジェクトや値が戻されることはありません。代わりに、このコマンドレットは Microsoft.Rtc.Management.WritableConfig.Settings.Diagnostics.DiagnosticHeaderSettings オブジェクトの既存のインスタンスを変更します。