Export (0) Print
Expand All
Expand Minimize
This topic has not yet been rated - Rate this topic

Get-CsReportingConfiguration

Lync Server 2013
 

Topic Last Modified: 2013-02-21

Returns information about the reporting configuration settings in use in the organization. Reporting configuration settings are used to specify the URL used for accessing Lync Server 2013 Monitoring Reports. This cmdlet was introduced in Lync Server 2013.

Get-CsReportingConfiguration [-Identity <XdsIdentity>] <COMMON PARAMETERS>
Get-CsReportingConfiguration [-Filter <String>] <COMMON PARAMETERS>
COMMON PARAMETERS: [-LocalStore <SwitchParameter>]

The command shown in Example 1 returns information for all the reporting configuration settings currently in use in the organization.

Get-CsReportingConfiguration

In Example 2, information is returned for a single collection of reporting configuration settings: the settings with the Identity "Service:MonitoringDatabase:atl-sql-001.litwareinc.com".

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

In Example 3, information is returned for all the reporting configuration settings that have an Identity that ends in ".litwareinc.com". To do this, the command uses the Filter parameter and the filter value "*.litwareinc.com".

Get-CsReportingConfiguration -Filter "*.litwareinc.com"

Example 4 returns information for all the reporting configuration settings that include the string value "_ARCHINST" somewhere in their reporting URL. To do this the command first uses the Get-CsReportingConfiguration cmdlet to return a collection of all the reporting configuration settings currently in use. This collection is then piped to the Where-Object cmdlet, which picks out only those settings where the ReportingUrl includes (-like) the string value "_ARCHINST".

Get-CsReportingConfiguration | Where-Object {$_.ReportingUrl -like "*_ARCHINST*"}

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 "Get-CsReportingConfiguration

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

 

Parameter Required Type Description

Filter

Optional

System.String

Enables you to use wildcard characters when specifying the reporting configuration settings to be returned. For example, this syntax returns all the settings configured at the service scope:

-Filter "service:*"

Note that you cannot use both the Filter and the Identity parameters in the same command.

Identity

Optional

Microsoft.Rtc.Management.Xds.XdsIdentity

Service Identity of the monitoring database associated with the reporting configuration settings. For example:

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

If you do not include either the Identity parameter or the Filter parameter in your command, then the Get-CsReportingConfiguration cmdlet will return all the reporting configuration settings in use in your organization.

LocalStore

Optional

System.Management.Automation.SwitchParameter

Retrieves the reporting configuration data from the local replica of the Central Management store rather than from the Central Management store itself.

None. The Get-CsReportingConfiguration cmdlet does not accept pipelined input.

The Get-CsReportingConfiguration cmdlet returns instances of the Microsoft.Rtc.Management.WritableConfig.Settings.Reporting.ReportingConfiguration object.

 
Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft. All rights reserved.