lync sdn api 2.0 release notes · web viewrelease notes: lync sdn api 2.0 contents introduction1...

11
Release Notes: Lync SDN API 2.0 Contents Introduction......................................................... 1 What's new with Lync SDN API 2.0.....................................1 New architecture................................................ 1 The Lync SDN Manager (LSM)......................................2 Backwards compatibility.........................................3 Installation Instructions............................................ 3 Alternative Installation and Workaround for Install Issues with Lync SDN API 2.0.......................................................... 3 Most frequent issues................................................4 Manual Installation.................................................4 Identifying the pool FQDN...........................................5 Lync Server QoE settings............................................6 QoE settings – Lync Server Control Panel..........................6 QoE settings – Lync Server Management Shell.......................6 Known Issues......................................................... 7 Introduction Lync SDN API Version 2.0 is the newest version after 1.2. The new version is focused on improving scalability while simultaneously providing a better platform for near future new use cases and network management scenarios. What's new with Lync SDN API 2.0

Upload: vocong

Post on 11-Apr-2018

233 views

Category:

Documents


5 download

TRANSCRIPT

Page 1: Lync SDN API 2.0 Release Notes · Web viewRelease Notes: Lync SDN API 2.0 Contents Introduction1 What's new with Lync SDN API 2.01 New architecture1 The Lync SDN Manager (LSM)2 Backwards

Release Notes: Lync SDN API 2.0ContentsIntroduction.................................................................................................................................................1

What's new with Lync SDN API 2.0..............................................................................................................1

New architecture.............................................................................................................................1

The Lync SDN Manager (LSM)..........................................................................................................2

Backwards compatibility..................................................................................................................3

Installation Instructions...............................................................................................................................3

Alternative Installation and Workaround for Install Issues with Lync SDN API 2.0......................................3

Most frequent issues...............................................................................................................................4

Manual Installation..................................................................................................................................4

Identifying the pool FQDN.......................................................................................................................5

Lync Server QoE settings..........................................................................................................................6

QoE settings – Lync Server Control Panel............................................................................................6

QoE settings – Lync Server Management Shell....................................................................................6

Known Issues...............................................................................................................................................7

Introduction

Lync SDN API Version 2.0 is the newest version after 1.2. The new version is focused on improving scalability while simultaneously providing a better platform for near future new use cases and network management scenarios.

What's new with Lync SDN API 2.0

New architectureo The biggest change that is noticeable from an IT perspective is the new architecture,

which includes a new component called the Lync SDN Manager (LSM). More information regarding the LSM is available below. The Lync Dialog Listener component still exists but is now only responsible for sending Lync SDN messages to the LSM.

Page 2: Lync SDN API 2.0 Release Notes · Web viewRelease Notes: Lync SDN API 2.0 Contents Introduction1 What's new with Lync SDN API 2.01 New architecture1 The Lync SDN Manager (LSM)2 Backwards

The Lync SDN Manager (LSM)o The new Lync SDN Manager (LSM) is a server application that should not run on the Lync

server or virtualized instance of a Lync server. It should be run separately on an application server, such as a separate hardware server or a separate Hyper-V VM running on an application server.

o The Minimum requirements of the LSM are as follows: .NET Framework 4.5, 4 GB RAM, quad core running Windows Server 2012 or 2008. Hard disk space is dependent on the amount of logging.

o The LSM is responsible for processing the dialog events received from the Lync Dialog Listener (LDL) component. It maintains state of the individual real-time streams—including starting state, ending state, updated state, and more—and sends the resulting XML data to the configured network controllers. State maintenance is no longer the responsibility of the developer, and network controller state can now be enhanced by the use of the LSM state.

o Developers can utilize the new Lync SDN API schema version A, which has several improvements. Please see the Lync SDN Manager Schema document (.xsd) for development purposes. Also see the "Backwards Compatibility" section below for more info.

o IT Pros should be aware that LSM 2.0 can be scaled out to have a secondary LSM in case of loss of the primary. Switchover to the secondary is automatic, based on the LDL components’ experience with the configured primary LSM. The previous primary will become the new secondary, once the issues that caused it to stop receiving messages from the LDL is fixed. Optionally, if IT Pros want to change the order back to the original primary/secondary, IT Pros can simply restart the secondary LDL and it will fail-over back to the primary. Note that in 2.0, state is not shared between primary and secondary LSMs, and LSM will not send incomplete or out of sync messages to the network controller. The LDL configuration file has a place for primary (submituri) and secondary (alternativeuri).

Page 3: Lync SDN API 2.0 Release Notes · Web viewRelease Notes: Lync SDN API 2.0 Contents Introduction1 What's new with Lync SDN API 2.01 New architecture1 The Lync SDN Manager (LSM)2 Backwards

o Load balancing between LSMs is not supported in this version.o LSM and LDL have separate installers. Both need to be installed and configured to work

in unison.

Backwards compatibilityo LSM 2.0 can be configured to be compatible with the XML schema used in product

version 1.2 (schema version 1.0).o When in compatibility mode, LSM does not maintain state. New feature enhancements

such as new message types, improved error reporting, linking error messages more efficiently to specific stream data, are not available.

o Compliance to the new 2.0 XML schema is required for any 2.0 LSM enhancements.

Installation Instructions1. Run the installers for both the LDL and LSM, on their appropriate servers, and follow the on-

screen instructions.2. Set the correct URI of the LSM by configuring LDL config files (dialoglistener.exe.config) on the

FE's. Both LDL and LDL logging configuration are combined in the single dialoglistener.exe.config file. Note: The output directory for logging with the LDL is configured during the installation process, so editing the config file for logging is not required.

3. Configure LSM config files (LyncSDNManager.exe.config) on the LSM, and secondary if exists, to send messages to the URI of the network controller. Note: Similarly to the LDL, the output directory is configured during the installation process, so editing the config file for logging is not required.

Alternative Installation and Workaround for Install Issues with Lync SDN API 2.0

The installation of the LyncDialogListener 2.0 has a known issue in certain situations and even if successful may execute rather slow. These instructions here provide a more manual installation which circumvents these issues and may, as well, speed up installation on a number of front-ends.

In general, the LDL install steps are:

1.       Copy LDL files,2.       Configure the application, firewall, port bindings, etc.3.       Verify Lync Server QoE is enabled,4.       Register LDL with Lync Server,5.       Start the LDL service

The steps 3 - 5 can be performed manually using the following instructions:

Page 4: Lync SDN API 2.0 Release Notes · Web viewRelease Notes: Lync SDN API 2.0 Contents Introduction1 What's new with Lync SDN API 2.01 New architecture1 The Lync SDN Manager (LSM)2 Backwards

Most frequent issues

- Please ensure the Windows Services panel is closed before running the setup.- If the service fails to start: Credentials used to run the LyncDialogListener service must be in the

RTC Server Applications local security group. The Network Services account may not have sufficient permissions. (This is especially true for Lync 2010).

- If your Lync CMS holds registration of several Lync pools, we recommend manual registration as the setup registers the LyncDialogListener with EVERY pool.

Manual Installation

1) Run: msiexec.exe /i LyncSDNAPI.msi SKIPREGISTRATION=1

This command will install the LyncDialogListener component without attempting to check and register with Lync Server.

2) Registration with Lync Server is performed using a PowerShell script. This script is available for inspection, editing and manual execution in c:\ProgramData\Microsoft\Lync SDN API\Register.ps1

a. Basically, this script performs a number of validations before removing (if it exists) and re-adding its registration.

b. This registration only needs to be done ONCE for a pool. There is no need to do this for every Lync Front-End or LDL installation (therefore doing it manually will save time during the installation of a larger Lync pool)

3) Prerequisites: a. You know your Lync pool FQDN name (see below) – e.g. consider

pool1.lneprod.contoso.com for below example, b. QoE is enabled (see instructions below) , and c. All FE are synchronized with the CMS (see Lync documentation)

4) Essentially, only a single command is necessary to complete the registration of the LyncDialogListener with Lync Server:

a. Start the Lync Server Management Shell running as an Administrator or user authorized to make changes to Lync Server

b. Verify that the registration is not already there: Use Get-CsServerApplications

This will display a list of all applications registered for all pools in this CMS.

Page 5: Lync SDN API 2.0 Release Notes · Web viewRelease Notes: Lync SDN API 2.0 Contents Introduction1 What's new with Lync SDN API 2.01 New architecture1 The Lync SDN Manager (LSM)2 Backwards

If a record like above is shown with Uri=http://www.microsoft.com/LC/NetworkEnlightenment, the correct pool FQDN as part of the Identity property, Priority set to 0, Enabled = True, and Critical=False, LyncDialogListener is correctly registered.

c. If this record does not yet exists, execute the following command and verify the result using Get-CsServerApplications:

New-CsServerApplication –Identity “Service:Registrar:<your pool FQDN>/Diagnostics” –Uri http://www.microsoft.com/LC/NetworkEnlightenment -Enabled $true -Critical $false –Priority 0

d. A restart of the Front-End would ONLY be necessary if you changed the membership of the RTC Server Applications group.

5) You will also need to manually start the Lync Dialog Listener Windows service in the Windows Services panel or using net start “Lync Dialog Listener”.

Identifying the pool FQDN

If you need to find the pool name, use the Get-CsPool command and locate the FE’s FQDN in the Computers property.

Page 6: Lync SDN API 2.0 Release Notes · Web viewRelease Notes: Lync SDN API 2.0 Contents Introduction1 What's new with Lync SDN API 2.01 New architecture1 The Lync SDN Manager (LSM)2 Backwards

Lync Server QoE settings

Lync Server must be configured to process QoE. Although verified by the installer, QoE can be disabled after Lync Dialog Listener is installed. If QoE is disabled, LDL will have nothing to report. Verify that QoE is enabled with either the Lync Server Control Panel, or the Lync Server Management Shell.

QoE settings – Lync Server Control Panel

The settings for QoE are presented in the ‘Monitoring and Archiving” section, “Quality of Experience Data” tab:

QoE settings – Lync Server Management Shell

The Management Shell uses the PowerShell command ‘Get-CsQoEConfiguration’ to access QoE configurations. The Get-CsQoEConfiguration command will report ALL defined configurations. If there is more than one configuration defined, you may need to determine which collection is the appropriate one.

In any case, the configuration must indicate ‘EnableQoE’ is True.

Example:

Page 7: Lync SDN API 2.0 Release Notes · Web viewRelease Notes: Lync SDN API 2.0 Contents Introduction1 What's new with Lync SDN API 2.01 New architecture1 The Lync SDN Manager (LSM)2 Backwards

Example – ‘Global’ QoE configuration reports ‘EnableQoE’ is True

Known IssuesXSD validation exceptions may occur

There may be occasional XSD validation exceptions due to Lync clients producing an invalid token in the report xml.

ResolutionThese exceptions can be ignored.

Lync Server Control Panel 'Stop All Services' function fails to stop all services on a machine with

SDN API installed.

When attempted,

the control panel reports a warning stating that "Service RTCSRV failed to stop within the expected timeframe."

the RTCSRV and "Lync Dialog Listener" services are still running on the selected host

no errors or warning are reported in the host event log

Resolution

Instead of using the 'Stop All Services' function of the Lync Server Control Panel, use the

Management Shell command.

1. Open "Lync Server Management Shell" as a CsAdministrator2. Issue the command "Stop-CsWindowsService -ComputerName

[computername]", where [computername] is the target machine name upon which to stop Lync Server services

The LDL installer uses current user credentials while installing

The LDL installer always uses the current user credentials while installing, which may not have sufficient privileges to succeed.

Page 8: Lync SDN API 2.0 Release Notes · Web viewRelease Notes: Lync SDN API 2.0 Contents Introduction1 What's new with Lync SDN API 2.01 New architecture1 The Lync SDN Manager (LSM)2 Backwards

Resolution

When installing the LDL, the current user must be part of the local RTC Administrators group.

“Login denied” error when fetching QoE limits using 'implicit' credentials

If the LDL is configured to use implicit credentials for accessing the QoE database to receive threshold limits, then a “Login denied” error is reported when retrieving QoE limits.

Resolution

Either configure the LDL to use explicit SQL credentials or change the LDL service to logon as an account with access to the QoE database.

SSL server certificate binding is not valid after LSM reboot

When rebooted, the LSM may report an error "An existing connection was forcibly closed by the remote host". This can occur if the LSM is configured with an SSL certificate.

Resolution

The LSM must be configured to use a server certificate directly imported into the local machine store, otherwise the SSL certificates may not be available during startup.

LDL does not stop retrying after receiving "[TransmissionError]" for the delivery of a message to an LSM

When the LDL receives a constant “[TransmissionError]”, after attempting to deliver a message to the LSM, the LDL will continually retry. This may result in extra logging.

481 Error may be incorrectly filtered

In one case, a 481 error "Call Leg/Transaction Does Not Exist” may intermittently be incorrectly filtered. In this case, a log message is reported “[Error] QoE timer expired before Ended received or Ended message lost.” In this situation, the only indicator that the call has terminated is a QualityUpdate message, rather than the expected Error or Ended message.

Repairing the LDL installation can reset the service credentials

When the LDL installation is in repair mode, the previously configured service account will be reset back to the default Network Service.

Resolution

After running repair, manually configure the LDL service to use the intended credentials.

LDL installation does not check for service account permission levels

During LDL installation, you must choose a service account that is part of the RTCAdministrator group. The LDL installation will not enforce this requirement. If this requirement is not met, the LDL service will not start.

Resolution

Page 9: Lync SDN API 2.0 Release Notes · Web viewRelease Notes: Lync SDN API 2.0 Contents Introduction1 What's new with Lync SDN API 2.01 New architecture1 The Lync SDN Manager (LSM)2 Backwards

After running LDL setup, manually configure the LDL service to use correct credentials for a user that is part the RTCAdministrator group (or “Network Service”).

Misleading error message when specifying incorrect service account privileges during LDL installation

During LDL installation, the following misleading error message will be reported when you have specified incorrect privileges for the service account: “Service Lync Dialog Listener (Lync Dialog Listener) could not be installed. Verify that you have sufficient privileges to install system services.” To clarify, the account being used to install the LDL may be correct—the error is referring to the account used to run the service.

During LDL installation, PowerShell errors may be hidden behind the LDL installer window

If there is an error during a PowerShell phase of LDL installation, the window displaying the error may be hidden behind the main LDL installation window. In this case, installation will be paused.

Resolution

If installation has paused, check to see if there are any open PowerShell windows with error messages in the task bar or by using task manager.