Topic Last Modified: 2013-02-21

Creates a new collection of reporting configuration settings at the service scope. Reporting configuration settings are used to specify the URL used to access Lync Server 2013 Monitoring Reports. This cmdlet was introduced in Lync Server 2013.

Syntax

New-CsReportingConfiguration -Identity <XdsIdentity> [-Confirm [<SwitchParameter>]] [-Force <SwitchParameter>] [-InMemory <SwitchParameter>] [-ReportingUrl <String>] [-WhatIf [<SwitchParameter>]]

Examples

Example 1

The command shown in Example 1 creates a new collection of reporting configuration settings assigned to the monitoring database with the identity service:MonitoringDatabase:atl-sql-001.litwareinc.com. In this example, the value of the ReportingUrl property is set to "https://atl-sql-001.litwareinc.com/lync_reports".

Copy Code
New-CsReportingConfiguration -Identity "service:MonitoringDatabase:atl-sql-001.litwareinc.com" -ReportingUrl "https://atl-sql-001.litwareinc.com/lync_reports"

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.

If you do not know the URL for the Monitoring Reports home page you can determine that URL by doing the following:

  1. Open the SQL Server Reporting Services Configuration Manager for the SQL Server instance that contains your monitoring database.

  2. In the Configuration Manager, click Report Manager URL and then click the URL for your Monitoring Reports. If you see two URLs, click the one that uses the https protocol.

  3. In SQL Server Reporting Services, click LyncServerReports.

  4. On the LyncServerReports page, click Reports Home Page. That will take you to the home page for the Monitoring Reports. You can then copy the URL and use that URL in conjunction with the CsReportingConfiguration cmdlets.

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 "New-CsReportingConfiguration"}

Lync Server Control Panel: The functions carried out by the New-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 to be associated with the new reporting configuration settings. 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.

InMemory

Optional

System.Management.Automation.SwitchParameter

Creates an object reference without actually committing the object as a permanent change. If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet’s matching Set- cmdlet.

ReportingUrl

Optional

System.String

URL for the Lync Server 2013 Monitoring Reports.

WhatIf

Optional

System.Management.Automation.SwitchParameter

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

Input Types

None. The New-CsReportingConfiguration cmdlet does not accept pipelined data.

Return Types

The New-CsReportingConfiguration cmdlet creates new instances of the Microsoft.Rtc.Management.WritableConfig.Settings.Reporting.ReportingConfiguration object.

See Also