Set-CsQoEConfiguration
Topic Last Modified: 2012-03-26
Modifies an existing collection of QoE (Quality of Experience) settings.
Syntax
Set-CsQoEConfiguration [-Identity <XdsIdentity>] [-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>]]
Set-CsQoEConfiguration [-Confirm [<SwitchParameter>]] [-EnableExternalConsumer <$true | $false>] [-EnablePurging <$true | $false>] [-EnableQoE <$true | $false>] [-ExternalConsumerIssuedCertId <IssuedCertId>] [-ExternalConsumerName <String>] [-ExternalConsumerURL <String>] [-Force <SwitchParameter>] [-Instance <PSObject>] [-KeepQoEDataForDays <UInt32>] [-PurgeHourOfDay <UInt32>] [-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 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 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 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"}
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
Identity |
Optional |
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 2010 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 Get-CsQoEConfiguration. |
EnableExternalConsumer |
Optional |
Boolean |
Specifies whether an external consumer is able to receive QoE reports. |
EnablePurging |
Optional |
Boolean |
Specifies whether records will be purged after the duration defined in the KeepQoEDataForDays property has elapsed. |
EnableQoE |
Optional |
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 |
IssuedCertId |
The certificate ID of the certificate that allows access to the external consumer web service. |
ExternalConsumerName |
Optional |
String |
The friendly name of the external consumer of the QoE report. |
ExternalConsumerURL |
Optional |
String |
The URL of the external consumer to which the QoE reports will be posted. |
KeepQoEDataForDays |
Optional |
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 |
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. |
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
Set-CsQoEConfiguration does not return a value or object. Instead, the cmdlet configures instances of the Microsoft.Rtc.Management.WritableConfig.Settings.QoE.QoESettings object.
Example
-------------------------- Example 1 --------------------------
Set-CsQoEConfiguration -Identity site:Redmond -EnableQoE $False
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.
-------------------------- Example 2 --------------------------
Set-CsQoEConfiguration -Identity site:Dublin -KeepQoEDataForDays 45 -PurgeHourOfDay 4
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.