Get-CsQoEConfiguration
Topic Last Modified: 2012-03-23
Retrieves one or more collections of Quality of Experience (QoE) settings.
Syntax
Get-CsQoEConfiguration [-Identity <XdsIdentity>] [-LocalStore <SwitchParameter>]
Get-CsQoEConfiguration [-Filter <String>] [-LocalStore <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 retrieve settings that configure QoE at the global or site level.
QoE is part of the Monitoring Server role; therefore Monitoring Server must be deployed on your Microsoft Lync Server 2010 installation before QoE recording takes effect or any QoE data can be collected.
Who can run this cmdlet: By default, members of the following groups are authorized to run the Get-CsQoEConfiguration cmdlet locally: RTCUniversalUserAdmins, 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 "Get-CsQoEConfiguration"}
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
Identity |
Optional |
XdsIdentity |
The unique identifier of the settings you want to retrieve. Possible values are global and site:<site name>, where <site name> is the name of the site in your Lync Server 2010 deployment to which you want to apply the changes. |
Filter |
Optional |
String |
Enables you to use wildcard characters in order to return a collection (or multiple collections) of QoE configuration settings. To return a collection of all the settings configured at the site scope, use this syntax: -Filter site:*. To return a collection of all the settings that have the string value "Western" somewhere in their Identity (the only property you can filter on) use this syntax: -Filter *Western*. |
LocalStore |
Optional |
SwitchParameter |
Retrieves the settings from the local replica of the Central Management store. |
Input Types
None.
Return Types
Get-CsQoEConfiguration returns instances of the Microsoft.Rtc.Management.WritableConfig.Settings.QoE.QoESettings object.
Example
-------------------------- Example 1 --------------------------
Get-CsQoEConfiguration
This example uses Get-CsQoEConfiguration to return a collection of all the QoE settings configured for use in your organization.
-------------------------- Example 2 --------------------------
Get-CsQoEConfiguration -Identity site:Redmond
Example 2 uses the Identity parameter to ensure that Get-CsQoEConfiguration returns only the QoE settings with the Identity site:Redmond.
-------------------------- Example 3 --------------------------
Get-CsQoEConfiguration -Filter site:*
In Example 3 the Filter parameter is used to return all the QoE settings that have been configured at the site scope. The wildcard "site:*" returns all the QoE settings that have an Identity beginning with the string value site:. Settings that meet those criteria are settings that have been configured at the site scope.
-------------------------- Example 4 --------------------------
Get-CsQoEConfiguration | Where-Object {$_.KeepQoEDataForDays -lt 30}
The preceding example returns a collection of all the QoE settings where the KeepQoEDataForDays property is less than 30 days. To do this, the command first uses Get-CsQoEConfiguration to return a collection of all the QoE settings configured in the organization. That collection is then piped to the Where-Object cmdlet, which applies a filter that limits the returned data to those settings that have a KeepQoEDataForDays value of less than 30 days.