Topic Last Modified: 2013-02-21

Removes an existing collection of reporting configuration settings. Reporting configuration settings are used to specify the URL for installations of Lync Server 2013 Monitoring Reports. This cmdlet was introduced in Lync Server 2013.

Syntax

Remove-CsReportingConfiguration -Identity <XdsIdentity> [-Confirm [<SwitchParameter>]] [-Force <SwitchParameter>] [-WhatIf [<SwitchParameter>]]

Examples

Example 1

In Example 1, the reporting configuration settings with the Identity service:MonitoringDatabase:atl-sql-002.litwareinc.com are removed.

Copy Code
Remove-CsReportingConfiguration -Identity "service:MonitoringDatabase:atl-sql-002.litwareinc.com"

Example 2

In Example 2, all the reporting configuration settings currently in use in the organization are removed. To do this, the command first uses the Get-CsReportingConfiguration cmdlet to return a collection of all the reporting configuration settings. This collection is then piped to the Remove-CsReportingConfiguration cmdlet, which removes each item in the collection.

Copy Code
Get-CsReportingConfiguration | Remove-CsReportingConfiguration

Example 3

The command shown in Example 3 deletes any reporting configuration settings where the reporting URL is set to https://atl-sql-002.litwareinc.com/lync_reports. To carry out this task, the command first uses the Get-CsReportingConfiguration cmdlet to return all the reporting configuration settings currently in use. This collection is then piped to the Where-Object cmdlet, which selects only those settings where the ReportingURL property is equal to https://atl-sql-002.litwareinc.com/lync_reports. That filtered collection is then piped to the Remove-CsReportingConfiguration cmdlet, which removes each item in the collection.

Copy Code
Get-CsReportingConfiguration | Where-Object {$_.ReportingUrl -eq "https://atl-sql-002.litwareinc.com/lync_reports" | Remove-CsReportingConfiguration

Detailed Description

Reporting configuration settings are used to specify the home page for the Lync Server Monitoring Reports; if you are not using Monitoring Reports then there is no reason for you to modify the reporting configuration settings.

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 command-line interface prompt:

Get-CsAdminRole | Where-Object {$_.Cmdlets –match "Remove-CsReportingConfiguration"}

Lync Server Control Panel: The functions carried out by the Remove-CsReportingConfiguration cmdlet are not available in the Lync Server Control Panel.

Parameters

Parameter Required Type Description

Identity

Required

Microsoft.Rtc.Management.Xds.XdsIdentity

Service Identity of the monitoring database whose reporting configuration settings are to be removed. For example:

-Identity "Service:MonitoringDatabase:atl-sql-001.litwareinc.com"

Confirm

Optional

System.Management.Automation.SwitchParameter

Prompts you for confirmation before executing the command.

Force

Optional

System.Management.Automation.SwitchParameter

Suppresses the display of any non-fatal error message that might occur when running the command.

WhatIf

Optional

System.Management.Automation.SwitchParameter

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

Input Types

The Remove-CsReportingConfiguration cmdlet accepts pipelined instances of the Microsoft.Rtc.Management.WritableConfig.Settings.Reporting.ReportingConfiguration object.

Return Types

None. Instead, the Remove-CsReportingConfiguration cmdlet deletes existing instances of the Microsoft.Rtc.Management.WritableConfig.Settings.Reporting.ReportingConfiguration object.

See Also