Lync 2013 Centralised Logging Deep Dive

April 7, 2013, 12:19 am

≫ Next: Lync 2013 Centralised Logging Tool

Overview

Lync 2013 brings with it a new form of logging that differs greatly from the logging tools previously supplied in Lync 2010. In Lync 2010 the Lync Logging Tool offered the ability to log directly on a single server in a pool. As a result, in Lync 2010 logging across a pool of ten servers requires running the logging tool on multiple servers at once, which can be a cumbersome undertaking.

Lync 2013 has new capability called the Centralised Logging Service. The new logging service consists of two main components, a Logging Controller, and a Logging Agent. The Logging Agent runs on each of the Lync Front End servers, under the service name “Lync Server Centralised Logging Service Agent”.

The service runs the ClsAgent.exe executable and listens for commands on the following ports: TCP 50001, TCP 50002, and TCP 50003. This can be seen using netstat:

When the agent receives a command, it sends messages to the defined components for tracing, and writes the trace logs to disk. It also reads the trace logs for its computer and sends the trace data back to the controller when requested.

The Second component used for centralised logging is the Centralised Logging Controller. The Centralised Logging Controller sends Start, Stop, Flush, and Search commands to the ClsAgents on all the servers in a specified pool. The Lync 2013 Preview release contained a command line tool called ‘ClsController.exe’ (which still exists in the RTM release) that could be used to control the Centralised Logging Agents on the Lync Front End servers. The release of Lync 2013 RTM has taken this a step forward offering Powershell commands that send commands through a Dynamic Link Library called “ClsControllerLib.dll”.

When search commands are sent, the resulting logs are returned to the ClsControllerLib.dll and aggregated. The controller is responsible for sending commands to the agent, receiving the status of those commands and managing the search log file data as it is returned from the agents, and aggregating the log data into a meaningful and ordered output set.

Here is a diagram of the relationship between the two Controller and Agents:

The documentation now available on TechNet states that two scenarios can be run on a given computer at any one point in time. What this actually means in practice is that you can run one default or custom scenario, in addition to AlwaysOn logging. Even if you have AlwaysOn logging turned off, you can’t run multiple other scenarios at once. If you are in a situation where you need to run multiple default scenarios at once, then you can create your own custom scenario that includes all of the logging providers used by the default scenarios you are trying to emulate (see the Custom Scenarios section of this post).

How Does Centralised Logging compare to Lync 2010 Logging Tool?

So, what are all these weird scenario names and how do they relate to my favourite Lync Logging Tool filters (SIPStack, S4, etc)? I’m glad you asked, and I made this table to help you understand what the new Scenarios are doing in the background. The following table shows the default scenario names used for centralised logging, and the components that are logged for each of these scenarios.

Lync 2010 Logging Tool

The third column in this table relates to the Components from the old Lync Logging Tool (which is incidentally still available for download for Lync 2013 in the Debugging tools install). The components list can be seen on the left hand side of the tool.

Logging Comparison Table

The table explains which components get used for each default logging scenario in Lync 2013 centralised logging.

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

What is AlwaysOn Logging?

AlwaysOn is a setting that can be made on a pool that forces the pool to be logging all the time. When you run a Show-CsClsLogging on your server you can see that AlwaysOn gets its own separate status shown in the output:

> Show-CsClsLogging

Success Code - 0, Successful on 1 agents

Tracing Status:

2013STDFE001.mylynclab.com (2013STDFE001 v5.0.8308.0) (AlwaysOn=No,Scenario=HostedMigration,Started=

4/6/2013 11:25:47 PM,By=2013STDPC\Administrator,Duration=0.04:00)

2013STDFE001.mylynclab.com (2013STDFE001 v5.0.8308.0) (Same as pool)

This is because AlwaysOn functions as an everyday log that can be used to troubleshoot issues that might have happened during the day. The AlwaysOn logging scenario logs for all of the components available, at an Infolevel, as shown below:

> Get-CsClsScenario | Where-Object {$_.identity -like "Global/AlwaysOn"} | Select-Object provider | Select-Object -ExpandProperty provider

Name : AsMcu

Type : WPP

Level : Info

Flags : TF_COMPONENT,TF_PROTOCOL

Name : AcpMcu

Type : WPP

Level : Info

Flags : TF_COMPONENT

Name : AVMCU

Type : WPP

Level : Info

Flags : TF_COMPONENT,TF_PROTOCOL

Continued...

So, if you are running AlwaysOn already on a pool, then the only reason you would need to run another scenario at the same time would be to log at a higher level of detail (eg. Debug). Note, only one additional scenario can be logging at the same time as AlwaysOn is running.

If you run a Search-CsClsLogging (with no filters) on a scenario, at the same time as AlwaysOn was logging, you will receive the AlwaysOn logging in the output file as well. As a result, if you need to do very specific logging, you might want to turn off the AlwaysOn logging before you start the specific scenario you want to log for (or remember to use an appropriate filter when running Search-CsClsLogging to remove the unnecessary logs).

Logging Files

Temporary log files are written to the folder on each of the Lync servers with logging enabled. All log files will be placed in the folder specified in the Get-CsClsConfiguration command, as shown below:

> Get-CsClsConfiguration

Identity : Global

Scenarios : {Name=AlwaysOn, Name=MediaConnectivity, Name=ApplicationSharing, Name=AudioVideoConferencingIssue...}

SearchTerms : {Type=Phone;Inserts=ItemE164,ItemURI,ItemSIP,ItemPII, Type=URI;Inserts=ItemURI,ItemSIP,ItemPII, Type=CallId;Inserts=ItemCALLID,ItemURI,ItemSIP,ItemPII,

Type=ConfId;Inserts=ItemCONFID,ItemURI,ItemSIP,ItemPII...}

SecurityGroups : {}

Regions : {}

EtlFileFolder : %TEMP%\Tracing

EtlFileRolloverSizeMB : 20

EtlFileRolloverMinutes : 60

TmfFileSearchPath :

CacheFileLocalFolders : %TEMP%\Tracing

CacheFileNetworkFolder :

CacheFileLocalRetentionPeriod : 14

CacheFileLocalMaxDiskUsage : 80

ComponentThrottleLimit : 5000

ComponentThrottleSample : 3

MinimumClsAgentServiceVersion : 6

Note: If you cut and paste this address into the file browser you will end up in a location like this:

C:\Users\Administrator.DOMAIN\AppData\Local\Temp\2\Tracing

Most likely this location is void of any logging files, which might leave you scratching you head. However, there is good reason for this: you’re logged in as a user on the server and as a result you’re getting taken to the temp folder of the user you’re logged in as.

Meanwhile, the Logging Service is logged in as the NetworkService (as are all Lync services), so when it accesses this address it ends up at the following folder:

C:\Windows\ServiceProfiles\NetworkService\AppData\Local\Temp\Tracing

The logs folder will have three different types of files in it: ETL, HDR and CACHE files. Currently running logging services are streaming to ETL files (eg. CLS_WPP_04-05-2013-13-34-46_1.etl). When the logging is stopped the ETL file content gets converted into an HDR and a CACHE file.

The HDR file contains information about the capture, eg:

AgentVersion=2.0

Starttime=5/04/2013 2:27:11 AM

Endtime=5/04/2013 2:30:26 AM

MostSevereLevel=3

ComponentNames=(Shared),SIPStack,UserServices

CorrelationIds=0,2446939738,2446939785,2899899976,2970877857,1910046407,2765731706,1926842570,947404259,3734898740,3285769719,2895070652,2630969344,1910046457,3397217402,3308872234,2765731776,1484520309,1137574355

The CACHE file is an actual logging file that contains the information that was logged. Sections of this file are in binary, and sections in clear text. The CACHE file cannot be directly opened in Snooper. In order to do this you must run the Search-CsClsLogging command to retrieve the correct format.

Other Useful Centralised Logging Settings

There are a number of other useful settings within Get-CsClsConfiguration that might be of use to you when it comes to finely tuning your logging solution. Here are some settings that you might consider tweaking:

EtlFileRolloverSizeMB : 20

EtlFileRolloverMinutes : 60

TmfFileSearchPath :

CacheFileLocalFolders : %TEMP%\Tracing

CacheFileNetworkFolder :

CacheFileLocalRetentionPeriod : 14

CacheFileLocalMaxDiskUsage : 80

ComponentThrottleLimit : 5000

ComponentThrottleSample : 3

EtlFileRolloverSizeMB: Maximum size (in megabytes) that at event trace log file can reach before a new file is created. The default value is 20.

EtlFileRolloverMinutes: Maximum amount of time (in minutes) that can elapse before a new event log trace file is created. (This new file will be created even if the existing trace file has not reached the specified rollover size.) The default value is 60.

CacheFileLocalRetentionPeriod: Maximum number of days that cache files are retained locally. The default value is 14.

CacheFileLocalMaxDiskUsage: Maximum amount of disk space (percentage) that can be used for the cache files. The default value is 80.

Creating Custom Logging Scenarios

Let me first start by explaining in a little more depth what a scenario actually is. A scenario is basically a collection of one, or many, logging streams (in Microsoft speak; ‘components’). For example, if we were to take AddressBook scenario, which logs things to do with the Address Book Service. From the table earlier we can see that the components being logged for the AddressBook scenario include ABCommon, ABServer, ABServerIISModule, and Dlx. As might be obvious by their names, these services are all directly relating to the Address Book, whereas components likeMediaStack_MediaManager have nothing to do with the AddressBook so we don’t include them in the scenario.

Put in a different way, a Scenario functions as a Pre-Capture filter that determines what is written to disk on the server running the Centralised Logging Agent Service. After this information has been logged to disk on the Agent server, the search-cslcslogging command can be used in conjunction with additional (Post-Capture) filter parameters to determine the logging output that is written to the final log file. Below is a diagram that describes the process:

Creating a custom Centralised Logging Scenario is quite simple: it’s a matter of first creating provider(s) and then creating a scenario from the providers:

Create a provider:

$provider=New-CsClsProvider-Name"AvMcu"-Type"WPP"-Level"Info"-Flags"All"

The New-CsClsProviderpage on TechNet currently (April 2013) states that the provider Nameparameter is a “Unique Name”. After reading this and looking at the command, I was left a little confused, because there are no other parameters that tell the provider what components it should be logging for. So, whilst the New-CsClsProvider command will let you create a provider with a Name of “MegaLoggingSuperLogLogger”, this isn’t a component name that means anything to the logging service. If you use this provider (with a unique name) and try and run it on an Agent it will Start successfully:

> Start-CsClsLogging -Scenario CUSTOMSCENARIO -pools 2013ENTFE004.mylynclab.com

Success Code - 0, Successful on 1 agents

Tracing Status:

2013ENTFE004.mylynclab.com (2013ENTFE004 v5.0.8308.0) (AlwaysOn=No,Scenario=CUSTOMSCENARIO,Started=4/04/2013 5:43:07 PM,By=2013ENT\Administrator,Duration=0.04:00)

2013ENTFE004.mylynclab.com (2013ENTFE004 v5.0.8308.0) (Same as pool)

It will say it’s logging when you run the Show command:

> Show-CsClsLogging

Success Code - 0, Successful on 6 agents

Tracing Status:

2013ENTFE004.mylynclab.com (2013ENTFE004 v5.0.8308.0) (AlwaysOn=No,Scenario=CUSTOMSCENARIO,Started=4/04/2013 5:43:07 PM,By=2013ENT\Administrator,Duration=0.04:00)

...

However, it will failwhen you stop correctly run the Stopcommand:

>Stop-CsClsLogging -scenario CUSTOMSCENARIO -pools 2013ENTFE004.mylynclab.com

Failed on 1 agents

Agent - 2013ENTFE004.mylynclab.com, Reason - Error code - 20005, Message - Scenario 'CUSTOMSCENARIO' not currently running.

So choosing a “Unique Name” doesn’t actually appear to be the way to go… The Name parameter should actually be the name of a component. Here is a list of Component names to choose from:

Component Names
ABCommon	InternalCommon	PNCHService
ABServer	JoinLauncher	Powershell
ABServerIISModule	LDM	RdpApiTrace
AcpMcu	LegalIntercept	RDPEncComTrace
AppShareOoty	LogRetention	RgsClientsLib
AsMcu	Lyss	RgsCommonLibrary
AvMcu	McuInfra	RgsDatastores
AVMP	McxService	RgsDeploymentApi
BackupService	MediaStack_AudioCodecs	RgsDeploymentLibrary
BICommon	MediaStack_AudioEngine	RgsDiagnostics
BICOSMOS	MediaStack_AUDIO_AGC	RgsHostingFramework
BIDATACOLLECTOR	MediaStack_AUDIO_DRC	RgsMatchMakingService
CAAServer	MediaStack_AUDIO_ECHODT	Routing_Data_Sync_Agent
CertProvisioning	MediaStack_AUDIO_FAXDT	RtcDbSyncAgent
ChatCommon	MediaStack_AUDIO_HEALER	S4
ChatCompliance	MediaStack_AUDIO_NOISEDT	ServerAgent
ChatEndpoint	MediaStack_AUDIO_VAD	ServerTransportAdaptor
ChatServer	MediaStack_AUDIO_VSP	Sipstack
ChatWebService	MediaStack_COMAPI	SPCLSTool
ClientVersionFilter	MediaStack_COMMON	SPHelper
CLSAgent	MediaStack_Crossbar	SPModule
CLSCommon	MediaStack_Crypto	SPSearchTool
CLSController	MediaStack_DebugUI	StoreWeb
CLSControllerLib	MediaStack_DebugUI_AEC	SupportPortal
Collaboration	MediaStack_DEVICE	TenantAdminUI
CpsDiagnostics	MediaStack_MassConvertedTraces1	TranslationApplication
CpsHostingFramework	MediaStack_MediaManager	UCWA
DataMCU	MediaStack_PerFrame	UDCAgent
DataMCURunTime	MediaStack_PerPacket	UserPinService
DeviceUpdate	MediaStack_QualityController	UserServices
DeviceUpdateHttpHandler	MediaStack_RTCP	WebInfrastructure
Dlx	MediaStack_RTP	WebRelay
ExumRouting	MediaStack_StreamingEngine	XmppCommonLibrary
HostedMigration	MediaStack_TLS	XmppListener
IIMFilter	MediaStack_Transport	XmppRouting
IMMCU	MediaStack_VIDEO	XmppTGW
InboundRouting	MediaStack_VOICEENHANCE	XmppTGWProxy
Infrastructure	MediationServer
InterClusterRouting	OutboundRouting

Now that you’ve created a provider and written it to a variable ($provider), it now needs to be attached to a Scenario. You do this by running New-CsClsScenario and passing it the provider as a parameter.

Attaching the provider to a new custom global scenario:

New-CsClsScenario-Identity"global/CUSTOMSCENARIO"-Provider$provider

If you would like to have a scenario with multiple providers (components) logging at once, then you can do so by passing the New-CsClsLogging command a plist with multiple providers in it.

Scenarios can be created with multiple providers, here’s how:

$LyssProvider =New-CsClsProvider-Name"Lyss"-Type"WPP"-Level"Info"-Flags"All"

$ABServerProvider =New-CsClsProvider-Name"ABSever"-Type"WPP"-Level"Info"-Flags"All"

$SIPStackProvider =New-CsClsProvider-Name"SIPStack"-Type"WPP"-Level"Info"-Flags"All"

New-CsClsScenario-Identity"global/MULTICUSTOMSCENARIO" -Provider @{Add=$LyssProvider, $ABServerProvider, $SIPStackProvider}

What about if you want to only allow administrators at a specific site to use the logging scenario? Then you can create the scenario with a site scope.

You can attach the provider to a new site specificcustom scenario:

New-CsClsScenario-Identity"site:Melbourne Site/SITECUSTOMSCENARIO"-Provider$provider

Note:After creating a Custom Site based scenario (as shown above), and you try and start any of the Default Global scenarios, you will get an error like the one below telling you that the scenario is “Unknown”:

Start-CsClsLogging : Cannot validate argument on parameter 'Scenario'. Unknown scenario name 'VoiceMail'

At C:\Users\Administrator.2013ENT\Desktop\myCentralisedLoggingUI.ps1:43 char:50

+ [string]$clscmd = Start-CsClsLogging -Scenario $scenariotype -pools $pooltotra ...

+ ~~~~~~~~~~~~~

+ CategoryInfo : InvalidData: (:) [Start-CsClsLogging], ParameterBindingValidationException

+ FullyQualifiedErrorId : ParameterArgumentValidationError,Microsoft.Rtc.Management.Cls.StartOcsLoggingCmdlet

But hang on a minute, of course the “VoiceMail” scenario is a valid scenario! In fact, it’s one of the default scenarios… So what is going on here?

Well, the reason for this is that when you create a Site based Custom scenario, in the background, Lync will also create a new site based Configuration Identity (eg. In the background it runs New-Cs-ClsConfiguration), for example, if you run a Get-CsClsConfiguration you will see:

Identity : Global

Scenarios : {Name=AlwaysOn, Name=MediaConnectivity, Name=ApplicationSharing, Name=AudioVideoConferencingIssue...}

SearchTerms : {Type=Phone;Inserts=ItemE164,ItemURI,ItemSIP,ItemPII, Type=URI;Inserts=ItemURI,ItemSIP,ItemPII, Type=CallId;Inserts=ItemCALLID,ItemURI,ItemSIP,ItemPII,

Type=ConfId;Inserts=ItemCONFID,ItemURI,ItemSIP,ItemPII...}

SecurityGroups : {}

Regions : {}

EtlFileFolder : %TEMP%\Tracing

EtlFileRolloverSizeMB : 20

EtlFileRolloverMinutes : 60

TmfFileSearchPath :

CacheFileLocalFolders : %TEMP%\Tracing

CacheFileNetworkFolder :

CacheFileLocalRetentionPeriod : 14

CacheFileLocalMaxDiskUsage : 80

ComponentThrottleLimit : 5000

ComponentThrottleSample : 3

MinimumClsAgentServiceVersion : 6

Identity : Site:Melbourne Site

Scenarios : {Name=SITECUSTOMSCENARIO}

SearchTerms : {Type=Phone;Inserts=ItemE164,ItemURI,ItemSIP,ItemPII, Type=URI;Inserts=ItemURI,ItemSIP,ItemPII, Type=CallId;Inserts=ItemCALLID,ItemURI,ItemSIP,ItemPII,

Type=ConfId;Inserts=ItemCONFID,ItemURI,ItemSIP,ItemPII...}

SecurityGroups : {}

Regions : {}

EtlFileFolder : %TEMP%\Tracing

EtlFileRolloverSizeMB : 20

EtlFileRolloverMinutes : 60

TmfFileSearchPath :

CacheFileLocalFolders : %TEMP%\Tracing

CacheFileNetworkFolder :

CacheFileLocalRetentionPeriod : 14

CacheFileLocalMaxDiskUsage : 80

ComponentThrottleLimit : 5000

ComponentThrottleSample : 3

MinimumClsAgentServiceVersion : 6

See the new Site Identity (Site:Melbourne Site) that has appeared out of nowhere... It’s now taking precedence over the top of the Global policy for that pool. Also, notice that the only scenario that is under this Site is the SITECUSTOMSCENARIO, and as a result, this is the only scenario that can now be run from this site.

At this point, you may think that removing the scenario with a “Remove-CsClsScenario”, may fix this, however, this is not the case. To revert back using the Global configuration you need to remove the site configuration with the following command:

Remove-CsClsConfiguration –Identity “Site:Melbourne Site”

Now, you may need to restart the Lync Server Centralised Logging Service Agent in Windows Services so that the configuration is updated.

The moral of this story is to only use Global policies for Centralised Logging, unless you have a very good reason not to!

Wrap up

This Deep Dive into the Centralised Logging Service has clarified how the service works, and how you can use it to get the information you need out of the system. Hopefully, this will leave you in a position to start debugging using it instead of leaning on the old Lync Logging Tool. As far as Custom Scenarios go, I would suggest you think about the type of information you may be needing out the system to fix common problems and tailoring some custom scenarios ahead of time, because you don’t really want to be messing around when the faults start rolling in. Keep logging, and bye for now.

PS: But what if you don’t like Powershell? Well, have no fear, as my next post will include a new Centralised Logging Tool GUI for your logging pleasure.

↧

Lync 2013 Centralised Logging Tool

April 11, 2013, 5:29 pm

≫ Next: Lync Phone Edition Localisation

≪ Previous: Lync 2013 Centralised Logging Deep Dive

Centralised logging is a very powerful service. However, because it’s only accessible through Powershell commands, it can be a rather daunting alternative to the old Lync Logging Tool, especially when you’re trying to troubleshoot an issue.

So what can be done about this? Well, Randy Wintle over at the UC Made Easy blog had the great idea of making a GUI interface for the Lync 2013 Preview release, which was based on the ‘ClsController.exe’ command line tool. I like this idea a lot, so now that 2013 is released, I decided to give Randy’s tool a major “Backend Lift” (different than that offered by Kim Kardashian’s plastic surgeon…) and add a bunch of new capabilities.

Centralised Logging Tool Features

Centralised Logging Tool features:

The tool's backend uses Powershell commands, instead of ClsController.exe commands.
The tool has the ability to manage logging on multiple Pools at once. When the tool first loads it will learn the current state of all the Pools. The UI can show the state of each pool as they are clicked on in the Pools listbox and only allow the user to execute functions that are available in that state (eg. Start and Stop buttons will be disabled if the current state of the pool doesn’t allow you to use them).
When the tool loads it will query the Lync servers for the status of running logging scenarios, and the tool will display the current state of each pool as it is selected in the pools list. This means that you can use the tool to learn what logging is currently running on each pool.
The scenarios list is dynamic, so Custom Scenarios will also be included in the scenarios list along with the default scenarios.
All pool types, including Persistent Chat pools are listed. If Mediation server is co-located with the front end server it will not be added to the list, but if it’s on a separate physical server it will be listed.
The tool has the ability to have AlwaysOn and Scenario logging enabled at the same time. AlwaysOn logging has its own button and status messages.
The components filter list can either show all the components available for logging on the system, or list only the components for the specific scenario that is currently being logged (or just logged) on a pool.
The Logging duration time can be specified when you Start logging, and running scenarios can have their Duration updated with the new Update button. By default, logging will run for 4 hours and then automatically stop. So if you want to do a long running log, or a much shorter log you can specify this when you start logging, or you have the option to Change the duration of a log whilst it’s running. The format of Logging duration is as follows: <days.hours:minutes> (eg. “0.04:00”) .
You can now select either MatchAll, or MatchAny settings. These settings affect the way multiple filters are applied when Searching/Exporting logs. If MatchAll is used, then the filters execute in a logical ‘AND’ fashion, where all the filters must match to return results. If MatchAny is selected, then the filters apply in a logical ‘OR’, which means if any of the filters match the result will be returned.
The Call-Id, IP Address, Phone and URI filters have separate text boxes, so these filters can be used in conjunction with each other (and the MatchAll/MatchAny setting) for more precise filtering.
The Components listbox is Multi-Selectable, offering export filtering by one or many component types at once.
Start and End time filter is now included as a filter option. By default the Search command will filter through only the last 30 minutes of logs to return a result. If you need to capture more than this then you can used the Start and End time settings. I have made the defaults in these boxes display the range of 1 hour as a starting point. It’s best that you keep the date/time format in the format shown.
The logging folder can be selected using a Folder Browse dialog to having to type the location.
Analyse Log button allows you to choose a log file to open directly in Snooper, to save you having to manually open Snooper and import the logs.
Interface is now written in Australian/British English :)

The Details

The Centralised Logging Tool is Stateful on a per pool basis. By that I mean that it will learn the status of all pools when it loads and it will maintain the state as you Start and Stop services. The process of querying the server (Show-CsClsLogging) for the status of the Centralised Logging Service can take several seconds to execute. This means the Controller has to query all of the Agents and then wait for them to respond before it can report back about the status of the pools. As a result, I tried to minimise the number of times the tool had to re-sync its state with the server. So, it will only request updates on the status of the Agents upon receiving an error response from a command execution (ie. A Start/Stop request). When this happens, it will fully refresh all of the Pools logging status.

I give you the new Centralised Logging Tool UI:

DOWNLOAD HERE Version 1.00:

When starting out with the tool you might easily get confused with how the filtering of captures works. As I detailed in my last post about Centralised Logging, logging captures are filtered in the following way:

The scenario filter section shown above will either be a default scenario (capturing only the pre-defined components) that’s are already defined as part of Lync 2013, or you can build your own custom scenarios that log only the components that you are interested in.

The Agent Search filter shown above allows you to run post-capture filters on the data, so you only end up with the log information you want. This is done in the Centralised Logging Tool using the Export filters, and the Export button.

The Centralised Logging Tool has these two sections broken up as follows:

This basically means that the settings outlined in red work in conjunction with the Export button, and the Scenario list works in conjunction with the Start tracing button.

Current Operation on Lync 2013 February 2013 CU

As of the February 2013 CU update there are some Search parameters that are described on TechNet that don’t appear to work in practice. From the testing I have done, here is a summary of what works and doesn't work:

Start and End Times:The Start and End filter works. It will return only items captured between the times specified.

Components Filter:Component filter is currently working. You can select one or many components in the list and Lync will return only the components specified.

Logging Level: Logging level filters are working. Lync will return all levels up to the level you select; for example ‘Warning’ will retrieve Fatal, Error, and Warning results. The hierarchy is:

Fatal
Error
Warning
Info
Verbose
Debug
All

URI Filter: The URI Filter setting works as long as you use a full SIP URI, for example john.woods@domain.com, or sip:john.woods@domain.com

IP Filter:Doesn’t appear to work. Lync returns no results for IP addresses.

CallID Filter: Doesn’t appear to work.Lync returns no results for CallID.

Phone Filter:Doesn’t appear to work. Lync returns no results for phone numbers.

SIP Contents:Doesn’t appear to work. Lync returns no results when content is filtered by SIP Content.

The last four items on the list currently don’t seem to work (as of CU Feb 2013). I have left them in the tools interface in the hope that Microsoft will correct these issues in a future CU release.

If you have different results, please let me know!

Known Issue: Errors when Stopping Logging Service

Whilst testing the tool I’ve had some issues from time to time when calling Stop on a running scenario (both AlwaysOn and other Scenarios). The error received looks like this:

Failed on 1 agents

Agent - 2013ENTFE004.domain.com, Reason - Error code - 20003, Message - Unknown error returned by Wpp native assembly - 1168. Please refer CLS logs for details.

Unfortunately, the CLS log didn’t shine any light on why this is occurring (the logs report the same error as shown above with no additional info). I have made the tool so it’s smart enough to recognise these errors and query the server for the state of the pool again, to re-sync the status of all the pools. I have found that if you wait a few minutes (maybe 5 minutes) and then try to stop the logging scenario again it tends to work (or just keep trying till it does). I should stress that this isn’t a problem with the tool, as the issue happens when using Powershell directly as well. So I assume it’s a bug in the Agent side of the code.

If anyone knows how to avoid this error, let me know!

Notes on 2013 Snooper

Snooper is a tool that was available in Lync 2010, which provides the ability to analyse log files that are generated by the Lync Logging Tool. Snooper 2013 now also provides the ability to analyse Lync Centralised Logging Service log files.

Whilst you can also open these log files in a text editor, Snooper makes reading logs far easier. So, to make life easier I decided to put a button in the Centralised Logging Tool that will launch Snooper directly. Here it is:

When you click this button you will be shown a File Dialog that allows you to select which log file you want to open. Select the file you want to open and Snooper will open the file.

Note: If your Snooper tool is in a non-standard location you can edit a global variable in the script to point to whatever location you like:

$script:snooperLocation = "C:\Program Files\Microsoft Lync Server 2013\Debugging Tools\Snooper.exe"

If you want to change the location that the log files are saved to, edit this global variable:

$script:pathDialog = "C:\Lync2013Tracing\"

Some other good news about Snooper for Lync 2013 is that it has some cool new features, one of which is the Call Diagram button:

When you have messages from a SIP dialog selected in Snooper, and press this button, it will launch a diagrammatic representation of that particular SIP Dialog, as shown here:

Note: You have to be on the Messages tab of Snooper to launch the call flow analyser. If you are on the Trace tab you will receive a “This message is not eligible for callflow” error.

Pretty cool, huh!

Wrap Up

I have spent quite a bit of time working on the tool and tweaking it to work for most functions that I can see people wanting to use it for. If I’ve missed something and you have an awesome idea for additional functionality, let me know. Other than that, happy logging!

↧

Lync Phone Edition Localisation

April 13, 2013, 6:30 pm

≫ Next: Microsoft Lync: The Facts about Fax

≪ Previous: Lync 2013 Centralised Logging Tool

I was reading a post over at Jeff Schertz’s site the other day regarding getting Lync Phone Editions to use the tone set of your country, rather than the standard US tones.

It said that using Powershell and changing the “co” attribute within Active Directory was enough to set the tones on the phone to your country of choice. Unfortunately, this is not actually the case. Changing the “co” attribute in Powershell will actually not affect the country combo box shown on the Address tab. If you just set the "co" attribute with Powershell you end up with a situation like this:

The “Country/Region” setting in the Address tab when changed actually controls two attributes within Active Directory, the “co” and the “c”. The Lync Phone edition actually honours the “c” attribute, and not the “co” attribute.

As a result, I would recommend that when scripting for tone changes across your Lync users, you run a Powershell command that changes both settings. Here is my example for Australia:

Script to set Australia tones on Lync Phone Edition for all Lync users:

Import-Moduleactivedirectory

$question=Read-Host"Do you want to change the Country Parameter in AD for all lync users? (Y/N)"

if($question -eq "Y" -or $question-eq "y")

{

Get-ADUser-Filter {msRTCSIP-UserEnabled-eq$true} | Set-ADUser-country"AU"-replace @{co="Australia"}

}

Note: You can edit the country name in the script for your appropriate country.

Hope that helps some of my non-American Lync friends J

↧

Microsoft Lync: The Facts about Fax

April 18, 2013, 8:59 pm

≫ Next: Lync 2013 Database Mirror Manager Tool

≪ Previous: Lync Phone Edition Localisation

I find that fax is often misunderstood, especially when it comes to way it works on VoIP networks. Also, I’ve noticed that there is very little information on the internet about how to deploy fax on Lync. In my years working with VoIP, I have run into many fax issues on many different platforms. So I thought I might write an article that explains exactly how Lync does, and doesn’t, support fax.

This article is not designed to be a walk-through of how to configure fax on your specific gateway, but instead to provide you with information that will help you troubleshoot your own fax problems in the future. After all; "If you give a man a fish you feed him for a day. If you teach a man to fish you feed him for a lifetime."

The best place to start here will be to talk about the Protocols used for fax communications and how they relate to each other. There are loads of protocols when it comes to fax transmissions; however, there are only a few we really need to understand the basics of for this article. Here are the main offenders:

T.30– Is an ITU recommendation that describes procedures for sending faxes over the PSTN (via modem tones). These include: call establishment and call release; compatibility checking, status and control command; checking and supervision of line conditions; control functions and facsimile operator recall. If you would like to read the spec you can download it here.

V.34 (and other V.x protocols)– The V protocols describe the modulation and demodulation (modem) techniques used to pass data (in our case, fax) over a phone line.

T.38– Is a protocol that describes how to relay T.30 fax messages over a VoIP network. The relaying of fax is done hop by hop through the data network between VoIP gateway devices. The end fax devices are not aware that this relay process is happening (unless it’s a fax gateway that directly supports T.38), and it uses T.30 protocol directly with the Gateway that is closest to it. The gateway terminates the T.30 protocol and converts the stream into a packetised byte stream that it relays to the next hop gateway over an IP network. The Gateway on the other side receiving the T.38 stream will then convert the messaging back into T.30 protocol and pass it to the end fax machine.

CNG Tone: A word that will also come up in this article is “CNG Tone”. CNG tone is basically a tone that the originator of a fax call plays on the line to indicate that it is a fax call, and that it’s ready to start fax handshaking. The CNG signal is simply an 1100 Hz tone that plays for half a second, and then repeats every three seconds.

T.38 Calls on Lync

The T.38 protocol works in conjunction with SIP in a two step process. The first step is to set up a voice stream session. The voice stream is used by the originating fax machine to transmit its CNG tone to the far end fax machine. The far end fax machine then responds with an answer signal (ANSam) over the voice stream. It’s at this point that the gateway can recognise that the call is a fax call, and now move into T.38 transmission processing. To do this a re-invite is sent out by the receiving gateway that includes T.38 settings in the SDP, and the gateways agree upon updating the media session to a T.38 image transmission.

The re-invite message will look like this:

INVITE sip:192.168.0.191:5068;transport=Tcp;maddr=192.168.0.191;ms-opaque=b584fc305c6ad126 SIP/2.0

Call-ID: 5eb671a0-9a63-4701-b186-ed8c87f64b3a

Contact: <sip:1300368999@192.168.0.220;user=phone>

Content-Length: 258

Content-Type: application/sdp

CSeq: 517 INVITE

From: <sip:1300368999@DX001.domain.com;user=phone>;tag=c0a800dc-18ed8

Max-Forwards: 70

To: "Fax Test Device"<sip:0395551111@domain.com;user=phone>;epid=1C2A8F4B3B;tag=3088606813

User-Agent: Quintum/1.0.0 SN/0030E101408B SW/P108-09-21

Via: SIP/2.0/TCP 192.168.0.220;branch=z9hG4bK-tenor-c0a8-00dc-00af

v=0

o=Quintum 131 131 IN IP4 192.168.0.220

s=VoipCall

c=IN IP4 192.168.0.220

t=0 0

m=image 10428 udptl t38

c=IN IP4 192.168.0.220

a=T38FaxVersion:0

a=T38MaxBitRate:14400

a=T38FaxFillBitRemoval:0

a=T38FaxTranscodingMMR:0

a=T38FaxTranscodingJBIG:0

When the Lync server receives this message it tries to parse the SDP of the Invite before it forwards it back to the Analog Gateway (with the fax machine connected to it). When it parses the message it finds the m field equals image (m=image), which it doesn’t support. This results in an Invalid SDP message being sent back to the far end gateway and the call being torn down.

SIP/2.0 488 Invalid SDP: The offer from Gateway during a re-INVITE has changed an existing m-line (Media Name)

FROM: <sip:1300368999@DX001.domain.com;user=phone>;tag=c0a800dc-18ee0

TO: "Fax Test Device"<sip:0395551111@domain.com;user=phone>;epid=1C2A8F4B3B;tag=87d3f0ce82

CSEQ: 522 INVITE

CALL-ID: e2a7db66-3311-44cf-a08a-17befafb3b0f

VIA: SIP/2.0/TCP 192.168.0.220;branch=z9hG4bK-tenor-c0a8-00dc-00b1

CONTENT-LENGTH: 0

SUPPORTED: 100rel

SERVER: RTCC/5.0.0.0 MediationServer

A completed T.38 negotiation process is described in the following diagram:

This concludes the sad fact that Lync (2010 and 2013) does not support T.38 protocol negotiation directly with Analog and PSTN Gateways.

Lync Fax Settings

If you’ve ever tried to connect a fax machine to Lync before, you will no doubt have seen the only setting on the system that relates to Fax. This setting is in the New/Set-AnalogDevice command, and is a Boolean setting called AnalogFax. The command looks something like this:

New-CsAnalogDevice -LineUri tel:+61399991111 -DisplayName "Name of Fax Machine" -RegistrarPool lyncpool.domain.com -AnalogFax $True -Gateway <IP/FQDN> -OU "ou=LyncUsers,dc=domain,dc=com"

So I would expect that the first thing a good IT professional would do when installing a fax machine is turn this setting on, because it’s a fax machine, right? So I definitely should tell the system that it’s a fax machine, right!? Well, not necessarily. As it turns out, this setting is very specific in its operation, and is what, at best, I would describe as a work around solution for fax.

Basically, if an analog device is marked as being AnalogFax it invokes a special ‘hairpinning’ routing procedure within Lync when the device makes an outbound call. This procedure basically means that Lync bypasses regular routing rules and sends the invite message straight back to the gateway that sent it. The idea of this is that the analog gateway is supposed to send the call out a PSTN line that is also directly connected to it, and in the process avoids sending the fax media stream over the IP network all together.

So, when AnalogFax is set to true, AND the system is configured with Media Bypass turned on, any outbound call from the analog device with this setting will be automatically routed back to the gateway that sent the call. The call scenario looks like this:

|Time | 192.168.0.49 | 192.168.0.191

| | |

|0.000 | Request: INVITE sip |SIP/SDP: Request: INVITE sip:130036899

| |(62301) ------------------> (5068) |

|0.001 | Status: 100 Trying |SIP: Status: 100 Trying

| |(62301) <------------------ (5068) |

|0.220 | Status: 183 Session |SIP/SDP: Status: 183 Session Progress

| |(62301) <------------------ (5068) |

|0.269 | Request: PRACK sip: |SIP: Request: PRACK

| |(62301) ------------------> (5068) |

|0.270 | Status: 200 OK |SIP: Status: 200 OK

| |(62301) <------------------ (5068) |

|0.532 | Status: 200 OK |SIP/SDP: Status: 200 OK

| |(5060) ------------------> (61427) |

|0.845 | Request: INVITE sip |SIP/SDP: Request: INVITE sip:+611300368999

| |(5060) <------------------ (61429) |

|0.893 | Status: 404 Not Fou |SIP: Status: 404 Not Found

| |(5060) ------------------> (61429) |

|0.893 | Request: ACK sip:+6 |SIP: Request: ACK sip:+611300368999

| |(5060) <------------------ (61429) |

Note: My gateway didn’t accept the call, and as a result sent a 404 Not Found back to Lync. After this the call fails.

So, why don’t you just don’t save the money on the gateway and connect the fax machine directly to the network? The only reason is that if you do this, there will be no CDR records output by Lync for calls made from fax machines. So the question is, how much are CDR records worth to you? If the answer is more than the price of an analog VoIP gateway with FXS and FXO ports, then you’ve come to the right place!

What are the options available on Lync for fax?

Option 1 – Bypass Lync Altogether

The first option, as I have already described above, is to connect the fax machine directly to the network and bypass Lync altogether. There are two problems with this method: the first is that it requires individual analog/digital carrier services brought into the premises; the second is that there will be no CDR records reporting in Lync for these calls.

Diagram:

Option 2: Fax Hairpinning

This is the method that Microsoft officially supports for fax calls. On Technet it is described as “hairpinning”. The way it works is that once you enable the AnalogFax setting within the New/GetCsAnalogDevice command, and enable Media Bypass, calls from this device to external numbers will get sent directly back the device by Lync. This actually bypasses all of the regular routing flow within Lync.

Lync configuration:

Set-CsAnalogDevice -AnalogFax $true
Enable Media Bypass on Lync. (If you do not enable this the hairpinning will not work)
Use an analog gateway with FXS, and FXO/ISDN ports. Ensure that calls get routed inbound from SIP to the FXO/ISDN ports. Note that Lync will normalise the number before it's sent back, so you will have to do something with the “+<prefix>” before sending it to the carrier.

Diagram:

Option 3: Connect Fax over G.711 to SIP Carrier

In this scenario the fax tones are sent directly over G.711 out to the SIP network (either direct, or through an SBC). Whilst this may work, it depends heavily on what happens to the G.711 RTP stream over the network. If there is significant network jitter or packet loss whilst the fax is being sent, then the transmission may fail. Microsoft explicitly states that it does not support this scenario. Technet states: “Fax calls are not supported through a SIP trunk.”

Lync configuration:

Set-CsAnalogDevice -AnalogFax $false
Enable Media Bypass on Lync.
Grant a Voice Policy with appropriate PSTN Usages for the Analog Device.
Configure your VoIP gateway to use G.711 for fax. This usually involves disabling T.38 settings.

Diagram:

Option 4: Fax over G.711 to PSTN VoIP Gateway

For this scenario the fax stream is sent via G.711 to a local ISDN/Analog gateway and then on to the carrier. This scenario can be achieved as long as you can ensure that there is no network jitter or packet loss issues between the two gateways. So I would not recommend making fax calls from an Analog gateway across a WAN to the PSTN gateway, as you may not be able to guarantee the quality of the voice stream.

Lync configuration:

Set-CsAnalogDevice -AnalogFax $false
Enable Media Bypass on Lync.
Grant a Voice Policy with appropriate PSTN Usages for the Analog Device.
Configure your VoIP gateways to use G.711 for fax. This usually involves disabling T.38 settings.

Diagram:

Option 5: Fax via SBC with T.38 to SIP Trunk

This is the most complex scenario on the list, because you have to ensure that internally you are using G.711 between the gateways and externally you are using T.38. Note, this will only work if the Carrier SIP trunk provider supports T.38 protocol. So ensure that you consult with your carrier before attempting this kind of configuration.

Lync and Gateway configuration:

Set-CsAnalogDevice -AnalogFax $false
Enable Media Bypass on Lync.
Grant a Voice Policy with appropriate PSTN Usages for the Analog Device.
Configure the fax connected analog gateway to use G.711. This usually involves disabling T.38 settings.
On the Lync facing SIP leg of the SBC ensure that fax calls are configured for G.711. This usually involves disabling T.38 settings.
Enable T.38 on the external SIP trunk that faces the SIP Carrier.

Diagram:

On a AudioCodes Gateway this would look like this:

Lync Facing Trunk Setting:

Open the 'IP Profile Settings' page for the Lync Trunk (Configuration tab > VoIP menu > Coders And Profiles > IP Profile Settings).

SIP Trunk Facing Trunk setting:

Open the 'IP Profile Settings' page for the SIP Carrier (Configuration tab > VoIP menu > Coders And Profiles > IP Profile Settings).

Call Routing for Analog Devices

Note: Voice Routing, as described below, only works when the AnalogFax setting is set to $false.

I’ve seen different things mentioned around the web for how routing works with Analog Devices. My testing has shown that a Voice Policy must be granted on a Analog Device before you can get it to route externally. If you do not set a VoicePolicy to the Analog Device, then you will receive the following error when dialling an external number:

SIP/2.0 403 Forbidden
FROM: "Fax Test Device"<sip:+61395551111@domain.com;user=phone>;epid=1D3FB4561B;tag=ffa63dd9c5TO: <sip:0407555999;phone-context=Melbourne_Site@domain.com;user=phone>;tag=1A8C27C7FDB2A881C9C77A96575A9CCCCSEQ: 6895 INVITECALL-ID: 4e9c791b-3235-40c0-8c37-47431a1ba82dVIA: SIP/2.0/TLS 192.168.0.191:57505;branch=z9hG4bKbcf5ff8;ms-received-port=57505;ms-received-cid=2CCA00CONTENT-LENGTH: 0SERVER: OutboundRouting/5.0.0.0ms-diagnostics: 12001;reason="User Policy does not contain phone route usage";source="2013ENTFE001.DOMAIN.COM";UserUri="sip:+61395551111@domain.com";appName="OutboundRouting"ms-application-via: ms-udc.cdr%3D09e4c67d9b3eeb2bbdb82e47464ebb80%3A5;ms-pool=melbfepool.domain.com;ms-application=http%3A%2F%2Fwww.microsoft.com%2FLCS%2FUdcAgent;ms-server=2013ENTFE001.domain.com

If you do a Get-CsAnalogDevice on the system you will see the Voice Policies that have been applied to your Analog Devices:

> Get-CsAnalogDevice

Identity : CN=Fax Test Device,OU=LyncUsers,DC=mylynclab,DC=com

VoicePolicy :

VoiceRoutingPolicy :

RegistrarPool : melbfepool.domain.com

Gateway : AudioCodes.domain.com

AnalogFax : False

Enabled : True

SipAddress : sip:79c6c937-8a6b-40fd-8dd9-aacca43f5f1b@domain.com

LineURI : tel:+61395551111

DisplayName : Fax Test Device

DisplayNumber :

ExUmEnabled : False

Note: Above there is no VoicePolicy assigned to this user. This will result in external calls failing.

So we need to Grant a Voice Policy to the Analog Device. Here’s an example:

> Grant-CsVoicePolicy -Identity "Fax Test Device" -PolicyName ExecutiveUserPolicy-International

Now the Get-AnalogDevice should show that a Policy has been granted:

> Get-CsAnalogDevice

Identity : CN=Fax Test Device,OU=LyncUsers,DC=mylynclab,DC=com

VoicePolicy : ExecutiveUserPolicy-International

VoiceRoutingPolicy :

RegistrarPool : melbfepool.domain.com

Gateway : AudioCodes.domain.com

AnalogFax : False

Enabled : True

SipAddress : sip:79c6c937-8a6b-40fd-8dd9-aacca43f5f1b@domain.com

LineURI : tel:+61395551111

DisplayName : Fax Test Device

DisplayNumber :

ExUmEnabled : False

So now your Analog Device has a Voice Policy, which is great for allowing it to dial out. What if a user was to dial an un-normalised number from an Analog Station though, will it get normalised? Well, this is where things get interesting… The short answer is that it will get Normalised, however, which normalisation rules are used is the bigger issue.

I’ve analysed logs from the server and found that Analog Device function as follows:

If there is no Site based rules configured on the system, then the Analog device gets normalised under the DefaultProfile (which equates to the Global dial plan):

SIP/2.0 101 Progress Report

FROM: <sip:+61395551111@domain.com;user=phone>;epid=1D3FB4561B;tag=bd71af9e4a

TO: <sip:0407555999;phone-context=DefaultProfile@domain.com;user=phone>

CSEQ: 6940 INVITE

CALL-ID: 4c88062c-60d7-459d-96f0-7005702a5f51

VIA: SIP/2.0/TLS 192.168.0.191:58292;branch=z9hG4bK8a8934bc;ms-received-port=58292;ms-received-cid=2D1200

CONTENT-LENGTH: 0

SERVER: TranslationService/5.0.0.0

ms-diagnostics: 14011;reason="Called Number translated";source="2013ENTFE001.DOMAIN.COM";RuleName="Keep All";CalledNumber="0407555999";TranslatedNumber="+0407555999";appName="TranslationService"

If there is a Site based Dial Plan Policy deployed for the Pool that the Analog Device is deployed on, then the Site Policy will be used:

SIP/2.0 101 Progress Report

FROM: <sip:+61395551111@domain.com;user=phone>;epid=1D3FB4561B;tag=ffa63dd9c5

TO: <sip:0407555999;phone-context=Melbourne_Site@domain.com;user=phone>

CSEQ: 6895 INVITE

CALL-ID: 4e9c791b-3235-40c0-8c37-47431a1ba82d

VIA: SIP/2.0/TLS 192.168.0.191:57505;branch=z9hG4bKbcf5ff8;ms-received-port=57505;ms-received-cid=2CCA00

CONTENT-LENGTH: 0

SERVER: TranslationService/5.0.0.0

ms-diagnostics: 14011;reason="Called Number translated";source="2013ENTFE001.DOMAIN.COM";RuleName="AU-Mobile";CalledNumber="0407555999";TranslatedNumber="+61407555999";appName="TranslationService"

Note: the TranslatedNumber is different in both cases, the first case used my Melbourne Site dial plan and the second used my Global dial plan.

So now you might be wondering what happens if you force a User Policy onto the Analog Device. Well, here’s what happens.

Configure a User Policy onto the Analog Device:

Grant-CsDialPlan -Identity "Fax Test Device" -PolicyName AnalogTest

The above command is accepted by the system. If we run Get-CsAnalogDevice we will see the following:

> Get-CsAnalogDevice

Identity : CN=Fax Test Device,OU=LyncUsers,DC=domain,DC=com

VoicePolicy : ExecutiveUserPolicy-International

VoiceRoutingPolicy :

RegistrarPool : melbfepool.domain.com

Gateway : AudioCodes.domain.com

AnalogFax : False

Enabled : True

SipAddress : sip:79c6c937-8a6b-40fd-8dd9-aacca43f5f1b@domain.com

LineURI : tel:+61395551111

DisplayName : Fax Test Device

DisplayNumber :

ExUmEnabled : False

There is no Dial Plan Policy listed in the above get command. So what if you run a full get on the Analog Device:

> Get-CsAnalogDevice |fl *

Gateway : AudioCodes.domain.com

AnalogFax : False

Created : True

DisplayName : Fax Test Device

DisplayNumber :

ProxyAddresses : {sip:79c6c937-8a6b-40fd-8dd9-aacca43f5f1b@domain.com}

HomeServer : CN=Lc Services,CN=Microsoft,CN=1:1,CN=Pools,CN=RTC Service,CN=Services,CN=Configuration,DC=domain,DC=com

TargetServerIfMoving :

EnabledForFederation : True

EnabledForInternetAccess : True

PublicNetworkEnabled : True

EnterpriseVoiceEnabled : True

EnabledForRichPresence : True

ExchangeArchivingPolicy : Uninitialized

LineURI : tel:+61395551111

SipAddress : sip:79c6c937-8a6b-40fd-8dd9-aacca43f5f1b@domain.com

Enabled : True

TenantId : 00000000-0000-0000-0000-000000000000

UserRoutingGroupId : 1c864cc6-c83f-5683-b379-0f0d7bdfbb45

TargetRegistrarPool :

VoicePolicy : ExecutiveUserPolicy-International

MobilityPolicy :

ConferencingPolicy :

PresencePolicy :

VoiceRoutingPolicy :

RegistrarPool : melbfepool.domain.com

DialPlan : AnalogTest

LocationPolicy :

ClientPolicy : AnalogClientPolicy

ClientVersionPolicy :

ArchivingPolicy :

LegalInterceptPolicy :

PinPolicy :

ExternalAccessPolicy :

HostedVoicemailPolicy :

PersistentChatPolicy :

UserServicesPolicy :

ExperiencePolicy :

HostingProvider : SRV:

ObjectId : 00000000-0000-0000-0000-000000000000

ExUmEnabled : False

Name : Fax Test Device

DistinguishedName : CN=Fax Test Device,OU=LyncUsers,DC=domain,DC=com

Identity : CN=Fax Test Device,OU=LyncUsers,DC=domain,DC=com

Guid : 9839f2a2-5206-4d20-942a-2144a69840d8

ObjectCategory : CN=Person,CN=Schema,CN=Configuration,DC=domain,DC=com

ObjectClass : {top, person, organizationalPerson, contact}

WhenChanged : 22/04/2013 2:16:02 PM

WhenCreated : 12/04/2013 6:01:18 PM

OriginatingServer : 2013ENTDC001.domain.com

IsByPassValidation : False

IsValid : True

ObjectState : Unchanged

This list up reveals that the setting was actually applied to the Contact Object within active directory. So now the expectation would be that this would now try and Normalise based on the applied User Policy, right? Actually, unfortunately, this is wrong. The Analog Device still continues to get Normalised via the Site Policy and not the user Policy:

SIP/2.0 101 Progress Report

FROM: <sip:+61395551111@domain.com;user=phone>;epid=1D3FB4561B;tag=ffa63dd9c5

TO: <sip:0407555999;phone-context=Melbourne_Site@domain.com;user=phone>

CSEQ: 6895 INVITE

CALL-ID: 4e9c791b-3235-40c0-8c37-47431a1ba82d

VIA: SIP/2.0/TLS 192.168.0.191:57505;branch=z9hG4bKbcf5ff8;ms-received-port=57505;ms-received-cid=2CCA00

CONTENT-LENGTH: 0

SERVER: TranslationService/5.0.0.0

ms-diagnostics: 14011;reason="Called Number translated";source="2013ENTFE001.DOMAIN.COM";RuleName="AU-Mobile";CalledNumber="0407555999";TranslatedNumber="+61407555999";appName="TranslationService"

It would seem that the fact that Lync doesn't list the DialPlan parameter within Get-CsAnalogDevice is a hint to tell you that it doesn't actually apply this setting on Analog Devices. So why does Lync let you set this value if it’s not used by Lync? My guess is because the Contact Object still contains a msRTCSIP-UserPolicies attribute that it can write to, so it writes to it without giving you an error:

The moral of this long winded story is that you must set a Voice Policy for the Analog Device. When it comes to Dial Plan normalisation you have two choices, either normalise the number on the gateway (using translation rules of the gateway) before sending it to Lync, or use the Global or Site based default rules to normalise the number once it reaches Lync.

Enabling Media Bypass

All of the configurations for fax require that media bypass is enabled on the internal leg of the call. This will avoid any additional jitter and delays that might be caused by sending the stream via the mediation server. Here’s how you do it:

Enable Media Bypass for the Gateway:

>Set-CsTrunkConfiguration -Identity “PstnGateway:DX001.domain.com” -EnableBypass $True –EnableReferSupport $True

Or if Refer is not supported by the gateway:

> Set-CsTrunkConfiguration -Identity "PstnGateway:DX001.domain.com" -EnableBypass $True -RTCPActiveCalls $False -RTCPCallsOnHold $False

>Set-CsTrunkConfiguration -Identity "PstnGateway:DX001.mylynclab.com" –EnableSessionTimer $True

Note: There are some other special requirements that the gateway has to support here.

Turn on Media Bypass at a System Level:

If you are not using CAC then you can select “Always Bypass” as the option. In this configuration, both client and trunk subnets are mapped to one and only one bypass ID, which is computed by the system.

- If CAC is enabled then the processing works as follows:

If you enable CAC, you cannot select Always Bypass, and vice-versa, because the two configurations are mutually exclusive. That is, only one of the two will apply to any given PSTN call. First, a check is made to determine if media bypass applies to the call. If it does, then CAC is not used. This makes sense, because if a call is eligible for bypass, it is by definition using a connection where CAC is not needed. If bypass cannot be applied to the call (that is, if the client’s and gateway’s bypass IDs do not match), then CAC is applied to the call.

- CAC not enabled and Media Bypass set to Use Site and Region Information.

Where Use Site and Region Information is enabled, bypass determination works essentially the same way, regardless of whether CAC is enabled or not. That is, for any given PSTN call, the client’s subnet is mapped to a particular site, and the bypass ID for that subnet is extracted. Similarly, the gateway’s subnet is mapped to a particular site, and the bypass ID for that subnet is extracted. Only if the two bypass IDs are identical will bypass happen for the call. If they are not identical, media bypass will not occur.

Even though CAC is disabled globally, bandwidth policy needs to be defined for each site and link if you want to use site-and-region configuration to control the bypass decision. The actual value of the bandwidth constraint or its modality doesn’t matter. The ultimate goal is to have the system automatically calculate different bypass IDs to associate with different locales that are not well connected. Defining a bandwidth constraint by definition means a link is not well connected.

Other Settings that Affect Fax

Just when you thought you were safe, there are actually more settings that can adversely affect your fax transmissions. In addition to the settings mentioned above for Lync there are other settings that can affect Fax transmission over G.711 connection. You need to be careful of the following:

Faxes don’t like jitter that is caused from variable delays in packetised voice networks. So some gateways will actively try and reduce the amount of jitter by increasing the Jitter Buffers (perhaps to 100ms) for calls that they detect as being fax calls. What this does is reduce the chance of Jitter affecting the media stream, by increasing the overall end to end latency on the call. This trade off works because fax was built to handle fixed latency caused in long distance PSTN calling scenarios back in the good old days of TDM voice networks. This functionality does not usually have explicit settings in a VoIP gateway. However, if there is a fax setting that allows you to choose G.711 (passthrough), then it can often be a built in function of this setting.
Ensure that you turn off Silence Suppression (Voice Activity Detection) on all hops. Silence Suppression means that when the gateway detects that audio is under a certain threshold on the call, in an effort to save bandwidth, it will stop sending RTP on the link. For voice calls, this is fine, but for fax calls this is not a good idea.

Note: this is called different things on different gateways. The other most common name is Voice Activity Detection (VAD).

Quintum Silence Suppression Example

Note on AudioCodes: On AudioCodes Media Pack gateways, I’ve had issues with the silence suppression not working. By this I mean that Voice Activity Detection is still being enforced, and the RTP stream is being suppressed during breaks in fax tone. This unfortunately doesn’t mix well with fax.

When you have “No Fax” set in combination with this setting (with the Silence Suppression bug), the fax tones get treated the same as voice.

If you set “G.711 Transport” as the Fax Signalling Method this bug gets bypassed.

When you are using a G.711 codec, ensure that you test your volume levels. In Australia we have a great service offered by Telstra called “FaxStream” (1300368999) that allows you to send a fax to it, and get sent back a return fax that details if the audio levels on the call were acceptable or not. Based on the response on some gateways you can tweak the Tx and Rx levels of the voice stream. An example is on Quintum gateways: this is set under the IP Routing Groups->Advanced Tab.
Ensure that configuration on the Analog Gateways that the fax machine is connected to, the PSTN Gateway, the SBC, and the carrier SIP network are all correct. Each hop matters as much as the others, so don't fall into the trap of assuming it's one specific device that's the problem without first checking them all.

Wrap Up

Wow! That was a lot of stuff about fax… Who would have dreamed it could be so complicated? So anyway, I hope this helps some of the IT people out there that don’t necessarily have a background in telecommunications. In keeping with the eastern philosophy from the start of the article, I will now leave you with the great words of Mr Miyagi: “Fax on, Fax off, Daniel-san.”

↧

Lync 2013 Database Mirror Manager Tool

May 3, 2013, 1:24 am

≫ Next: Installing Lync 2013 Cumulative Updates with Mirrored Databases

≪ Previous: Microsoft Lync: The Facts about Fax

So it seems there has been quite a bit of interest in my Lync Centralised Logging Tool since I released it to the world. So I figured I might work on another tool to help with managing database mirroring within Lync 2013…

Database Mirroring Overview

In Lync 2013 we have been given a new SQL High Availability option for Lync databases to replace the old and more complicated SQL Clustering method from Lync 2010. The Lync 2013 SQL Mirroring method is easy to provision using topology builder, and can be managed using Powershell commands.

Managing Mirrored Databases

The mirror state of the databases can be controlled by Lync Powershell commands (probably best not to go fiddling with the SQL configuration directly). The command used to change the state of databases is shown below:

The Invoke command is broken down into Database Types. These ‘database types’ do not line up with the actual names of the databases within SQL, but instead, are given function names that relate to their role within Lync. The ‘database types’ can also contain more than one physical database. Here is how the database types are mapped to SQL names:

DatabaseType	Databases
Application	Rgsconfig Rgsdyn Cpsdyn
Archiving	Lcslog
Monitoring	Lcscdr Qoemetrics
User	Rtcab Rtcxds Rtcshared
CentralMgmt	Xds Lis
PersistentChat	Mgc
PersistentChatCompliance	Mgccomp
Provision	Not Implemented
CentralAdmin	Not Implemented
Lyss	Not Implemented
Registrar	Not Implemented Note: When you Invoke a changeover on the Archiving or Monitoring database, Lync will ask you if you want to accept the action to perform changeover on the target "Registrar". Kind of weird that it refers to these databases in that way... At any rate, you can't actually call the invoke command on a 'database type' of "Registrar" so don't try it.
Edge	Not Implemented
Cls	Not Implemented

Note: The Not Implemented database types above are listed on Technet as being database types. However, you can’t actually call the Invoke command on these 'database types' in Powershell. I’m assuming this is a documentation error…

You can see the physical databases within SQL. Here’s what they look like:

What you might notice in the picture above is that some of the physical databases that are grouped together within the Powershell database type categories are actually in different database states. For example, cpsdyn and rgsdyn are in mirrored state, whilst rgsconfig is in Principal state. This is because SQL manages these databases mirrored state per physical database, and not in the groupings that Microsoft chose to build the Invoke changeover command.

By running a Get-CsDatabaseMirrorState command, we can see that these databases are not in the same state:

PS > Get-CsDatabaseMirrorState

cmdlet Get-CsDatabaseMirrorState at command pipeline position 1

Supply values for the following parameters:

PoolFqdn: pool.domain.com

DatabaseName : rtcab

StateOnPrimary : Mirror

StateOnMirror : Principal

MirroringStatusOnPrimary : synchronized

MirroringStatusOnMirror : synchronized

DatabaseName : rtcxds

StateOnPrimary : Principal

StateOnMirror : Mirror

MirroringStatusOnPrimary : synchronized

MirroringStatusOnMirror : synchronized

DatabaseName : rtcshared

StateOnPrimary : Principal

StateOnMirror : Mirror

MirroringStatusOnPrimary : synchronized

MirroringStatusOnMirror : synchronized

DatabaseName : lcscdr

StateOnPrimary : Principal

StateOnMirror : Mirror

MirroringStatusOnPrimary : synchronized

MirroringStatusOnMirror : synchronized

DatabaseName : qoemetrics

StateOnPrimary : Principal

StateOnMirror : Mirror

MirroringStatusOnPrimary : synchronized

MirroringStatusOnMirror : synchronized

DatabaseName : lcslog

StateOnPrimary : Mirror

StateOnMirror : Principal

MirroringStatusOnPrimary : synchronized

MirroringStatusOnMirror : synchronized

DatabaseName : rgsconfig

StateOnPrimary : Principal

StateOnMirror : Mirror

MirroringStatusOnPrimary : synchronized

MirroringStatusOnMirror : synchronized

DatabaseName : rgsdyn

StateOnPrimary : Mirror

StateOnMirror : Principal

MirroringStatusOnPrimary : synchronized

MirroringStatusOnMirror : synchronized

DatabaseName : cpsdyn

StateOnPrimary : Mirror

StateOnMirror : Principal

MirroringStatusOnPrimary : synchronized

MirroringStatusOnMirror : synchronized

DatabaseName : xds

StateOnPrimary : Mirror

StateOnMirror : Principal

MirroringStatusOnPrimary : synchronized

MirroringStatusOnMirror : synchronized

DatabaseName : lis

StateOnPrimary : Principal

StateOnMirror : Mirror

MirroringStatusOnPrimary : synchronized

MirroringStatusOnMirror : synchronized

Note: I refer to this as being ‘out of sync’, which is not to be confused with their synchronisation state…

If I was to run the Invoke command on the User database here, I would end up with the following:

Invoke-CsDatabaseFailover -PoolFqdn pool.domain.com -DatabaseType "User" -NewPrincipal "Primary"

This causes the rtcab to move back to the primary mirror with the other user services:

PS > Invoke-CsDatabaseFailover -PoolFqdn pool.domain.com -DatabaseType "User" -NewPrincipal "Primary"

Confirm

Are you sure you want to perform this action?

Performing operation "Invoke-CsDatabaseFailover" on Target "UserServices".

[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"): y

DatabaseName FailoverResult

------------ --------------

rtcab Success

rtcxds SucceededAsNewPrincipalAlreadyOwnsThePrincipalRole

rtcshared SucceededAsNewPrincipalAlreadyOwnsThePrincipalRole

PS > Get-CsDatabaseMirrorState -PoolFqdn pool.domain.com -DatabaseType User

DatabaseName : rtcab

StateOnPrimary : Principal

StateOnMirror : Mirror

MirroringStatusOnPrimary : synchronized

MirroringStatusOnMirror : synchronized

DatabaseName : rtcxds

StateOnPrimary : Principal

StateOnMirror : Mirror

MirroringStatusOnPrimary : synchronized

MirroringStatusOnMirror : synchronized

DatabaseName : rtcshared

StateOnPrimary : Principal

StateOnMirror : Mirror

MirroringStatusOnPrimary : synchronized

MirroringStatusOnMirror : synchronized

Now all the physical databases within the User Database Type are all in the Principal state.

Alternatively the databases can be failed over as a single database. However, you need to run a more complicated powershell command:

Invoke-CsDatabaseFailover -PoolFqdn pool.domain.com –DatabaseType “User” -NewPrincipal "Primary" -ExcludeDatabaseList "rtcxds", "rtcshared"

Note: There’s an error on technet that includes an additional switch “-ExcludeDatabase” which isn’t actually needed (or available, for that matter).

Running the command will look something like this:

PS > Invoke-CsDatabaseFailover -PoolFqdn pool.domain.com -NewPrincipal "Mirror" -DatabaseType "User" -ExcludeDatabaseList "rtcxds", "rtcshared"

Confirm

Are you sure you want to perform this action?

Performing operation "Invoke-CsDatabaseFailover" on Target "UserServices".

[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"): y

DatabaseName FailoverResult

------------ --------------

rtcab Success

It makes sense that Microsoft designed the commands to force functionally associated databases to be running on the one SQL machine. However, it can make it a bit confusing to administer from a Powershell perspective. Which brings me to the real point of this article…

Lync 2013 Database Mirror Manager Tool

Wouldn’t it be much easier to just have GUI interface that shows you the state of the database? And be able to simply click to choose which ones you wanted to fail over? Well, today is your lucky day. I’ve made another GUI based tool that does just that. It looks like this:

Enterprise Edition Mirroring

Persistent Chat Mirror

Download Version 1.00 here:

It’s pretty straightforward to use (much more than Powershell anyway!). You simply select the pool from the list, and the databases that have mirroring enabled will display check boxes that show you the current Primary/Mirror status of the databases. If you decide you want to change one, or many, of the states, you simply click on the desired state check box for each database type, and then hit the Invoke button.

Note: You will be prompted in the Powershell window for each database that the tool is changing over. The tool will not make any changes without your knowledge.

So, what if databases within the Database groups get out of sync, like I described earlier in the article? Well, the tool is smart enough to realise this, and will inform you that the underlying physical databases within a 'database type' are out of sync. At this point you can choose to leave them out of sync, or invoke a change-over.

Out of Sync Error

Note: If you want to have your databases out of sync (because you just love defying Microsoft’s best practices), then don't press the invoke button. If you do, it will re-sync the databases back to the value selected in the check box for that database type.

Let me know if you find the tool useful or have any ideas on how you would like it improved.

The Wrap Up

The Evil Queen: "Mirror, mirror upon the wall, Who is the fairest of all?"

SQL Mirror: "O Lady Queen, though fair ye be, Lync Mirroring is the fairest of them all."

The Evil Queen: "Fair enough.”

See y’all next time. Enjoy!

↧

Installing Lync 2013 Cumulative Updates with Mirrored Databases

June 8, 2013, 1:54 am

≫ Next: Lync 2013 Call Pickup Group Manager

≪ Previous: Lync 2013 Database Mirror Manager Tool

Overview

There are now additional steps involved when running cumulative updates on Lync 2013 pools that have mirrored SQL databases. So I thought I would go into some detail about this new process and show how my Database Manager Tool can be used as part of this procedure. This post specifically covers the process documented for Lync 2013 CU1 (Feb 2013), however, it's likely the process will be similar for future cumulative updates. So this post should continue to function as a reference in the future, but be sure to always check the process documented for the specific CU you are installing before doing an upgrade.

The high level steps for this process are:

Download and install the updates all of the Lync Servers.
Run the Update Installer on all Lync Servers.
Check that all of the databases are running on the Primary SQL server.
Uninstall (remove) the database mirror for the Application database type.
Install the schema updates on the Primary database.
Recreate the database mirror for the Application Database type. This will recreate the Application databases back on the mirror server.
Check the status of the database to see that they are all running correctly.
(Optional) If your Monitoring backend databases are on a different server, update them now.
Update the Central Management Database schema. (only if the database is on Lync 2013. If the CMD is on a Lync 2010 pool then you don’t do this)
Enable the Mobility Service.
Enable the UCWA service.

Note: the official process is on Technet here, please read it: http://support.microsoft.com/kb/2809243

The Process

Step 1: Download Update

The first step in upgrading Lync is downloading the CU1 Update installer from the Microsoft site: http://www.microsoft.com/en-us/download/details.aspx?id=36820

Step 2: Run the update on all Lync Servers

Run the CU1 Update Installer executable on all of your Lync Servers (one at a time, as the tool will take the services offline when updating them). The Updater will show you that all of your Lync services need updating:

This will take the services offline and upgrade them. After they are upgraded the Update Installer will show them as being the latest version with a green tick:

If you run your Lync Servers in this state (ie. Without updating the database schema) you might notice some strange errors being logged in the Event Viewer, for example:

The above error states that “There was a problem communicating with the Group Pickup backend database” (Event ID 31055). This is because the CU1 release has added the new Group Pickup feature, which requires new schema additions in the Lync SQL databases for storing the data for this feature.

Step 3: Check the current state of the SQL databases

When you’re not using mirrored databases this process is relatively simple, and can be achieved running one or two commands. However, when you’re using database mirroring there is a requirement to remove the mirror for specific databases that need to have the schema updated, and then re-create the mirror databases after the update has been applied to the primary database.

To remove the database mirror you will first need to ensure that all of your databases are running on the Primary SQL server. Using the database Lync 2013 Mirror Manager Tool you can do this as shown:

Note: The Lync 2013 Mirror Manager can be downloaded from here.

If you have databases that are showing up in the Secondary column of the tool, then it means that they are running on the secondary SQL server and need to be moved back onto the primary SQL server (if you're running a witness server these database may have changed over to the secondary server without your knowledge). Move the databases back onto the primary simply by ticking all the check boxes in the Primary column and then click the Invokebutton. You will then be prompted in the Powershell window about changing the databases back to the Primary server. Type “y” as a response to these questions. After this is complete the tool will update and the databases should all appear in the Primary column.

Note: In the above example I haven’t checked the status of the Persistent Chat Databases. In the real world you should actually do this at this point. However, for the purposes of this example I haven’t done this to show what effect it has later when running the Database Install commands.

Step 4: Remove the Database Mirror for the 'Application' database

We now need to remove the mirrored database configuration for the 'Application' database type.

Note: In the future the need to remove the database mirror for other database types may become a requirement as well. So if you are coming to this post for a newer CU update, please refer to the specifics of the KB article relating to your specific CU release.

Run the following command:

Uninstall-CsMirrorDatabase -DatabaseType Application -SqlServerFQDN DOMAINSQL001.domain.com -SqlInstanceName Lync2013-DropExistingDatabasesOnMirror -Verbose

Here is an example of the command running:

PS > Uninstall-CsMirrorDatabase -DatabaseType Application -SqlServerFQDN DOMAINSQL001.domain.com -SqlInstanceName Lync2013 -DropExistingDatabasesOnMirror -Verbose

VERBOSE: Creating new log file

"C:\Users\Administrator.DOMAIN\AppData\Local\Temp\2\Uninstall-CsMirrorDatabase-ca7fc931-e778-40f4-bc17-9c7d51040855.xml".

Uninstall Mirrors

Uninstall mirrors required by Lync Server role(s). Note that the cmdlet will try its best to drop the databases on the mirror server, but

this is not guaranteed. After the cmdlet is finished, manually verify that the databases are dropped. If the databases are not dropped, drop

the databases manually. Are you sure you want to proceed?

[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"): y

VERBOSE: No changes were made to the Central Management Store.

VERBOSE: Creating new log file

"C:\Users\Administrator.DOMAIN\AppData\Local\Temp\2\Uninstall-CsMirrorDatabase-ca7fc931-e778-40f4-bc17-9c7d51040855.html".

WARNING: Uninstall-CsMirrorDatabase failed.

WARNING: Detailed results can be found at

"C:\Users\Administrator.DOMAIN\AppData\Local\Temp\2\Uninstall-CsMirrorDatabase-ca7fc931-e778-40f4-bc17-9c7d51040855.html".

On the Primary SQL Server:

As can be seen above, the cpsdyn, rgsconfig, and rgsdyn databases (which make up the Application database type) have now had their mirror configuration removed (ie. There is no “Principal, Synchronized” state written next to them now).

An important part of the command that we just ran was the “-DropExistingDatabasesOnMirror” switch, which tells Lync to delete these databases from the mirror server. Unfortunately, this function doesn't seem to always work, and databases can be left on the mirror server. So now we need to check the SQL instance on the Mirror server to see if these were deleted.

On the Mirror SQL Server:

From the screenshot above we can see that on the secondary server, the rgsconfig database has been automatically deleted. The cpsdyn and rgsdyn databases, however, are still there but stuck in “Restoring…” state. These databases will get re-created later when the Mirror is reconfigured between the two SQL servers, so it’s safe to manually delete these databases:

Step 5: Install the new schema updates on the Primary Database

Run the following command to install the Schema updates:

Install-CsDatabase -ConfiguredDatabases -SqlServerFqdn DOMAINSQL001.domain.com -Verbose

NOTE: The error below can be caused by not having enough free disk space on the SQL servers. This is most likely to happen in a lab environment where you’ve only provisioned the minimum disk space for each machine. I had this happen with 15.3GB of disk space free, however, when I expanded the disk to have 29GB free this error went away.

Install-CsDatabase : Command execution failed: Cannot find any suitable disks for database files. You must manually specify database paths.

At line:1 char:1

+ Install-CsDatabase -ConfiguredDatabases -SqlServerFqdn DOMAINSQL001.mylynclab.c ...

+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

+ CategoryInfo : InvalidOperation: (:) [Install-CsDatabase], DeploymentException

+ FullyQualifiedErrorId : ProcessingFailed,Microsoft.Rtc.Management.Deployment.InstallDatabaseCmdlet

The execution of this command will look like this:

PS C:\Users\Administrator.DOMAIN> Install-CsDatabase -ConfiguredDatabases -SqlServerFqdn DOMAINSQL001.domain.com -Verbose

VERBOSE: Creating new log file

"C:\Users\Administrator.DOMAIN\AppData\Local\Temp\2\Install-CsDatabase-817afad5-d1d5-42dc-a4cf-70589c7bdd09.xml".

VERBOSE: Install databases required by Lync Server role(s).

VERBOSE: Skipping Central Management Database "1-CentralMgmtStore-1". Central Management Databases are installed using the

-CentralManagementDatabase parameter.

****Creating DbSetupInstance for 'Microsoft.Rtc.Common.Data.BlobStore'****

Trying to connect to Sql Server DOMAINSQL001.domain.com\Lync2013. using windows authentication...

Sql version: Major: 11, Minor: 0, Build 2100.

Sql version is acceptable.

Checking state for database rtcxds.

****Creating DbSetupInstance for 'Microsoft.Rtc.Common.Data.RtcSharedDatabase'****

Trying to connect to Sql Server DOMAINSQL001.domain.com\Lync2013. using windows authentication...

Sql version: Major: 11, Minor: 0, Build 2100.

Sql version is acceptable.

Checking state for database rtcshared.

****Creating DbSetupInstance for 'Microsoft.Rtc.Common.Data.AbsDatabase'****

Trying to connect to Sql Server DOMAINSQL001.domain.com\Lync2013. using windows authentication...

Sql version: Major: 11, Minor: 0, Build 2100.

Sql version is acceptable.

Checking state for database rtcab.

****Creating DbSetupInstance for 'Microsoft.Rtc.Common.Data.RgsConfigDatabase'****

Trying to connect to Sql Server DOMAINSQL001.domain.com\Lync2013. using windows authentication...

Sql version: Major: 11, Minor: 0, Build 2100.

Sql version is acceptable.

Checking state for database rgsconfig.

****Creating DbSetupInstance for 'Microsoft.Rtc.Common.Data.RgsDynDatabase'****

Trying to connect to Sql Server DOMAINSQL001.domain.com\Lync2013. using windows authentication...

Sql version: Major: 11, Minor: 0, Build 2100.

Sql version is acceptable.

Checking state for database rgsdyn.

****Creating DbSetupInstance for 'Microsoft.Rtc.Common.Data.CpsDynDatabase'****

Trying to connect to Sql Server DOMAINSQL001.domain.com\Lync2013. using windows authentication...

Sql version: Major: 11, Minor: 0, Build 2100.

Sql version is acceptable.

Checking state for database cpsdyn.

****Creating DbSetupInstance for 'Microsoft.Rtc.Common.Data.ArchivingDatabase'****

Trying to connect to Sql Server DOMAINSQL001.domain.com\Lync2013. using windows authentication...

Sql version: Major: 11, Minor: 0, Build 2100.

Sql version is acceptable.

Checking state for database LcsLog.

****Creating DbSetupInstance for 'Microsoft.Rtc.Common.Data.MonitoringDatabase'****

Trying to connect to Sql Server DOMAINSQL001.domain.com\Lync2013. using windows authentication...

Sql version: Major: 11, Minor: 0, Build 2100.

Sql version is acceptable.

Checking state for database LcsCDR.

****Creating DbSetupInstance for 'Microsoft.Rtc.Common.Data.QoEMetricsDatabase'****

Trying to connect to Sql Server DOMAINSQL001.domain.com\Lync2013. using windows authentication...

Sql version: Major: 11, Minor: 0, Build 2100.

Sql version is acceptable.

Checking state for database QoEMetrics.

****Creating DbSetupInstance for 'Microsoft.Rtc.Common.Data.MgcDatabase'****

Trying to connect to Sql Server DOMAINSQL001.domain.com\Lync2013. using windows authentication...

Sql version: Major: 11, Minor: 0, Build 2100.

Sql version is acceptable.

Checking state for database mgc.

****Creating DbSetupInstance for 'Microsoft.Rtc.Common.Data.MgcCompDatabase'****

Trying to connect to Sql Server DOMAINSQL001.domain.com\Lync2013. using windows authentication...

Sql version: Major: 11, Minor: 0, Build 2100.

Sql version is acceptable.

Checking state for database mgccomp.

VERBOSE: Assigning "BackendStore:BlobStore:LogPath" to C:\CsData

VERBOSE: Assigning "BackendStore:RtcSharedDatabase:LogPath" to C:\CsData

VERBOSE: Assigning "ArchivingStore:ArchivingDatabase:LogPath" to C:\CsData

VERBOSE: Assigning "MonitoringStore:MonitoringDatabase:LogPath" to C:\CsData

VERBOSE: Assigning "MonitoringStore:QoEMetricsDatabase:LogPath" to C:\CsData

VERBOSE: Assigning "ArchivingStore:ArchivingDatabase:DbPath" to C:\CsData

VERBOSE: Assigning "MonitoringStore:MonitoringDatabase:DbPath" to C:\CsData

VERBOSE: Assigning "MonitoringStore:QoEMetricsDatabase:DbPath" to C:\CsData

VERBOSE: Assigning "ABSStore:AbsDatabase:LogPath" to C:\CsData

VERBOSE: Assigning "ApplicationStore:RgsConfigDatabase:LogPath" to C:\CsData

VERBOSE: Assigning "ApplicationStore:RgsDynDatabase:LogPath" to C:\CsData

VERBOSE: Assigning "ApplicationStore:CpsDynDatabase:LogPath" to C:\CsData

VERBOSE: Assigning "PersistentChatStore:MgcDatabase:LogPath" to C:\CsData

VERBOSE: Assigning "PersistentChatComplianceStore:MgcCompDatabase:LogPath" to C:\CsData

VERBOSE: Assigning "BackendStore:BlobStore:DbPath" to C:\CsData

VERBOSE: Assigning "BackendStore:RtcSharedDatabase:DbPath" to C:\CsData

VERBOSE: Assigning "ABSStore:AbsDatabase:DbPath" to C:\CsData

VERBOSE: Assigning "ApplicationStore:RgsConfigDatabase:DbPath" to C:\CsData

VERBOSE: Assigning "ApplicationStore:RgsDynDatabase:DbPath" to C:\CsData

VERBOSE: Assigning "ApplicationStore:CpsDynDatabase:DbPath" to C:\CsData

VERBOSE: Assigning "PersistentChatStore:MgcDatabase:DbPath" to C:\CsData

VERBOSE: Assigning "PersistentChatComplianceStore:MgcCompDatabase:DbPath" to C:\CsData

VERBOSE: Installing "BackendStore" on DOMAINSQL001.domain.com\Lync2013, collocated: False

****Creating DbSetupInstance for 'Microsoft.Rtc.Common.Data.BlobStore'****

Trying to connect to Sql Server DOMAINSQL001.domain.com\Lync2013. using windows authentication...

Sql version: Major: 11, Minor: 0, Build 2100.

Sql version is acceptable.

Checking state for database rtcxds.

Database created by script "BlobStore" already exists and is current.

****Creating DbSetupInstance for 'Microsoft.Rtc.Common.Data.RtcSharedDatabase'****

Trying to connect to Sql Server DOMAINSQL001.domain.com\Lync2013. using windows authentication...

Sql version: Major: 11, Minor: 0, Build 2100.

Sql version is acceptable.

Checking state for database rtcshared.

Database created by script "RtcSharedDatabase" already exists and is current.

VERBOSE: Successfully installed the database. For details, see the following log:

"C:\Users\Administrator.DOMAIN\AppData\Local\Temp\2\Create-BackendStore-DOMAINSQL001.domain.com_Lync2013-[2013_06_05][13_10_24].log"

VERBOSE: Installing "ABSStore" on DOMAINSQL001.domain.com\Lync2013, collocated: False

****Creating DbSetupInstance for 'Microsoft.Rtc.Common.Data.AbsDatabase'****

Trying to connect to Sql Server DOMAINSQL001.domain.com\Lync2013. using windows authentication...

Sql version: Major: 11, Minor: 0, Build 2100.

Sql version is acceptable.

Checking state for database rtcab.

Database created by script "AbsDatabase" already exists and is current.

VERBOSE: Successfully installed the database. For details, see the following log:

"C:\Users\Administrator.DOMAIN\AppData\Local\Temp\2\Create-ABSStore-DOMAINSQL001.domain.com_Lync2013-[2013_06_05][13_10_24].log"

VERBOSE: Installing "ApplicationStore" on DOMAINSQL001.domain.com\Lync2013, collocated: False

****Creating DbSetupInstance for 'Microsoft.Rtc.Common.Data.RgsConfigDatabase'****

Trying to connect to Sql Server DOMAINSQL001.domain.com\Lync2013. using windows authentication...

Sql version: Major: 11, Minor: 0, Build 2100.

Sql version is acceptable.

Checking state for database rgsconfig.

Database created by script "RgsConfigDatabase" already exists and is current.

****Creating DbSetupInstance for 'Microsoft.Rtc.Common.Data.RgsDynDatabase'****

Trying to connect to Sql Server DOMAINSQL001.domain.com\Lync2013. using windows authentication...

Sql version: Major: 11, Minor: 0, Build 2100.

Sql version is acceptable.

Checking state for database rgsdyn.

Database created by script "RgsDynDatabase" already exists and is current.

****Creating DbSetupInstance for 'Microsoft.Rtc.Common.Data.CpsDynDatabase'****

Trying to connect to Sql Server DOMAINSQL001.domain.com\Lync2013. using windows authentication...

Sql version: Major: 11, Minor: 0, Build 2100.

Sql version is acceptable.

Checking state for database cpsdyn.

Creating database cpsdyn from scratch. Data File Path = C:\CsData\ApplicationStore\Lync2013\DbPath, Log File Path= C:\CsData\ApplicationStore\Lync2013\LogPath.

Setting the database cpsdyn to single user mode.

Database cpsdyn set to mode Single.

Setting the database cpsdyn to restricted mode.

Database cpsdyn set to mode Restricted.

WARNING: Setting SQL Server Show Advanced Options to 1

WARNING: Setting SQL Server Recover Interval to 5 mins.

Executing CpsDyn.sql...

Setting owner for database cpsdyn to sa.

Creating login DOMAIN\RTCComponentUniversalServices.

Creating user DOMAIN\RTCComponentUniversalServices.

Creating Schema DOMAIN\RTCComponentUniversalServices.

Creating login DOMAIN\RTCUniversalReadOnlyAdmins.

Creating user DOMAIN\RTCUniversalReadOnlyAdmins.

Creating Schema DOMAIN\RTCUniversalReadOnlyAdmins.

Creating login DOMAIN\RTCUniversalServerAdmins.

Creating user DOMAIN\RTCUniversalServerAdmins.

Creating Schema DOMAIN\RTCUniversalServerAdmins.

Adding account DOMAIN\RTCComponentUniversalServices to role ReadWriteRole.

Adding account DOMAIN\RTCUniversalServerAdmins to role ReadWriteRole.

Adding account DOMAIN\RTCUniversalReadOnlyAdmins to role ReadOnlyRole.

Setting database version: Schema Version 1, Sproc Version 1, Update Version 2.

Setting the database cpsdyn to multi user mode.

Database cpsdyn is set to multi user mode.

VERBOSE: Successfully installed the database. For details, see the following log:

"C:\Users\Administrator.DOMAIN\AppData\Local\Temp\2\Create-ApplicationStore-DOMAINSQL001.domain.com_Lync2013-[2013_06_05][13_10_25].log

VERBOSE: Installing "ArchivingStore" on DOMAINSQL001.domain.com\Lync2013, collocated: False

****Creating DbSetupInstance for 'Microsoft.Rtc.Common.Data.ArchivingDatabase'****

Trying to connect to Sql Server DOMAINSQL001.domain.com\Lync2013. using windows authentication...

Sql version: Major: 11, Minor: 0, Build 2100.

Sql version is acceptable.

Checking state for database LcsLog.

Database created by script "ArchivingDatabase" already exists and is current.

VERBOSE: Successfully installed the database. For details, see the following log:

"C:\Users\Administrator.DOMAIN\AppData\Local\Temp\2\Create-ArchivingStore-DOMAINSQL001.domain.com_Lync2013-[2013_06_05][13_10_34].log"

VERBOSE: Installing "MonitoringStore" on DOMAINSQL001.domain.com\Lync2013, collocated: False

****Creating DbSetupInstance for 'Microsoft.Rtc.Common.Data.MonitoringDatabase'****

Trying to connect to Sql Server DOMAINSQL001.domain.com\Lync2013. using windows authentication...

Sql version: Major: 11, Minor: 0, Build 2100.

Sql version is acceptable.

Checking state for database LcsCDR.

Database created by script "MonitoringDatabase" already exists and is current.

****Creating DbSetupInstance for 'Microsoft.Rtc.Common.Data.QoEMetricsDatabase'****

Trying to connect to Sql Server DOMAINSQL001.domain.com\Lync2013. using windows authentication...

Sql version: Major: 11, Minor: 0, Build 2100.

Sql version is acceptable.

Checking state for database QoEMetrics.

Database created by script "QoEMetricsDatabase" already exists and is current.

VERBOSE: Successfully installed the database. For details, see the following log:

"C:\Users\Administrator.DOMAIN\AppData\Local\Temp\2\Create-MonitoringStore-DOMAINSQL001.domain.com_Lync2013-[2013_06_05][13_10_34].log"

VERBOSE: Installing "PersistentChatStore" on DOMAINSQL001.domain.com\Lync2013, collocated: False

****Creating DbSetupInstance for 'Microsoft.Rtc.Common.Data.MgcDatabase'****

Trying to connect to Sql Server DOMAINSQL001.domain.com\Lync2013. using windows authentication...

Sql version: Major: 11, Minor: 0, Build 2100.

Sql version is acceptable.

Checking state for database mgc.

State of database mgc is DbState_NotAccessible.

Database 'mgc' exists but not accessible. It must be repaired manually or dropped and a new one created. if you want to preserve data, you must use this product's backup/e

. Examine the product documentation for instructions.

Install-CsDatabase : An error occurred while creating or updating the database for feature PersistentChatStore. For details, see the log file

'C:\Users\Administrator.DOMAIN\AppData\Local\Temp\2\Create-PersistentChatStore-DOMAINSQL001.domain.com_Lync2013-[2013_06_05][13_10_34].log'

At line:1 char:1

+ Install-CsDatabase -ConfiguredDatabases -SqlServerFqdn DOMAINSQL001.mylynclab.c ...

+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

+ CategoryInfo : InvalidOperation: (:SourceCollection) [Install-CsDatabase], DbSetupDatabaseInUnusableStateException

+ FullyQualifiedErrorId : InstallDatabaseInternalFailure,Microsoft.Rtc.Management.Deployment.InstallDatabaseCmdlet

VERBOSE: Successfully installed the database. For details, see the following log:

"C:\Users\Administrator.DOMAIN\AppData\Local\Temp\2\Create-PersistentChatStore-DOMAINSQL001.domain.com_Lync2013-[2013_06_05][13_10_34].

log"

VERBOSE: Installing "PersistentChatComplianceStore" on DOMAINSQL001.domain.com\Lync2013, collocated: False

****Creating DbSetupInstance for 'Microsoft.Rtc.Common.Data.MgcCompDatabase'****

Trying to connect to Sql Server DOMAINSQL001.domain.com\Lync2013. using windows authentication...

Sql version: Major: 11, Minor: 0, Build 2100.

Sql version is acceptable.

Checking state for database mgccomp.

State of database mgccomp is DbState_NotAccessible.

Database 'mgccomp' exists but not accessible. It must be repaired manually or dropped and a new one created. if you want to preserve data, you must use this product's back

tion. Examine the product documentation for instructions.

Install-CsDatabase : An error occurred while creating or updating the database for feature PersistentChatComplianceStore. For details, see the log file

'C:\Users\Administrator.DOMAIN\AppData\Local\Temp\2\Create-PersistentChatComplianceStore-DOMAINSQL001.domain.com_Lync2013-[2013_06_05][13_10_34].log'

At line:1 char:1

+ Install-CsDatabase -ConfiguredDatabases -SqlServerFqdn DOMAINSQL001.mylynclab.c ...

+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

+ CategoryInfo : InvalidOperation: (:SourceCollection) [Install-CsDatabase], DbSetupDatabaseInUnusableStateException

+ FullyQualifiedErrorId : InstallDatabaseInternalFailure,Microsoft.Rtc.Management.Deployment.InstallDatabaseCmdlet

VERBOSE: Successfully installed the database. For details, see the following log:

"C:\Users\Administrator.DOMAIN\AppData\Local\Temp\2\Create-PersistentChatComplianceStore-DOMAINSQL001.domain.com_Lync2013-[2013_06_05][

13_10_34].log"

VERBOSE: No changes were made to the Central Management Store.

VERBOSE: Creating new log file

"C:\Users\Administrator.DOMAIN\AppData\Local\Temp\2\Install-CsDatabase-817afad5-d1d5-42dc-a4cf-70589c7bdd09.html".

WARNING: Install-CsDatabase encountered errors. Consult the log file for a detailed analysis, and ensure all errors (4) and warnings (2) are

addressed before continuing.

WARNING: Detailed results can be found at

"C:\Users\Administrator.DOMAIN\AppData\Local\Temp\2\Install-CsDatabase-817afad5-d1d5-42dc-a4cf-70589c7bdd09.html".

As you can see in the above output, I had two failures in the upgrade process. These failures were on the ‘mgc’ and the ‘mgccomp’ database, which both happen to be Persistent Chat databases. The reason for this was that I didn’t check if they were running on the Primary SQL instance back in Step 3 (I did this for the example to show what happens when you don’t do this. Really you should have done this check back in Step 3). So now when I check the status of the Persistent Chat databases with the Database Mirror Manager I notice that they are both on the Secondary SQL instance:

To change these back over I just clicked on the Primary check boxes for both of these databases and then click the Invokebutton. Within the Powershell window you will be asked if you want to change the PersistentChat and PersistentChatCompliance databases over to Primary, which you answer “y” to:

Invoking change of PersistentChat database to Primary

Confirm

Are you sure you want to perform this action?

Performing operation "Invoke-CsDatabaseFailover" on Target "PersistentChatService".

[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"): y

Invoking change of PersistentChatCompliance database to Primary

Confirm

Are you sure you want to perform this action?

Performing operation "Invoke-CsDatabaseFailover" on Target "PersistentChatService".

[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"): y

---------------------------------------------------

Now the Persistent Chat databases are running back on the Primary SQL. So run the Install-CsDatabase command again to ensure that the Persistent Chat databases are also updated:

PS C:\Users\Administrator.DOMAIN> Install-CsDatabase -ConfiguredDatabases -SqlServerFqdn DOMAINSQL001.domain.com -Verbose

VERBOSE: Creating new log file

"C:\Users\Administrator.DOMAIN\AppData\Local\Temp\2\Install-CsDatabase-01cfc038-b340-4894-91a1-55d3864d7c2c.xml".

VERBOSE: Install databases required by Lync Server role(s).

VERBOSE: Skipping Central Management Database "1-CentralMgmtStore-1". Central Management Databases are installed using the

-CentralManagementDatabase parameter.

****Creating DbSetupInstance for 'Microsoft.Rtc.Common.Data.BlobStore'****

Trying to connect to Sql Server DOMAINSQL001.domain.com\Lync2013. using windows authentication...

Sql version: Major: 11, Minor: 0, Build 2100.

Sql version is acceptable.

Checking state for database rtcxds.

****Creating DbSetupInstance for 'Microsoft.Rtc.Common.Data.RtcSharedDatabase'****

Trying to connect to Sql Server DOMAINSQL001.domain.com\Lync2013. using windows authentication...

Sql version: Major: 11, Minor: 0, Build 2100.

Sql version is acceptable.

Checking state for database rtcshared.

****Creating DbSetupInstance for 'Microsoft.Rtc.Common.Data.AbsDatabase'****

Trying to connect to Sql Server DOMAINSQL001.domain.com\Lync2013. using windows authentication...

Sql version: Major: 11, Minor: 0, Build 2100.

Sql version is acceptable.

Checking state for database rtcab.

****Creating DbSetupInstance for 'Microsoft.Rtc.Common.Data.RgsConfigDatabase'****

Trying to connect to Sql Server DOMAINSQL001.domain.com\Lync2013. using windows authentication...

Sql version: Major: 11, Minor: 0, Build 2100.

Sql version is acceptable.

Checking state for database rgsconfig.

****Creating DbSetupInstance for 'Microsoft.Rtc.Common.Data.RgsDynDatabase'****

Trying to connect to Sql Server DOMAINSQL001.domain.com\Lync2013. using windows authentication...

Sql version: Major: 11, Minor: 0, Build 2100.

Sql version is acceptable.

Checking state for database rgsdyn.

****Creating DbSetupInstance for 'Microsoft.Rtc.Common.Data.CpsDynDatabase'****

Trying to connect to Sql Server DOMAINSQL001.domain.com\Lync2013. using windows authentication...

Sql version: Major: 11, Minor: 0, Build 2100.

Sql version is acceptable.

Checking state for database cpsdyn.

****Creating DbSetupInstance for 'Microsoft.Rtc.Common.Data.ArchivingDatabase'****

Trying to connect to Sql Server DOMAINSQL001.domain.com\Lync2013. using windows authentication...

Sql version: Major: 11, Minor: 0, Build 2100.

Sql version is acceptable.

Checking state for database LcsLog.

****Creating DbSetupInstance for 'Microsoft.Rtc.Common.Data.MonitoringDatabase'****

Trying to connect to Sql Server DOMAINSQL001.domain.com\Lync2013. using windows authentication...

Sql version: Major: 11, Minor: 0, Build 2100.

Sql version is acceptable.

Checking state for database LcsCDR.

****Creating DbSetupInstance for 'Microsoft.Rtc.Common.Data.QoEMetricsDatabase'****

Trying to connect to Sql Server DOMAINSQL001.domain.com\Lync2013. using windows authentication...

Sql version: Major: 11, Minor: 0, Build 2100.

Sql version is acceptable.

Checking state for database QoEMetrics.

****Creating DbSetupInstance for 'Microsoft.Rtc.Common.Data.MgcDatabase'****

Trying to connect to Sql Server DOMAINSQL001.domain.com\Lync2013. using windows authentication...

Sql version: Major: 11, Minor: 0, Build 2100.

Sql version is acceptable.

Checking state for database mgc.

****Creating DbSetupInstance for 'Microsoft.Rtc.Common.Data.MgcCompDatabase'****

Trying to connect to Sql Server DOMAINSQL001.domain.com\Lync2013. using windows authentication...

Sql version: Major: 11, Minor: 0, Build 2100.

Sql version is acceptable.

Checking state for database mgccomp.

VERBOSE: All databases at the specified installation location are already up to date.

VERBOSE: No changes were made to the Central Management Store.

VERBOSE: Creating new log file

"C:\Users\Administrator.DOMAIN\AppData\Local\Temp\2\Install-CsDatabase-01cfc038-b340-4894-91a1-55d3864d7c2c.html".

VERBOSE: "Install-CsDatabase" processing has completed successfully.

VERBOSE: Detailed results can be found at

"C:\Users\Administrator.DOMAIN\AppData\Local\Temp\2\Install-CsDatabase-01cfc038-b340-4894-91a1-55d3864d7c2c.html".

PS C:\Users\Administrator.DOMAIN>

Now our Application database schema has been updated and is ready to run all the new features of CU1.

Step 6: Re-establish the Database Mirror

Run the following command:

Install-CsMirrorDatabase -DatabaseType Application -SqlServerFQDN DOMAINSQL001.domain.com -SqlInstanceName Lync2013 -FileShare \\DOMAINSQL001.domain.com\FileShare-Verbose

Command output example:

PS > Install-CsMirrorDatabase -DatabaseType Application -SqlServerFQDN DOMAINSQL001.domain.com -SqlInstanceName Lync2013 -FileShare "\\DOMAINSQL001.domain.com\Fil

eShare" -Verbose

VERBOSE: Creating new log file

"C:\Users\Administrator.DOMAIN\AppData\Local\Temp\2\Install-CsMirrorDatabase-be00671d-7932-4f68-b657-66a9b3c560e6.xml".

Install Mirror Database

This cmdlet sets up mirroring for databases on primary SQL Server instance on the mirror SQL Server instance. If a witness is specified, it also sets up a witness for databases on the primary SQL Server instance.

The following databases will be mirrored and configured with a witness if a witness is specified:

Database Name:rgsconfig

Data File:C:\CsData\ApplicationStore\Lync2013\DbPath\rgsconfig.mdf

Log File:C:\CsData\ApplicationStore\Lync2013\LogPath\rgsconfig.ldf

Primary SQL: DOMAINSQL001.domain.com\Lync2013

Account: DOMAIN\DOMAINSQL001$

Mirror SQL: DOMAINSQL002.domain.com\Lync2013

Account: DOMAIN\DOMAINSQL002$

Witness SQL : DOMAINSQL003.domain.com\Lync2013

Account: DOMAIN\DOMAINSQL003$

Database Name:rgsdyn

Data File:C:\CsData\ApplicationStore\Lync2013\DbPath\rgsdyn.mdf

Log File:C:\CsData\ApplicationStore\Lync2013\LogPath\rgsdyn.ldf

Primary SQL: DOMAINSQL001.domain.com\Lync2013

Account: DOMAIN\DOMAINSQL001$

Mirror SQL: DOMAINSQL002.domain.com\Lync2013

Account: DOMAIN\DOMAINSQL002$

Witness SQL : DOMAINSQL003.domain.com\Lync2013

Account: DOMAIN\DOMAINSQL003$

Database Name:cpsdyn

Data File:C:\CsData\ApplicationStore\Lync2013\DbPath\cpsdyn.mdf

Log File:C:\CsData\ApplicationStore\Lync2013\LogPath\cpsdyn.ldf

Primary SQL: DOMAINSQL001.domain.com\Lync2013

Account: DOMAIN\DOMAINSQL001$

Mirror SQL: DOMAINSQL002.domain.com\Lync2013

Account: DOMAIN\DOMAINSQL002$

Witness SQL : DOMAINSQL003.domain.com\Lync2013

Account: DOMAIN\DOMAINSQL003$

Verify that the following things are taken care of before proceeding:

Port 5022 is accessible through the firewall if Windows Firewall is enabled in the primary SQL Server

DOMAINSQL001.domain.com\Lync2013.

Port 5022 is accessible through the firewall if Windows Firewall is enabled in the mirror SQL Server

DOMAINSQL002.domain.com\Lync2013.

Port 7022 is accessible through the firewall if Windows Firewall is enabled in the witness SQL Server

DOMAINSQL003.domain.com\Lync2013.

Accounts running the SQL Servers on all primary and mirror SQL servers have read/write permissions to the file share

\\DOMAINSQL001.domain.com\FileShare

The cmdlet will use WMI provider to find the account information for SQL Server services running on all primary, mirror and witness

servers. Verify that WMI provider is running on all these servers.

The cmdlet will try to create folders for data and log files for all the mirror servers. Verify that the account running this cmdlet has

permission to create these folders.

[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"): y

VERBOSE: Mirroring was configured successfully for database "rgsconfig".

VERBOSE: Witness was configured successfully for database "rgsconfig".

VERBOSE: Mirroring was configured successfully for database "rgsdyn".

VERBOSE: Witness was configured successfully for database "rgsdyn".

VERBOSE: Mirroring was configured successfully for database "cpsdyn".

VERBOSE: Witness was configured successfully for database "cpsdyn".

VERBOSE: Successfully created SQL Server Agent jobs on DOMAINSQL002.domain.com\Lync2013.

VERBOSE: No changes were made to the Central Management Store.

VERBOSE: Creating new log file

"C:\Users\Administrator.DOMAIN\AppData\Local\Temp\2\Install-CsMirrorDatabase-be00671d-7932-4f68-b657-66a9b3c560e6.html".

VERBOSE: "Install-CsMirrorDatabase" processing has completed successfully.

VERBOSE: Detailed results can be found at

"C:\Users\Administrator.DOMAIN\AppData\Local\Temp\2\Install-CsMirrorDatabase-be00671d-7932-4f68-b657-66a9b3c560e6.html".

PS C:\Users\Administrator.DOMAIN>

Note: If you get an RPC error at this point like the example I've provided below, it’s likely caused by ports being blocked on the Windows Firewall of the SQL servers.

PS > Install-CsMirrorDatabase -DatabaseType Application -SqlServerFQDN DOMAINSQL001.domain.com -SqlInstanceName Lync2013 -FileShare "\\DOMAINSQL001.domain.com\FileShare" -Verbose

VERBOSE: Creating new log file

"C:\Users\Administrator.DOMAIN\AppData\Local\Temp\2\Install-CsMirrorDatabase-20abaefd-828b-4920-b221-6d15774ea486.xml".

VERBOSE: Creating new log file

"C:\Users\Administrator.DOMAIN\AppData\Local\Temp\2\Install-CsMirrorDatabase-20abaefd-828b-4920-b221-6d15774ea486.html".

WARNING: Install-CsMirrorDatabase failed.

WARNING: Detailed results can be found at

"C:\Users\Administrator.DOMAIN\AppData\Local\Temp\2\Install-CsMirrorDatabase-20abaefd-828b-4920-b221-6d15774ea486.html".

Install-CsMirrorDatabase : Command execution failed: The RPC server is unavailable. (Exception from HRESULT: 0x800706BA)

At line:1 char:1

+ Install-CsMirrorDatabase -DatabaseType Application -SqlServerFQDN DOMAINSQL001. ...

+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

+ CategoryInfo : InvalidOperation: (:) [Install-CsMirrorDatabase], COMException

+ FullyQualifiedErrorId : ProcessingFailed,Microsoft.Rtc.Management.Deployment.InstallMirrorDatabaseCmdlet

From the testing that I have done, I’ve found that the Ports that need to be open to avoid these errors are TCP 135, TCP 445 and TCP 49154-49155. This is in addition to the SQL Mirroring signalling ports that also need to be opened: TCP 5022 on the Primary and Secondary servers, and TCP 7022 on the Witness server (also the regular SQL ports UDP 1434, TCP 1433, and the Dynamic TCP port used when Named SQL database is used).

Step 7: Confirm that the databases are all back up and running

Check the state of the database mirror:

Get-CsDatabaseMirrorState -PoolFqdn melbfepool.domain.com -Verbose

Note: You could also do this check with the Mirror Manager Tool. However, just in case there is some edge case where the mirror has failed to re-establish (with an error I haven’t seen before), it’s probably best to use the command in this circumstance.

PS C:\Users\Administrator.DOMAIN> Get-CsDatabaseMirrorState -PoolFqdn melbfepool.domain.com -Verbose

VERBOSE: Creating new log file

"C:\Users\Administrator.DOMAIN\AppData\Local\Temp\2\Get-CsDatabaseMirrorState-22e57066-60a0-4d5a-a699-3e7e0fcf3894.

xml".

VERBOSE: Primary SQL Server Instance: DOMAINSQL001.domain.com\Lync2013

VERBOSE: Mirror SQL Server Instance: DOMAINSQL002.domain.com\Lync2013

DatabaseName : rtcab

StateOnPrimary : Principal

StateOnMirror : Mirror

MirroringStatusOnPrimary : synchronized

MirroringStatusOnMirror : synchronized

DatabaseName : rtcxds

StateOnPrimary : Principal

StateOnMirror : Mirror

MirroringStatusOnPrimary : synchronized

MirroringStatusOnMirror : synchronized

DatabaseName : rtcshared

StateOnPrimary : Principal

StateOnMirror : Mirror

MirroringStatusOnPrimary : synchronized

MirroringStatusOnMirror : synchronized

VERBOSE: Primary SQL Server Instance: DOMAINSQL001.domain.com\Lync2013

VERBOSE: Mirror SQL Server Instance: DOMAINSQL002.domain.com\Lync2013

DatabaseName : lcscdr

StateOnPrimary : Principal

StateOnMirror : Mirror

MirroringStatusOnPrimary : synchronized

MirroringStatusOnMirror : synchronized

DatabaseName : qoemetrics

StateOnPrimary : Principal

StateOnMirror : Mirror

MirroringStatusOnPrimary : synchronized

MirroringStatusOnMirror : synchronized

VERBOSE: Primary SQL Server Instance: DOMAINSQL001.domain.com\Lync2013

VERBOSE: Mirror SQL Server Instance: DOMAINSQL002.domain.com\Lync2013

DatabaseName : lcslog

StateOnPrimary : Principal

StateOnMirror : Mirror

MirroringStatusOnPrimary : synchronized

MirroringStatusOnMirror : synchronized

VERBOSE: Primary SQL Server Instance: DOMAINSQL001.domain.com\Lync2013

VERBOSE: Mirror SQL Server Instance: DOMAINSQL002.domain.com\Lync2013

DatabaseName : rgsconfig

StateOnPrimary : Principal

StateOnMirror : Mirror

MirroringStatusOnPrimary : synchronized

MirroringStatusOnMirror : synchronized

DatabaseName : rgsdyn

StateOnPrimary : Principal

StateOnMirror : Mirror

MirroringStatusOnPrimary : synchronized

MirroringStatusOnMirror : synchronized

DatabaseName : cpsdyn

StateOnPrimary : Principal

StateOnMirror : Mirror

MirroringStatusOnPrimary : synchronized

MirroringStatusOnMirror : synchronized

VERBOSE: Primary SQL Server Instance: DOMAINSQL001.domain.com\Lync2013

VERBOSE: Mirror SQL Server Instance: DOMAINSQL002.domain.com\Lync2013

DatabaseName : xds

StateOnPrimary : Principal

StateOnMirror : Mirror

MirroringStatusOnPrimary : synchronized

MirroringStatusOnMirror : synchronized

DatabaseName : lis

StateOnPrimary : Principal

StateOnMirror : Mirror

MirroringStatusOnPrimary : synchronized

MirroringStatusOnMirror : synchronized

VERBOSE: No changes were made to the Central Management Store.

VERBOSE: Creating new log file

"C:\Users\Administrator.DOMAIN\AppData\Local\Temp\2\Get-CsDatabaseMirrorState-22e57066-60a0-4d5a-a699-3e7e0fcf3894.

html".

VERBOSE: "Get-CsDatabaseMirrorState" processing has completed successfully.

VERBOSE: Detailed results can be found at

"C:\Users\Administrator.DOMAIN\AppData\Local\Temp\2\Get-CsDatabaseMirrorState-22e57066-60a0-4d5a-a699-3e7e0fcf3894.

html".

PS >

From the above output you will see that rgsconfig, rgsdyn, and cpsdyn are back in Principal state on the Primary server.

Step 8 (Optional):If you have your Archiving and Monitoring databases on a different SQL backend than the main Lync databases are stored you need to run the install on it now:

Install-CsDatabase -ConfiguredDatabases -SqlServerFqdn DOMAINARC001.domain.com -Verbose

Step 9: After we have finished updating all the Lync databases we need to now update the CMS database with the following command:

Install-CsDatabase -CentralManagementDatabase –SqlServerFqdn DOMAINSQL001.domain.com-SqlInstanceName Lync2013–Verbose

The output of the command will look something like this:

PS C:\Users\Administrator.DOMAIN> Install-CsDatabase -CentralManagementDatabase -SqlServerFqdn DOMAINSQL001.domain.com -SqlInstanceName Lync2013 -Verbose

VERBOSE: Creating new log file

"C:\Users\Administrator.DOMAIN\AppData\Local\Temp\2\Install-CsDatabase-6b47e723-1091-4669-bb19-c1d673ad5612.xml".

VERBOSE: Install databases required by Lync Server role(s).

****Creating DbSetupInstance for 'Microsoft.Rtc.Common.Data.XdsDatabase'****

Trying to connect to Sql Server DOMAINSQL001.domain.com\Lync2013. using windows authentication...

Sql version: Major: 11, Minor: 0, Build 2100.

Sql version is acceptable.

Checking state for database xds.

VERBOSE: Assigning "CentralMgmtStore:XdsDatabase:LogPath" to C:\CsData

VERBOSE: Assigning "CentralMgmtStore:LisDatabase:LogPath" to C:\CsData

VERBOSE: Assigning "CentralMgmtStore:XdsDatabase:DbPath" to C:\CsData

VERBOSE: Assigning "CentralMgmtStore:LisDatabase:DbPath" to C:\CsData

VERBOSE: Installing "CentralMgmtStore" on DOMAINSQL001.domain.com\Lync2013, collocated: False

****Creating DbSetupInstance for 'Microsoft.Rtc.Common.Data.XdsDatabase'****

Trying to connect to Sql Server DOMAINSQL001.domain.com\Lync2013. using windows authentication...

Sql version: Major: 11, Minor: 0, Build 2100.

Sql version is acceptable.

Checking state for database xds.

State of database xds is DbState_RequiresMinorUpgrade.

Database xds set to mode Restricted.

Dropping all procedures, functions and views from database xds.

Executing Xds.sql...

Adding master role...

Setting database state to active...

Setting owner for database xds to sa.

Creating login DOMAIN\RTCUniversalConfigReplicator.

Creating user DOMAIN\RTCUniversalConfigReplicator.

Creating Schema DOMAIN\RTCUniversalConfigReplicator.

Creating login DOMAIN\RTCUniversalReadOnlyAdmins.

Creating user DOMAIN\RTCUniversalReadOnlyAdmins.

Creating Schema DOMAIN\RTCUniversalReadOnlyAdmins.

Creating login DOMAIN\RTCUniversalServerAdmins.

Creating user DOMAIN\RTCUniversalServerAdmins.

Creating Schema DOMAIN\RTCUniversalServerAdmins.

Adding account DOMAIN\RTCUniversalReadOnlyAdmins to role ConsumerRole.

Adding account DOMAIN\RTCUniversalConfigReplicator to role ReplicatorRole.

Adding account DOMAIN\RTCUniversalServerAdmins to role PublisherRole.

Setting database version: Schema Version 10, Sproc Version 13, Update Version 2.

Setting the database xds to multi user mode.

Database xds is set to multi user mode.

****Creating DbSetupInstance for 'Microsoft.Rtc.Common.Data.LisDatabase'****

Trying to connect to Sql Server DOMAINSQL001.domain.com\Lync2013. using windows authentication...

Sql version: Major: 11, Minor: 0, Build 2100.

Sql version is acceptable.

Checking state for database lis.

Database created by script "LisDatabase" already exists and is current.

VERBOSE: Successfully installed the database. For details, see the following log:

"C:\Users\Administrator.DOMAIN\AppData\Local\Temp\2\Create-CentralMgmtStore-DOMAINSQL001.domain.com_Lync2013-[2013_06_05][17_01_59].log

VERBOSE: Creating new log file

"C:\Users\Administrator.DOMAIN\AppData\Local\Temp\2\Install-CsDatabase-6b47e723-1091-4669-bb19-c1d673ad5612.html".

VERBOSE: "Install-CsDatabase" processing has completed successfully.

VERBOSE: Detailed results can be found at

"C:\Users\Administrator.DOMAIN\AppData\Local\Temp\2\Install-CsDatabase-6b47e723-1091-4669-bb19-c1d673ad5612.html".

PS C:\Users\Administrator.DOMAIN>

Step 10: To enable the Mobility service, run the following cmdlet:

Enable-CsTopology

Step 11: To enable the Unified Communications Web API (UCWA), you must run the Bootstrapper.exe tool again on all Lync Server 2013 servers on which the Web Components were installed and updated. The command to run the tool is as follows:

"%ProgramFiles%\Microsoft Lync Server 2013\Deployment\Bootstrapper.exe"

The command executes like this:

C:\Program Files\Common Files\Microsoft Lync Server 2013>"%ProgramFiles%\Microsoft Lync Server 2013\Deployment\Bootstrapper.exe"

Logging status to: C:\Users\Administrator.DOMAIN\AppData\Local\Temp\2\Bootstrap-CsMachine-[2013_06_06][10_17_38].html

Checking prerequisites for bootstrapper...

Checking prerequisite WMIEnabled...prerequisite satisfied.

Checking prerequisite NoBootstrapperOnBranchOfficeAppliance...prerequisite satisfied.

Checking prerequisite SupportedOS...prerequisite satisfied.

Checking prerequisite NoOtherVersionInstalled...prerequisite satisfied.

Host name: DOMAINfe001.domain.com

Disabling unused roles...

Executing PowerShell command: Disable-CSComputer -Confirm:$false -Verbose -Report "C:\Users\Administrator.DOMAIN\AppData\Local\Temp\2\Disable-CSComputer-[2013_06_06][10_17_48].html"

Checking prerequisites for roles...

Checking prerequisite SupportedOS...prerequisite satisfied.

Checking prerequisite SupportedOSNoDC...prerequisite satisfied.

Checking prerequisite SupportedSqlRtcLocal...prerequisite satisfied.

Checking prerequisite WMIEnabled...prerequisite satisfied.

Checking prerequisite NoOtherVersionInstalled...prerequisite satisfied.

Checking prerequisite PowerShell...prerequisite satisfied.

Checking prerequisite WindowsIdentityFoundation...prerequisite satisfied.

Checking prerequisite SupportedServerOS...prerequisite satisfied.

Checking prerequisite NoUnsupportedWinFab...prerequisite satisfied.

Checking prerequisite SupportedSqlLyncLocal...prerequisite satisfied.

Checking prerequisite IIS...prerequisite satisfied.

Checking prerequisite IIS7Features...prerequisite satisfied.

Checking prerequisite ASPNet...prerequisite satisfied.

Checking prerequisite KB2646886Installed...prerequisite satisfied.

Checking prerequisite BranchCacheBlock...prerequisite satisfied.

Checking prerequisite WCF...prerequisite satisfied.

Checking prerequisite WindowsMediaFoundation...prerequisite satisfied.

Checking prerequisite SqlInstanceRtcLocal...prerequisite satisfied.

Checking prerequisite VCredist...prerequisite satisfied.

Checking prerequisite SqlNativeClient...prerequisite satisfied.

Checking prerequisite SqlClrTypes...prerequisite satisfied.

Checking prerequisite SqlSharedManagementObjects...prerequisite satisfied.

Checking prerequisite UcmaRedist...prerequisite satisfied.

Checking prerequisite WinFab...prerequisite satisfied.

Checking prerequisite MicrosoftIdentityExtensions...prerequisite satisfied.

Checking prerequisite SqlInstanceLyncLocal...prerequisite satisfied.

Checking prerequisite RewriteModule...prerequisite satisfied.

Checking prerequisite SpeechPlatformRuntime...prerequisite satisfied.

Checking prerequisite MSSpeech_TTS_ca-ES_Herena...prerequisite satisfied.

Checking prerequisite MSSpeech_TTS_da-DK_Helle...prerequisite satisfied.

Checking prerequisite MSSpeech_TTS_de-DE_Hedda...prerequisite satisfied.

Checking prerequisite MSSpeech_TTS_en-AU_Hayley...prerequisite satisfied.

Checking prerequisite MSSpeech_TTS_en-CA_Heather...prerequisite satisfied.

Checking prerequisite MSSpeech_TTS_en-GB_Hazel...prerequisite satisfied.

Checking prerequisite MSSpeech_TTS_en-IN_Heera...prerequisite satisfied.

Checking prerequisite MSSpeech_TTS_en-US_Helen...prerequisite satisfied.

Checking prerequisite MSSpeech_TTS_es-ES_Helena...prerequisite satisfied.

Checking prerequisite MSSpeech_TTS_es-MX_Hilda...prerequisite satisfied.

Checking prerequisite MSSpeech_TTS_fi-FI_Heidi...prerequisite satisfied.

Checking prerequisite MSSpeech_TTS_fr-CA_Harmonie...prerequisite satisfied.

Checking prerequisite MSSpeech_TTS_fr-FR_Hortense...prerequisite satisfied.

Checking prerequisite MSSpeech_TTS_it-IT_Lucia...prerequisite satisfied.

Checking prerequisite MSSpeech_TTS_ja-JP_Haruka...prerequisite satisfied.

Checking prerequisite MSSpeech_TTS_ko-KR_Heami...prerequisite satisfied.

Checking prerequisite MSSpeech_TTS_nb-NO_Hulda...prerequisite satisfied.

Checking prerequisite MSSpeech_TTS_nl-NL_Hanna...prerequisite satisfied.

Checking prerequisite MSSpeech_TTS_pl-PL_Paulina...prerequisite satisfied.

Checking prerequisite MSSpeech_TTS_pt-BR_Heloisa...prerequisite satisfied.

Checking prerequisite MSSpeech_TTS_pt-PT_Helia...prerequisite satisfied.

Checking prerequisite MSSpeech_TTS_ru-RU_Elena...prerequisite satisfied.

Checking prerequisite MSSpeech_TTS_sv-SE_Hedvig...prerequisite satisfied.

Checking prerequisite MSSpeech_TTS_zh-CN_HuiHui...prerequisite satisfied.

Checking prerequisite MSSpeech_TTS_zh-HK_HunYee...prerequisite satisfied.

Checking prerequisite MSSpeech_TTS_zh-TW_HanHan...prerequisite satisfied.

Checking prerequisite MSSpeech_SR_ca-ES_TELE...prerequisite satisfied.

Checking prerequisite MSSpeech_SR_da-DK_TELE...prerequisite satisfied.

Checking prerequisite MSSpeech_SR_de-DE_TELE...prerequisite satisfied.

Checking prerequisite MSSpeech_SR_en-AU_TELE...prerequisite satisfied.

Checking prerequisite MSSpeech_SR_en-CA_TELE...prerequisite satisfied.

Checking prerequisite MSSpeech_SR_en-GB_TELE...prerequisite satisfied.

Checking prerequisite MSSpeech_SR_en-IN_TELE...prerequisite satisfied.

Checking prerequisite MSSpeech_SR_en-US_TELE...prerequisite satisfied.

Checking prerequisite MSSpeech_SR_es-ES_TELE...prerequisite satisfied.

Checking prerequisite MSSpeech_SR_es-MX_TELE...prerequisite satisfied.

Checking prerequisite MSSpeech_SR_fi-FI_TELE...prerequisite satisfied.

Checking prerequisite MSSpeech_SR_fr-CA_TELE...prerequisite satisfied.

Checking prerequisite MSSpeech_SR_fr-FR_TELE...prerequisite satisfied.

Checking prerequisite MSSpeech_SR_it-IT_TELE...prerequisite satisfied.

Checking prerequisite MSSpeech_SR_ja-JP_TELE...prerequisite satisfied.

Checking prerequisite MSSpeech_SR_ko-KR_TELE...prerequisite satisfied.

Checking prerequisite MSSpeech_SR_nb-NO_TELE...prerequisite satisfied.

Checking prerequisite MSSpeech_SR_nl-NL_TELE...prerequisite satisfied.

Checking prerequisite MSSpeech_SR_pl-PL_TELE...prerequisite satisfied.

Checking prerequisite MSSpeech_SR_pt-BR_TELE...prerequisite satisfied.

Checking prerequisite MSSpeech_SR_pt-PT_TELE...prerequisite satisfied.

Checking prerequisite MSSpeech_SR_ru-RU_TELE...prerequisite satisfied.

Checking prerequisite MSSpeech_SR_sv-SE_TELE...prerequisite satisfied.

Checking prerequisite MSSpeech_SR_zh-CN_TELE...prerequisite satisfied.

Checking prerequisite MSSpeech_SR_zh-HK_TELE...prerequisite satisfied.

Checking prerequisite MSSpeech_SR_zh-TW_TELE...prerequisite satisfied.

Checking prerequisite UcmaWorkflowRuntime...prerequisite satisfied.

Installing any collocated databases...

Executing PowerShell command: Install-CSDatabase -Confirm:$false -Verbose -LocalDatabases -Report "C:\Users\Administrator.DOMAIN\AppData\Local\Temp\2\Install-CSDatabase-[2013_06_06][10_17_54].html"

Enabling new roles...

This step will configure services, apply permissions, create firewall rules, etc.

Executing PowerShell command: Enable-CSComputer -Confirm:$false -Verbose -Report "C:\Users\Administrator.DOMAIN\AppData\Local\Temp\2\Enable-CSComputer-[2013_06_06][10_18_28].html"

Complete.

Log file was: %TEMP%\Bootstrap-CsMachine-[2013_06_06][10_17_38].html

And we’re done!

The Wrap Up

It’s safe to say that updating a Lync server with a Mirrored Database is a bit more involved than doing a single database server. It’s one of those processes that if taken lightly might cause you some grief in the real world. Hopefully this post will help to make your life a little easier.

↧

Lync 2013 Call Pickup Group Manager

October 12, 2013, 7:31 am

≫ Next: Lync 2013 Centralised Logging Deep Dive

≪ Previous: Installing Lync 2013 Cumulative Updates with Mirrored Databases

In Lync 2013 Cumulative Update 1 (February Update) Microsoft added the new call pickup group feature. Call pickup has been a classic voice feature since the very early days of PBXs. As a result, lots of businesses are still used to being able to answer other people’s calls by dialling special access codes from their phone. So it’s great that Lync finally has this capability to help ease some of the pain points for businesses transitioning from their previous traditional PBX systems to the new world.

Group Call Pickup Operation:

Calls coming in to any member of a call pickup group can be answered by dialling a special access code for that group. Note: the person wanting to answer the call will physically need to hear the other person’s phone ringing.
Any other user on the system can answer a call to a call pickup group by dialling the call pickup access code associated with that group. This feature does not restrict the call to only be answered by people in the group.
If there are multiple calls ringing on phones in the same group, the first call into the group is the call that will be answered when the access code is dialled. The other calls in the group will be queued in the order the calls came into the group after that.
Only direct calls to a user’s phone number can be answered with call pickup. (see limitations below for more details)

Call Pickup Groups in Lync 2013 have the following limitations:

Users can be assigned to only one call pickup group at a time.
Call pickup service uses the call park services running on the Lync front end server. When a call rings on a call pickup group user’s number it will simultaneously be automatically parked on the call park service. If the user picks up the phone the parked call is removed, or if the call pickup number used to answer the call, the user’s phone will stop ringing.
Calls into a call pickup group can be answered by any phone within the organisation, as long as the user wanting to pick up the call knows the correct access code to dial for that group.
Response group calls ringing on a call pickup group user’s phone cannot be answered via call pickup.
Delegate Calls – Calls delegated to another phone cannot be answered with call pickup.
Team Calls – Calls to users with team calling configured cannot be answered using a call pickup access code.
Simultaneous Ring Calls cannot be picked up with group call pickup.

Unfortunately, configuring call pickup groups has not been very easy to do (till now), due to Microsoft only giving access to configure call pickup groups through the very archaic SEFAUtil from the Lync Resource Kit (ResKit). This tool was originally designed to be used for administratively configuring Call Forwards and Team Calling by running commands from the prompt. SEFAUtil can check which call pickup group a user is in, or set which group a user in, via the command line.

A big problem with SEFAUtil is that it usually takes 3-5 seconds to check the settings for each user, and another 3-5 seconds to change their setting via the command line. In addition to this, you can’t directly query a call pickup group number to see which users are in that particular group. Instead, you have to query each user individually to establish the call pickup groups of which they are a member. If you think about that, for 1000 users it could take you (1000 x 5 seconds) well over an hour just to discover which groups all the users are in. This seems a little excessive to me.

It’s time for a better way…

Lync 2013 Call Pickup Group Manager

So after many evenings in the lab scripting away, I have created a tool that will hopefully make life (when it comes to call pickup groups, at least), a bit easier. So what does it look like?

Features of Lync 2013 Call Pickup Manager:

View all call pickup group configuration (Orbits, Groups and Users) in one simple interface.
Call Pickup Group Manager discovers call pickup configuration information directly from the Lync database, to avoid having to poll every user individually using SEFAUtil. This makes configuration discovery super fast!
Easy configuration of Call Pickup Orbits.
Group-centric configuration of groups. ie. you attach users to a group, rather than groups to a user like the SEFAUtil tool would have you do.
Multi-selectable user list boxes for adding or removing multiple users at once.

Download Version 1.00 here:

Prerequisites to use Call Pickup Group Manager

Under the hood, the Call Pickup Manager will use the SEFAUtil for adding and removing users from groups. This was a deliberate choice, as I wanted the tool to be supportable by Microsoft (ie. by avoiding any direct database editing, or hacking of things), and you don’t have to fear any unnecessary database corruption from using the tool.

Resource Kit Download

Download and install a copy of the Lync 2013 ResKit from here:

http://www.microsoft.com/en-au/download/details.aspx?id=36821

Make sure you have the ResKit installed on the Front End server you are running the Call Pickup Manger Tool on. I have written prerequisite checks into the tool, so you will get an error in the console window if it's missing.

SEFAUtil Configuration

Once the resource kit has been installed you need to configure Lync so it will trust the SEFAUtil tool. This allows the SEFAUtil to make UCMA calls to the Lync system.

Adding SEFAUtil as a trusted application:

Create a variable containing the site you will be configure SEFAUtil for:

$Site = Get-CsSite –Identity Melbourne

Configure the Trusted Application Pool:

New-CsTrustedApplicationPool –id pool.domain.com–Registrar pool.domain.com-site $Site.SiteId

Configure the Trusted Application:

New-CsTrustedApplication –ApplicationId sefautil–TrustedApplicationPoolFqdn pool.domain.com–Port 7489

Enable the Topology for the pool to start using the Trusted Application:

Enable-CsTopology

Here's the Technet explaination if you need it: http://technet.microsoft.com/en-us/library/jj945659.aspx

Allow Call Park Manager to Connect to Remote Pools

In order for the Lync 2013 Call Pickup Manager to quickly download call pickup settings from your deployment, it needs access to your RTCLOCAL databases for each pool. If you only have one Standard Edition server, then you can run the tool directly on this server and it will be able to access the RTCLOCAL database directly (note: this is also the case for an enterprise edition pool, but you need to run the tool on the first server in the Get-CsPool -> Computers property array, because this will be the database the tool tries to connect to). If you have multiple pools, the Call Pickup Manager will try and connect to each pool to download all the call pickup data for each pool (Branch SBA's also count as a separate pool).

In order for the SQL connection to be made (as shown in the diagram above), inbound connections to the SQL Browser Service and RTCLOCAL database will need to be allowed through the Windows firewall. These rules are not created automatically during Lync Server 2013 Setup like most of the other rules are. So you will need to do this manually, by following the process below:

Opening SQL ports in Windows Firewall

You can add Firewall rules either through the Windows Firewall settings in Control Panel, or by the command line. In this example I will show you how to add the ports using the command line.

Step 1: Add the SQL Named Instance Browser with the following command:

netsh advfirewall firewall add rule name="Lync 2013 Call Pickup Manager - SQL Browser (UDP 1434)" dir=in action=allow protocol=UDP localport=1434 profile=domain

Step 2: Find the Dynamic TCP port used by the Named Instance (RTCLOCAL). Firstly, open the SQL Server Configuration Manager (On a Standard Edition server, this is installed when the local databases are deployed).

Open SQL Server Configuration Manager
(Select) Protocols for RTCLOCAL
(Right Click) TCP/IP -> Select Properties
(Select) IP Address Tab -> IPAll -> TCP Dynamic Ports

As you can see in the example below, for IPAll the TCP Dynamic Port is 49264. This is the Dynamic Port for this Named Instance that needs to be opened in the firewall.

Step 3: Add the Named Instances Dynamic Port via the following command (Substitute the Dynamic Port for your deployment in the highlighted area below):

netsh advfirewall firewall add rule name="Lync 2013 Call Pickup Manager - SQL RTCLOCAL Dynamic Port (TCP-in)" dir=in action=allow protocol=TCP localport=<Insertporthere>profile=domain

Or, if you are not fond of doing manual processes, you could just use the script below for opening the ports automatically on your remote Front End servers:

Download Open SQL Ports For Call Pickup Manager 1.00 Script here:

Run this script on the server you want to open the SQL Browser and RTCLOCAL Dynamic TCP SQL ports on.

The Wrap Up

Once again, we’ve come to the end of another show. I hope you like my new tool and it makes your life a little easier. If you find any bugs or have any issues with it, please report them back to me so I can update the tool. Until next time, remember to answer your phone, and if you don’t, at least remember to get someone else to dial #110 to answer it for you. See ya next time!

↧

Lync 2013 Centralised Logging Deep Dive

April 7, 2013, 12:19 am

≫ Next: Lync 2013 Centralised Logging Tool

≪ Previous: Lync 2013 Call Pickup Group Manager

Overview

The service runs the ClsAgent.exe executable and listens for commands on the following ports: TCP 50001, TCP 50002, and TCP 50003. This can be seen using netstat:

Here is a diagram of the relationship between the two Controller and Agents:

How Does Centralised Logging compare to Lync 2010 Logging Tool?

Lync 2010 Logging Tool

Logging Comparison Table

The table explains which components get used for each default logging scenario in Lync 2013 centralised logging.

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

What is AlwaysOn Logging?

> Show-CsClsLogging

Success Code - 0, Successful on 1 agents

Tracing Status:

2013STDFE001.mylynclab.com (2013STDFE001 v5.0.8308.0) (AlwaysOn=No,Scenario=HostedMigration,Started=

4/6/2013 11:25:47 PM,By=2013STDPC\Administrator,Duration=0.04:00)

2013STDFE001.mylynclab.com (2013STDFE001 v5.0.8308.0) (Same as pool)

> Get-CsClsScenario | Where-Object {$_.identity -like "Global/AlwaysOn"} | Select-Object provider | Select-Object -ExpandProperty provider

Name : AsMcu

Type : WPP

Level : Info

Flags : TF_COMPONENT,TF_PROTOCOL

Name : AcpMcu

Type : WPP

Level : Info

Flags : TF_COMPONENT

Name : AVMCU

Type : WPP

Level : Info

Flags : TF_COMPONENT,TF_PROTOCOL

Continued...

Logging Files

> Get-CsClsConfiguration

Identity : Global

Scenarios : {Name=AlwaysOn, Name=MediaConnectivity, Name=ApplicationSharing, Name=AudioVideoConferencingIssue...}

SearchTerms : {Type=Phone;Inserts=ItemE164,ItemURI,ItemSIP,ItemPII, Type=URI;Inserts=ItemURI,ItemSIP,ItemPII, Type=CallId;Inserts=ItemCALLID,ItemURI,ItemSIP,ItemPII,

Type=ConfId;Inserts=ItemCONFID,ItemURI,ItemSIP,ItemPII...}

SecurityGroups : {}

Regions : {}

EtlFileFolder : %TEMP%\Tracing

EtlFileRolloverSizeMB : 20

EtlFileRolloverMinutes : 60

TmfFileSearchPath :

CacheFileLocalFolders : %TEMP%\Tracing

CacheFileNetworkFolder :

CacheFileLocalRetentionPeriod : 14

CacheFileLocalMaxDiskUsage : 80

ComponentThrottleLimit : 5000

ComponentThrottleSample : 3

MinimumClsAgentServiceVersion : 6

Note: If you cut and paste this address into the file browser you will end up in a location like this:

C:\Users\Administrator.DOMAIN\AppData\Local\Temp\2\Tracing

Meanwhile, the Logging Service is logged in as the NetworkService (as are all Lync services), so when it accesses this address it ends up at the following folder:

C:\Windows\ServiceProfiles\NetworkService\AppData\Local\Temp\Tracing

The HDR file contains information about the capture, eg:

AgentVersion=2.0

Starttime=5/04/2013 2:27:11 AM

Endtime=5/04/2013 2:30:26 AM

MostSevereLevel=3

ComponentNames=(Shared),SIPStack,UserServices

Other Useful Centralised Logging Settings

EtlFileRolloverSizeMB : 20

EtlFileRolloverMinutes : 60

TmfFileSearchPath :

CacheFileLocalFolders : %TEMP%\Tracing

CacheFileNetworkFolder :

CacheFileLocalRetentionPeriod : 14

CacheFileLocalMaxDiskUsage : 80

ComponentThrottleLimit : 5000

ComponentThrottleSample : 3

EtlFileRolloverSizeMB: Maximum size (in megabytes) that at event trace log file can reach before a new file is created. The default value is 20.

CacheFileLocalRetentionPeriod: Maximum number of days that cache files are retained locally. The default value is 14.

CacheFileLocalMaxDiskUsage: Maximum amount of disk space (percentage) that can be used for the cache files. The default value is 80.

Creating Custom Logging Scenarios

Creating a custom Centralised Logging Scenario is quite simple: it’s a matter of first creating provider(s) and then creating a scenario from the providers:

Create a provider:

$provider=New-CsClsProvider-Name"AvMcu"-Type"WPP"-Level"Info"-Flags"All"

> Start-CsClsLogging -Scenario CUSTOMSCENARIO -pools 2013ENTFE004.mylynclab.com

Success Code - 0, Successful on 1 agents

Tracing Status:

2013ENTFE004.mylynclab.com (2013ENTFE004 v5.0.8308.0) (AlwaysOn=No,Scenario=CUSTOMSCENARIO,Started=4/04/2013 5:43:07 PM,By=2013ENT\Administrator,Duration=0.04:00)

2013ENTFE004.mylynclab.com (2013ENTFE004 v5.0.8308.0) (Same as pool)

It will say it’s logging when you run the Show command:

> Show-CsClsLogging

Success Code - 0, Successful on 6 agents

Tracing Status:

2013ENTFE004.mylynclab.com (2013ENTFE004 v5.0.8308.0) (AlwaysOn=No,Scenario=CUSTOMSCENARIO,Started=4/04/2013 5:43:07 PM,By=2013ENT\Administrator,Duration=0.04:00)

...

However, it will failwhen you stop correctly run the Stopcommand:

>Stop-CsClsLogging -scenario CUSTOMSCENARIO -pools 2013ENTFE004.mylynclab.com

Failed on 1 agents

Agent - 2013ENTFE004.mylynclab.com, Reason - Error code - 20005, Message - Scenario 'CUSTOMSCENARIO' not currently running.

So choosing a “Unique Name” doesn’t actually appear to be the way to go… The Name parameter should actually be the name of a component. Here is a list of Component names to choose from:

Component Names
ABCommon	InternalCommon	PNCHService
ABServer	JoinLauncher	Powershell
ABServerIISModule	LDM	RdpApiTrace
AcpMcu	LegalIntercept	RDPEncComTrace
AppShareOoty	LogRetention	RgsClientsLib
AsMcu	Lyss	RgsCommonLibrary
AvMcu	McuInfra	RgsDatastores
AVMP	McxService	RgsDeploymentApi
BackupService	MediaStack_AudioCodecs	RgsDeploymentLibrary
BICommon	MediaStack_AudioEngine	RgsDiagnostics
BICOSMOS	MediaStack_AUDIO_AGC	RgsHostingFramework
BIDATACOLLECTOR	MediaStack_AUDIO_DRC	RgsMatchMakingService
CAAServer	MediaStack_AUDIO_ECHODT	Routing_Data_Sync_Agent
CertProvisioning	MediaStack_AUDIO_FAXDT	RtcDbSyncAgent
ChatCommon	MediaStack_AUDIO_HEALER	S4
ChatCompliance	MediaStack_AUDIO_NOISEDT	ServerAgent
ChatEndpoint	MediaStack_AUDIO_VAD	ServerTransportAdaptor
ChatServer	MediaStack_AUDIO_VSP	Sipstack
ChatWebService	MediaStack_COMAPI	SPCLSTool
ClientVersionFilter	MediaStack_COMMON	SPHelper
CLSAgent	MediaStack_Crossbar	SPModule
CLSCommon	MediaStack_Crypto	SPSearchTool
CLSController	MediaStack_DebugUI	StoreWeb
CLSControllerLib	MediaStack_DebugUI_AEC	SupportPortal
Collaboration	MediaStack_DEVICE	TenantAdminUI
CpsDiagnostics	MediaStack_MassConvertedTraces1	TranslationApplication
CpsHostingFramework	MediaStack_MediaManager	UCWA
DataMCU	MediaStack_PerFrame	UDCAgent
DataMCURunTime	MediaStack_PerPacket	UserPinService
DeviceUpdate	MediaStack_QualityController	UserServices
DeviceUpdateHttpHandler	MediaStack_RTCP	WebInfrastructure
Dlx	MediaStack_RTP	WebRelay
ExumRouting	MediaStack_StreamingEngine	XmppCommonLibrary
HostedMigration	MediaStack_TLS	XmppListener
IIMFilter	MediaStack_Transport	XmppRouting
IMMCU	MediaStack_VIDEO	XmppTGW
InboundRouting	MediaStack_VOICEENHANCE	XmppTGWProxy
Infrastructure	MediationServer
InterClusterRouting	OutboundRouting