GSX Blog

Best practices: Track usage of Lync Online with PowerShell and REST Web Services

Posted by Arnaud Buonaccorsi on Wed, Oct 08, 2014

Lync13Logo 300x300Lync Online was released in 2010. Since end of 2013 you can access nice reports in the interface. However they are a little bit limited and not very flexible. Here is the list of reports you can find in UI: 

Peer to peer session reports:

• Total number of P2P sessions
• Number of IM sessions
• Number of audio sessions
• Number of video sessions
• Number of application sharing sessions
• Number of file transfer sessions

Conference reports:

• Total number of conferences
• Number of IM conferences
• Number of AV conferences
• Number of application sharing conferences
• Number of web conferences
• Number of telephony conferences

Microsoft provides PowerShell cmdlets and the REST reporting web service to access those reports. Here is a list of what you can find:

describe the image

PowerShell commands require some scripting knowledge to be used but remain very accessible. Rest Web Service is more oriented for programming in C# or VB#.
PowerShell allows to see user activities and voice usage or different metrics.  First you have to open a remote PowerShell session to be sure that you can monitor your Lync Online. You could use this script to connect:

cred = Get-Credential   (provide your Lync Online administrator credentials)
$lyncSession = New-CsOnlineSession -Credential $cred
Import-PSSession $lyncSession -AllowClobber

Now you're connected on your tenant, you can pass some command. Here are some examples:

• If you wish to see the amount of active users on your Lync architecture since 3 months use this :

Get-CsActiveUserReport -ReportType Monthly -StartDate 06/01/2014 -EndDate 09/30/2014

You will get the following output:
 blog arnaud t2 resized 600

• If you need to know how long meeting conferences have been used in August you can use a script like this :

Get-CsAVConferenceTimeReport -ReportType Monthly -StartDate 08/01/2014 -EndDate 08/30/2013

• If you need to have the time P@P sessions has been used between Lync users in the cloud use this:

Get-CsP2PAVTimeReport -ReportType Monthly -StartDate 06/01/2014 -EndDate 06/30/2014

You will get this report:

blog arnaud t4 resized 600

For each command you can specify the start and end date aswell as the type of report: daily, weekly, monthly, yearly.

• If you need to know all possible commands available you can use this command:

Get-Command –Module <LyncOnlineModuleName>

Of course not everone is online and you cannot get any information on the system or the response times. If you need to test a good solution for Lync On-premises or if you want to see the response time between your On-premises communication system and your cloud, you can try the GSX offer for Lync here: 

Fully agentless, GSX Monitor & Analyzer acts as a Robot User, sitting on a virtual machine or any laptop to automatically discover, display, troubleshoot and report on the health of your Lync environments by using applications as would an administrator. GSX Monitor & Analyzer provides pinpoint alerts that enable administrators to anticipate and avoid any system outages.


describe the image

Tags: Lync Monitoring Lync Online Lync Reporting Lync Ou, Best practices