Remove-CsQoEConfiguration
Topic Last Modified: 2012-03-27
Removes a collection of QoE (Quality of Experience) settings.
Syntax
Remove-CsQoEConfiguration -Identity <XdsIdentity> [-Confirm [<SwitchParameter>]] [-Force <SwitchParameter>] [-WhatIf [<SwitchParameter>]]
Detailed Description
QoE metrics track the quality of audio and video calls made in your organization, including such things as the number of network packets lost, background noise, and the amount of "jitter" (differences in packet delay). These metrics are stored in a database apart from other data (such as call detail records), which allows you to enable and disable QoE independent of other data recording. Use this cmdlet to remove settings that configure QoE at the site level. Calling this cmdlet on the global QoE configuration will reset all properties to the defaults.
Who can run this cmdlet: By default, members of the following groups are authorized to run the Remove-CsQoEConfiguration cmdlet locally: RTCUniversalServerAdmins. To return a list of all the role-based access control (RBAC) roles this cmdlet has been assigned to (including any custom RBAC roles you have created yourself), run the following command from the Windows PowerShell prompt:
Get-CsAdminRole | Where-Object {$_.Cmdlets –match "Remove-CsQoEConfiguration"}
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
Identity |
Required |
XdsIdentity |
The unique identifier of the settings you want to remove. Possible values are global and site:<site name>, where <site name> is the name of the site in your Microsoft Lync Server 2010 deployment with the settings to be removed. |
Force |
Optional |
SwitchParameter |
Suppresses any confirmation prompts that would otherwise be displayed before making changes. |
WhatIf |
Optional |
SwitchParameter |
Describes what would happen if you executed the command without actually executing the command. |
Confirm |
Optional |
SwitchParameter |
Prompts you for confirmation before executing the command. |
Input Types
Microsoft.Rtc.Management.WritableConfig.Settings.QoE.QoESettings object. Accepts pipelined input of QoE configuration objects.
Return Types
This cmdlet does not return a value or object. Instead, it removes instances of the Microsoft.Rtc.Management.WritableConfig.Settings.QoE.QoESettings object.
Example
-------------------------- Example 1 --------------------------
Remove-CsQoEConfiguration -Identity site:Redmond
The preceding command uses Remove-CsQoEConfiguration to remove the QoE settings assigned to the site Redmond. Using the Identity parameter ensures that only the settings assigned to the specified site will be removed.
-------------------------- Example 2 --------------------------
Get-CsQoEConfiguration -Filter site:* | Remove-CsQoEConfiguration
The command shown in Example 2 removes all the QoE settings that have been assigned at the site scope. To do this, the command first uses Get-CsQoEConfiguration and the Filter parameter to retrieve the appropriate QoE settings; the wildcard string "site:*" ensures that only those settings that have an identity beginning with the string value site: are returned. The filtered collection is then passed to Remove-CsQoEConfiguration, which deletes all the items in the collection.
-------------------------- Example 3 --------------------------
Get-CsQoEConfiguration | Where-Object {$_.KeepQoEDataForDays -lt 30} | Remove-CsQoEConfiguration
In Example 3, any QoE settings where the KeepQoEDataForDays property is less than 30 are deleted. To carry out this task, the command calls Get-CsQoEConfiguration, without any parameters, in order to return a collection of all the QoE settings currently in use in the organization. This collection is then piped to the Where-Object cmdlet, which picks out only those settings where the KeepQoEDataForDays property is less than (-lt) 30 days. In turn, the filtered collection is piped to Remove-CsQoEConfiguration, which deletes each item in that collection.