Remove-CsDiagnosticHeaderConfiguration
上次修改主題的時間: 2012-03-27
刪除一或多個目前在組織中使用的診斷標頭組態設定集合。診斷標頭組態設定會決定 SIP 訊息是否要搭配有助於疑難排解和錯誤報告的標頭資訊。
語法
Remove-CsDiagnosticHeaderConfiguration -Identity <XdsIdentity> [-Confirm [<SwitchParameter>]] [-Force <SwitchParameter>] [-WhatIf [<SwitchParameter>]]
詳細描述
系統管理員可以選擇在每則傳送到組織的 SIP 訊息上附加 ms-diagnostics 標頭。此訊息 (一般使用者看不到) 包含有助於疑難排解連線問題或報告錯誤的資訊。例如,發生特定的狀況時,診斷標頭中的錯誤碼可讓用戶端應用程式採取預先決定的動作。
若是在內部網路內傳送的 SIP 訊息,有幾個理由可以不包含這些診斷標頭:它們對訊息大小的影響最小,且對於要解決連線問題的系統管理員來說可能是沒價值的工具。但是,診斷標頭也包含了一些您可能不想讓內部網路以外人員看到的資訊,像是 SIP 伺服器的完整網域名稱 (FQDN)。因此,診斷標頭組態設定可讓您決定是否傳送診斷標頭給外部網路使用者 (例如,同盟網域的使用者) 和/或外部使用者 (外部使用者係指從內部網路之外進行連線,且尚未經過驗證的使用者)。
或者,您可以在站台範圍或服務範圍 (針對 Edge Server 或登錄器服務) 建立自訂設定。這樣一來,您就可以選擇包含從某一個站台或經由某一個 Edge Server 傳送的訊息診斷標頭,同時不允許從其他站台或經由其他 Edge Server 傳送的訊息診斷標頭。
不論是在站台範圍或服務範圍內建立的新集合,您都可以在稍後使用 Remove-CsDiagnosticHeaderConfiguration 指令程式予以移除。您也可以針對通用集合執行此指令程式。但在此情況下,通用集合並不會遭到移除,原因在於您無法移除通用集合。而是會將通用集合中的兩個屬性 (SendToExternalNetworks 和 SendToOutsideUnauthenticatedUsers) 重設為預設值 (兩者皆為 False)。
誰可以執行此 Cmdlet:下列群組的成員預設會獲授權可以在本機上執行 Remove-CsDiagnosticHeaderConfiguration Cmdlet:RTCUniversalServerAdmins。若要傳回所有獲指派此 Cmdlet 的角色存取控制 (RBAC) 角色清單 (包括您自行建立的自訂 RBAC 角色),請在 Windows PowerShell 提示字元中執行下列命令:
Get-CsAdminRole | Where-Object {$_.Cmdlets –match "Remove-CsDiagnosticHeaderConfiguration"}
參數
參數 | 必要 | 類型 | 描述 |
---|---|---|---|
Identity |
必要 |
Xds 識別身份 |
要移除之診斷標頭組態設定的唯一識別碼。若要移除在此站台範圍設定的設定,請使用類似如下的語法:-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 會移除 Identity 為 site:Redmond 的診斷標頭組態設定。
-------------------------- 範例 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,由其刪除所有允許傳送到外部網路的設定。