Edit

Share via


Get-CsQoEConfiguration

Retrieves one or more collections of Quality of Experience (QoE) settings. This cmdlet was introduced in Lync Server 2010.

Syntax

Identity

Get-CsQoEConfiguration
    [[-Identity] <XdsIdentity>]
    [-LocalStore]
    [<CommonParameters>]

Filter

Get-CsQoEConfiguration
    [-Filter <String>]
    [-LocalStore]
    [<CommonParameters>]

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 Skype for Business Server 2015 installation before QoE recording takes effect or any QoE data can be collected.

Examples

Example 1

Get-CsQoEConfiguration

This example uses the Get-CsQoEConfiguration cmdlet 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 the Get-CsQoEConfiguration cmdlet 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}

Example 4 returns a collection of all the QoE settings where the KeepQoEDataForDays property is less than 30 days. To do this, the command first uses the Get-CsQoEConfiguration cmdlet 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.

Parameters

-Filter

Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019

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*

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

Filter
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Identity

Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019

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 Skype for Business Server deployment to which you want to apply the changes.

Parameter properties

Type:XdsIdentity
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

Identity
Position:2
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-LocalStore

Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019

Retrieves the settings from the local replica of the Central Management store.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

None

Outputs

Microsoft.Rtc.Management.WritableConfig.Settings.QoE.QoESettings