CLSController
Managed using ClsController.exe. Run this from the command prompt with elevated permissions which have access to the Lync CMS.
Ports 50001, 50002 and 50003 need to be open on each server. This should be configured in Windows Firewall automatically during installation, however the Edge server for example will need some holes from the DMZ to Internal.
C:Program FilesCommon FilesMicrosoft Lync Server 2013ClsAgentClsController.exe
The typical sequence of commands you want to run are:
ClsController.exe -start –scenario <scenario> –pools <pool fqdn>
Repro issue
ClsController.exe -stop –scenario <scenario> –pools <pool fqdn>
ClsController.exe -flush –pools <pool fqdn>
ClsController.exe -search –pools <pool fqdn> –components <component> –loglevel <loglevel>
Scenario Comparisons
|
Description
|
Centralised Logging Tool Scenario
|
Lync 2010 Logging Tool Components
|
|
AlwaysOn is a special scenario that can be enabled to log all the time. The AlwaysOn scenatio can run in conjunction with one other scenario.
|
AlwaysOn
|
AsMcu
AcpMcu
AVMCU
AVMP
BICommon
BICOSMOS
BIDATACOLLECTOR
CAAServer
Collaboration
DataMCU
DataMcuRuntime
ExumRouting
IMMCU
InboundRouting
InterClusterRouting
McuInfra
MediationServer
OutboundRouting
Routing_Data_Sync_Agent
S4
ServerTransportAdaptor
Sipstack
LDM
AppShareOoty
RDPApiTrace
RDPEncComTrace
RdpApiTrace
UserServices
UDCAgent
PNCHService
TenantAdminUI
HostedMigration
Powershell
UCWA
ChatCommon
ChatEndpoint
ChatServer
ChatCompliance
ChatWebService
XmppTGW
XmppCommonLibrary
XmppListener
XmppRouting
XmppTGWProxy
Lyss
StoreWeb
TranslationApplication
RgsClientsLib
RgsCommonLibrary
RgsDatastores
RgsDiagnostics
RgsHostingFramework
RgsMatchMakingService
CpsDiagnostics
CpsHostingFramework
JoinLauncher
WebInfrastructure
Infrastructure
InternalCommon
McxService
UserPinService
CertProvisioning
BackupService
RtcDbSyncAgent
WebRelay
ServerAgent
|
|
Media related logging
|
MediaConnectivity
|
MediaStack_AUDIO_AGC
MediaStack_AUDIO_DRC
MediaStack_AUDIO_ECHODT
MediaStack_AUDIO_FAXDT
MediaStack_AUDIO_HEALER
MediaStack_AUDIO_NOISEDT
MediaStack_AUDIO_VAD
MediaStack_AUDIO_VSP
MediaStack_AudioCodecs
MediaStack_AudioEngine
MediaStack_COMAPI
MediaStack_COMMON
MediaStack_Crossbar
MediaStack_Crypto
MediaStack_DebugUI
MediaStack_DebugUI_AEC
MediaStack_DEVICE
MediaStack_MassConvertedTraces1
MediaStack_MediaManager
MediaStack_PerFrame
MediaStack_PerPacket
MediaStack_QualityController
MediaStack_RTCP
MediaStack_RTP
MediaStack_StreamingEngine
MediaStack_TLS
MediaStack_Transport
MediaStack_VIDEO
MediaStack_VOICEENHANCE
|
|
Application Sharing
|
ApplicationSharing
|
AsMcu
AppShareOoty
ServerTransportAdaptor
RDPApiTrace
RDPEncComTrace
MCUInfra
Collaboration
S4
|
|
Audio and Video Conferencing Logging
|
AudioVideoConferencingIssue
|
AvMcu
AvMP
MCUInfra
Collaboration
S4
|
|
Hybrid Cloud voice deployments
|
HybridVoice
|
MediationServer
S4
Sipstack
OutboundRouting
TranslationApplication
|
|
General Call logging
|
IncomingAndOutgoingCall
|
MediationServer
S4
Sipstack
TranslationApplication
OutboundRouting
InboundRouting
UserServices
|
|
Voice Mail
|
VoiceMail
|
Sipstack
ExumRouting
InboundRouting
|
|
IM and Presence Logging
|
IMAndPresence
|
Sipstack
UserServices
|
|
Address Book service logging
|
AddressBook
|
ABCommon
ABServer
ABServerIISModule
Dlx
|
|
Device Update service logging
|
DeviceUpdate
|
DeviceUpdate
DeviceUpdateHttpHandler
|
|
Lync Storage Service and Unified Contact Store logging
|
LYSSAndUCS
|
UserServices
Lyss
McuInfra
|
|
Centralised Logging Service logging
|
CLS
|
CLSAgent
CLSCommon
CLSController
CLSControllerLib
|
|
Support Portal logging
|
SP
|
SupportPortal
SPHelper
SPModule
SPSearchTool
SPCLSTool
CLSCommon
CLSControllerLib
|
|
Web Access Server logging
|
WAC
|
DataMCURunTime
DataMCU
LDM
Infrastructure
WebInfrastructure
InternalCommon
|
|
User Replicator Service (synchronization between AD DS and Lync Server)
|
UserReplicator
|
UserServices
|
|
Lync Online Migration
|
HostedMigration
|
HostedMigration
Powershell
WebInfrastructure
|
|
Monitoring and Archiving logging
|
MonitoringAndArchiving
|
UDCAgent
|
|
LILRLegacy
|
LILRLegacy
|
LogRetention
LegalIntercept
|
|
LILRLYSS
|
LILRLYSS
|
LogRetention
UDCAgent
|
|
Meeting logging
|
MeetingJoin
|
Collaboration
S4
UserServices
McuInfra
JoinLauncher
WebInfrastructure
Infrastructure
InternalCommon
UCWA
WebRelay
|
|
Response Group Service
|
RGS
|
RgsClientsLib
RgsCommonLibrary
RgsDatastores
RgsDeploymentApi
RgsDeploymentLibrary
RgsDiagnostics
RgsHostingFramework
RgsMatchMakingService
UserServices
Collaboration
S4
Sipstack
|
|
Call Park Service
|
CPS
|
CpsDiagnostics
CpsHostingFramework
UserServices
Collaboration
S4
Sipstack
|
|
XMPP service logging
|
XMPP
|
XmppTGW
XmppCommonLibrary
XmppListener
XmppRouting
XmppTGWProxy
Collaboration
S4
Sipstack
|
|
Conference Auto Attendant
|
CAA
|
CAAServer
Collaboration
S4
Sipstack
UserServices
|
|
Dial in conferencing MCU
|
ACPMCU
|
AcpMcu
Collaboration
S4
SipStack
|
|
Authentication Logging
|
Authentication
|
SipStack
UserServices
WebInfrastructure
UserPinService
CertProvisioning
|
|
High Availability
Disaster Recovery
|
HADR
|
UserServices
PowerShell
BackupService
RtcDbSyncAgent
|
|
Powershell
|
Powershell
|
Powershell
|
|
FilterApps
|
FilterApps
|
IIMFilter
ClientVersionFilter
ServerAgent
SipStack
|
Other Useful Commands
Show-CsClsLogging – Use to show the CLS status.
Stop-CsClsLogging – Use to stop a scenario
Start-CsClsLogging – Use to start a scenario
Get-CsClsScenario – Use to get information on the scenarios in your Lync deployment
The default folder for temp files is C:WindowsServiceProfilesNetworkServiceAppDataLocalTempTracing seen by running Get-CsClsConfiguration.
I occasionally see the following error:
Failed on 1 agents
Agent – pool.domain.com, Reason – Error code – 20003, Message – Unknown error returned by Wpp native assembly – 1168. Please refer CLS logs for details.
Usually persistence will get around this – Try again until it works 🙂
To make life easier for your self James Cussen has written a PowerShell GUI for the Logging service which can be found here – http://www.mylynclab.com/2013/04/lync-2013-centralised-logging-tool.html
Cheers to James and Jens –
http://www.mylynclab.com/2013/04/lync-2013-centralised-logging-tool.html
http://blogs.technet.com/b/jenstr/archive/2012/08/01/using-centralized-logging-service-in-lync-server-2013-preview.aspx
