Export (0) Print
Expand All
Expand Minimize

Set-CsQoEConfiguration

 

Topic Last Modified: 2013-02-21

Modifies an existing collection of QoE (Quality of Experience) settings. This cmdlet was introduced in Lync Server 2010.

Set-CsQoEConfiguration [-Identity <XdsIdentity>] <COMMON PARAMETERS>
Set-CsQoEConfiguration [-Instance <PSObject>] <COMMON PARAMETERS>
COMMON PARAMETERS: [-Confirm [<SwitchParameter>]] [-EnableExternalConsumer <$true | $false>] [-EnablePurging <$true | $false>] [-EnableQoE <$true | $false>] [-ExternalConsumerIssuedCertId <IssuedCertId>] [-ExternalConsumerName <String>] [-ExternalConsumerURL <String>] [-Force <SwitchParameter>] [-KeepQoEDataForDays <UInt32>] [-PurgeHourOfDay <UInt32>] [-WhatIf [<SwitchParameter>]]

The command in Example 1 uses the Set-CsQoEConfiguration cmdlet to modify the Quality of Experience settings for the Redmond site (-Identity site:Redmond). The new settings turn off QoE by setting the EnableQoE parameter to False.

Set-CsQoEConfiguration -Identity site:Redmond -EnableQoE $False

This command modifies QoE settings that apply to the Dublin site. In this example we’ve set the KeepQoEDataForDays parameter to 45, so QoE data will be purged from the database after 45 days. In addition, we’ve set the PurgeHourOfDay parameter to 4, meaning any data older than the 45 days we just specified will be purged at 4:00 AM.

Note: If you have enabled QoE and call detail recording (CDR), for performance reasons it’s a good idea to make sure the PurgeHourOfDay setting is different for QoE than for CDR.

Set-CsQoEConfiguration -Identity site:Dublin -KeepQoEDataForDays 45 -PurgeHourOfDay 4

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 modify 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 Lync Server 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 Set-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 "Set-CsQoEConfiguration"}

 

Parameter Required Type Description

Confirm

Optional

System.Management.Automation.SwitchParameter

Prompts you for confirmation before executing the command.

EnableExternalConsumer

Optional

System.Boolean

Specifies whether an external consumer is able to receive QoE reports.

EnablePurging

Optional

System.Boolean

Specifies whether records will be purged after the duration defined in the KeepQoEDataForDays property has elapsed.

EnableQoE

Optional

System.Boolean

Specifies whether QoE records will be collected and saved to the monitoring database.

Note that even if EnableQoE is set to True, QoE data will not be collected unless a Monitoring Server has been deployed and associated with a Registrar pool.

ExternalConsumerIssuedCertId

Optional

Microsoft.Rtc.Management.WritableConfig.BaseTypes.IssuedCertId

The certificate ID of the certificate that allows access to the external consumer web service.

ExternalConsumerName

Optional

System.String

The friendly name of the external consumer of the QoE report.

ExternalConsumerURL

Optional

System.String

The URL of the external consumer to which the QoE reports will be posted.

Force

Optional

System.Management.Automation.SwitchParameter

Suppresses any confirmation prompts that would otherwise be displayed before making changes.

Identity

Optional

Microsoft.Rtc.Management.Xds.XdsIdentity

The unique identifier of the settings you want to modify. Possible values are global and site:<site name>, where <site name> is the name of the site in your Lync Server deployment to which you want to apply the changes.

Instance

Optional

QoESettings

An object reference to a QoE configuration object. This object must be of type QoESettings and can be retrieved by calling the Get-CsQoEConfiguration cmdlet.

KeepQoEDataForDays

Optional

System.UInt32

The number of days QoE data will be stored before being purged from the database. This value is ignored if EnablePurging is set to False.

Must be a value from 1 through 2562.

PurgeHourOfDay

Optional

System.UInt32

The hour of the day that QoE records that have exceeded the number of days specified in the KeepQoEDataForDays property will be purged.

Must be a value 0 through 23, representing the hour of the day. For example, 0 would be midnight, 13 would be 1:00 PM.

WhatIf

Optional

System.Management.Automation.SwitchParameter

Describes what would happen if you executed the command without actually executing the command.

Microsoft.Rtc.Management.WritableConfig.Settings.QoE.QoESettings object. Accepts pipelined input of QoE configuration objects.

The Set-CsQoEConfiguration cmdlet does not return a value or object. Instead, the cmdlet configures instances of the Microsoft.Rtc.Management.WritableConfig.Settings.QoE.QoESettings object.

 
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft