Microsoft Lync Server 2010
Resource Kit Tools
This document is provided “as-is”. Information and views expressed in this document, including URL and other Internet Web site references, may change without notice. You bear the risk of using it.
Some examples depicted herein are provided for illustration only and are fictitious. No real association or connection is intended or should be inferred.
This document does not provide you with any legal rights to any intellectual property in any Microsoft product. You may copy and use this document for your internal, reference purposes.
© 2010 Microsoft Corporation. All rights reserved.
Microsoft, Active Directory, Excel, Internet Explorer, Outlook, SQL Server, Windows, Windows Media, Windows PowerShell, and Windows Server are trademarks of the Microsoft group of companies.
All other trademarks are property of their respective owners.
Contents
AboutthisDocument...... 1
InstallationoftheResourceKitTools...... 2
SupportedEnvironments...... 3
ResourceKitToolsOverview...... 4
ResourceKitTools
ABSConfig...... 8
AudioExtractor...... 11
BandwidthPolicyServiceMonitor...... 14
BandwidthUtilizationAnalyzer...... 16
CallParkometer...... 32
DBAnalyze...... 36
ErrorLog Replayer...... 40
ErrorStringDisplay...... 44
LCSSync...... 46
MsTurnPing...... 47
NetworkConfigurationViewer...... 50
ResponseGroupAgentLive...... 56
ResponseGroupExport-Import...... 61
SEFAUtil...... 64
ResourceKitTools(continued)
Snooper...... 70
TopologyValidator...... 81
WatsonSupportToolforLyncPhoneEdition...... 87
WebConfData...... 89
Microsoft Lync Server 2010 Resource Kit Tools
About this Document
This document describes the tools that are part of the Microsoft Lync Server 2010 Resource Kit. In addition, the purpose of each tool and how to use it is provided. Most tools have output and examples.
These tools are provided to help make some routine tasks easier for IT administrators who deploy and manage Lync Server 2010. For example, the Web Conf Data tool can be used to more easily control data that’s uploaded by users during an online meeting. The SEFAUtil tool can be used to set up delegate call forwarding and answering for users.
We encourage IT administrators to use these tools to more easily manage Lync Server 2010.
Installation of the Resource Kit Tools
To Install the Resource Kit tools, download OCSReskit.msi.
Run OCSResKit.msi to do a simple installation. The .msi installs all the tools in \Program Files\ Microsoft Lync Server 2010\ResKit. Tools that are self-contained executables are in this folder. Tools that also have files are in their own sub folders.
Supported Environments
For optimal performance, the Resource Kit tools should be installed in the same environment and with the same specifications that are required for Lync Server 2010.
Resource Kit Tools Overview
The following table describes the tools that are provided in the Lync Server 2010 Resource Kit.
Tool Name / DescriptionABSConfig / ABSConfig is an administrative tool that helps to customize Microsoft Lync Server 2010 communications software Address Book Service configuration.
Audio Extractor / Audio Extractor is a supporting tool for the Collect Logs feature. It allows you to collect Microsoft Lync 2010 communications software logs so that Microsoft can investigate audio, video, or connectivity issues that you may encounter. During log collection, the user can choose to add audio recording. Audio Extractor enables the user to extract the audio from the collected logs to verify the audio content. The extracted audio is a .wav file, which can be listened to by using applications such as Windows Media Player.
Bandwidth Policy Service Monitor / The Bandwidth Policy Service Monitor tool, which is part of the Microsoft Lync Server 2010 Resource Kit, allows administrators visibility into the state of each of the Microsoft Lync Server 2010 communications software Bandwidth Policy services that are defined in the topology. In addition, administrators can see real-time bandwidth usage for all the links that are defined in the Network configuration document.
Bandwidth Utilization Analyzer / The Bandwidth Utilization Analyzer tool is part of the Microsoft Lync Server 2010 Resource Kit. This tool is used to generate reports about bandwidth utilization across various WAN links in an enterprise as represented in the Network Configuration Setting.
Call Parkometer / Call Parkometer is a command-line application that provides easy access to the Call Park Server orbit database.
DBAnalyze / DBAnalyze enables you to gather analysis reports about the Lync Server 2010 database.
Error Log Replayer / For organizations that are subject to compliance regulations, the ErrorLogReplayer tool helps ensure that archiving and call detail recording (CDR) messages that failed to insert into the Archiving or CDR database are inserted into these databases. Administrators can use this tool to make sure all messages are archived in the Archiving and CDR databases for accurate tracking of usage information and call failure information.
Error String Display / The command-line tool, CSError.exe, helps troubleshoot event log errors that do not display any descriptive text. The tool attempts to map the error code to a description of the error. When possible, it prints the cause of the error and recommends a resolution.
LCSSync / The LCSSync tool helps to deploy Microsoft Lync Server 2010 communications software in a multi-forest environment. This tool is used to synchronize users and groups from different user forests as an Active Directory Domain Services contact object to a central forest where Lync Server 2010 is installed.
MsTurnPing / The MSTurnPing tool enables an administrator to check the status of the servers running the Lync Server Audio/Video Edge service and the Lync Server Audio/Video Authentication service and the servers that are running the Lync Server Bandwidth Policy Service (Authentication) and the Lync Server Bandwidth Policy Service (Core) in the topology.
Network Configuration Viewer / Network Configuration Viewer can be used by Microsoft Lync Server 2010 communications software administrators to view call admission control (CAC) network topology for an enterprise that is provisioned to allow real-time communication sessions, such as voice or video calls based on specified bandwidth capacity. Lync Server 2010 administrators define CAC policies, which are enforced by the Bandwidth Policy services that are installed with Lync Server 2010.
Response Group Agent Live / Response Group Agent Live is a Windows application that provides sign-in and sign-out functionality and some real-time information (such as group membership and current number of calls) to Response Group agents. It is meant to be an enhanced version of the Agent Groups page (accessible from Lync 2010).
Response Group Export-Import / Response Group Export-Import is a Windows PowerShell script that enhances the Microsoft Lync Server 2010 communications software Management Shell by adding two additional cmdlets to export the complete Response Group configuration from a given pool and import this configuration to another (or the same) pool.
SEFAUtil / SEFAUtil (secondary extension feature activation) is a command-line tool that enables Microsoft Lync Server 2010 communications software administrators and helpdesk agents to configure delegate-ringing and call-forwarding settings on behalf of a Lync Server 2010 user. The tool also allows administrators to query the call-routing settings that are published for a particular user.
Snooper / Snooper is a multi-purpose debugging tool for Microsoft Lync Server 2010 communications software. It parses server and client trace log files and makes protocol (for example, SIP and HTTP) messages and traces easier to read. It can also read call details and stored procedure execution reports for errors. In addition, Snooper can display reports about users, conferences, and conferencing servers (also known as multipoint control units or MCUs).
TopologyValidator / TopologyValidator is a test tool that helps validate the state of Microsoft Lync Server 2010 communications software topologies.
Watson Support Tool for Lync Phone Edition / Software applications sometimes ship with bugs. Intensive scenario, stress, and beta testing helps keep the occurrence of bugs to a reasonable minimum; but customers might still encounter bugs. It’s a reality of the software business. An obstacle to fixing bugs has always been the lack of statistics on the frequency and severity of customer incidents in the real world. Customers don't report every problem they encounter. When they do contact technical support, they rarely provide the details needed to trace the root cause of the problem. The Watson technology is built for crash reporting. It is a mechanism for customers to report issues and help Microsoft gain visibility and prioritize issues faced by customers.
Resource Kit Tools
The following section describes each tool in the Resource Kit.
ABSConfig
Abstract: ABSConfig is an administrative tool that helps to customize Microsoft Lync Server 2010 communications software Address Book Service configuration.
Introduction
Address Book Service Configuration tool (ABSConfig) is an administrative tool that helps administrators customize Address Book Service configuration in Microsoft Lync Server 2010. It also allows Lync Server 2010 administrators to restore the default Address Book Service settings.
Description
ABSConfig is a graphical user interface application that enables administrators to configure Active Directory directory service attributes that are related to Address Book Service.
The primary scenarios for the tool are the following:
· To enable administrators to map attributes in Active Directory to the attributes for Lync Server 2010.
· To enable administrators to specify the Active Directory attribute to be included or excluded in the Address Book Service files.
· To enable administrators to restore default Address Book Service settings.
The ABSConfig tool can be started by using the absConfig.exe file. The tool opens to the Configure Attributes tab. This table has options to map Active Directory attributes to the attribute fields for Lync Server 2010 and to specify which users to include or exclude in Address Book Service files based on specific attribute filters. It also has options to customize which value of the phone number to be included in the Address Book file. The Restore Defaults option enables administrators to restore Address Book Service settings to default values.
Output
ABSConfig stores the Address Book Service configuration in the database.
Path: %programFiles%\Microsoft Lync Server\Reskit
Purpose
ABSConfig provides a quick and easy way to customize Lync Server 2010 Address Book Service.
Requirements
Computer
ABSConfig can be run only from a domain-joined computer that has Microsoft Lync Server 2010 installed. In the case of Microsoft Lync Server 2010, Enterprise Edition, this tool can be run on any Front End servers that have the Address Book Service enabled during setup.
Network
The computer should be able to connect to the Front End pool and back-end database.
Software
The following software components must be installed before running the ABSConfig tool:
· Microsoft Lync Server 2010
Users
Administrators who have the permissions required to update the Lync Server 2010 deployment.
Examples
ABSConfig can be started by typing ABSConfig.exe at a command prompt. Figure 1 shows the ABSConfig tool user interface.
Figure 1. ABSConfig tool UI
Summary
The ABSConfig tool provides administrators a quick and easy to use tool to customize Lync Server 2010 Address Book Service.
Audio Extractor
Abstract: Audio Extractor is a supporting tool for the Collect Logs feature. It allows you to collect Microsoft Lync 2010 communications software logs so that Microsoft can investigate audio, video, or connectivity issues that you may encounter. During log collection, the user can choose to add audio recording. Audio Extractor enables the user to extract the audio from the collected logs to verify the audio content. The extracted audio is a .wav file, which can be listened to by using applications such as Windows Media Player.
Introduction
Audio Extractor is a supporting tool for the Collect Logs feature. This feature allows you to collect Lync 2010 logs so that Microsoft can investigate audio, video, or connectivity issues that you may encounter. During log collection, the user can choose to add audio recording. This tool enables the user to extract the audio from the collected logs to verify the audio content. The extracted audio is a .wav file, which can be listened to by using applications such as Windows Media Player.
Description
The Collect Logs feature allows you to collect Microsoft Lync 2010 logs so that Microsoft can investigate audio, video, or connectivity issues that you may encounter.
Output
There are two output .wav files as follows:
· The recording of the local talker: MEDIAMETRICS_mic.wav
· The recording of the remote speaker: MEDIAMETRICS_mic.wav. Note that to protect the privacy of the remote speaker, the remote speaker recording has been down-sampled so that the content is not intelligible.
Purpose
This tool extracts audio recording from logs that are collected by the Collect Logs feature so that users can verify the audio content in the recording.
The Collect Logs feature is not enabled by default. It can be enabled by using in-band provision. When the Collect Logs feature is enabled, the user will see the Collect Logs button in Lync 2010. By clicking Collect Logs and following the instructions, the user can collect Lync 2010 logs for diagnostics purposes. The logs are stored locally on your computer (under %USERPROFILE%\tracing\). You need to manually upload the logs according to your enterprise administrator's instructions.
When the user clicks Collect Logs, the following information will be collected:
· Lync 2010 logs, containing your contact list and information about your previous conversation sessions. Lync 2010 logs do not include the content of your instant messaging conversation
· Audio parameters such as speech signal level and noise level
· Network conditions
· Device setup
· Operating system version and information
· Applications that run on your computer such as Microsoft Outlook and Microsoft Internet Explorer
If the user chooses, the following information is also collected:
· A 30-second recording of your most recent call
· A screenshot of your desktop
The AudioExtractor.exe tool is provided for the user or administrator to extract the audio recording from the log files, and then verify their contents (if necessary) before submitting the information to Microsoft for diagnostic analysis.
Requirements
Run this script at the command-line prompt.
Examples
When a user clicks Collect Logs and follows the instructions, a compressed log file will be created under %UserProfile%\tracing that has a name in the following format:
MediaLog_GUID_yyyy-mm-dd_hh-mm-ss_4.0.xxxx.xxxx.cab .
This compressed log file may include 30 seconds of audio recording if this is provisioned and the user chooses to include the recording. The user or administrator can listen to the audio recording by using the following steps: