Professional Documents
Culture Documents
Lotus Sametime Unified Telephony: Installation Guide
Lotus Sametime Unified Telephony: Installation Guide
Version 8.5.1.2
Note
Before using this information and the product it supports, read the information in "Notices."
Edition notice
This edition applies to version 8.5.1.2 of IBM Lotus Sametime Unified Telephony (program number 5724–U79) and
to all subsequent releases and modifications until otherwise indicated in new editions.
© Copyright IBM Corporation 2009, 2011.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule Contract
with IBM Corp.
Contents
Chapter 1. Sametime Unified Telephony Configuring Telephony Application Servers . . . 167
overview . . . . . . . . . . . . . . 1 Initializing the persistent cache on a Telephony
Sametime Unified Telephony PDF library . . . . . 1 Application Server . . . . . . . . . . 167
Solution overview . . . . . . . . . . . . 1 Establishing trust between Telephony
Features and functions . . . . . . . . . . 2 Application Servers and Lotus Sametime servers 171
Supported interfaces, protocols, PBXs, and Configuring the dial plan . . . . . . . . . 173
gateways . . . . . . . . . . . . . . 4 Example dial plan . . . . . . . . . . . 174
Component overview . . . . . . . . . . . 5 Creating office codes . . . . . . . . . . 175
Telephony Application Server. . . . . . . . 6 Creating Home DNs . . . . . . . . . . 177
Media Server overview . . . . . . . . . . 8 Different numbering plans available . . . . . 180
Telephony Control Server. . . . . . . . . 10 Configuring business groups . . . . . . . 182
Deployment scenarios . . . . . . . . . . . 11 Creating numbering plans . . . . . . . . 185
Minimal server deployment . . . . . . . . 11 Creating default unified number feature profiles 187
Multiple TAS server deployment with Standby Creating a queue device . . . . . . . . . 187
TAS . . . . . . . . . . . . . . . . 12 Creating call routing components. . . . . . 195
Deployment with IP PBX environment . . . . 13 Adding subscribers for testing. . . . . . . . 210
Deployment with non-IP PBX environment . . . 13 Conducting simple call tests . . . . . . . . 211
Configuring conferencing . . . . . . . . . 212
Enabling conferencing on the Media Server . . 213
Chapter 2. Installing . . . . . . . . . 15 Updating the dial plan . . . . . . . . . 217
Hardware installation . . . . . . . . . . . 15 Configuring conferencing resources on TAS . . 230
Setting up hardware for a Telephony Control Modifying endpoint in CLI . . . . . . . . 235
Server . . . . . . . . . . . . . . . 15 Testing conference features . . . . . . . . 240
Setting up hardware for a Telephony Application Configuring security . . . . . . . . . . . 243
Server . . . . . . . . . . . . . . . 26 Enabling TLS encryption for the deployment 243
SAN deployment . . . . . . . . . . . 31 Configuring SUT SIP proxy/registrar security 247
Software installation . . . . . . . . . . . 46 Configuring TLS trunks . . . . . . . . . 250
Installing Telephony Control Server . . . . . 46 Configuring advanced features . . . . . . . 251
Installing Telephony Application Servers . . . 62 Localizing announcements . . . . . . . . 251
Starting and stopping services . . . . . . . 124 Configuring CDR and call records . . . . . 261
Verifying the installation . . . . . . . . 126 Setting up 911 . . . . . . . . . . . . 261
Deploying Lotus Sametime Unified Telephony to Communications Assistance for Law
users . . . . . . . . . . . . . . . . 127 Enforcement Act . . . . . . . . . . . 262
Preparing the Sametime client . . . . . . . 127 Setting up speed dial lists . . . . . . . . 263
Setting up voice mail . . . . . . . . . . 263
Chapter 3. Configuring . . . . . . . 129
Configuring the Telephony Control Server. . . . 129 Notices . . . . . . . . . . . . . . 265
Command-line interface tasks . . . . . . . 129 Trademarks . . . . . . . . . . . . . . 267
CMP (Common Management Portal)
configuration tasks . . . . . . . . . . 142
Guide Description
Lotus Sametime Unified Telephony The Quick Start Guide provides an overview of the
8.5.1/8.5.1.2Quick Start Guide installation requirements and process for deploying
Lotus Sametime Unified Telephony.
Lotus Sametime Unified Telephony The Functional Specification includes a description of
8.5.1.2 Functional Specification Lotus Sametime Unified Telephony software
capabilities and benefits, as well as a summary of user
and administrator features. The specification describes
supported languages and product architecture,
including detailed server specifications for the
Telephony Control Server, the Telephony Application
Server, and the Media Server. The functional
specification also describes the storage area network
and IP network connections. The specification also
includes information on interoperability and testing.
Lotus Sametime Unified Telephony The Installation Guide provides detailed information
8.5.1.2 Installation Guide on installing and configuring Lotus Sametime Unified
Telephony 8.5.1.2, including: hardware, operating
systems, primary servers, and failover servers.
Solution overview
Enterprises need to deliver products and services faster to enhance customer
service and speed decision making. Companies are finding that a key to improving
productivity and business responsiveness is delivering communication and
collaboration tools in a consistent and meaningful context. By integrating
telephony into the company's greater communications platform, decision making
and handling business processes are accelerated. The telephony integration allows
person-to-person as well as multi-person interaction.
Benefits
v Helps users access telephony functionality from within real-time collaboration
software. The front-end user capabilities in IBM Lotus Sametime Unified
Telephony software are designed to be intuitive and ease access to telephony
functionality from within the Lotus Sametime client.
v Provides users a simple, consistent user communications experience including
telephony presence, incoming call management and call control, click to call and
softphones. Within a single client, users have the same functions and user
experience independent of the phone system to which they are connected. Users
can see if colleagues are available and then reach them more reliably and
effectively without having to find different numbers for different locations.
v Fosters communication and collaboration within applications to help speed
business processes for users. Lotus Sametime and IBM Lotus Sametime Unified
Telephony software allow communication and collaboration in a meaningful
context that accommodates work-style preferences. Users can access and manage
their communications from a Lotus Sametime or IBM Lotus Notes client; a
Microsoft Outlook, Microsoft Exchange, or Microsoft Office application; or an
enterprise application.
v Helps optimize the value from existing enterprise applications and telephony
systems - independent of the telephony infrastructure or migration to IP
telephony. The software integrates both IP PBX and legacy TDM systems.
v Helps reduce calling costs with softphone, call management, and aggregated
presence awareness. Calls made through the softphone feature avoid PBX
telephone charges. Call management capabilities can direct calls to a user's
preferred device so that colleagues do not have to call various devices to find
the user. The aggregation of presence information - a user's availability for
instant messaging or a telephone call - helps colleagues avoid making
unnecessary calls or calls that cannot be accepted by a user. The
click-to-conference feature can reduce cost of expensive audio-conferencing
services for improvised conferences
Features
v Presence awareness - including telephony status. At a glance, users can see
telephone status (for example, on the phone, off the phone) along with online
presence status (for example, available, away, in a meeting, do not disturb),
making it easy to know whether it is appropriate to initiate a real-time
conversation through instant messaging or a phone/conference call.
v Telephony and voice — The front-end user capabilities in Lotus Sametime
Unified Telephony software are designed to be intuitive and ease users' access to
telephony functionality from within the Lotus Sametime client. The software
combines the immediacy of instant messaging with telephone capabilities, right
on users' desktops. Users can see if colleagues are available and then reach them
more reliably and effectively without having to look up their numbers — even if
they are on the move.
– Softphone users can initiate and manage phone calls through their PC
microphone and speakers using the Lotus Sametime Unified Telephony
embedded softphone.
– Click to Call and Click to Conference — Users can initiate a call or audio
conference through a PBX telephone system by selecting one or multiple
The list of interfaces and PBXs that are supported by Sametime Unified Telephony
are included in the Sametime Unified Telephony system requirements.
Protocols
v Proprietary protocol
– Virtual Places (VP) - A proprietary protocol used in Sametime for
communication between clients and server applications and the Sametime
server.
v Standard protocols:
– Hypertext Transfer Protocol (HTTP) - A communications protocol for the
transfer of information about the Internet.
– Session Initiation Protocol (SIP) - A signaling protocol used for setting up and
tearing down multimedia communication sessions.
– Media Gateway Control Protocol (MGCP) - A signaling and call control
protocol used within a distributed Voice over IP system.
– Simple Object Access Protocol (SOAP) - A simple XML-based protocol to let
applications exchange information over HTTP.
– Computer-Supported Telecommunications Applications (CSTA) - An
abstraction layer for telecommunications applications.
– SIMPLE
– T.120
– XMPP
– H.323
Gateways
v Siemens Gateway
– SIP gateways for Non-IP PBX sites
– Gateway RG8702 - two E1/T1 ports - 60 or 46 IP channels
– Gateway RG8708 - eight E1/T1 ports - 240 or 184 IP channels
– Gateway RG8716 - 16 x E1/T1 ports - 480 or 368 IP channels
– Software RG7800
v Dialogic Gateway
– DMG2030DTI - one E1/T1 port - 30 IP channels
– DMG2060DTI - two E1/T1 ports - 60 IP channels
– DMG2120DTI - four E1/T1 ports - 120 IP channels
Component overview
This section describes the components that make up the IBM Lotus Sametime
Unified Telephony product including servers, clients, and external telephony
equipment.
The following graphic shows the various components and how they work together.
The Lotus Sametime Connect client is the end-user client for letting community
users collaborate in real-time activities: presence, chat, and VoIP over an intranet or
the Internet.
The Telephony Application Server (TAS) executes the workflow for handling the
calls of the users. The Telephony Application Server (TAS) executes the workflow
for handling the calls of the users. Users must be provisioned to a specific
Telephony Application Server before they can use IBM Lotus Sametime Unified
Telephony. The Telephony Application Server is notified when a user logs on to the
Lotus Sametime Connect and a channel opens to the user and notifies the user that
the telephony service is available.
Users can provision as many preferred devices and phone numbers for themselves
as they like. The Telephony Application Server can ring any of these devices based
on rich presence and user rules that allow the user to determine what device they
want to ring according to any combination of time, location, and presence status.
Telephony Application Servers are deployed with at least one warm standby server
Components
SIP Proxy/Registrar
The Session Initiation Protocol (SIP) is a protocol for creating, modifying,
and terminating sessions with one or more Lotus Same Unified Telephony
users. SIP uses elements called proxy servers to help route requests to the
user's computer, to authenticate and to authorize users. SIP also provides a
registration function that lets users send their current locations for use by
the proxy servers.
Presence Adapter
This component publishes telephony presence to the Lotus Sametime
community.
Communications Adapter
This component starts and manages two-party and conference calls. The
communication adapter keeps the Lotus Sametime Connect client informed
of the IP address of the SIP registrar.
Media Server
This component provides tones and announcements for teleconference
messages.
Administration
This component displays the status of the main components and provides
real-time monitoring of user sessions and registered devices.
REST API
The Representational State Transfer Convention (REST) is the standard for
building web services. The REST interface allows for Click-To-Call and
conference integration with third-party applications.
Functions
Every Media Server node can handle up to a certain number of media channels. A
media channel is an active call with an active RTP-based media steam.
Note: One TAS server is used as a failover server in this diagram but it is not
active until required.
The Sametime server supports 30,000 - 50,000 users depending on the operational
profile. The Sametime cluster support can be scaled as needed.
Media Servers support ad-hoc conferencing. Users can initiate conference calls and
the conference bridge in the Media Server dials out to participants. Once the
ad-hoc conference has been started by the user, the conference bridge in the Media
Server can accept inward dialing into the conference bridge. The Media Server
conferences feature has its own set of specifications:
v There is no fixed limit to the number of simultaneous ad-hoc conferences. The
limit is based on the maximum number of total conference participants allowed.
v The Media Server transcodes between different codecs if needed.
v The number of conference participants in a single conference can be configured.
The default number of users is 6.
v An onboard Media Server can handle 400 concurrent conference legs. For
example, there can be 100 conferences with 4 people each, or 80 conferences
with five people each, and so on.
For failover purposes, the TAS and Media Server must be on the same subnet.
Specifications
The Telephony Control Server handles VoIP connections. This server is part of a
duplex configuration that serves as a failover system. The Telephony Control
Server is always deployed in a duplex configuration with RAID hard disk drives
to provide high availability.
The Telephony Control Server provides the unified number facility that informs the
Telephony Application Server about receiving a call from the unified number of a
user. It also uses that number for any calls the user makes through Lotus Sametime
Connect client. The unified number is the single telephone number for routing calls
to the telephony devices of the user.
Deployment scenarios
The following sections describe the supported deployment scenarios for the
Sametime Unified Telephony system.
The basis for this system is the storing of all the individual TAS application
configuration details on separate partitions on a storage area network (SAN).
When a particular Telephony Application Server fails, the standby Telephony
The time IT takes for the Telephony Application Server system to restore itself is
directly proportional to the user base that it needs to reload.
All calls routed to the desk-phones must be intercepted by the Sametime Unified
Telephony system. Based on Sametime Unified Telephony Subscriber rules, the call
is then routed. There is a gateway between the PBX and the phones.
Calls made to the PBX system are now routed through the Sametime Unified
Telephony system and then routed to the desk top. The customer can choose to
keep the current telephone numbers or get a new set of numbers for the Sametime
Unified Telephony installation. Most customers elect to keep their current numbers
to avoid disruption in their communications environment. The telephone numbers
are converted into Sametime Unified Telephony format, which can include a
special prefix. The call gets directed to the preferred client device.
v Calls routed from the PBX to the desk phones no longer reach the desk phones
directly, but instead are routed to Sametime Unified Telephony.
v Calls from Sametime Unified Telephony destined for desk phones are routed to
the phones directly.
v Calls from Sametime Unified Telephony to anywhere else are routed to the PBX
(and then to the PSTN if needed).
v Calls from desk phones can be routed directly back to the PBX which route to
Sametime Unified Telephony if needed.
Calls placed on the phones are routed through the non-IP PBX to other phones or
to the Public Switched Telephone Network (PSTN).
All calls out to the desk-phones must be intercepted and the calls redirected to the
Sametime Unified Telephony system. Sametime Unified Telephony then decides,
based on subscriber rules, where the call is routed. There are several options.
v If the non-IP PBX has a SIP interface, it could act like a gateway between the IP
and the Time Division Multiplexing (TDM) world, as the integration point.
v If there is no SIP interface available on the PBX, the use of a SIP Gateway is
possible. The proposed gateway must be compatible with the existing TDM
traffic and there can be no known interoperability issues between the gateway
and the non-IP PBX.
Hardware installation
Hardware technical information relating to the Telephony Control Server and the
Telephony Application Server.
The Telephony Control Server runs on an IBM xSeries® 3550 M2, using SuSE
Enterprise Linux Server version 10 SP3. Install Telephony Control Server in pairs to
provide backup and failover services; each server can be cabled in a
switchover/failover style or directly to the network. For technical specifications,
see the Sametime Unified Telephony system requirements.
Hardware checklist
The basic system sometimes come with the memory and additional NIC cards.
These cards are packaged separately and need to be inserted into the server. The
dual port and Quad port Gigabyte Ethernet cards must be placed in specific PCI
slots.
Procedure
1. Turn on the server.
It make take a few minutes for the server to start up and display the IBM
System x screen.
2. When the IBM System x screen appears, press the F1 key to run the Setup
program.
Tip: Refer to the banner at the bottom of the Setup screens for information on
how to navigate the Setup program and manipulate the data on the various
screens. Some of the Setup screens display screen specific help in the right
column of the screen.
Chapter 2. Installing 17
6. On the System Information screen, select Product Data.
7. On the Product Data screen:
a. Verify that the version levels of the Host Firmware, Integrated
Management Module, and Diagnostics are at least at the levels listed in the
following screen:
If any of the versions are not up to the level listed, consult the IBM System
X documentation for information concerning the update of drivers and
firmware.
b. Press the Esc key to return to the System Configuration and Boot
Management screen.
Chapter 2. Installing 19
c. Press the Enter key to save your changes.
d. Press the Esc key to exit the Setup screens until you have backed up to the
System Configuration and Boot Management screen.
10. Do one of the following:
v If you will proceed to set up the RAID unit as described in the next task,
leave the System Configuration and Boot Management screen open.
v Otherwise, press the Esc key to exit the Setup program.
You must have set up the BIOS on the server before you can configure the SCI
RAID.
You can download the software from the IBM Support site.
If you do not have the IBM ServerGuide software available, you can set up the
SCSI RAID unit and create a disk mirror as follows:
Tip: Refer to the banner at the bottom of the Setup screens for information on
how to navigate the Setup program and manipulate the data on the various
screens. Some of the Setup screens display screen specific help in the right
column of the screen.
Chapter 2. Installing 21
3. On the System Settings screen, select Adapters and UEFI Drivers.
4. On the Adapters and UEFI Drivers screen, press the Enter key to refresh the
list of adapters and drivers.
Chapter 2. Installing 23
7. On the Select New Array Type screen, select Create IM Volume.
Chapter 2. Installing 25
The mirroring takes a while; however there is no need to wait because the
mirroring will continue in the background. You can proceed immediately to
the next step.
10. Select Apply changes and exit menu to create the array.
11. Press the Esc key to close out all of the preceding screens, until you have
backed up to the System Configuration and Boot Management screen.
Attention: Be sure to save any configurations when prompted.
The Telephony Application Server runs on an IBM System x® using the SuSE Linux
10 SP3 operating system. For technical specifications, see the Sametime Unified
Telephony system requirements.
Hardware checklist
BIOS Settings
During the installation of the TAS hardware, you must also perform BIOS settings.
Determine that all the hardware works as expected. The Remote Management
Controller (iRMC) must be configured.
You can enter the BIOS by pressing the F2 key during the Startup process.
Example 1
v Signaling for Telephony Application Server/WebSphere Application Server
nodes will be on the bond0 interface. The bond0 interface is assigned to subnet
A.
v A management LAN will be on the bond1 interface. The bond1 interface is
assigned to subnet B, to keep it separate from the bond0 interface.
Example 2
v Signaling for the Telephony Application Server nodes will be on the bond0
interface. The bond0 interface assigned to subnet A.
v Signaling for the WebSphere Application Server nodes will be on the bond1
interface. The bond1 interface is also assigned to subnet A. Because bond0 and
bond1 are both used for signaling, they can reside on the same subnet.
Chapter 2. Installing 27
v A management LAN will be on the bond2 interface. The bond2 interface is
assigned to subnet B, because it must be hosted on a separate subnet from the
signaling interfaces.
The reason for this requirement is that it is not possible to have static configured
network interfaces in the same IP subnet as the Telephony Application
Server/WebSphere Application Server signaling subnet. Each IP address will
require an entry in the kernel routing table. In the case of an interface in the same
subnet as the TAS/WAS signaling subnet, there will be 2 routes for the same
subnet. If the interface that created the second entry (in our examples, for the
management LAN) fails, the communication for this subnet will break down –
even if there is another interface that still is able to communicate. As a result
SAMP will incorrectly recognize the Telephony Application Server/WebSphere
Application Server interface as broken and initiate a failover to the standby node.
Keeping the signaling interfaces on a separate subnet prevents this problem.
Network considerations
When setting up a SAMP cluster, it is important to understand that all peer nodes
must have the same network interface configuration; in particular:
v If Telephony Application Server/WebSphere Application Server signaling will be
on bond0, then all nodes in the cluster must have a bond0 interface.
v If Telephony Application Server signaling will be on bond0 and WebSphere
Application Server signaling on bond1, then all nodes in the cluster must have a
bond0 interface and a bond1 interface.
v If an extra interface is required (for example, for network security purposes), this
interface must be on a separate subnet from the subnet used by Telephony
Application Server and WebSphere Application Server.
Bonding adaptors
The SUT cluster of TAS and Media Server systems are intended to be highly
available. The cluster is installed on top of cluster-failover software, called Tivoli
System Automation for Multiplatforms which is covered in detail in the Installation
of TAS Software section. With reliability in mind, it is necessary to add redundancy
to network ports in a TAS machine. In a failover configuration, a bond interface
(bond0) using two ethernet interfaces (eth0 and eth1) must be created.
Procedure
1. To configure bonding adapters for SUT on SLES 10 SP3, modify the ifcfg scripts
in the /etc/sysconfig/network directory. By default, there is at least one file in
the form of ifcfg-eth-id-mac_address format. Example:
Chapter 2. Installing 29
b. Include BONDING_SLAVEx for each physical adapter to be included in the
bond pair.
c. Execute service network restart to activate the configuration. With the steps
completed, network connectivity is not interrupted if either of the networks
independently fail.
Bonding Adapter (ifcfg-bond0)
BONDING_MASTER=’yes’
BONDING_MODULE_OPTS=’mode=1 miimon=100 primary=eth0’
BOOTPROTO=’static’
BROADCAST=’’
ETHTOOL_OPTIONS=’’
IPADDR=’19.142.227.17’
MTU=’’
NAME=’’
NETMASK=’255.255.252.0’
NETWORK=’’
REMOTE_IPADDR=’’
STARTMODE=’auto’
USERCONTROL=’no’
BONDING_SLAVE0=’eth0’
BONDING_SLAVE1=’eth1’
You must configure the SCSI RAID unit and create a disk mirror as follows:
Procedure
1. Turn on the server. A number of screens display the system information until
an LSI banner displays and indicates that the LSI controller is initializing.
LSI Logic Corp. MPT SAS BIOS
MPTBIOS-6.12.00.00 (2006.10.31)
Copyright 2000-2006 LSI Logic Corp.
Initializing ............
2. After initialization is complete, the system displays the following message:
LSI Logic Corp. MPT SAS BIOS
MPTBIOS-6.12.00.00 (2006.10.31)
Copyright 2000-2006 LSI Logic Corp.
Press Ctrl-C to start LSI Logic Configuration Utility...
3. Press CTRL+C. The LSI Logic Utility Screen displays.
4. Press Enter to select the internal controller (SAS1068)
5. Press the Down Arrow Key to select RAID properties. Press Enter.
6. Select Create IM Volume and press Enter to create the array.
7. Use the Right Arrow Key to select the RAID Disk in the Slot Num 0.
8. Press the + (plus sign) key to select the drive to be placed in the array.
9. Press the D key to overwrite all existing data and create an IM array. The first
drive is now selected.
10. Use the Down Arrow Key to select the RAID Disk in Slot Num 1.
Using the web browser, log on to the Remote Console. Test the console using the
Video Redirection.
Procedure
1. Log on to the Remote Console through a web browser using the IP address
you entered within the BIOS for the LAN settings.
2. Accept any certificate warnings that appear, enter the user name, and password
as follows: USERID/PASSW0RD (the 0 is a zero.)
3. The Server Management Information screen appears. Select Server
Management, then Video Redirection in the navigation list on the left side.
4. Start the Video Redirection using the button.
5. Accept all the certificate warnings that appear and all other messages by
clicking OK.
6. At the end, a similar screen appears that reflect the console messages.
7. To finish, select Exit from the Extra drop down menu and click Ok.
SAN deployment
The following document focuses on the setup of a SAN (Storage Area Network)
system — IBM DS3400. The document also describes an example environment of
multiple TAS systems with a single standby/failover server. A SAN is a hard
requirement for this environment.
Acronyms/Terminology:
v FC: Fiber Channel: A gigabit speed network technology used to access storage
networking. Can be either twisted pair or fiber-optic
v SAN: Storage Area Network. A disk array that is accessed with an FC
v HBA: Host Bus Adapter. The PCI card installed in the host to access the SAN or
SAN switch with an FC
v Array: Set of disk drives logically grouped and associated to a RAID level
Chapter 2. Installing 31
v Logical Drive: Virtual component created for the host to access an allocated
portion of the disk array
v LUN: Logical Unit Number. The logical drive identifier as it is known to the
accessing host
Hardware:
The hardware components relevant to this setup focus on the TAS and SAN
portion of the topology, with no details of the Sametime Server or TCS. These
components remain unchanged and are independent of a TAS and SAN. The
following table includes the hardware components and reference host names for
examples used through the document.
Architecture Overview
Logical Mappings
Note: The cluster software, SAMP, is not included in this diagram. Full
deployment descriptions, including how the cluster software interacts with the
topology, are provided in subsequent sections. The main purpose of this section is
to explain how the SAN is used.
Chapter 2. Installing 33
The active and standby TAS systems interact with the SAN LUNs in the following
manner:
By providing the logical mappings to each system, the standby can take over from
any system in the cluster.
Note: All systems maintain all logical mappings. If the standby takes over from a
failed system, once the failed system has been repaired, for example with an OS
patch, the original active node becomes the acting standby node.
Procedure
1. Install the HBA card into an empty PCI slot on the Telephony Application
Server.
2. Update the system to the latest RPMs.
3. Ensure that the active kernel is a valid non-debug kernel and that the driver
installation hangs:
a. SLES 10 SP3 kernel used: 2.6.16.54-0.2.8-bigsmp.
b. Validate using the uname -a command.
c. Switch the kernel by updating the "default" integer in /boot/grub/menu.lst
(second line) and reboot.
4. Download the latest QLogic driver:
a. Browse to http://www.qlogic.com.
b. Click the Downloads tab.
c. Under "QLogic Models" click operating system in the search box.
Chapter 2. Installing 35
d. Select Fibre Channel Adapters > Linux > Linux Novell SLES (32-bit).
e. Click the Go button to run the search.
f. On the results page, look in the "Drivers" table, then locate the section for
the "2.6 Kernel Drivers" and click the link for SANsurfer Linux Driver
Installer (x86/x64/IA64) to begin the download.
The SANsurfer installer includes the scli for performing operations with a CLI.
It also automates all the steps necessary to install, configure, and load the HBA
drivers upon reboot.
5. Extract qlafc-linux-8.02.*-install.tgz.
6. Change to the extract qlafc-linux-8.02.*-install directory.
7. Install the drivers using ./qlinstall.
8. Reboot the system.
Download both the SANSurfer application and the Multi-boot image, and then use
SANSurfer to install the image.
Procedure
1. Download the Qlogic Multi-boot Image for 4GB FC adapters:
a. Browse to http://driverdownloads.qlogic.com/
QLogicDriverDownloads_UI/ShowEula.aspx?resourceid=25334
&Contentid=69579&docid=21253.
b. Click the Agree button at the bottom of the page.
c. In the "File Download" dialog box, click Save.
d. In the "Save As" box, select a directory for storing the file, and click Save.
e. Extract the Multi-boot Image.
This step extracts several files, so you may want to extract them to a
subdirectory.
2. Download the Qlogic SANSurfer Management Application for Linux:
a. Browse to http://driverdownloads.qlogic.com/
QLogicDriverDownloads_UI/ShowEula.aspx?resourceid=24816
&Contentid=67882&docid=19583.
b. Click the Agree button at the bottom of the page.
c. In the "File Download" dialog box, click Save.
d. In the "Save As" box, select a directory for storing the file, and click Save.
e. Extract the SANSurfer Management Application.
f. Run the extracted file to install the SANSurfer Management Application.
g. On the "Choose a product" screen, click FC HBA GUI and ALL Agent.
Chapter 2. Installing 37
4. In the "Enter Hostname or IP Address" box, select Local Host from the list,
and then click the Connect button.
7. Click the Utilities tab, and then click Update Entire Image.
9. When prompted, type the security password for the HBA Adapter Bios, click
OK to continue, and wait for the update to complete.
The default password is "config" (contact your technical support if the
password has been changed).
Chapter 2. Installing 39
10. When the "Flash Update Complete" message appears, click OK.
Procedure
1. Start SuSE Linux from the system's internal RAID.
Chapter 2. Installing 41
tasnode1:/sys/bus/scsi/devices # ls 5\:0\:0\:0
block:sdb delete driver iocounterbits ioerr_cnt
model queue_depth rescan rev scsi_disk:5:0:0:0
scsi_level timeout uevent
bus device_blocked generic iodone_cnt iorequest_cnt
power queue_type retries scsi_device:5:0:0:0 scsi_generic:sg3
state type vendor
tasnode1:/sys/bus/scsi/devices # ls 5\:0\:0\:1
block:sdc delete driver iocounterbits ioerr_cnt
model queue_depth rescan rev scsi_disk:5:0:0:1
scsi_level timeout uevent
bus device_blocked generic iodone_cnt iorequest_cnt
power queue_type retries scsi_device:5:0:0:1 scsi_generic:sg4
state type vendor
tasnode1:/sys/bus/scsi/devices # ls 5\:0\:0\:2
block:sdd delete driver iocounterbits ioerr_cnt
model queue_depth rescan rev scsi_disk:5:0:0:2
scsi_level timeout uevent
bus device_blocked generic iodone_cnt iorequest_cnt
power queue_type retries scsi_device:5:0:0:2 scsi_generic:sg5
state type vendor
tasnode1:/sys/bus/scsi/devices # ls 5\:0\:0\:3
block:sde delete driver iocounterbits ioerr_cnt
model queue_depth rescan rev scsi_disk:5:0:0:3
scsi_level timeout uevent
bus device_blocked generic iodone_cnt iorequest_cnt
power queue_type retries scsi_device:5:0:0:3 scsi_generic:sg6
state type vendor
tasnode1:/sys/bus/scsi/devices # ls 5\:0\:0\:4
block:sdf delete driver iocounterbits ioerr_cnt
model queue_depth rescan rev scsi_disk:5:0:0:4
scsi_level timeout uevent
bus device_blocked generic iodone_cnt iorequest_cnt
power queue_type retries scsi_device:5:0:0:4 scsi_generic:sg7
state type vendor
tasnode1:/sys/bus/scsi/devices # ls 5\:0\:0\:5
block:sdg delete driver iocounterbits ioerr_cnt
model queue_depth rescan rev scsi_disk:5:0:0:5
scsi_level timeout uevent
bus device_blocked generic iodone_cnt iorequest_cnt
power queue_type retries scsi_device:5:0:0:5 scsi_generic:sg8
state type vendor
tasnode1:/sys/bus/scsi/devices #
4. Create an ext3 file system for each SATA drive using mke2fs -j /dev/sdb.
Substitute /dev/sdb with the information determined from step 2. Repeat for
each drive.
5. Determine the disk identifier to use in the /etc/fstab file for mounting by
browsing /dev/disk/by-id. In the example, scsi-
3600a0b80000f14a900000368489ae610 is the disk identifier for /dev/sdb.
tasnode1:~ # cd /dev/disk/by-id/
tasnode1:/dev/disk/by-id # ls -al
total 0
drwxr-xr-x 2 root root 320 Aug 7 15:03 .
drwxr-xr-x 5 root root 100 Aug 7 11:03 ..
lrwxrwxrwx 1 root root 9 Aug 7 11:03 edd-int13_dev80 -> ../../sda
lrwxrwxrwx 1 root root 10 Aug 7 11:03 edd-int13_dev80-part1 -> ../../sda1
lrwxrwxrwx 1 root root 10 Aug 7 11:03 edd-int13_dev80-part2 -> ../../sda2
lrwxrwxrwx 1 root root 9 Aug 7 11:03
scsi-3600508e00000000046b9ebfdf84b9a0a -> ../../sda
lrwxrwxrwx 1 root root 10 Aug 7 11:03
scsi-3600508e00000000046b9ebfdf84b9a0a-part1 -> ../../sda1
lrwxrwxrwx 1 root root 10 Aug 7 11:03
scsi-3600508e00000000046b9ebfdf84b9a0a-part2 -> ../../sda2
lrwxrwxrwx 1 root root 9 Aug 7 11:03
scsi-3600a0b80000f14a900000368489ae610 -> ../../sdb
The example used in this topic is a 3550 M2 with a dual port Qlogic card. Both
ports are connected to two different Dell EMC SAN switches. Two LUNs are
configured on the SAN and assigned to the Qlogic WWNs.
Procedure
1. Log in to the server as root.
2. Show SCSI devices:
geatas1node2:~ # lsscsi
[0:0:0:0] cd/dvd TSSTcorp CDDVDW TS-L633B IB03 /dev/sr0
[4:0:0:0] disk IBM-ESXS ST9146803SS B536 -
[4:0:1:0] disk IBM-ESXS ST9146803SS B536 -
[4:1:1:0] disk LSILOGIC Logical Volume 3000 /dev/sda
[5:0:0:0] disk DGC RAID 5 0428 /dev/sdb
[5:0:0:1] disk DGC RAID 5 0428 /dev/sdc
[5:0:1:0] disk DGC RAID 5 0428 /dev/sdd
Chapter 2. Installing 43
[5:0:1:1] disk DGC RAID 5 0428 /dev/sde
[6:0:0:0] disk DGC RAID 5 0428 /dev/sdf
[6:0:0:1] disk DGC RAID 5 0428 /dev/sdg
[6:0:1:0] disk DGC RAID 5 0428 /dev/sdh
[6:0:1:1] disk DGC RAID 5 0428 /dev/sdi
Two LUNs are created and visible. LUN 0 is indicated by "0" as the last digit:
[5:0:0:0]
[5:0:1:0]
[6:0:0:0]
[6:0:1:0]
while LUN 1 is indicated by "1" as the last digit:
[5:0:0:1]
[5:0:1:1]
[6:0:0:1]
[6:0:1:1]
3. Add the multipath package using yast.
4. Insert the multipath drivers into the boot sequence:
geatas1node2:~ # insserv multipathdgeatas1node2:~ # insserv boot.multipath
5. Start the drivers:
geatas1node2:~ # /etc/init.d/boot.multipath start
edd-int13_dev80
edd-int13_dev80-part1
edd-int13_dev80-part2
scsi-3600508e000000000a8648159e62e3106
scsi-3600508e000000000a8648159e62e3106-part1
scsi-3600508e000000000a8648159e62e3106-part2
scsi-36006016001802200b493f40ae042df11
scsi-36006016001802200b593f40ae042df11
10. Create File systems:
geatas1node2:/dev/disk # mkfs -j /dev/disk/by-id/scsi-6006016001802200b493f40ae0
Chapter 2. Installing 45
Writing inode tables: done
Creating journal (32768 blocks): done
Writing superblocks and filesystem accounting information: done
geatas1node2:/ # cd /opt/
[mgeatas1node2:/opt # mkdir IBM
geatas1node2:/opt # cd IBM/
geatas1node2:/opt/IBM # mkdir WebSphere
12. Display disks for mounting:
geatas1node2:~ # mount /dev/disk/by-id/
edd-int13_dev80
edd-int13_dev80-part1
edd-int13_dev80-part2
scsi-3600508e000000000a8648159e62e3106
scsi-3600508e000000000a8648159e62e3106-part1
scsi-3600508e000000000a8648159e62e3106-part2
scsi-36006016001802200b493f40ae042df11
scsi-36006016001802200b593f40ae042df11
13. Mount disks
geatas1node2:~ # mount /dev/disk/by-id/scsi-36006016001802200b493f40ae042df11 /enterprise/
Software installation
Review the installation checklist, and then install TCS and TAS.
The Telephony Control Server is packaged with the Linux operating system; the
combined package is referred to as the "Connect Server" in the Download
document.
Procedure
1. Do one of the following:
v DVD: Insert the DVD of for the Telephony Control Server into the DVD
drive, and mount it.
v Download: Download the Sametime Unified Telephony Connect Server
package to a temporary location.
– See the SametimeUnified Telephony 8.5.1 download document for details
on part numbers and assemblies.
– For information on downloading packages from IBM Passport Advantage®
website, see Using Passport Advantage to download IBM products.
2. Create a directory called /software/IBM by running the following command:
mkdir /software/IBM
3. Copy the package to the new /software/IBM directory:
For DVD, use the following command:
cp /DVD_mount_point/file_name.tgz /software/IBM
4. Now navigate to the new directory:
cd /software/IBM
5. Finally, extract the appropriate installer with the following command:
tar xvfz file_name.tgz
IBM Passport Advantage website provides access to all of your entitled software;
you can download products directly to your computer for installation, and
download the Quick Start Guide for information how to get started installing IBM
Lotus Sametime.
Passport Advantage provides access to your IBM software purchases, so you can
download products directly to the computers where you want to install them. For
information on the Passport Advantage program, review the program overview.
Chapter 2. Installing 47
2. Complete the new customer registration form.
3. Click Register.
When you receive your IBM customer ID, proceed to download products as
explained below.
Procedure
1. Open a browser and navigate to the Passport Advantage sign-in page.
2. Click Customer sign in
3. Enter your IBM customer ID and password, and then click Sign in.
4. On the "Software and services online" page, click Software download &
media access.
8. Under " Download options", select Yes for the option "If available, would you
like to see associated products at no additional charge?".
This ensures that you can view and download optional products that are used
with the primary product (for example, an LDAP directory server where you
can store user names).
9. Click Continue.
Passport Advantage displays the list of assemblies (packages) for the selected
criteria.
10. Select your download:
v Select an assembly to download all of its included packages:
Chapter 2. Installing 49
v Click the + to expand the assembly so you can select individual packages:
Important: You should always download a copy of the product's Quick Start
Guide because it provides an overview of the product installation as well as
links to additional documentation.
11. Select items to download and scroll to the bottom of the page.
12. Review the license agreement, and click I agree.
13. Click Download and select a location on your computer to store the
downloaded files.
What to do next
Review the Quick Start Guide for an installation overview as well as links to the
product documentation, where you will find instructions on installing the product.
To prepare for the installation of the Telephony Control Server you do not need
access to the server hardware. The node.cfg file is a settings file carrying all the
site-specific information needed to conduct an unassisted installation. To create the
file, you need the following materials and information:
v The NCPE (Node Configuration Parameters Editor) wizard. This is a .iso image
file, which can be burned to a CD for use in Microsoft Windows or Linux.
v Two USB flash drives. You will store a copy of the node.cfg on each, for use
when installing the two Telephony Control Server nodes.
v The 27 IP addresses required for the installation of the two Telephony Control
Server nodes.
v The gateway, DNS, and NTP addresses.
v The number of subnets to be used in the Lotus Sametime Unified Telephony
deployment (for example, will there be separate signaling, billing, and
management networks?), and whether the subnets exist on separate vLAN's.
Note: It is possible to run only two subnets; the wizard displays a warning but
you can ignore it.
You will perform the Telephony Control Server installation using a reference image
DVD, which contains default system configuration data (for example, operating
system parameters, Unix accounts, IP parameters for the node.cfg, and RTP
parameters), and the install scripts. When you create the node.cfg file, you specify
the actual parameters for your deployment. During installation of the Telephony
Control Server, the settings in the node.cfg file will override the default values
stored on the reference image. Two copies of the reference image DVD are
delivered, allowing you to run the installation simultaneously on the two
Telephony Control Server nodes.
Procedure
1. Burn the NCPE wizard .iso file to a CD as a disk image.
2. Start the NCPE wizard from the disk:
v Linux
Open a terminal (for example, xTerm) and navigate to the CD drive.
Depending on the version of Linux, check the permissions of the fies stored
in /mnt/cdrom or /media/cdrom (specifically, check the file
cdrom/ncpe/bin/ncpe. If this file is not executable, then you must copy the
entire NCPE directory onto the local file system, where you can change the
permissions using the following command:
#chmod 700 ncpe_location/ncpe/bin/ncpe
v Windows
Open Windows Explorer and browse the CD. Double-click the RunIfGui.bat
to run it.
3. On the Installation Framework screen, select Install then click Next to begin the
wizard.
Chapter 2. Installing 51
What to do next
Run the wizard as explained in the following two topics. When the wizard
finishes, you will have configured the node.cfg file for use when installing the
Telephony Control Server.
Run the NCPE wizard and specify configuration settings that will be stored in the
node.cfg file and applied to each Telephony Control Server during installation in
an IBM Lotus Sametime Unified Telephony deployment.
Start the NCPE wizard as explained in “Preparing for the node.cfg file use during
installation” on page 51.
Procedure
1. On the Configuration and Hardware (1/1) screen fill in at least the following
fields before clicking Next:
Option Description
Hardware Platform Select IBM x3550M2.
Configuration Select Standard Duplex.
Node Separation Select one of the following:
v none if geographic separation will not be
used for the Telephony Control Server.
v separate if the Telephony Control Server
nodes will be geographically separated.
Survival Authority Type the IP address of the Telephony
Application Server, or if there will be
multiple Telephony Application Servers, use
the IP address of one that is physically
co-located.
Chapter 2. Installing 53
3. On the IP Configuration (1/3) screen, type the IP address of the following the
subnets for administration, signaling, and billing.
By default the Telephony Control Server configures 3 separate subnets. If you
will not use separate subnets, then the netmask for each network should be
the same and it should be at least 64 bits (for example, 255.255.255.192).
Option Description
Default Router Node 1 Type the IP address of the default router for
node 1.
Domain Name Type the fully qualified domain name of the
default router for node 1.
Cluster Name This field displays the default cluster name,
created by combining the cluster and node
names that you provided in step 2. You can
optionally override this name by typing a
new name now.
Chapter 2. Installing 55
6. Click the Expert Mode button (instead of Next).
Use Expert mode to configure the CSTA connection by specifying the IP
address of every CSTA server (ever Telephony Application Server node) that
connects to the Telephony Control Server.
7. On the Expert Mode screen, click IP Configuration (4/6) in the navigation
tree.
8. In the "CSTA Servers" section of the IP Configuration (4/6) screen, do the
following:
a. In the CSTA Server field, type the IP address of a Telephony Application
Server node.
12. In the IP Security (2/3) screen's "Billing Servers" section, type the IP address
of the Telephony Application Server deployed in the Billing network into the
Address field, and then click Next.
This is the IP address that you entered for the "Billing Network" section's
Subnet Node 1 field on the IP Configuration (1/3) screen in step 3.
Chapter 2. Installing 57
13. On the IP Security (3/3) screen, leave the settings alone and click the Finish
button.
Results
The settings you configured in the wizard are written to the node.cfg file, which
will be used to override default settings when the Telephony Control Server nodes
are installed.
Note: For a complete list of parts (with descriptions) included in the installation
package, see the Download document.
Procedure
1. Check the TCS machines:
a. Ensure that TCS is in power-down status and that it is available for a fresh
configuration.
b. Check the cabling and the required hardware configuration.
Note: The installation process will stall if the cluster interconnects are not in
place.
c. Ensure that a console is available for both nodes to monitor the installation
process.
2. Copy node.cfg onto two empty and separate FAT32-formated USB drives as
node.cfg.primary on USB 1 and as node.cfg.secondary on USB 2.
3. Insert the TCS software installation DVDs and power on the system to execute
the installation procedure.
4. Insert the appropriate USB drives when prompted. The installation takes
approximately 30 minutes. The installation causes several system reboots. The
installation is complete when the following message is displayed: – system was
started on mode1 node!. In this example, mode1 is the name of the node.
When you install IBMLotusSametime Unified Telephony 8.5.1.2, you must apply
the following patches to the Telephony Control Server to bring it fully up to date:
v PS0010.E07
v PS0010.E08
Chapter 2. Installing 59
You will install the patches individually and in sequence.
Procedure
1. On Telephony Control Server, download the appropriate patches to the
/software/patch/V5.00.01.ALL.11 directory on node 1 of the cluster:
For Lotus Sametime Unified Telephony 8.5.1.2, you need the following patches:
v V5.00.01.ALL.11_PS0010.E07.tar
v V5.00.01.ALL.11_PS0010.E08.tar
If you already downloaded the entire "Connect Server" package to node 1,
locate the patches now and copy both of them to the /software/patch/
V5.00.01.ALL.11 directory.
If you have not already downloaded the patches, do it now as explained in
“Downloading the Telephony Control Server installation package” on page 47
(be sure to store both patches in the /software/patch/V5.00.01.ALL.11
directory).
2. On the Telephony Application Server, add the Telephony Control Server to the
CMP (Common Management Portal) as explained in “Adding a Telephony
Control Server to the CMP” on page 143 (leave the CMP open for the next
step).
3. In the CMP, click Operation & Maintenance > Configuration & Monitoring >
System Status > Applications.
4. In the nodes list, click the arrow next to the Telephony Application Server, and
then click Software Activation.
5. Activate a patchset:
a. In the Software Activation dialog box, select the Telephony Control Server
node 1 as the Location.
Request the licenses as soon as possible. Allow at least two days receive them.
Procedure
1. Log in to both nodes as ‘root' user and running the following command on
each: tcsnode:# ifconfig eth0 | grep HWaddr
2. When you have both MAC addresses for each TCS node, request license files
for both nodes from your Sametime Unified Telephony contact. You receive two
Chapter 2. Installing 61
files, one for each node. The file names of these license files contain the MAC
address so you know which file belongs to which node.
3. When you receive the two license files you then must apply them to each TCS
node.
a. Open a scp (winSCP) session to each TCS node.
b. Change directory to: /opt/unisphere/srx3000/cla/import.
c. Copy the license file with the matching MAC address in its file name into
the TCS node which has that MAC address.
When the file is copied into the directory, the file is applied by the licensing
agent of that node and then removed from the directory. The licensing agent
checks the directory every 5 seconds, so the license file is applied and removed
from the directory within 5 seconds.
4. Verify that the licenses have been applied by opening CMP when it is
configured and navigate toTelephony Control Server > Maintenance > System
Information > Dashboard. Under the License Information TCS section, which
is at the bottom of the right column, you can see the number of licenses on
each machine. These licenses must be equal.
Before you can install the Telephony Application Server, you must install SUSE
Linux Enterprise Server.
Then, when you install the Telephony Application Server software, the following
applications are bundled with the Telephony Application Server software, and will
also be installed on the server:
v Tivoli® System Automation for Multiplatforms
v Telephony Application Server Framework
v WebSphere® Application Server
v Tivoli Directory Integrator
v Assembly lines scripts
v SIP proxy/registrar
v Administration applications
v OSGi bundles
v Call History database tables
The Telephony Application Server is packaged with the Linux operating system;
the combined package is referred to as the "Call Server" in the Download
document.
Procedure
1. Do one of the following:
v DVD: Insert the DVD of for the Telephony Application Server into the DVD
drive, and mount it.
v Download: Download the Sametime Unified Telephony Call Server package
to a temporary location.
– See the Sametime Unified Telephony 8.5.1 Call Server download document
for details on part numbers and assemblies.
– For information on downloading packages from IBM Passport Advantage
website, see Using Passport Advantage to download IBM products.
2. Create a directory called /software/IBM by running the following command:
mkdir /software/IBM
3. Copy the package to the new /software/IBM directory:
For DVD, use the following command:
cp /DVD_mount_point/file_name.tgz /software/IBM
4. Now navigate to the new directory:
cd /software/IBM
5. Finally, extract the appropriate installer with the following command:
tar xvfz file_name.tgz
IBM Passport Advantage website provides access to all of your entitled software;
you can download products directly to your computer for installation, and
download the Quick Start Guide for information how to get started installing IBM
Lotus Sametime.
Chapter 2. Installing 63
Before you begin
1. Review the Sametime Detailed System Requirements to ensure that your
systems are prepared for installation.
2. Use the Download document to determine product part numbers; these are the
items you will download from Passport Advantage.
Passport Advantage provides access to your IBM software purchases, so you can
download products directly to the computers where you want to install them. For
information on the Passport Advantage program, review the program overview.
Procedure
1. Open a browser and navigate to the Passport Advantage sign-in page.
2. Click Customer sign in
3. Enter your IBM customer ID and password, and then click Sign in.
4. On the "Software and services online" page, click Software download &
media access.
8. Under " Download options", select Yes for the option "If available, would you
like to see associated products at no additional charge?".
This ensures that you can view and download optional products that are used
with the primary product (for example, an LDAP directory server where you
can store user names).
Chapter 2. Installing 65
9. Click Continue.
Passport Advantage displays the list of assemblies (packages) for the selected
criteria.
10. Select your download:
v Select an assembly to download all of its included packages:
v Click the + to expand the assembly so you can select individual packages:
What to do next
Review the Quick Start Guide for an installation overview as well as links to the
product documentation, where you will find instructions on installing the product.
If you already have Linux SUSE 10 installed on your server, you can skip this task;
however make sure that the following requirements are in place before you
continue to the next task:
v The graphical desktop can be either GNOME or KDE
v The default run level at boot should be 3 - full multi-user with network
v In the network settings, the option "Change host name via DHCP" should be
disabled.
If you have not already installed Linux SUSE 10, then complete that task now by
following the instructions below.
Chapter 2. Installing 67
About this task
This task includes the steps to install the Telephony Application Server. Before
installing the Telephony Application Server, make sure that you have the following
items for installation:
v Minimum hardware requirements
v 4 CD's of SUSE Linux Enterprise Server 10 SP3 Installer DVDs of Telephony
Application Server
Procedure
1. Boot the machine from the CD1 SuSE Linux Enterprise Server 10 SP3. Select
Installation.
4. At the Software Selections and Systems Task screen, disable Gnome, enable
KDE, then click Accept.
Chapter 2. Installing 69
5. Disable the Change host name through DHCP option at the Host name and
Domain Name screen. Click Next.
Chapter 2. Installing 71
9. Select Disable IPv6 at the Network Setup Method screen. Click Next.
10. Click the Network Interface link at the Network Configuration screen.
12. Select Static Address Setup, enter IP address and Subnet Mask, click host
name and name the server at the Network Address Setup screen.
Chapter 2. Installing 73
13. Enter Host Name, Domain Name, Name Server 1 and click Ok at the Host
Name and Name Server Configuration screen.
Chapter 2. Installing 75
17. If there are more Network Interfaces, configure them and click Next at the
Network Card Configuration Overview screen.
18. Click the VNC Remote Administration link at the Network Configuration
screen.
What to do next
After SUSE Linux has been installed, use YaST to manually deactivate the services
"novell-zmd" and "suseRegister".
Chapter 2. Installing 77
Setting up failover services
Before you install any Telephony Application Servers in your IBM Lotus Sametime
Unified Telephony deployment, you need to set up failover services.
Lotus Sametime Unified Telephony uses IBM Tivoli System Automation for
Multiplatforms (SAMP) to provide failover services for Telephony Application
Servers. SAMP provides the following failover services:
v A high-availability environment, in which systems are continuously available
and whose self-healing infrastructure prevents downtime caused by system
problems.
v Automated control of system resources such as processes and file systems.
v Recovery and workflow processes that facilitate the automatic switching of
users, resources, and applications between clustered servers when a software or
hardware failure occurs.
This section explains the use of SAMP failover services in more detail, and then
provides instructions for installing the SAMP Base Component on a Telephony
Application Server.
SAMP Features
v Provides high availability and automation. Reduces the frequency and duration
of incidents that impact IT availability.
v Automates the control of IT resources; for example, processes, file systems, and
so on.
v Automatic switching of users, resources, and applications from one system to
another in a cluster after a software or hardware failure.
v Addresses the three leading causes of unplanned outage:
– Hardware failure,
– Software failure
– Operator errors
Finally, SAMP addresses the three leading causes of unplanned outage: hardware
failure, software failure, and operator errors.
SAMP Architecture
Base component
The SAMP base component resides on each node in a failover cluster, including the
standby node. Each base component includes an automation adapter. The
automation adapter of the base component of SAMP is required to establish and
manage the communication between the automation domains and the SA
operations console. On AIX and Linux systems, the adapter is installed
automatically with the base component.
Chapter 2. Installing 79
Operations Console (optional)
The Tivoli SAMP Web site is available for you to learn more about this product.
Failover for IBM Lotus Sametime Unified Telephony using IBM Tivoli System
Automation for Multiplatforms (SAMP).
The Telephony Application Server supports failover using a warm standby model.
Warm standby is a method of redundancy in which the standby system runs in the
background of the primary system.
This section contains notes for operating System Automation for Multiplatforms
and IBM Lotus Sametime Unified Telephony.
The actions are implemented through xml policies, or more specifically, automation
policies. Therefore, SAMP enables you to configure high-availability systems
through the use of automation policies, in which the relationships among the
various components are defined. These policies can be applied to existing
applications with minor modifications. Once the relationships are established,
SAMP assumes responsibility for managing the applications on the specified nodes
as configured. This reduces implementation time and the need for complex coding
of applications.
The policies are based on polling, so every resource that you require to monitor
must be defined as a SAMP resource. As part of the definition of a SAMP resource,
commands to stop, start, and check that the status of the resource must be defined.
SAMP uses the monitor command to poll the resource at preset intervals. If the
resource is stopped it attempts to restart it. If that fails, the resources are switched
over to the standby node and started there.
These policies include rules whose parameters differentiate between "moving" and
"restarting" nodes. Move means "move" the virtual IP to an alternate system.
During the installation of a Telephony Application Server or Media Server in a
highly available cluster, the Telephony Application Server or media server are
installed with a virtual IP address. The Telephony Application Server/Media
Server is started with the virtual IP address. If the Telephony Application Server
fails, and SAMP is unable to restart on the same node, SAMP detaches the virtual
IP address from the existing node and switches it to the standby.
Once the move is accomplished, the policies specify data points to mount and the
actual mounting of those data points.
SAMP then uses the relationships and resources defined in the automation policy
to determine how to start each application, and the start sequence of those
applications.
These are your results when you set up a highly available IBM Lotus Sametime
Unified Telephony cluster.
v A script to generate the automation policy
v A response file that is used by the policy generation script
v A script to handle SAN mounts. This script is called sutctrl-data.sh
v A Script to monitor Lotus Sametime Telephony Software including start, stop
and monitor commands
v A script to allow SAMP to control WebSphere Application Server
You will receive files associated with the xml automation policy that defines your
SAMP domain. You will receive sample policies, but more importantly, you will
receive a script to generate an automation policy specific to your own
environment. This script is called generateAutomationPolicy.sh. In order to use
this script, you must first fill out a response file. The response file includes
information relative to each TAS, such as the TAS mount point ID, the WebSphere
Chapter 2. Installing 81
Application Server mount point ID, the virtual IP addresses of the Telephony
Application Server and WebSphere Application Server, the SAMP domain name
and the automation policy name. This is covered in full in a later topic.
Once the policy has been generated, note that the policy file includes resources; for
example, VIPA and mount points; it also includes start sequence and relationships
as well as start, stop, and monitor script calls.
Once the failover cluster is in place and online, it can be monitored and controlled
through any node in the cluster, or through the Operations Console. You have
more control and autonomy through the command line. More detail can be found
in official SAMP documentation.
Note: All scripts are automatically installed during the installation of SAMP. The
scripts to control the mount points, TAS and WebSphere Application Server are
located in the following directory.
/usr/sbin/rsct/sapolicies/SUT
The script to generate the automation policy (and its associated response file) are
located under:
/software/IBM/Failover/tools
Deployment Overview:
There are two types of IBM Lotus Sametime Unified Telephony deployments
available: onboard and offboard.
Onboard Deployment
With an onboard deployment, all the functional elements exist on the same
machine, for example, Lotus Sametime Telephony Software, SIP Proxy, and
Registrar, Lotus Sametime Unified Telephony specific applications and the Media
Server all reside on the same machine. With this type of deployment, there are
scalability issues regarding conferencing services. Because the Media Server resides
on the same machine, there are not the same conferencing opportunities due to
hardware restraints. With an onboard installation, there is only one installation
response file.
Offboard Deployment
With an offboard deployment, Lotus Sametime Telephony Software, SIP Proxy and
Registrar, and Lotus Sametime Unified Telephony specific applications reside on
the one machine. The media server resides on a separate, dedicated machine. There
is the option of more than one media server per Telephony Application Server.
This is dependent upon the conferencing and announcement requirements of the
customer.
The cluster software (SAMP), the Telephony Application Server software, the
incorporated Media Server and SIP Proxy and Registrar are installed on the
primary node. The standby server is running, the operating system is up, and the
cluster software is actively monitoring the node. The database, as well as all
configuration data such as the WebSphere Application Server and Telephony
Application Server binaries are stored on a storage area network, or a SAN. The
hardware profile has to be identical for both servers. The software is fully installed
on the SAN Drive.
The SAMP operations console is not installed on any system in the cluster. It is
installed on a separate server. It is able to provide a web-based high-level view of
the cluster, once the base component automation adapter on the cluster nodes has
been configured.
The next diagram illustrates e a more realistic real world failover cluster. In this
case, it shows a multiple Telephony Application Server (TAS) onboard deployment,
with a single standby server, to serve all Telephony Application Servers in the
event of a failure on any one of them.
Again, the cluster software is installed on each of the primary nodes. Standby
server is running, that is the operating system is up and the cluster software is up
and monitoring the node. Like the previous slide, the database as well as all
configuration data such as the WebSphere Application Server and Telephony
Application Server binaries are stored on the SAN.
The application data for each Telephony Application Server are stored on separate
SAN LUNs, or Logical Unit Numbers. A LUN is a reference to a specific disk area
in the SAN.
Chapter 2. Installing 83
If there is a failure of one of the Telephony Application Server, SAMP releases the
specific mount points and reactivates them on the standby node using the relevant
SAN disk ID.
Offboard Deployment:
The cluster software is installed on each of the primary nodes. The standby server
is running — the operating system is up — and the cluster software is up and
monitoring the node. In this case, all the application data is stored on the SAN,
including the media server application data.
If one of the Telephony Application Server or media servers fails, SAMP releases
the specific mount points and reactivates them on the standby node using the
relevant SAN disk ID. SAMP is then able to restart the application on the standby
node. Any maintenance can be carried out on the primary failed node at this time.
Chapter 2. Installing 85
Each of these scenarios are described in full in their respective sections that follow.
Each section provides a high-level description of a particular failover scenario that
might be encountered in the day to day administration of a highly available SAMP
cluster.
This section describes what causes a system to failover, and how the failover is
achieved.
Goal:
Pre-Conditions:
v SAMP software is installed on all nodes (both active and standby nodes) and is
fully functional – it is monitoring the significant active software artifacts, for
example the Telephony Application Server and WebSphere Application Server
components.
v Standby node is running: Operation System up, Cluster SW up
v The database, as well as all configuration data is stored on a shared storage
system (SAN)
v The HW profile has to be identical for all nodes.
v The SW is fully installed on the SAN drive.
v For a Media Server installation, only a subset of the TAS components are
installed. For example, no database is used.
Description:
v SAMP detects a severe failure situation and decides to switch over to a stand-by
node.
v False failure situations such as a “planned shutdown” need to be excluded
v The system tries to shut down all running software artifacts, the database (if
used) and releases (un-mounts) the shared file system, and releases the virtual IP
address from the active/failing node
v The system attempts to gracefully shut down the failing node, but if that is not
possible, it forces a shutdown (OS level)
v Reconfigure or Activate the “external” IP address (for example Virtual IP
address) in order to make the standby node available for SUT clients
v The System becomes fully operational again, with the standby node replacing
the corrupted/failed node. From a client / service consumer perspective, the
system / cluster behaves like a single node that has been restarted.
v Client / Service consumers on other nodes reestablish connections to the new
server node
Post-Condition: .
v The System is fully operational again (now on the standby node)
v The System can be connected to by clients and other services using the same IP
address as before the switch over (such as through Virtual IP address).
v Failed node is out of operation, or running with only the OS active (for example
a SAMP resource is in FAILED OFFLINE state). It is possible to service the failed
node hardware and operating system (OS) such as apply the OS patches or even
reinstall the OS which is for example necessary after hard disc crash. It is not
Note: The update on the standby node is not possible (RPM database inconsistent
between install and standby node). To update the system a switch back to the node
that was originally installed is necessary.
This section describes an administrator manual task, where a system that failed
over to standby due to some error condition can be returned to the original node.
Goal:
Actor:
Administrator
Pre-Condition:
The previously failed system has been repaired and is able to operate again
Description:
The administrator triggers the Cluster Software manually, for example, using a
command-line interface, to switch over to the other node. More detail on how to
achieve this is covered in a later section: Failover Cluster Installation.
Post-Condition:
The other node is active and the previously active node is now, again, the standby
node. The system is fully operational again.
Goal:
Actor:
Administrator
Pre-Condition:
The previous failed system has been repaired and is able to operate again.
Description:
v The administrator sets the SAMP software to a “manual” mode to prevent
interactions during the update installation.
Chapter 2. Installing 87
v The update must be performed on the system that the software was initially
installed, because the rpm database is only updated on that specific node.
v The Administrator stops the Telephony Application Server software and updates
the software as would normally be done on a single node system.
v During the update, the system is offline. The administrator activates the cluster
software again, by taking SAMP out of manual mode, and consequently SAMP
restarts the Telephony Application Server software.
Post-Condition:
v The System is fully operational again.
v The stand by node is running and prepared to take over in case of failure on
any active node.
Example Cluster:
Following picture describes the example scenario where three nodes are running
the different applications: TAS1 (Telephony Application Server), MediaServer1 and
MediaServer2. Both Media Servers are configured to provide conference and tone
channels. Each of the application could switch over to the standby node in case of
failure.
All SAMP resources and dependencies are defined in a SAMP policy file based on
XML.
The following figure shows the resource modeling used for a Telephony
Application Server/Media Server installation on a resource group level.
Each BASE_TAS and BASE_MS resource group consists of a resource to mount the
file system on a SAN disk, /enterprise, and a resource to assign a virtual IP
address — VIPA or either a Telephony Application Server or Media Server.
Chapter 2. Installing 89
“DependsOn” relationship). The NODE_MGR_MS requires the assigned virtual IP
address and mounted file system provided by BASE_MS on same node
("DependsOn" relationship). Furthermore the Media Server must be started after
the Telephony Application Server, including the database (MS “StartsAfter” TAS).
To assure that an offboard Media Server and Telephony Application Server always
are running on different nodes the BASE_MS and BASE_TAS resource groups are
defined “AntiCollocated”).
To handle the WebSphere Application Server (WAS) the following resource model
has to be applied.
In this SAMP resource model there are only limited “DependsOn” relationships.
Since “DependsOn” also contains a “ForcedDownBy” relationship it will stop the
resource A if resource B goes down (for example NODE_MGR_TAS will be
stopped if BASE_TAS goes down). The WebSphere Application Server can be
stopped independent of Telephony Application Server, but has to be started before
Telephony Application Server (“StartAfter”). WebSphere Application Server has to
run on same node as TAS (“Collocated” (in both directions!)). The BASE_xxx
resources (mount points and virtual IP addresses) of WebSphere Application Server
and Telephony Application Server have to run on the same node (“Collocated”).
Note: For a more detailed description of these SAMP relationships, please refer to
the SAMP administrators guide, which can be found on the official SAMP site:
http://www-01.ibm.com/software/tivoli/products/sys-auto-multi/
Setting up prerequisites:
The following subsections describe in full the prerequisites that must be met before
installing a failover cluster in an IBM Lotus Sametime Unified Telephony
deployment.
SAN prerequisites:
Each active Telephony Application Server requires 2 LUNs (Logical Unit Number)
on the SAN, with a total of 20GB disk space:
v /enterprise - requires 10GB disk space
v /opt/IBM/WebSphere - requires 10 GB disk space
The standby Telephony Application Server does not count towards disk space
requirements. For example, if your deployment contains one active TAS and one
standby TAS, you will need a total of 20GB disk space for the SAN.
An offboard Media Server only requires 1 LUN on the SAN (/enterprise), with
10GB disk space
Procedure
1. Configuring SAN.
a. SAN installed and configured.
b. SAN LUNs configured
v LUN: Logical Unit Number.
c. The SAN is configured using a utility called Storage Manager.
v Use Storage Manager to create new logical drives and view logical drive
name to LUN mapping.
What follows is an example of a Telephony Application Server and separate
Media Server LUN Mapping table.
Chapter 2. Installing 91
d. Logical drives must be created on your SAN with 140 GB of size per
Telephony Application Server or Media Server node. Refer to the manual of
your SAN manufacturer on how to complete that task.
e. HBA cards installed on each host system, including standby nodes.
v HBA: Host Bus Adapter. The PCI card installed in the host to access the
SAN or SAN switch through Fibre Channel.
v Installation instructions outside the scope of this section, but further
information about how to configure HBA cards can be found under the
separate section “SAN Deployments.”
f. Connect the nodes to the SAN.
2. Ensure that the relevant directories exist on each node. Create the following
directories on every node in the cluster, including all standby nodes (directory
names are case sensitive):
/enterprise
/opt/IBM/WebSphere
3. Add mount points to /etc/fstab file.
Before you start with the further installation steps, you must prepare mount
points on all systems in such a way that the /enterprise partition for Telephony
Application Server or Media Server can be mounted on any node and similarly
the /opt/IBM/WebSphere can be mounted on any node for WebSphere
Application Server.
The device name must be adapted depending on partitioning of your SAN.
Since each TAS or Media Server installation uses an /enterprise mount point
there are several entries for the mount point /enterprise in the /etc/fstab file,
but all with different devices.
Note: The fstab file must contain entries for each ACTIVE node in the cluster.
The following example is a sample fstab file for a cluster of 2 TAS, 2 Media
Servers and 1+ stand-by nodes.
/dev/disk/by-id/scsi-3600a0b8000496cbe0000025348ce2b6c /enterprise
ext3 noauto,acl,user_xattr 1 0
/dev/disk/by-id/scsi-3600a0b8000496cbe0000025448ce2b80
/opt/IBM/WebSphere ext3 noauto,acl,user_xattr 1 0
/dev/disk/by-id/scsi-3600a0b8000496cbe0000025548ce2b92
/enterprise ext3 noauto,acl,user_xattr 1 0
/dev/disk/by-id/scsi-3600a0b8000496cbe0000033a48f5f0e4
/enterprise ext3 noauto,acl,user_xattr 1 0
/dev/disk/by-id/scsi-3600a0b8000496cbe0000033b48f5f102
/opt/IBM/WebSphere ext3 noauto,acl,user_xattr 1 0
/dev/disk/by-id/scsi-3600a0b8000496cbe0000033c48f5f11c
/enterprise ext3 noauto,acl,user_xattr 1
It is important that the mounts are not auto-mounted which means that after a
reboot the system will not mount it (noauto option). Furthermore the value 0
must be set in last column, which means that the file system check will not run
automatically for this mount point. Otherwise, a file system check can be
started on the standby node after the reboot, although the file system is
mounted on another node and although it is not automatically mounted. If this
event happens, the fsck fails and the node will not install properly. Use an
editor to change /etc/fstab according to the example.
4. Check /etc/fstab settings.
Check if the mounts are working correctly on all nodes before continuing. Be
careful to never mount the same mount point on multiple nodes at the same
time. Log on to the first node, being aware to use the device name of your
installation, and call:
If the system is correctly mounted you can check it by calling the mount
command without any options. It should print out the mounted devices.
Other prerequisites:
This section describes other non-SAN related requirements that must be satisfied
before continuing with a failover cluster installation.
Extra IP addresses
v 1 or 2 extra IP addresses per Telephony Application Server
– 1 extra if WebSphere Application Server and Telephony Application Server
reside on same IP address
– 2 extra if WebSphere Application Server and Telephony Application Server
have unique IP addresses
v 1 extra IP address per offboard Media Server
Downloads
for example:
tar xvfz CZJJ1ML.tgz
v Verify that all media has been extracted to the following directory /software/IBM
v The extracted media includes all relevant software: cluster software SAMP,
Telephony Application Server software, IBM WebSphere Application Server,
scripts, and so on.
Installing SAMP:
Install the IBM Tivoli System Automation for Multiplatforms (SAMP) Base
Component before you begin installing the Telephony Application Server in your
IBM Lotus Sametime Unified Telephony deployment.
Ensure all the prerequisites have been satisfied and all media has been
downloaded to /software/IBM. The Tivoli SAMP V3.1 Base Component is included
in the Telephony Application Server installation package.
Chapter 2. Installing 93
About this task
Procedure
1. Log in to the server as root.
2. Navigate to the /software/IBM directory.
3. Run the following command to install SAMP:
./installSAMP.sh
This topic describes all the commands that must be invoked in order to create a
SAMP logical cluster.
Procedure
1. Issue the following command on every node in the cluster:
preprpnode node1 node2 nodeN
Use the automation policy response files to configure the Telephony Application
Servers and offboard Media Servers in the deployment. There are two automation
policy response files:
v AutomationPolicyResponseFile_Onboard.txt: Use this version of the file for an
onboard deployment, where each Media Server is installed directly onto a
Telephony Application Server.
v AutomationPolicyResponseFile_Offboard.txt: Use this version of the file for an
offboard deployment, where each Media Server is installed separately from any
Telephony Application Server. This version of the file contains additional settings
that are specifically used for the offboard Media Server.
Chapter 2. Installing 95
v SampleResponsefile_1TAS_1Standby.txt: This sample represents the simplest
scenario, a deployment of a single active Telephony Application Server and a
single standby server. This sample is based on the
AutomationPolicyResponseFile_Onboard.txt file.
v SampleResponsefile_2TAS_2MS_2Standby.txt: This sample represents a more
complex secenario consisting of a cluster with two active Telephony Application
Servers, two standby servers, and two offboard Media Servers. This sample is
based on the AutomationPolicyResponseFile_Offboard.txt file.
Procedure
1. Navigate to the /software/IBM/Failover/tools directory and open either the
AutomationPolicyResponseFile_Onboard.txt or the
AutomationPolicyResponseFile_Offboard.txt file in a text editor.
You will only use one of the files, depending on whether you are using
onboard Media Servers or offboard Media Servers.
2. In the script, replace every occurrence of CRLF with LF to ensure the script
executes properly.
3. Fill in the following general fields; these fields are required:
Table 2. Required general fields
Field Description
Policy Name The name of the automation policy. This is the policy name that
you will use in the next step to activate the automation policy.
Domain Name The name defined in Step 2 above, when the SAMP cluster was
created using the ‘mkrpdomain' command.
Standby Node If there is a single standby node for all nodes in the cluster, enter
the host name in Standby_Node. If there are multiple standby
nodes for the cluster, enter the host names of all the standby
servers, comma-separated.
Note: Only use the short host names of the nodes; for example, if
the fully qualified domain name of your node is host123.zyx.com,
the short the host name is host123.
TAS_Network_ Network interfaces that will host the virtual ‘floating' IP addresses
Interface must be defined. If WebSphere Application Server and the
Telephony Application Server use the same IP address, only enter
a value for TAS_Network_Interface. A network interface typically
has a value of “eth0”, “eth1” and so on. Alternatively, if bonded
adapters are used, a value such as “bond0” would be used.
Note: Bonded adapters decrease the likelihood of a failover
condition due to a network switch. Information about how to set
up a bonded adapter is provided in the section that describes the
SAN deployments.
WAS_Network_ If WebSphere Application Server is going to have a separate IP
Interface address, then enter the WebSphere Application Server virtual IP
address value here.
Tie_Breaker A tie breaker is required in a cluster with an even number of
nodes. A network tie breaker should only be used for domains
where all nodes are in the same IP sub net. Although it is
recommended to use the default gateway IP address, this must
not be used if it is virtualized by the network infrastructure.
Provide an IP address that can only be reached through a single
path from each node in the domain.
Netmask The netmask of the IP address. The attribute must be given as a
character string, for example: 255.255.255.0.
This is the value that the /enterprise folder is mapped to; you can
find it in the /etc/fstab file.
VIPA_TAS: Virtual IP address of the TAS. Ask your network administrator for
the address.
App_Type Application type (accepted values are TAS, WAS, and MS). In this
section, the value should be WAS, as the remaining values in this
section apply to the IBM WebSphere Application Server.
NODE_ID ID of install. Should correspond to ID file on the corresponding
mount point, for example. WAS1, WAS2, and so on.
VIPA_WAS Virtual IP address of WebSphere Application Server.
Note: This is left blank if Telephony Application Server and
WebSphere Application Server reside on the same IP.
MOUNT_WAS Mount point for Telephony Application Server software:
/dev/disk/by-id/scsi-3600a0b8000496cbe0098630jhf09823
5. For each active Telephony Application Server in the deployment, make a copy
of the Telephony Application Server section and edit it as appropriate.
Note: There is NO section in the response file for the standby server. Only the
active nodes are included.
6. (Offboard only) Fill in the values for an offboard Media Server:
This section appears only in the AutomationPolicyResponseFile_Offboard.txt
file because it is not needed for an onboard deployment.
Table 4. Required offboard Media Server fields
Field Description
App_Type Application type (accepted values are TAS, WAS, and MS). In this
section, the value should be MS because you are providing details
about the offboard Media Server.
Chapter 2. Installing 97
Table 4. Required offboard Media Server fields (continued)
Field Description
MS_Hostname Host name of the machine on which the Media Server is installed;
for example: ms1
Node_ID ID of install. Should correspond to ID file on the corresponding
mount point for example MS1, MS2, and so on.
VIPA_MS Virtual IP address of Media Server.
MOUNT_MS Mount point for Media Server software: /dev/disk/by-id/scsi-
3600a0b8000496cbe0098098432h
7. For each offboard Media Server in the deployment, make a copy of the
offboard Media Server section and edit it as appropriate.
Example
#If there is a single standby node for all nodes in the cluster, enter the
#hostname in #Standby_Node. If there #are multiple standby nodes for the
#cluster, enter the hostnames #of all the standby servers, comma-#separated
# - enter the node name of the standby TAS in Standby_Node
Standby_Node: host123
########################################################################
########################################################################
# TAS Details
########################################################################
#Type of installation such as TAS, WAS or MS. In this case, TAS
App_Type: TAS
########################################################################
# Offboard Media Server Details
########################################################################
#Type of installation such as TAS or MS
App_Type: MS
Chapter 2. Installing 99
#End of Media Server details
########################################################################
Generate the automation policy for an IBM Lotus Sametime Unified Telephony
deployment using the response file that you created previously.
Procedure
1. Ensure that the generation script is executable by running the following
command:
- chmod 777 generateAutomationPolicy.pl
2. Generate the policy using the generateAutomationPolicy.pl script.
./generateAutomationPolicy.pl -i automation_policy_response_file.txt
where automation_policy_response_file.txt is the response file that you
edited in the previous task. If you modified one of the provided templates for
your response file, it uses one of the following names:
v AutomationPolicyResponseFile_Onboard.txt
v AutomationPolicyResponseFile_Offboard.txt
The output from this command should look like this example:
Generating SAMP policy using response file: AutomationPolicyResponsefile.txt...
...
Generated SAMP policy: SUT_Policy2.xml
3. Verify that the policy is valid with the following command:
sampolicy -c policy_name.xml
4. If the policy is valid, activate the policy the following command
sampolicy -a policy_name.xml
5. If the policy is activated without problem, the system responds with a message.
Prepare the response file for use when installing a Telephony Application Server
into an IBM Lotus Sametime Unified Telephony deployment.
You must prepare the response file manually. This file contains the IBM WebSphere
Application Server parameters, Lotus Sametime Unified Telephony parameters,
Telephony Application Server parameters, and SolidDB parameters.
There are different forms of response files available depending on whether you are
using an onboard or offboard installation, or whether you are installing Telephony
Application Server or the Media Server. Use the Telephony Application Server's
own IP address wherever the Telephony Application Server IP is requested. Use
the Media Server's virtual IP address (VIPA) wherever the Media Server IP is
requested. Use the Telephony Application Server's virtual IP address (VIPA) for the
SIP proxy server's IP address.
Procedure
1. Prepare the Lotus Sametime Unified Telephony response file.
v For an onboard installation use the
responsefile.txt.TEMPLATE.TAS_Node_Small_Deployment file.
Example: WAS_USERNAME=wasadmin
•WAS_PASSWORD
It is used by the installer to create a password for the username specified
in WAS_USERNAME property.
Example: WAS_PASSWORD=pasbw2dfg7
•WAS_IP
It is one of the IP addresses or virtual IP address in fail-over
configuration of the machine where WebSphere Application Server is installed.
Enter one of the two IPs that are configured for this server.
The other IP should be entered into the TAS_IP section.
Example: WAS_IP=192.168.232.128
•SUT_USERNAME
It is used by the installer to create a user in WebSphere, when installing
WebSphere, for Sametime Unified Telephony administration purposes. When
this user logs into WebSphere he can only see Sametime Unifief Telephony
applications.
Example: SUT_USERNAME=sutadmin
•SUT_PASSWORD
It is used by the installer to create a password for the username specified
in SUT_USERNAME property.
Example: SUT_PASSWORD=ituy7ngsd9o
•TAS_USERNAME
It is the TAS (CMP) administrator username and is used by installer when
installing sutadmin applicationsin WebSphere.
Example: TAS_USERNAME=administrator
•TAS_PASSWORD
It is the password for the TAS (CMP) administrator specified in TAS_USERNAME.
Example: TAS_PASSWORD=abc1def?GH
•TAS_IP
It is the IP address (or virtual IP address in fail-over configuration)
of the machine on which TAS is installed and is used by installer when
installing sutadmin applicationsin WebSphere and is used for a deployment
type of TAS_NODE_SMALL or TAS_NODE_MEDIUM.
Enter one of the two IPs that are configured for this server.
The other IP should be entered into the TAS_IP section
Example: TAS_IP=192.168.232.128
•MEDIA_SERVER_IP
Example: MEDIA_SERVER_IP=9.123.53.90
•MEDIA_SERVER_NAME
It is the name of the Media Server. This value is used for a deployment
type of MEDIA_SERVER_NODE_MEDIUM.
•NODE_MEDIA_SERVER_1_IP
It is the IP address (or virtual IP address in fail-over configuration)
of the machine on which the Media Server is installed. This value is used
for a deployment type of TAS_NODE_MEDIUM.
Example: NODE_MEDIA_SERVER_1_IP=9.123.53.90
•NODE_MEDIA_SERVER_1_NAME
It is the name of the Media Server. This value is used for a deployment
type of TAS_NODE_MEDIUM.
•NODE_MEDIA_SERVER_2_IP
It is the IP address (or virtual IP address in fail-over configuration)
of the machine on which the Media Server is installed. This value is used
for a deployment type of TAS_NODE_MEDIUM.
Example: NODE_MEDIA_SERVER_2_IP=9.123.53.91
•NODE_MEDIA_SERVER_2_NAME
It is the name of the Media Server. This value is used for a deployment
type of TAS_NODE_MEDIUM.
•SI_COMMUNITY_NAME
It is the unique ID for each TAS and/or Media server and for a TAS Medium
installation the SI_COMMUNITY_NAME must be the same for both TAS and Media
server
Example: SI_COMMUNITY_NAME=Some_Unique_ID
•FORCE_ROUTING_URL
The IP address used here is the one you assigned to the sipsm1_vip parameter
in the node.cfg file during the Telephony Control Server configuration.
It is the IP address and port number of the B2BUA (Back-to-Back User Agent)
that a proxy request needs to be routed to if the enforcement mechanism is
provided, and its format must be a valid sip URL such as sip:<IP address>:<port>.
This value is used by the installer when installing the SIP application in WebSphere.
# e.g. FORCE_ROUTING_URL=sip:9.123.53.33:5060;transport=tcp
# e.g. FORCE_ROUTING_URL=sips:9.123.53.33:5061;transport=tls
Example: FORCE_ROUTING_URL=sip:9.123.105.72:5060;transport=tcp
Example: COMMUNITY_HOST=192.168.232.128
Example: SOFTPHONE_PREFIX=7111
Example: SIP_PROXY_IP=192.168.232.128
Example: STI_QUEUE_NUMBER=+15555741100
Example: STIGNF_PREFIX_REPLACEMENT=00
Example: CONNECTING_SERVER_DNS=web.company.com
Example: TELEPHONY_USERID_DOMAIN_SUFFIX=system
Example: STI_QUEUE_TIMEOUT_DEFAULT=10
Example: STI_DEFAULT_RNA_TIMEOUT=10
Example: STI_CONFERENCE_DEVICES=+15819991000,+15819991001
Example: TAS_DEPLOYMENT_TYPE=TAS_NODE_SMALL
To install the Telephony Application Server, choose the primary node of the cluster
where the installation is to be performed.
You must have edited and saved the appropriate response.txt file in the previous
topic.
After the installation, you will need to create an ID file on each mount point. The
cluster will not run as expected without the ID files.
Procedure
1. Use SAMP to start the Telephony Application Server and IBM WebSphere
Application Server mount points and virtual IP addresses by running the
following command:
chrg –o online SUT_BASE_TASx SUT_BASE_WASx
2. Set the cluster on manual mode with the following command:
samctrl -M T
If this command is not issued, the installation in a SAN deployment fails
because SAMP will switch to another drive and the WebSphere Application
Server will not be available under the /opt/IBM/Websphere/ path as expected.
3. Install Sametime Unified Telephony. Log on to the primary node on which the
TAS installation is to be performed. For a fresh installation:
a. Log in as root.
b. Issue the following command to install the TAS software: ./install.sh all
c. Type yes when prompted to agree to the licenses.
The installation takes approximately 45 minutes.
4. After a successful installation, create ID files on each mount point. The ID files
are created in order to identify the installed system. The name of the file must
correlate with the NODE_ID definitions in the automation policy responsefile
file. For example, a TAS installation can be identified by a file called TAS1; a
WebSphere Application Server installation can be identified by a file called
WAS1; a Media Server installation can be identified by a file called MediaServer1.
Log in as root and execute the following commands:
v touch /enterprise/TAS1 for a TAS.
v touch /opt/IBMWebSphere/AppServer/WAS1 for a WebSphere Application
Server. This command creates empty files to identify the servers.
v touch /enterprise/MediaServer1 for a Media Server on a separate Media
Server node.
After the Telephony Application Server software has been installed on the primary
node in the IBM Lotus Sametime Unified Telephony cluster and you have created
ID files for each mount point, you can bring the primary TAS node online.
You must have created the ID files on each mount point in the cluster. These are
only created on the mounted directories, not on any particular system.
To bring the node online, SAMP must be taken out of manual mode. You can then
start and verify that the Telephony Application Server is up and running. SAMP
must have total control over all cluster components, including processes that run
on startup.
Procedure
1. Take SAMP out of manual mode with the following command:
samctrl -M F
2. Start the Telephony Application Server with the following command:
chrg -o online CLUSTER_TASx
Where x is 1, 2, 3... or
chrg NODE_MGR_MediaServerX
Now, you can perform all the remaining Telephony Application Server
installations. Remember to perform these tasks for each node in the cluster.
Procedure
1. Bring the mount points and virtual IP address online first: For TAS1:
chrg -o online SUT_BASE_TAS1 SUT_BASE_WAS1
For TAS2:
chrg -o online SUT_BASE_TAS2 SUT_BASE_WAS2, and so on
2. Put SAMP into manual mode.
samctrl -M T
3. Prepare the Sametime Unified Telephony response file.
4. Install the Telephony Application Server software.
./install.sh all
5. Create ID files on the mount points if you have not already done so, for
example: On TAS2:
touch /enterprise/TAS2 and
touch /opt/IBM/WebSphere/Appserver/WAS2
6. Take SAMP out of manual mode
samctrl -M F
7. Start the Telephony Application Server, for example: For TAS 3:
chrg -o online CLUSTER_TAS3
8. Invoke the commands that prevent automatic startup of the Telephony
Application Server components:
chkconfig symphoniad off
chkconfig solidSYM off
chkconfig websphere off
You can optionally install an off board Media Server after the Telephony
Application Server software installation, depending on customer requirements.
If you are going to install an off board Media Server, ensure that the corresponding
Telephony Application Server is running.
Procedure
1. To ensure that the corresponding Telephony Application Serve is running, use
the following command:
lssam
4. Log in to the node where you will perform the Media Server installation.
5. Prepare the Media Server responsefile.txt using the following template (can
be found under /software/IBM/:
responsefile.txt.TEMPLATE.Media_Server_Node_Medium_Deployment
6. Put SAMP in manual mode using the command:
samctrl -M T
7. Using the Sametime Unified Telephony installer, install the Media Server only.
Use the following command:
./install.sh ms
8. Create the ID file on the Media Server mount point using the command:
touch /enterprise/MediaServer1
9. Take SAMP out of manual mode:
samctrl -M -F
10. Start the Media Server, for example, for Media Server 2
chrg -o online NODE_MGR_MediaServer2
11. Verify that the Media Server is running with the command (example output
below):
lssam
After successful installation of the Telephony Application Server and the Media
Server in your IBM Lotus Sametime Unified Telephony deployment, you must
copy some additional files, such as the start scripts in /etc/init.d/, to the standby
nodes. A specialized script, coldStandby.sh, is provided for this purpose.
Note: Once SAMP resources reach a FAILED offline state, you must reset
them manually.
5. Prevent the automatics startup of system components.
chkconfig symphoniad off
chkconfig solidSYM off
chkconfig websphere off
6. Check for the presence of the symbolic link:
ls -al /usr/lib/liblog4cxx.so
If the symbolic link exists, the reply will indicate where the link points. If the
link does not exist, create one as follows:
ln -s -T /enterprise/mediaserver/application_host/bin/liblog4cxx.so
/usr/lib/liblog4cxx.so
7. Bring the node online on the standby node.
chrg -o online CLUSTER_TAS1
8. Verify that all components are running as expected:
lssam
9. Reset resources that are in the FAILED offline state:
resetrsrc -s ’Name like "%"’ IBM.Application
10. Fail back to the primary node.
rgreq -o move -n <standby_node> SUT_BASE_TAS1
Procedure
1. Start the Telephony Control Server command-line interface in standard (not
expert) mode:
startCli
2. Select 6, 8, 4, create.
3. Add the following 11 rules for Telephony Application Server IP. This has to be
made for all Telephony Application Servers which uses the CMP to access the
Telephony Control Server.
---------------------------------------------------------------
Packet Filter Rule Name: TAS1_PHY
Description: SNMP Packets from TAS1 to Node IP
Remote FQDN:
Remote IP Address: <Virtual IP Address of TAS1>
Remote NetMask: 255.255.255.255
Remote Port Begin: 0
Remote Port End: 0
Direction: InComing
Local Host : bond_node_alias
Local Port Begin: 161
Local Port End: 0
Transport Protocol: UDP
Action : Allow
---------------------------------------------------------------
Packet Filter Rule Name: TAS1_PHY_FTPC
Description: FTP Control from Trusted TAS1 to Node IP
Remote FQDN:
Remote IP Address: <Virtual IP Address of TAS1>
Remote NetMask: 255.255.255.255
Remote Port Begin: 0
Remote Port End: 0
Direction: InComing
Local Host : bond_node_alias
Local Port Begin: 21
Local Port End: 0
Transport Protocol: TCP
Action : Allow
---------------------------------------------------------------
Packet Filter Rule Name: TAS1_PHY_FTPD
Description: FTP Data from TAS1 to Node IP
Remote FQDN:
Remote IP Address: <Virtual IP Address of TAS1>
Remote NetMask: 255.255.255.255
Remote Port Begin: 0
Remote Port End: 0
Direction: InComing
Local Host : bond_node_alias
Local Port Begin: 20
Local Port End: 0
Transport Protocol: TCP
Action : Allow
---------------------------------------------------------------
Packet Filter Rule Name: TAS1_SOAP_Node
Description: SOAP from TAS1 to Node IP
Remote FQDN:
Remote IP Address: <Virtual IP Address of TAS1>
Remote NetMask: 255.255.255.255
Remote Port Begin: 0
Remote Port End: 0
Direction: InComing
Local Host : bond_node_alias
Local Port Begin: 8767
This topic describes some of the failover tests you can perform on the primary and
standby Telephony Application Server nodes.
There are several tests that you can execute to verify that the failover installation is
working. The following tests are general guidelines for these components.
Procedure
1. Reboot the active node. It is expected that the switchover is successful, and that
the times are comparable with a manual switchover.
2. Power off the active node. Check to see if the switchover is successful.
3. Disconnect the network cable to the outside network. Check to see if the
switchover is successful.
4. Switchover to the standby node while the mount is busy, for example, by an
opened shell that changes to the mounted directory. The expected result is the
switchover is successful and that the shell has been closed.
5. Manually stop the processes, using this command:
symphoniad stop
Where node is the currently active node. Use the lssam command to see which
node is currently active.
You can update or uninstall any of the components, for example Telephony
Application Server, WebSphere Application Server, or the Media Server.
Procedure
1. Switch the resources to be updated to the node where the original installation
was performed. The rpm database is consistent on the primary node. Use the
rgreq commands.
2. Set the cluster on manual mode:
samctrl -M T
3. Perform the update or uninstall according to the installation instructions, for
example, to uninstall and reinstall the OSGI container:
./uninstall.sh osgi
./install.sh osgi
4. To update, set the cluster back to automatic mode:
samctrl -M F
Use the following command to start Lotus Sametime Unified Telephony services in
a failover environment:
chrg -o online SUT_BASE_TASx SUT_BASE_WASx CLUSTER_TASx
Use the following command to stop Lotus Sametime Unified Telephony services in
a failover environment:
chrg -o offline CLUSTER_TASx
Issuing the above command stops services running on the Telephony Application
Server. However, the Telephony Application Server and WebSphere Application
Server mount points will still be online and under the control of SAMP. To stop
everything and unmount the disks, use the following command:
chrg -o offline SUT_BASE_TASx SUT_BASE_WASx CLUSTER_TASx
Administration guidelines
In a failover cluster, always use IBM Tivoli System Automation for Multiplatforms
(SAMP) commands to control the Telephony Application Servers.
Examples:
v To stop Lotus Sametime Unified Telephony services, use the SAMP command:
- chrg -o offline CLUSTER_TASx
All commands for controlling the cluster are described in Using the command line
for SAMP monitoring and maintenance.
It is very important to avoid dual mounting the SAN disks on both the primary
and standby nodes. If you use only SAMP commands to control the Telephony
Application Servers, this will never occur. Be aware that while SAMP controls the
cluster services, it also controls the mount points.
Lotus Sametime Unified Telephony services for that Telephony Application Server
can then be stopped and started using the native commands.
This topic describes some SAMP monitoring and maintenance tasks that can be
performed using the command-line interface (CLI).
The SAMP has the following useful commands from the CLI:
v For all SAMP commands, UNIX man-pages are available.
man command_name
v Monitor the cluster state:
lssam
v Monitor the system permanently:
lssam -top
v Set Automation to manual mode, that is, for installation, update, and so on:
samctrl -M T
v Set Automation to automatic mode:
samctrl -M F
v Reset the state of a resource (recover from Failed offline):
– Reset the resource DB_MGR when it is in Failed offline state:
resetrsrc -s ’Name="DB_MGR"’ IBM.Application
– Reset all resources:
resetrsrc -s ’Name like "%"’ IBM.Application
v Start / Stop resource group SUT_BASE_TASx:
(SUT_BASE_TASx controls the /enterprise mount point and the TAS virtual IP
address)
chrg -o online SUT_BASE_TASx
chrg -o offline SUT_BASE_TASx
v Bring down the active TAS node:
chrg -o offline CLUSTER_TASx
The IBM Tivoli System Automation Operations Console is the hub for automated
operations and monitoring of applications in a heterogeneous environment.
Normally installed on a separate server, the console is Web-based and designed to
provide easy and efficiently support of the end-to-end landscape. Use of the
operations console for SAMP monitoring is optional.
The selection in the topology tree controls what is shown in the resource table
below the domain topology. The resource table displays the automated resources
for the currently selected domain or node. Currently the automation domain
FriendlyE2E is selected in the topology tree. Therefore the resource table displays
the automated applications that have been defined for the automation domain.
Now, switch back to the end-to-end domain and have a closer look at the
automated e-business applications, below. To get more information about a
particular resource, an operator can select it in the resource table. As the icon
shows, Stock Trading Application is a group that consists of several sub-components
that make up the e-business application Stock Trading Application.
Look at the information area on the right side of the screen. The information area
always shows detailed information about the current selection. For example, it
shows the exact name and class, as well as owner information and provides a
hyperlink that can take an operator to further operational information about this
resource. The status section is also important. It shows the currently observed state
of the resource – online, which means that the Stock Trading Application is currently
up and running – and the required state, which is the automation goal that has
been defined in the automation policy. Above these two states the status section
shows summary information, also called a compound state, for the resource. Since
the observed state matches the required state, the summary says that the resource
works as intended and a green icon is displayed.
Install the IBM Tivoli System Automation for Multiplatforms (SAMP) operations
console.
Operations console installers are available for Linux and for Microsoft Windows
2003 Server. For detailed instructions, including hardware requirements, see the
SAMP V3.1 Installation and Configuration Guide. The installation steps are
summarized below.
Procedure
1. Open setup.bin.
2. Select the language of the installation.
3. Accept license agreement.
Start the configuration dialog. See Chapter 6 of the Installation and Configuration
guide SAMP to get more details.
Procedure
1. Typing either of the following commands will start the configuration dialog for
the Operations Console.
v In Windows, go to (cd) C:\Program Files\IBM\tsamp\eez\bin\ and type the
following command:
cfgdirect.bat
v On Linux, type the following command:
cfgdirect
2. Specify the Event port number on the Server tab. Default port is 2002.
Configuring the Base Component Automation Adapter of the SAMP Operations Console:
In order to directly access the Operations Console, you must configure the
automation adapter of the SAMP Base Component. The end-to-end automation
adapter can be configured with the cfgsamadapter utility.
Note: The automation adapter can be configured from any node in the SAMP
cluster.
Procedure
1. Start the adapter using the cfgsamadapter command. The following dialog
appears.
a. Select to replicate all the configuration files to all nodes by clicking both
Select all buttons.
This topic describes how the Base Component Automation Adapter is brought
online for the cluster, and how to verify that the cluster is available to administer
from the Operations Console.
Procedure
1. To start the automation adapter, log on to one of the nodes in the cluster and
bring it online using the chrg command
chrg –o online samadapter-rg
2. Check that the adapter is online using the command lssam. The automation
adapter resource group is visible at the bottom of the 'lssam' output. The
output provides the node on which the adapter is currently active.
3. It is now possible to administer the domain from the Operations Console. Log
in to the Operations Console and verify that the cluster is visible.
The Telephony Control Servers can operate on three different levels, with the
runtimes controlled separately from the databases. On Telephony Application
Servers, the IBM WebSphere Application Server and the framework can be
controlled separately. For more information, see the following topics:
TAS runtimes
To start and stop the IBM WebSphere Application Server and the framework on the
Telephony Application Server in an IBM Lotus Sametime Unified Telephony
deployment, issue the following commands.
Procedure
1. To stop or start the WebSphere Application Server, begin by opening up a
terminal on TAS (with Putty) and log in as root user.
2. To start the WebSphere Application Server, run the command #
/opt/IBM/WebSphere/AppServer/bin/startServer.sh server1.
3. To stop the WebSphere Application Server, run the command #
/opt/IBM/WebSphere/AppServer/bin/stopServer.sh server1 -user
WAS_Admin_Username -password WAS_Admin_Password.
4. To check the status of WebSphere Application Server, run the command:
/opt/IBM/WebSphere/AppServer/bin/serverStatus.sh server1 -user
WAS_Admin_Username -password WAS_Admin_Password.
TCS runtimes
To change the run level of the TCS server, follow these steps.
The TCS nodes can operate in one of three different documented levels:
v Level 4: The runtimes and databases are all up and running.
v Level 3: The TCS Runtime (RTT) is down, but the Database remains up.
v Level 2: The TCS Runtime (RTT) and Solid Database are down.
Procedure
1. To alter the run level, first execute the srxctrl command by logging in to a
TCS node as root user and change to the following directory # cd
/unisphere/srx3000/srx/startup
2. Then, execute the srxctrl command. The command to alter the run level of the
TCS nodes takes two arguments: Argument 1, the run level for the local node,
on which the command is being executed and Argument 2, the run-level of the
remote TCS node. The command to alter the run level of TCS is # ./srxctrl 4
4
3. Check the status of the server before leaving the console. Run the command: #
./srxqry
Example
To restart the TCS nodes (both of them) without disrupting service, first, take
down the primary node: # ./srxctrl 3 4. To start the primary node and take
down the secondary node: # ./srxctrl 4 3. To start the secondary node and set
nodes are back at run-level 4 # ./srxctrl 4 4. Here's an example of the output:
-- --- srxqry started on Tue Feb 2 09:05:02 GMT 2010 ---
-- OS : Linux
-- Platform : x3650T
-- Cluster : DUBTCS02
Node name Status
--------- ------
Local Node : dubtcs02node1 Online at state 4
Remote Node : dubtcs02node2 Online at state 4
- Get running applicationsinformation on dubtcs02node1, please stand by...
- Checking for running applicationson dubtcs02node1... -- UCE and all
signaling managers are up and running on dubtcs02node1 Found the
following interfaces configured from RTP configuration!
For Node: dubtcs02node1
CCM 0.5 Vip: 192.168.100.192
Up
CCM 1.0 Vip: 192.168.100.133
Up
CCM TGCP Vip: 192.168.100.199
Up
CSTA Vip: 192.168.100.246
Up
SIP Vip: 192.168.100.236
You must have performed the initial configuration of the TCS and TAS servers.
This testing phase checks the health of both TAS and TCS. You can print out the
actual TCS software version. After you have tested the connections and health
status, you can continue to integrate with the customer environment.
Procedure
1. Perform a health check for the TAS. Log in through SSH as root. These tests
verify that TAS can work with TCS and Sametime Server:
a. Test that two connections to the Sametime server on port 1516:
netstat -an |grep 1516.
b. Test that one connection to TCS CSTA is active on port 1040:
netstat -an |grep 1040.
Note: The port 1040 will not become actively connected until after the
CSTA connection has been configured in the Common Management Portal
(CMP).
c. Test that one connection to SIP WebsphereProxy is active on port 5060:
netstat -an |grep 5060.
d. Test that one connection to the SIP TLS WebsphereProxy on active on port
5061:
netstat -an |grep 5061.
e. Test that one connection to SIP Conference is active on port 5070:
netstat -an |grep 5070.
f. Test that one connection to SIP TLS Conference is active on port 5071:
netstat -an |grep 5071.
2. Print out the TCS software version using the following command: pkgversion
-ps. The output depends on the used patch set and the E-patch level.
Procedure
1. Enable Lotus Sametime Telephony features in the Lotus Sametime Connect
client.
Starting with release 8.5.1, telephony features are automatically installed into
the Lotus Sametime client, and you enable the telephony features from the
Lotus Sametime user interface as described in the Lotus Sametime Standard
information center topic, Enabling Sametime Unified Telephony client features.
2. On each Lotus Sametime Community Server in the deployment, edit the
sametime.ini file and specify a limit for the IGNORE_SUBSCRIBES_ABOVE_MAX
setting.
For more information, see the Lotus Sametime Standard information center
topic, Advanced settings to control contact list size.
Procedure
1. Open the access.conf file for editing and locate the following line:
-:root:ALL EXCEPT LOCAL vmtcs1a vmtcs1a_cip0 vmtcs2a vmtcs2a_cip0 console localhost tty1 tty2 tty3 tty4 tty5 tty6 clusternode1-priv clusternode2
2. At the beginning of the line, change the - to + as follows:
+:root:ALL EXCEPT LOCAL vmtcs1a vmtcs1a_cip0 vmtcs2a vmtcs2a_cip0 console localhost tty1 tty2 tty3 tty4 tty5 tty6 clusternode1-priv clusternode2
3. Now locate this line:
-:srx:ALL EXCEPT LOCAL 10.236.11.201 vmtcs1a vmtcs1a_cip0 vmtcs2a vmtcs2a_cip0 console localhost tty1 tty2 tty3 tty4 tty5 tty6 clusternode1-priv
4. Again at the beginning of the line, change the - to + as follows:
+:srx:ALL EXCEPT LOCAL 10.236.11.201 vmtcs1a vmtcs1a_cip0 vmtcs2a vmtcs2a_cip0 console localhost tty1 tty2 tty3 tty4 tty5 tty6 clusternode1-priv
5.
6. Save and close the file.
Example
NOTE: You may use this software only in accordance with the terms of your
license agreement, located on any of the installation CDs for this product.
Login: sysad
Main Menu:
Configuration Management.......................1
Fault Management...............................2
Performance Management.........................3
Security Management............................4
System Management..............................5
Application-level Management...................6
Open Logfile............................94
Show Callback Output....................95
Wait for Callbacks......................96
Change Password.........................97
Expert Mode.............................98
Exit....................................99
Selection: 1
Configuration Parameters.......................1
Logging........................................2
Return..................................99
Selection: 1
browseParameterNames...........................1
getParameterInfo...............................2
modifyParameter................................3
createParameter................................4
deleteParameter................................5
loadConfigVersion..............................6
removeConfigVersion............................7
getAllSavedConfigVersions......................8
saveCurrentConfigVersion.......................9
Return..................................99
Selection: 3
modifyParameter:
name : hiQ/CSTA/GNFPrefixReplacement
invariant settings:
name : hiQ/CSTA/GNFPrefixReplacement
type : PARM_STRING
usage : PARM_USAGE_CUSTOMER
lastUpdateMillis : 25.Nov.2009 19:29:19h (000 msec)
changeId : 0
descriptionString:
SIP session timers prevent the Telephony Control Server from hanging connections
when a call is lost.
Procedure
1. Log in as sysad.
When a call is received, the TCS sends the call to the TAS and within milliseconds
the TAS deflects the call to the target that is the outcome of the rules/routing
workflow engine. If there is a problem on the TAS, the TCS will deflect the call to
the dependable target after an interval defined by the timer. During high load
periods, the default 2 seconds can be too short, resulting in a deflection to the
dependable target just before a normal deflection to the correct target. Moving the
timer to 3 seconds makes deflection to the correct target more likely.
Procedure
1. Log in as srx and execute startCLI.
2. Log in as sysad.
3. At the Main Menu, enter 1.
4. At the Configuration Management menu, select 1.
5. At the Configuration Parameters menu, select 2.
6. At the getParameterInfo prompt, enter hiQ/CSTA/DelayAtONSOfferedState.
7. Press Enter to continue.
8. At the Configuration Parameters menu, select 4.
9. At the createParameter: name <max length: 255> : prompt, enter
hiQ/CSTA/DelayAtONSOfferedState.
10. At the usage <PARM_USAGE_CUSTOMER 2> (default: 2) field, select 2.
Then choose yes when asked, Do you want to execute this action? (default:
yes.
11. At the Configuration Parameters menu, select 2. At the name (default: ):,
enter hiQ/CSTA/DelayAtONSOfferedState
12. At the Configuration Parameters menu, select 99.
13. At the Configuration Management menu, select 99.
Example
dubtcs02node1:~ # su - srx
srx on dubtcs02node1 using /dev/pts/0 ...
dubtcs02node1:/unisphere/srx3000/srx (141> startCli
NOTE: You may use this software only in accordance with the terms of your
license agreement, located on any of the installation CDs for this product.
Login: sysad
Main Menu:
Configuration Management.......................1
Fault Management...............................2
Performance Management.........................3
Security Management............................4
System Management..............................5
Application-level Management...................6
Open Logfile............................94
Show Callback Output....................95
Wait for Callbacks......................96
Change Password.........................97
Expert Mode.............................98
Exit....................................99
Selection: 1
Configuration Management:
Configuration Parameters.......................1
Logging........................................2
Return..................................99
Selection: 1
Return..................................99
Selection: 2
getParameterInfo:
createParameter:
browseParameterNames...........................1
getParameterInfo...............................2
modifyParameter................................3
createParameter................................4
deleteParameter................................5
loadConfigVersion..............................6
removeConfigVersion............................7
getParameterInfo:
Ok.
Parameter Information:
name : hiQ/CSTA/DelayAtONSOfferedState
value : 3000
type : PARM_INT
usage : PARM_USAGE_CUSTOMER
lastUpdateMillis : 20.Mar.2009 09:14:25h (000 msec)
changeId : 0 descriptionString:
Configuration Management:
Configuration Parameters.......................1
Logging........................................2
Return..................................99
Main Menu:
Configuration Management.......................1
Fault Management...............................2
Performance Management.........................3
Security Management............................4
System Management..............................5
Application-level Management...................6
Open Logfile............................94
Show Callback Output....................95
Wait for Callbacks......................96
Change Password.........................97
Expert Mode.............................98
Exit....................................99
Return..................................99
Selection: 1
Return..................................99
Selection: 8
stopProcess:
logicalName: uce1
Ok.
startConfiguredProcess:
logicalName: uce1
Ok.
getProcessInformation..........................1
getAllProcessStatus............................2
configureProcess...............................3
modifyProcessConfiguration.....................4
deleteProcess..................................5
startConfiguredProcess.........................6
startProcess...................................7
stopProcess....................................8
createProcessGroup.............................9
modifyProcessGroup............................10
deleteProcessGroup............................11
getProcessGroupInformation....................12
getNumberOfProcessGroupMembers................13
startProcessGroup.............................14
stopProcessGroup..............................15
getAliasInformation...........................16
createAlias...................................17
modifyAlias...................................18
deleteAlias...................................19
getCeInformation..............................20
getAllProcessGroupStatus......................21
getAllConfiguredProcessGroups.................22
restartProcess................................23
stopProcess:
logicalName: uce2
Ok.
getProcessInformation..........................1
getAllProcessStatus............................2
configureProcess...............................3
modifyProcessConfiguration.....................4
deleteProcess..................................5
startConfiguredProcess.........................6
startProcess...................................7
stopProcess....................................8
createProcessGroup.............................9
modifyProcessGroup............................10
deleteProcessGroup............................11
getProcessGroupInformation....................12
getNumberOfProcessGroupMembers................13
startProcessGroup.............................14
stopProcessGroup..............................15
getAliasInformation...........................16
createAlias...................................17
modifyAlias...................................18
deleteAlias...................................19
getCeInformation..............................20
getAllProcessGroupStatus......................21
getAllConfiguredProcessGroups.................22
restartProcess................................23
startConfiguredProcess:
logicalName: uce2
Ok.
Press <Return> to continue
Process & Node (methods):
getProcessInformation..........................1
getAllProcessStatus............................2
configureProcess...............................3
modifyProcessConfiguration.....................4
deleteProcess..................................5
startConfiguredProcess.........................6
startProcess...................................7
stopProcess....................................8
createProcessGroup.............................9
modifyProcessGroup............................10
deleteProcessGroup............................11
getProcessGroupInformation....................12
getNumberOfProcessGroupMembers................13
startProcessGroup.............................14
stopProcessGroup..............................15
getAliasInformation...........................16
createAlias...................................17
modifyAlias...................................18
deleteAlias...................................19
getCeInformation..............................20
getAllProcessGroupStatus......................21
getAllConfiguredProcessGroups.................22
restartProcess................................23
Ok.
getProcessInformation..........................1
getAllProcessStatus............................2
configureProcess...............................3
modifyProcessConfiguration.....................4
deleteProcess..................................5
startConfiguredProcess.........................6
startProcess...................................7
stopProcess....................................8
createProcessGroup.............................9
modifyProcessGroup............................10
deleteProcessGroup............................11
getProcessGroupInformation....................12
getNumberOfProcessGroupMembers................13
startProcessGroup.............................14
stopProcessGroup..............................15
getAliasInformation...........................16
createAlias...................................17
modifyAlias...................................18
deleteAlias...................................19
getCeInformation..............................20
getAllProcessGroupStatus......................21
getAllConfiguredProcessGroups.................22
restartProcess................................23
startConfiguredProcess:
logicalName: uce3
Ok.
getProcessInformation..........................1
getAllProcessStatus............................2
configureProcess...............................3
modifyProcessConfiguration.....................4
deleteProcess..................................5
startConfiguredProcess.........................6
Ok.
getProcessInformation..........................1
getAllProcessStatus............................2
configureProcess...............................3
modifyProcessConfiguration.....................4
deleteProcess..................................5
startConfiguredProcess.........................6
startProcess...................................7
stopProcess....................................8
createProcessGroup.............................9
modifyProcessGroup............................10
deleteProcessGroup............................11
getProcessGroupInformation....................12
getNumberOfProcessGroupMembers................13
startProcessGroup.............................14
stopProcessGroup..............................15
getAliasInformation...........................16
createAlias...................................17
modifyAlias...................................18
deleteAlias...................................19
getCeInformation..............................20
getAllProcessGroupStatus......................21
getAllConfiguredProcessGroups.................22
restartProcess................................23
startConfiguredProcess:
logicalName: uce4
Ok.
Procedure
1. To change the TCS root user password, log in to each TCS node and enter the
passwd command to change the root password.
2. Once you enter the command, you will see the following:
Changing password for root.
Password changed
Note: Use the same password on both TCS nodes and change passwords at
the same time on both TCS nodes
You can create the packet filter rules to enable communication between the
Telephony Control Server and the offboard Media Server.
Procedure
1. Log in as srx and execute startCLI.
2. Log in as sysad.
3. Starting at the Main menu, select 6 > 8 > 4 > 1. Then, add the following
parameters:
Packet Filter Rule Name <Max length:63 (max length:63)> default: ):
Packet Filter Name
Description <To clear enter /000 (max length:63)> (default: ):
Packet Filter Name Description
Remote FQDN <To clear enter /000 (max length:63)> (default: ):
Press <enter>
Remote IP Address <To clear enter /000 (max length:15)> (default: ):
<Media Server IP address>
Remote Netmask <To clear enter /000 (max length:15)> (default: ):
<Media Server subnet mask>
In a cluster Telephone Control Server, the Packet Filter Rule must be added
three times for each of the three Telephony Control Server IP addresses, such as
the physical IP address of node1, physical IP of node2, or the virtual IP.
4. Verify that the Packet Filter Rule has been accepted by typing 4 from the
Packet Filter Rules Security Management (methods) menu. Then, enter the
packet filter name you have created.
The CMP is divided into three main sections: Operations & Maintenance,
Telephony Control Server, and Users & Resources.
The Users & Resources tab allows you to provision users and resources. This
section has three subsections:
v Domain: allows you to define domains for use with the Telephony Application
Server.
v Users: allows you to provision users.
One or more profiles or resources can be assigned to each user. The profiles are
used to assign specific features and access rights to a user. In addition to the
users of the selected domain, you can create foreign users: external users or
administrators from another domain who are to receive specific rights in the
selected domain. Profiles can be assigned from the selected domain to these
foreign administrators for this purpose. Profiles from the other domain cannot
be assigned. It is not possible to assign resources to foreign users.
v Resources: contains information about TCS Resources, such as office codes and
extensions, as well as containing information about Media Server resources for
example SIP Domains, and Conference Devices.
Procedure
1. On the Telephony Application Server, start the CMP:
a. Open a browser.
b. Enter the URL of the Telephony Application Server's CMP:
https://TAS_URL/management
For example:
https://tas01.example.com/management
c. Log in with the administrator@system.com user name and password.
2. Click Telephony Control Server > General > List of Switches > Switches.
5. Click the Test Connection button to verify that the CMP can connect to the
Telephony Application Server (or cluster).
If the test fails, check the network. If the Telephony Application Server is
operating on a different subnet from the management subnet, then configure
Procedure
1. In the CMP, click Operation & Maintenance > Configuration & Monitoring >
System Status > Applications.
2. Create a Media Server Connection:
You only need to add this connection when the Media Server is installed on a
separate computer from the Telephony Application Server (for example, in a
medium-scale deployment).
a. In the System Status table, select the Telephony Application Server, click the
arrow at the end of that row, and click on Media Server connection.
b. In the Media Server Connections dialog box, click the Add button
c. In the Media Server Connection Cluster dialog box, click the Add button.
d. In the Media Server Connection dialog box, fill in the information to define
the connection, and then click OK.
b. In the List of nodes dialog box, select the node where the Media Server is
installed, and click the Edit button.
c. On the Providers tab of the Physical node administration dialog box, click
IP Telephony (SIP), and then click the Edit button.
d. In the SIP configuration dialog box, fill in the SIP server's settings, and then
click Save.
The IP address you used to create the CSTA connection is displayed followed
by the word: ESTABLISHED; for example:
0 0 192.168.2.201:56255 192.168.2.115:1040 ESTABLISHED
Procedure
1. Click Telephony Server > Administration > Signalling Management > SIP.
2. In the SIP Settings dialog box, click the Rerouting tab.
3. In the Rerouting sesction, click the Enable Rerouting for SIP Subscribers check
box, and then click Save.
The Media Server comes with over 300 announcements. When the Telephony
Control Server requests an announcement from a Media Server, it uses an MGCP
endpoint for the Media Server, which must be configured.
Tag the user and endpoints with a routing area object. Prefix the routing areas with
“RA” and then an identifier, for example, for the Irish users it could be “RA_IRL”,
while for Scottish users it might be “RA_SCOT".
On the Telephony Control Server there are 349 intercepts, also called
announcements. The intercepts can be viewed in the CMP by clicking Telephony
Control Server > Administration > Media Servers > Intercepts. Within each
intercept, one or more treatments can be applied. A treatment is a pointer to a
wave file and also defines which destination can be used to access the resource.
The destination facilitates using a back-up Media Server in case the local Media
Server fails. In Lotus Sametime Unified Telephony, a destination and an endpoint
are created and then joined with a route. There is always one destination
containing one route, which points to one endpoint. For announcement
destinations, create multiple routes, and give each one a priority number, which is
referred to as the ID Number (the lower the ID, the higher the priority). It is
always a good idea to start with a low priority, and work higher. That way, if a
Media Server is taken offline, it is possible to add another Media Server and set it
to a higher priority without interruption.
For example, suppose you have two Media Servers: one located in Ireland and the
other in Germany. When the Telephony Control Server requires an announcement,
the intercept is pointed to the Origin Destination. It uses routing areas on that
object, and routes the request to the MS DE destination. This destination in turn
routes to both the MS_ANN_DE and MS_ANN_IRL servers; however because the
MS DE destination specifies that the MS_ANN_DE has priority, it routes to that
server first. If a failure occurs, the Irish Media Server continues to provide the
announcements to German users and endpoints but treats them as a lower priority.
Lotus Sametime Unified Telephony uses the MGCP (Media Gateway Control
Protocol) for routing announcements. Create a Media Server endpoint that uses
MCGP to serve as a destination for announcements.
4. Click the Extended tab, set the DTMF to Enabled, and leave the remaining
settings alone.
6. Click Save to save the MGCP endpoint. It displays on the Media Servers list, as
a blocked object.
The MGCP (Media Gateway Control Protocol) is a system of media gateways used
to bridge networks; each media gateway acts as an interface between a VoIP (Voice
over Internet Protocol) network and a classic telephone network. To ensure that
announcements can be delivered across the MGCP, you must create a Destination
that contains at least one route pointing to a Media Server within the MGCP
network. Most systems have multiple Telephony Application Servers and Media
Servers, so a destination will typically have two or three routes to other Media
Servers.
Procedure
1. On the Telephony Control Server, start CMP:
a. Open a browser and navigate to: https://TAS_URL/management/.
For example:https://tas01.example.com/management
b. Log in using the administrator@system.com credentials.
2. Click Telephony Control Server > Global Translation and Routing >
Destinations and Routes > Destinations.
Note: You must save the destination before you can add a route to it in the
next step.
The new destination now appears in the list on the Destinations list.
5. Click the new destination, which opens the Edit Destination dialog box.
6. Click the Routes tab, and then click the Add button.
.ann/$.
The selected server now appears in the MGCP Media Service field.
8. Leave the remaining fields on the page unchanged (be sure to leave the
Signaling Type as Undefined) and click OK.
The new route now appears on Routes list.
What to do next
Now that the destination has been defined, create a routing area as explained in
the next task.
Before you create the routing area, define ssign the Media Server's unified numbers
and endpoint profiles.
Procedure
1. Click Telephony Control Server > Global Translation and Routing >
Translation > Routing Areas.
4. Click Save.
5. Add a routing area for each Media Server.
Only one origin destination is needed for the deployment, even when you use
multiple Telephony Application Servers and Media Servers.
Procedure
1. Click Telephony Control Server > Global Translation and Routing >
Destinations and Routes > Origin Destinations.
2. Click the Add button.
3. In the Origin Destinations dialog box, type a descriptive name in the Name
field, and then click the Save button.
7. In the Origin Route dialog box, click the button next to the Routing Area
field, select a routing area from the list, and then click OK.
9. Click the button next to the Destination Name field, select a destination, and
then click OK.
11. Back in the Origin Destinations dialog box, the new origin destination
appears; now click Save to save it.
Enable auditing to ensure that the Telephony Control Server is checking for failures
and making use of other Media Server MGCP routes as needed in an IBM Lotus
Sametime Unified Telephony deployment.
Procedure
1. Click Telephony Control Server > Administration > Media Servers > Media
Server Audit.
Applying Treatments:
Treatments are for localizing announcements; you can apply treatments with a
script that is provided with IBM Lotus Sametime Unified Telephony. The msconf.sh
script lets you assign the treatments of all known intercepts of the Telephony
Control Server to an origin destination.
The msconf.sh script creates an ASK_ME intercept type that can be used to play
ringback in the queue device. It is different from the RINGBACK_TONE intercept
because the ASK_ME intercept answers the call before playing the intercept. The
msconf.sh script can also unassign the treatments from all known intercepts of the
TCS.
Procedure
1. Assign the proper execute rights to the msconf.sh script:
/tmp# chmod 744 msconf.sh.
2. Go to the /tmp directory and run the following command:
/tmp# ./msconf.sh
3. The script asks the following questions:
1) What do you want to do? Assign or Unassign treatments? [1 | 2]
-->1.1) Please give the name of the origin destination [max 15 characters]
------->1.1.1 Do you want to assign the treatments now? [y/n]
-->2.1) Do you want to unassign the treatments now? [y/n]
4. When you answer Y to the last question, the script starts running. At the end, a
report is offered that indicates whether the script executed:
CLI>stty: standard input: Inappropriate ioctl for device
The procedure is finished.
Report:
Treatments are assigned.
5. When the script is finished, check whether the script actually performed its
task. The output contains the following lines:
********* Treatment Request Response Message *********
Created treatment AOCBEnterProg(976)[1] in the database and shared memory
If the origin destination was not yet created in the TCS, the following line
would appear instead:
********* Treatment Request Response Message *********
Cannot find origin destination </ORIG_DEST_MS> in the database
.
6. If the msconf.sh script does not execute and the proper execute permissions are
set on the script, then run the command from the /tmp prompt:
/tmp# dos2unix msconf.sh
7. Check Intercepts in CMP and look at the last page for ASK_ME. Consider
Optimizing call interception for billing.
Set up and initialize the persistent cache once for each Telephony Application
Server, and then refresh each persistent cache as needed (usually whenever user
records are updated in the LDAP directory).
Initialize the cache after a new Telephony Application Server installation, after you
have started the TAS for the first time. The cache initialization may cause a high
load on both the Telephony Application Server and the Lotus Sametime server
because it must resolve all users in the unified telephony deployment, so you
should plan this task for a time when the deployment is in low demand.
Note: Initialize the persistent cache on every Telephony Application Server in the
deployment, except the failover nodes. In a failover environment, the persistent
cache may be copied from the failed server to the backup server (assuming that at
least the latest persistent cache version is stored on disk). Then if the server fails
before it has flushed the most recent cache additions to disk, the previous
persistent cache can be used; remember that if the mostly recently resolved names
had not been stored to disk, this version of the persistent cache will be missing
those names).
There are two methods for initializing the persistent cache; you only need to
complete one of these tasks:
Procedure
1. On the Telephony Application Server, open the /enterprise/ibm/
user.presence.adapter.properties file for editing (leave the server running).
2. Locate the following section in the file, and specify the chunk size (the number
of names to resolve in one pass) and the delay (in milliseconds) as shown:
###############################
# Description - The number of resolve requests to send at each chunk
# Value - The number of requests.
# Default value - 1000 requests
###############################
resolve.chunk.size=1000
###############################
# Description - The time to wait between chunks of resolve requests.
# Value - time interval in milliseconds
# Default value - 1 minute
###############################
resolve.chunk.delay=60000
In this example, the Telephony Presence Adapter sends 1000 resolve requests at
a time, and then waits for 1 minute (60000 milliseconds) before sending another
chunk of names. If 15000 users are provisioned on the Telephony Application
Server, the cache initialization will take approximately 15 minutes.
3. Save and close the file.
4. Restart the Telephony Application Server.
5. Once the cache has been initialized, edit the file again and reset the chunk size
to 15000 names and the delay to 10 milliseconds.
From now on, the cache will be initialized from the persistent cache and will
require much less time to process, so it is safe to lower these settings.
6. Repeat this process for every Telephony Application Server in the deployment,
except for failover servers.
Procedure
1. Configure the initial provisioning on the TAS, as explained in Initial
provisioning, in the Lotus Sametime Unified Telephony Administration
information center.
2. Now run the initial provisioning on that server.
3. Next, run the create_user_list.sh script to convert the provisioning output
file to a format that can be used for resolving user names with the Lotus
Sametime server:
/enterprise/ibm/tools/create_user_list.sh input_file.CSV output_file.TXT
where:
v input_file.CSV is the path and name of the CSV file that was generated when
you ran the initial provisioning.
v output_file.TXT is a name you assign to be used for storing the converted
names from the input file; this file will be stored in the current directory.
For example:
/enterprise/ibm/tools/create_user_list.sh /opt/IBM/tivoli/tdi/solutions/SUT/output/abc.csv users.txt
The output file generated by this script will look like this:
user10@hades.com
user11@hades.com
user12@hades.com
user13@hades.com
4. Start the Lotus Sametime server where you want to resolve users.
5. On the Telephony Application Server, run the init_resolve_cache.sh script to
activate the CachedResolveBatchMode application and resolve the user names
in the new file:
/enterprise/ibm/tools/init_resolve_cache.sh community_name external_users_file chunk_size chunk_delay_in_ms
where:
v community_name is the name of the Lotus Sametime community hosted on
the server that will resolve the user names.
v external_users_file is the full path and name of the output file generated in
step 3 above (called "users.text" in the example), which contains the names to
be resolved.
v chunk_size is the number of names to resolve in one pass.
v chunk_delay_in_ms is the amount of time (in milliseconds) to wait before
submitting another chunk of names to be resolved.
6. Start the Telephony Application Server and allow the persistent cache to be
initialized.
7. After the persistent cache is initialized, modify the Telephony Presence Adapter
and set the chunk size to 15,000 names and the delay to 10 milliseconds.
From now on, the cache will be initialized from the persistent cache and will
require much less time to process, so it is safe to lower these settings.
a. Open the /enterprise/ibm/user.presence.adapter.properties file for
editing.
b. Locate the following section in the file, and specify the chunk size (the
number of names to resolve in one pass) and the delay (in milliseconds) as
shown:
###############################
# Description - The time to wait between chunks of resolve requests.
# Value - time interval in milliseconds
# Default value - 1 minute
###############################
resolve.chunk.delay=10
c. Save and close the file.
8. Repeat this process for every Telephony Application Server in the deployment,
except for failover servers.
Whenever you install a server that communicates with a Lotus Sametime server,
you must add the new server's IP address to the Lotus Sametime server's
“Community Trusted IPs” list to ensure that the new server will be able to
establish a connection to the Lotus Sametime server.
The TAS will open a connection to each of the community's Lotus Sametime
servers for its ongoing operations. The Lotus Sametime servers are used for
publishing users' telephony status and receiving notifications about the users'
Lotus Sametime status changes. By providing access to all the Lotus Sametime
servers in the community, you enable the TAS to load-balance its Lotus Sametime
requests among all available community servers. This is the recommended practice.
In some cases you may not want a particular Lotus Sametime server to be used by
the TAS; for example if the Lotus Sametime services a large community or "high
priority" group of people.
Note: If your deployment includes Lotus Sametime servers that reside in different
geographical locations, you may prefer to add a TAS to the trust list of the nearest
Lotus Sametime servers and prevent the TAS from attempting connections to the
Lotus Sametime servers that are located farther away.
Complete the tasks below according to whether you want each Telephony
Application Server to connect to a particular Lotus Sametime server:
Print this table and fill it in for your deployment: for each Lotus Sametime
Community Server, list the IP addresses of all Telephony Application Servers that it
should trust.
Procedure
Print this table and fill it in for your deployment: for each Telephony Application
Server, list the fully qualified host names of all Lotus Sametime community servers
that the TAS should exclude from communications:
Procedure
1. Open the /enterprise/ibm/st.telephony.adapter.properties file for editing.
2. In the file, locate the servers.exclude.list key:
###############################
# Description - The list of servers which should not be connected
# Value - The list of server separated by ;
# Default value - null
###############################
#servers.exclude.list=TBD
3. Remove the comment marker (the # symbol), and remove the "TBD" (if
necessary); then type the list of fully qualified host names of the Lotus
Sametime servers that should be excluded from the current TAS.
For example:
servers.exclude.list=sales_st1.us.my_company.come;sales_st2.fr.my_company.com
4. Save and close the file.
5. Restart the Telephony Application Server.
A dial plan contains groups and rules that govern how calls are routed.
The Global Numbering Plan is often used for interbusiness group call routing and
is separate from Business Groups.
Within a business group, there can be multiple numbering plans. A Business Group
is needed for every dial plan, along with one Numbering Plan. The numbering
plan can either be a common numbering plan or a private numbering plan. When
the Numbering Plan is created, a feature profile can be created for all SUT users
which is added to the Numbering Plan.
The Supported Number Formats table can be used to represent the numbers
expected on SUT. It is not intended to be exhaustive, rather to highlight the most
interesting numbers, such as different formats for the SUT number, the softphone
number, and the desk phone numbers. Put the names of the Business Group and
Numbering plan above the Supported Number Formats table. Below the same
table are some of the key numbers for this system, such as the queue and
conference related numbers. The remaining tables have only a small subset of the
details needed, but gives an overview of components of the Dial Plan.
Procedure
1. Click Telephony Control Server > Global Translation and Routing > Directory
Numbers > Office Codes.
5. Click the button next to the Business Group field, select a business group from
the list, and click OK.
A Home DN is automatically created for each user during the import process;
during a typical deployment you would not need to create them manually. If you
find a need to create Home DNs yourself, follow the instructions in this topic.
Home DNs are used to indicate that the digit string is an SUT subscriber. It also
takes the appropriate SUT subscriber's office code which must exist already. The
dialed number is presented directly to the Home DN table. For each SUT
subscriber a Home DN must be configured with the fully qualified number. Home
DNs are created by first creating an office code and then creating a range of
extension numbers within that office code. The extension numbers here might be
scattered inside a range. Create the Home DNs starting from 1000 and ending at
1999. The combination of both results in the fully qualified number which is
known as a Home Directory Number (Home DN). There are two ways to choose
Home DNs:
v Define existing numbers as fully qualified directory numbers in TCS
v Create a set of numbers
In this case, number 4004 is not a Sametime Unified Telephony number even
though it is inside of the 4000 range targeted. Each Home DN must be created
individually. Later, when configuring the destination codes, determine if it is a
Home DN and route it accordingly.
Procedure
1. In the CMP, go to Telephony Control Server > Global Translation and
Routing > Directory Numbers > Office Codes.
When the Home DN numbers are created, they are displayed with a Vacant
destination type. Later, when SUT subscribers are created and assigned a number
from the list, the Home DNs change to End point, or in the case of the queue
number it changes to Service.
Private Numbering Plans are used for all special and Business Groups specific
dialing such as Service (features) Access Codes, Prefix Access Codes and Location
Dialing for Local, National, International and Extension Dialing.
A numbering plan is also used within a private numbering plan to identify the
locations, stations, and services:
v 9 or 0 = PNAC (Public/Private Network Access Code)
The numbering plan is used by the translation engine of the TCS to interpret
dialed digits and find an appropriate destination for a call. Dialed digits are
always interpreted in the context of the calling subscriber or originating endpoint.
v For an outgoing call from the TCS, the dialed digits are interpreted by the
numbering plan attributed to the subscriber that is calls or deflecting the call to
one of its associated devices or a dialed digit string.
v For an incoming call to a subscriber, the dialed digits are interpreted by the
numbering plan attributed to the gateway or SIP softswitch that sent the
incoming call to the TCS, where the end point is defined.
Default
The system provisioned a default during Business Group creation. The creation of
a business group includes the automatic creation of a default numbering plan. If
you need only one numbering plan in your business group, you have to do
nothing. If you want to use several numbering plans, you can define additional
numbering plans and one numbering plan can be set as a default numbering plan.
The default numbering plan cannot be deleted.
The private numbering plan is typically assigned to SUT subscribers, SIP gateways,
and softswitches. In the private numbering plan, local translation rules are stored.
All PNPs created by the administrator are called user defined. This PNP can be
deleted if there is no dependency on components of that NP edited to be the
default type. In this case the default becomes a user defined) or can be set as a
Common Numbering Plan. The PNP is a logical entity of subscribers/endpoints,
and the Dialing plan that govern their dialing pattern. The PNP exists in a private
network used by the private network subscribers belonging to a Business Group.
The Number Plan ID and Number Plan Name define all the related dialing objects
and tables. The valid ID range is “2 - 5999”. The default PNP ID = 1 (not used). A
PNP cannot be shared among different Business Groups. The system supports up
to 5999 PNPs.
One numbering plan per business group can be assigned as a Common numbering
plan. As the name suggests, translation rules common to the business group or
company are stored here. It is an optional, user-defined PNP which is assigned the
type “Common.” Its purpose is to reduce data entries and use the data tables in
many PNPs efficiently in one BG. All PNPs of a BG can access the CNP data table
of the same BG only. They cannot access the CNP of any other BG. The CNP can
access the Global NP the same way any other PNP can.
The public E.164 numbering plan has special status. It forms a global level and
holds the translation rules that allow business groups to communicate with each
other. This is the default system numbering plan. The components of the global
Be you have completed the task, “Creating office codes” on page 175.
When creating a business group, a default office code must be entered for that
business group. When configuring business groups, you create an office code, a
business group, and a numbering plan. Within the numbering plan, you create the
PAC table, destination codes, destinations, Multi-Line Hunt Group (MLHG), the
endpoint profile, and the endpoints.
Procedure
1. Log in to the Common Management Portal (CMP).
2. Open the web browser using the Telephony Application Server URL:
https://TAS IP/management/
3. Click Users & Resources > Resources > Telephony Control Server Resources
> Office Codes.
4. In the list of office codes, click the check box in front of an office code, and
then click the Edit button.
5. In the Edit Office Code dialog box, make sure that the Overlap, International,
and National fields contain a zero (0); then click Save.
International and outside line access display the digit that must be dialed to
reach a public exchange line for national or international dialing.
One numbering plan is created automatically when you create a business group. If
you want to use more than one numbering plans, you can define additional
numbering planes and set one numbering plan as a default numbering plan. You
can also create a common numbering plan if you have routing rules that are
common to all other numbering plans you have.
Procedure
1. To create a numbering plan, click TCS > Business Group > Available Business
Groups Then select your business group. Then click Private Numbering Plans
> Add.
2. In the CMP, go to Telephony Control Server > Business Group.
3. From the Available Business Groups, select the business group for which you
want to create the numbering plan.
4. Click Add to add your numbering plan for your business group.
5. On the next page, enter a name for the numbering plan.
Procedure
1. Log in to the Common Management Portal (CMP).
2. Open the web browser using the Telephony Application Server URL:
https://TAS IP/management/
3. Enter user name (administrator@system.com) and password.
4. Click Telephony Control Server > Business Group.
5. Select the business group for which you want to create a feature profile. Then
click BG Options, and then Feature Profiles. Click Add.
6. From the General tab, check Default. Click Save.
7. From the Add Feature Profile page, change all the following services required
for a Sametime Unified Telephony subscriber to Yes:
a. Called Name Delivery
b. Called Number Delivery
c. Caller ID
d. Calling Name Permanent Presentation Status
e. Calling Number Permanent Presentation Status
f. CSTA, type 1
g. Call Transfer
h. Music on Hold
i. One Number Service (ONS), InboundAndOutbound
Note: If you set Call Forwarding Dependable then you can see and change
Subscribers' Call Forwarding Dependable numbers (otherwise Call Forward
Dependable works but you cannnot see the details).
8. Click Save. The feature profile is generated.
Create a queue device to be used in a .csv file in later provisioning steps. Use the
following topics to configure the queue device.
Procedure
1. In the CMP, click Users & Resources > Users.
2. Select a user (administrator is fine for a newly installed system) or create a new
one.
4. On the next page, add a description and a phone number in GNF format for
the queue device. Then click Add. The queue device is created. There is no
need to assign the newly created device to the user.
The queue device is now available to be used in a .csv file for user provisioning.
The CSTA service must be activated. The unified number service might not be
activated for the queue device. The default feature profile cannot be used for this
profile-only subscriber. Creating a queue subscriber is just like other subscribers,
but must be marked as profile only.
The number you use does not necessarily need to be a public number. However, it
must be dialable from any SUT subscriber. Otherwise, you must create a queue
number for each numbering plan. A queue subscriber entry must be created using
the TCS assistant screens with the following steps:
Procedure
1. In the CMP, go to Telephony Control Server > Business Group.
2. From the available business groups, select the business group for which you
want to create the queue subscriber entry.
3. From Available Private Numbering Plans, select your numbering plan.
4. Then click Members > Subscribers > Add to add your queue subscriber entry.
This group is used for finding the next free line in a group. It is also used for
finding a free media server line for playing announcements and tones. The ring
tone is played from the media server. It might be replaced with other treatments
like customer announcements.
Procedure
1. In the CMP, click Telephony Control Server > Business Group.
2. Select the business group for which you want to create the multi-line hunt
group.
3. Click Teams > Hunt Groups. Click Add.
The dial plan is the definition of a set of rules within a numbering plan to route
calls according to user requirements. This dial plan has only one business group
and only one private numbering plan (PNP). There are a series of digit patterns
that need to be supported and routed. The digit patterns are one of the following:
v A Sametime Unified Telephony number — any number that matches the pattern
of a Sametime Unified Telephony user matches a list of defined numbers. Once
it matches the call is routed.
v An external number — this number could be a public number, or a private
number supported on some other PBX. Sametime Unified Telephony has at least
one endpoint which points to a PBX or a SIP Gateway. When there is only one
endpoint pointing to a PBX then the routing becomes simple. If it is not a
number pattern supported directly by Sametime Unified Telephony, then it
routes to that PBX.
A number starts off in the Prefix Access Code. Assuming that a match was found
and translation or tagging (setting the nature of address, for example) is applied, it
can be moved to another numbering plan. Typically, and in this example, it is
moved to the Destination Code. From the Destination Code, a match must be
found. That destination is typically only one of two kinds of destinations, a
The PAC table is where a number always starts its journey. If a number comes in
to a numbering plan, it must match a value in the PAC table or it is rejected. The
PAC table can be seen as a Number Normalization stage. Depending on the dial
plan design, it is desirable to normalize all numbers into the one format. A number
can arrive in one of many formats such as (but not limited to):
v International format
v National format
v Local format
v Private extension
v Extension prefixed with a department or steering code
The PAC entries are where these numbers can be translated and tagged. The PAC
table is where you can match specific patterns of numbers, add, or remove digits
from the number, tag it as being national or international number.
Destination codes
Destination codes are the server decides where the numbers go. It is where the
decision is made to send it to a subscriber, for example a Home DN, or to one of
many potential destinations, such as the IBM WebSphere Application Server SIP
Proxy, Conference Bridge, or the Customer PBX, or a PBX.
Destinations
A destination is the end of the line for a call. When a call gets to Destination, there
are no more decisions to make. For every endpoint, there must be a Destination.
However, this is not strictly always the case, especially with multiple numbering
plans.
Routes
Routes are the mechanism by which destinations are pointed to endpoints. Routes
can point to any endpoint in a system no matter what Numbering plan it is in. In
Lotus Sametime Unified Telephony, there is one route from a destination to an
endpoint. Many destinations can have a route pointing to the same endpoint. In
one example, there are two drastically different conference bridge numbers. They
each have a destination defined for them. But both of these destinations must point
to the one endpoint.
Endpoint
Creating endpoints
Create one or more endpoints in an IBM Lotus Sametime Unified Telephony
deployment.
Procedure
1. Click Telephony Control Server > Business Group.
2. Select the relevant Business Group from the Available Business Groups
dropdown menu.
3. Click Profiles > Endpoint Profiles > Add.
4. In the Add Endpoint Profile dialog box, type a descriptive name in the Name
field, and then click Save.
Procedure
1. Click Telephony Control Server > Business Group.
2. Select the relevant Business Group from the Available Business Groups list.
3. Click Members > Endpoints > Add.
This information can be found by contacting your PBX administrator. Enter the
signaling IP address, port number, authentication and protocol used under the SIP
tab of the endpoint definition.
Create an IBM WebSphere Application Server SIP proxy server endpoint that
defines the WebSphere Application Server SIP Proxy, which is used for softphone
calls in an IBM Lotus Sametime Unified Telephony deployment.
An endpoint is required for the WebSphere Application Server SIP Proxy in order
to support softphone calling. The following pieces of information are required:
v WebSphere Application Server SIP Proxy IP address
v WebSphere Application Server SIP Proxy port number
v Transport protocol used
Procedure
1. Now, create the endpoint for the WebSphere Application Server SIP Proxy. In
the General tab, provide a value for the name attribute. Select the Registered
check box. Select the “...” button beside the Profile attribute field. In the dialog
that opens, select the newly created endpoint profile.
2. Select OK. The General tab looks like the following screen capture:
f. Select Ok. The SIP tab looks like the following screen capture:
Note: An alias MUST be created for each endpoint, and each alias must be
unique. If the Media Server and WebSphere Application Server reside on the
same IP address, a unique alias must still be created for each. In this case,
name the alias the IP address followed by the port number. For example,
192.x.x.x_5060 for WebSphere Application Server, 192.x.x.x_5070 for Media
Server.
5. Click Ok to save the alias. Click Save to save the WebSphere Application
Server SIP Proxy endpoint. A dialog appears stating that the endpoint was
created successfully.
This task shows how to set the RTP Parameter Srx/Sip/ZeroIpOnHold to 0 and set
the CCM endpoint attribute Pre-Condition Signaling to 1.
Procedure
1. Open the command-line interface and log in as sysad.
2. At the Main Menu, select 1.
3. At the Configuration Management menu, select 1.
4. At the Configuration Parameters menu, select 3.
5. At the Modify Parameter prompt, enter Srx/Sip/ZeroIpOnHold.
6. At the line value max length <2047>:, enter 0 and then confirm your choice.
7. For the CCM endpoint, start at the Main Menu again, then select 6.
8. At the Application-level Management menu, select 5.
9. At the Zone Management (methods) menu, select 2.
10. Press the Enter key until the lineChange SIP endpoint attributes as bitmap
sums? (default: true): appears, and then enterfalse.
11. Press the Enter key until the line Pre-condition Signaling appears, and then
enter 1.
Example
Login: sysad
Main Menu:
Configuration Management.........................1
Fault Management......................................2
Performance Management..........................3
Security Management..................................4
System Management...................................5
Application-level Management.....................6
Open Logfile...............................................94
Show Callback Output................................95
Wait for Callbacks......................................96
Change Password......................................97
Expert Mode...............................................98
Exit.............................................................99
Selection: 1
Configuration Management:
Configuration Parameters............................1
Logging........................................................2
Return........................................................99
browseParameterNames............................1
getParameterInfo........................................2
modifyParameter........................................3
createParameter.........................................4
deleteParameter.........................................5
loadConfigVersion......................................6
removeConfigVersion.................................7
getAllSavedConfigVersions........................8
saveCurrentConfigVersion.........................9
Return......................................................99
Selection: 3
modifyParameter:
name : Srx/Sip/ZeroIpOnHold
invariant settings:
name : Srx/Sip/ZeroIpOnHold
type : PARM_INT
usage : PARM_USAGE_CUSTOMER
lastUpdateMillis : 10.Sep.2009 11:37:28h (000 msec)
changeId : 0
descriptionString:
Ok.
Here is the example session that shows how to set the CCM endpoint attribute
PreCondition Signaling to 1
Main Menu:
Configuration Management...........................1
Fault Management........................................2
Performance Management...........................3
Security Management...................................4
System Management....................................5
Application-level Management......................6
Open Logfile................................................94
Show Callback Output.................................95
Wait for Callbacks.......................................96
Change Password.......................................97
Expert Mode................................................98
Exit..............................................................99
Selection: 6
Application-level Management:
Softswitch Management.....................................1
Signaling Management......................................2
Media Gateway Management............................3
Selection: 5
Create Endpoint...............................................1
Modify Endpoint...............................................2
Remove Endpoint............................................3
Display Endpoint..............................................4
Create Alias.....................................................5
Remove Alias..................................................6
Display Alias....................................................7
Create Zone (Gatekeeper)..............................8
Modify Zone....................................................9
Remove Zone...............................................10
Display Zone.................................................11
Display Endpoint Profile................................12
Static SIP endpoint FQDNs Lookup..............13
Display SIP Endpoint Contact.......................14
Display SIP Endpoint Statistics.....................15
Return...........................................................99
Selection: 2
Procedure
1. Log in to the Common Management Portal (CMP).
2. Open the web browser using the Telephony Application Server URL:
https://TAS IP/management/
3. Enter user name (administrator@system.com) and password.
4. Go to Telephony Control Server > Business Group.
5. Select the business group for which you want to create the Prefix Access Codes
(PAC) table. Select the Available Private Numbering Plan. Select Prefix Access
Codes. Click Add.
6. From the General tab, enter the prefix code parameters for the business group.
Refer to your numbering plan.
7. The following parameters are an example only:
a. Prefix Access code: 0
b. Minimum Length: 3
c. Maximum Length: 24
d. Digit Position: 1
e. Digits to Insert: 4989
f. Prefix Type: Off-net Access
g. Nature of Address: International
h. Destination Type: None
8. Click Save.
9. Continue to add access codes from your numbering plan table. As you Save
each addition, the access codes are listed in the Prefix Access Code menu.
Procedure
1. Log in to the Common Management Portal (CMP).
2. Open the web browser using the Telephony Application Server URL:
https://TAS IP/management/
3. Enter user name (administrator@system.com) and password.
4. Go to Telephony Control Server > Business Group.
5. Select the business group for which you want to create the Destination table.
Select the Available Private Numbering Plan > Translation > Destination
Codes. Click Add.
6. From the General tab, enter a PAC table name or click the ellipsis next to
Destination Code: and choose it from a list. Click OK.
7. The following parameters are an example only:
a. Destination Code: 498961506
b. Nature of Address: International
c. Routing Area: RA_TAS1
d. Destination Type: Home DN
Creating destinations
A destination is used to define an off-network trunk. Routes are created within the
destination to handle the signaling traffic for this destination.
Be sure to create the destination within the correct numbering plan. To create a
destination, follow these steps:
Procedure
1. Click Telephony Control Server > Business Group . Select the relevant
Business Group from the Available Business Groups dropdown menu. Select
the relevant Numbering Plan from Available Private Numbering Plan
dropdown menu.
2. Click Destinations and Routes > Destination > Add.
3. In the destination dialog, provide a value for the Name attribute.
4. Select Save.
5. A dialog appears stating the destination was successfully created.
Make sure that a Destination has been created. Also, ensure that an endpoint has
been created. See the previous topic for information.
Procedure
1. Click Telephony Control Server > Business Group.
a. Select the relevant Business Group from the Available Business Groups
dropdown menu.
b. Select the relevant Numbering Plan from the Available Private Numbering
Plan dropdown menu.
2. Click Destinations and Routes > Destinations. Select the recently created
destination In the destination dialog. Then select the Routes tab, then click
Add.
3. In the Routes tab, values must be provided for the following attributes. Provide
a numeric value for the ID attribute. ID numbers must be used in ascending
order, with the highest priority route receiving the lowest ID number Select the
“...” button beside the 'SIP Endpoint' attribute field. On the dialog that opens,
select the relevant numbering plan, in this instance, NP_BG_TAS02.
Procedure
1. Log in to the Common Management Portal (CMP):
For example, 1. “Sametime Computer Phone -> Sametime Desk Phone” means “a
telephone call from Sametime client where Sametime Computer Phone is selected
as preferred device to Sametime client where a desk phone number is selected as
preferred device. 2. “Sametime Computer Phone -> Mobile Phone” means a
telephone call from Sametime client where Sametime Computer Phone is selected
as preferred device to a mobile phone number.
Configuring conferencing
Configure IBM Lotus Sametime Unified Telephony to support user phone
conferences.
Make sure both basic computer calls and desk phones work correctly. If basic calls
work, then the intercepts also work.
Conferencing terminology
Before you set up conferencing capabilities, you must establish two conferencing
numbers, which will be covered in topics which follow.
v Conference Bridge Number — a publicly accessible number, used for Click to
Conference calls
v Local Park Slot Number — a private number, used for drag and drop
conferencing
Then, there are five actions that must be taken to enable these conferencing calls:
Procedure
1. To create a connection to the Media Server for Conferencing, go to: Operation
& Maintenance > Configuration & Monitoring > Telephony Control Server
Configuration > Media Server Connections > Add.
2. In the following screen, select TAS Node – Small Deployment. Click Add to
add the connection.
4. The new connection name appears under Cluster Connections. Click Save to
finish.
Procedure
1. Open the node window by clicking the entry in List of Nodes.
2. Go to the Address Binding tab. Set the conference number and the Local Park
Slot number. Click the number for the terminal. A window opens where the
correct, fully qualified GNF number, which includes +, can be set.
4. Click Save. The node administration page appears. Click the Providers tab and
select the IP Telephony (SIP) link.
5. Configure the settings that the Media Server Conferencing feature requires to
send SIP invites to TCS. Set Hostname/IP address to the SIP Signaling manager
IP of TCS: sipsm1_vip in the node.cfg file. Set the Port number to 5060. Set the
Transport Protocol to User Datagram Protocol (UDP). Click Save.
The numbering plan, where the media server conferencing end point is defined,
must support the dialing of any numbers supported on the system. The conference
bridge may need to dial all kinds of numbers, both public and private. Dial
restrictions must also be carefully considered. If the dial plan consists of multiple
numbering plans it must be configured to support conferencing numbers from all
numbering plans.
This SIP endpoint must be provisioned for the correct transport type and the
domain name or IP address which it uses as a contact in outbound requests to the
TCS must be added as an alias. The Media Server endpoint used for SIP
conferencing is normally created in the common numbering plan (CNP) of the
business group. Use only fully qualified numbers, for example, GNF numbers for
public E.164 numbers and fully qualified private numbers for private network
numbers. There are two basic steps covered in this section:
v Creating the endpoint profile required for any end point
Chapter 3. Configuring 217
v Creating the end point
Procedure
1. Go to Telephony Control Server > Business Group. Choose the suitable
business group. Then click Numbering Plan. Choose the suitable numbering
plan. Then go to Endpoint Management > Endpoint Profiles > Add.
2. To create the endpoint profile, from the CMP, first create an endpoint profile
named EPP_CONF_IRL. Select the Routing Area created in the Configuring
Announcements from a list by clicking the ellipsis.
8. Skip the Attributes tab. Click the SIP tab. Enter the IP address of the TAS.
Then enter the port for the Media Server SIP. The default is 5070. Encrypted
servers use 5071. In this single NIC configuration, the WebSphere Application
Server SIP Proxy and Media Server SIP connection use the same network
adapter. If the Transport Protocol is UDP or TCP, the default Signaling
Binding port value is 5070. If the Transport Protocol is TLS or MTLS, the
default Signaling Binding port value is 5071.
Procedure
1. Go to Telephony Control Server > Business Group. Choose the suitable
business group. Then click Numbering Plan. Choose the suitable numbering
plan. Then go to Destinations and Routes > Destinations > Add.
3. To point the newly created destination to the conference bridge end point, open
the destination and go to the Route Tab. Click Add. The route tab only
becomes available when the destination has been saved. When initially creating
the destination, it needs to be saved and then opened again.
5. After choosing the numbering plan a list of endpoints is displayed. Select the
conferencing end point. Click Save.
Procedure
1. Go to Telephony Control Server > Business Group. Then select a Business
Group.
2. Then go to Available Private Numbering Plan. Select a Numbering Plan. Then
go to Translation > Destination Codes > Add.
Follow these steps to define the following features in the "Users & Resources"
section of CMP:
v SIP Domain
v Office code that the conference bridge and local park slot use
v Conference Codes
Procedure
1. To define the SIP Domain, go to User & Resources > Resources > Media
Server Resources > SIP Domains.
2. Click Add. The SipDomain ID can be any numeric value, as long as it is unique
within the system. There is typically only one SIP Domain. The Sip Domain is
the IP address which appears in the SIP headers from the Media Server. It must
be set to the IP address used by the Media Server Conference bridge. Click
Save.
Note: A park slot is a phone number that is reserved for storing, or "parking"
calls that are put on hold. A dedicated park slot can be accessed by all other
phones in the system so that any user can pick up the call that is on hold.
Although the conferencing number is set during the installation of the TAS, if it is
incorrect, it can be difficult to diagnose. Verify that the number is set correctly
before continuing the configuration by following these steps.
Procedure
1. In the Configuring and Monitoring section of the CMP, click the Root Cluster
on the left side of the screen. Click TAS Node — Small Deployment.
2. Find Conferencing Service by sorting the results by names. Click Conferencing
Service.
Send User Format in Telephone Subscriber Format must be set on the Media
Server Endpoint to force the TCS to send GNF numbers to it. It adds a + in front
of every international number sent to the Media Server. The administrator must
ensure that all numbers sent to the Media Server are in International format.
Ignore Incoming OTG must be set to force the TCS to ignore the Answer flag
setting on MLHG announcements for it. Accepting Billing Number must be set on
the Media Server Endpoint to force the TCS to use a 2-> n conference originator's
numbering plan and toll restriction services for the calls to the added parties.
Procedure
1. Start a secure remote shell to the TCS node using PuTTy. Or, log in to the TCS
node with the srx user account.
Example
Start a secure remote shell to the TCS node (for example, using PuTTy) or log in to
the TCS node with the srx user account. In the following example, user input is
shown as highlighted text.
dubtcs02node1:/unisphere/srx3000/srx (101> startCli
Login: sysad
Main Menu:
Configuration Management.......................1
Fault Management...............................2
Performance Management.........................3
Security Management............................4
System Management..............................5
Application-level Management...................6
Open Logfile............................94
Show Callback Output....................95
Wait for Callbacks......................96
Change Password.........................97
Expert Mode.............................98
Exit....................................99
Application-level Management:
Softswitch Management..........................1
Signaling Management...........................2
Media Gateway Management.......................3
Rate Area and Class of Service.................4
Zone Management................................5
Translation/Routing Management.................6
Feature Management.............................7
Network Element Security Management............8
Network Traffic Management.....................9
Service Broker Management.....................10
PCL Management................................11
Return..................................99
Selection: 5
Create Endpoint................................1
Modify Endpoint................................2
Remove Endpoint................................3
Display Endpoint...............................4
Create Alias...................................5
Remove Alias...................................6
Display Alias..................................7
Create Zone (Gatekeeper).......................8
Modify Zone....................................9
Remove Zone...................................10
Display Zone..................................11
Display Endpoint Profile......................12
Static SIP endpoint FQDNs Lookup..............13
Display SIP Endpoint Contact..................14
Display SIP Endpoint Statistics...............15
Return..................................99
Selection: 2
Application-level Management:
Softswitch Management..........................1
Signaling Management...........................2
Media Gateway Management.......................3
Rate Area and Class of Service.................4
Zone Management................................5
Translation/Routing Management.................6
Feature Management.............................7
Network Element Security Management............8
Network Traffic Management.....................9
Service Broker Management.....................10
PCL Management................................11
Return..................................99
Main Menu:
Configuration Management.......................1
Fault Management...............................2
Performance Management.........................3
Security Management............................4
System Management..............................5
Application-level Management...................6
Open Logfile............................94
Show Callback Output....................95
Wait for Callbacks......................96
Change Password.........................97
Expert Mode.............................98
Exit....................................99
Selection (default: 6): 99
dubtcs02node1:/unisphere/srx3000/srx (101>
Print this topic so you can record test results and comments in the provided tables.
All tests must pass if Lotus Sametime Unified Telephony is properly configured. A
test passes when audio is heard in both directions by all participants in a
conference.
In the tables below, the term "Sametime preferred device" indicates that a user is
using the Lotus Sametime client to make or accept conference calls (in these test,
the Sametime preferred device is set to either "Computer" or "Desk phone"). When
the term "Sametime preferred device" is not used (for example, in a test using
"Mobile phone" as the device), the user is using an external device with a
non-Sametime Unified Telephony number.
Procedure
1. Test the Click-to-Conference feature. For each test, set each user's preferred
device as shown, and then have User 1 complete the following actions to
conference with User 2 and User 3:
v Select User 2 and User 3.
v Call selected users.
Table 1. Click-to-Conference test settings
2. Test the Drag-and-Drop Conference feature. For each test, set each user's
preferred device as shown, and then have User 1 complete the following
actions to conference with User 2 and User 3:
v Select User 2 and call.
v Click Actions > Invite Others
v Select User 3.
Table 2. Drag-and-Drop Conference test settings
Sametime preferred
device Pass? Comments
Test 1 v User 1: Computer
v User 2: Computer
v User 3: Computer
Test 2 v User 1: Computer
v User 2: Desk
phone
v User 3: Desk
phone
Test 3 v User 1: Computer
v User 2: Mobile
phone
v User 3: Mobile
phone
3. Test the conference call controls and audio streams. For each test, complete the
specified actions and note the results:
Configuring security
This section describes how to enable security using TLS encruption in an IBM
Lotus Sametime Unified Telephony deployment.
Enabling TLS encryption involves extracting the SSL certificate from the
deployment's SIP Proxy/Registrar, importing it to all Telephony Control Servers
and Telephony Application Servers, modifying security settings, and then restarting
all servers.
Procedure
1. On the SIP Proxy/Registrar server, log in to the Integrated Solutions Console as
the WebSphere administrator.
Procedure
1. Store a copy of the certificate file in the following location:
${TAS_ROOT}/ibm/certs.
2. Execute the following commands:
chown sym:sym .cer
chmod 644 .cer
3. Edit the ${TAS_ROOT}/ibm/sutbcomadapter.properties file as follows:
a. Add the following “SIPProxyCert” entry:
SIPProxyCert=${TAS_ROOT}/ibm/certs/mycert.cer
Procedure
1. Store a copy of the certificate file in the following location:
/usr/local/ssl/certs.
2. Rename the file to use the extension .pem; the file name is now
/usr/local/ssl/certs/mycert.pem
3. Create a symlink to the .pem file and add the contents of the file to root.pem
as follows:
cd /usr/local/ssl/certs ln -s mycert.pem "`openssl x509 -noout -hash -in mycert.pem`.0" cat mycert.pem >> root.pem
4. Log in the CMP.
244 Lotus Sametime Unified Telephony: Installation Guide
5. Open the endpoint you created for WebSphere Application Server.
6. Create a new endpoint for the same WebSphere Application Server, with
following details:
a. On the SIP tab, change the transport to MTLS and change port to 5061.
b. On the Attributes tab, click the Use Server Virtual Address option.
7. Open the “Destination” you have created for routing to the old WebSphere
Application Server endpoint, and make the following changes:
a. On the Routes tab of the Destination, delete the old route.
b. Add a new route pointing to the new WebSphere endpoint.
8. Repeat steps 1 through 9 for each Telephony Control Server in the
deployment.
9. Active TCS only: Run the following command to determine the server's IP
address and port:
grep "sipsm3_vip:" /opt/unisphere/srx3000/ifw/tmp/reloc/etc/hiq8000/node.cfg
Notice that this is not your regular SIP signaling IP address.
10. Write down the IP address and port number for use in the next task.
Procedure
1. Open the ${WEBSPHERE_PATH}/sutConfig/proxy.xml file.
2. Locate the forceRouting setting.
The setting looks like this:
forceRouting="sip:9.51.253.160:5061;transport=tls"
3. Verify that the setting uses the IP address and port that you obtained from the
active Telephony Control Server in the previous task.
The IP address and port appear in bold in this example:
forceRouting="sip:9.51.253.160:5061;transport=tls"
Restarting servers
After enabling TLS encryption in an IBM Lotus Sametime Unified Telephony
deployment, restart the affected servers.
Procedure
1. On the SIP Proxy/Registrar server, restart IBM WebSphere Application Server
as follows:
${WEBSPHERE_PATH}/AppServer/profiles/AppSrv01/bin/stopServer.sh server1 -username WAS_Admin_user -password WAS_Admin_password
${WEBSPHERE_PATH}/AppServer/profiles/AppSrv01/bin/startServer.sh server1
2. Stop the Telephony Application Server with the following command:
Remember, you only need to stop the Telephony Application Server that you
just upgraded, you do not need to stop all nodes.
/etc/init.d/symphoniad stop
3. Restart each Telephony Control Server with the following commands:
/unisphere/srx3000/srx/startup/srxctrl 3 4
/unisphere/srx3000/srx/startup/srxctrl 4 3
/unisphere/srx3000/srx/startup/srxctrl 4 4
If your deployment includes more than one Telephony Control Server,
remember to restart each node.
4. Start the stopped Telephony Application Server with the following command:
/etc/init.d/symphoniad start
Procedure
1. On the SIP Proxy/Registrar server, log in to the Integrated Solutions Console as
the WebSphere administrator.
2. Click SIP Proxy and Registrar > SIP Registration
3. In the list of SIP registrations, verify the Device Address column displays:
transport=tls for each SIP registration.
If your certificate uses more than one OU component, they may be read in the
wrong order, which prevents TLS encryption from working properly. Correct the
problem as follows.
For more information about this issue, see the IBM document PK89438.
Procedure
1. Create a new root certificate:
a. On the SIP Proxy/Registrar server, log in to the Integrated Solutions
Console as the WebSphere administrator.
b. Click Security > SSL certificate and key management > Key stores and
Certificates.
c. In the "Keystore usages" list, click Root certificate keystore.
d. Click on the DmgrDefaultRootStore or the NodeDefaultRootStore
depending on what type of server you have installed.
e. Click Personal Certificates > Create > Self-signed Certificate.
2. Replace the old root certificate with the new one:
a. In the root certificate keystore list, select the old root certificate and then
click Replace.
b. On the Replace panel, select the new certificate's alias from "Replace with"
list.
c. Click Delete old certificate after replacement.
d. Click Delete old signers.
3. Now update each of the chained certificates in the configuration:
a. In the list of personal certificates, select a certificate to replace.
b. Click Renew.
Procedure
1. To begin configuring the SIP security, log in to the Integrated Solutions Console
as the WebSphere administrator.
2. Click Security > Global security.
3. Select Enable application security check box.
4. Click Apply.
5. Save your changes by clicking the Save link in the Messages box at the top of
the page.
Procedure
1. Log in to the Integrated Solutions Console as the WebSphere administrator.
2. Click Security > Global security.
3. Click the Configure button.
4. Under Related Items, click Manage repositories, and then click the Add
button.
5. Configure the LDAP server settings for the repository, and then click OK.
6. Save your changes by clicking the Save link in the "Messages" box at the top
of the page.
7. Return to Security > Global security page.
8. Click the Configure button, and then click the Add Base entry to Realm
button.
9. In the Repository list, select the newly defined LDAP repository.
10. In the Distinguished name that uniquely identifies this set of entries in the
realm field, type the distinguished name that uniquely identifies this set of
entries within the realm.
11. In the Distinguished name of a base entry in this repository field, type the
distinguished name of the base entry within the repository from which
searches start in the directory tree; then click OK.
12. Save your changes by clicking the Save link in the "Messages" box at the top
of the page.
All SIP INVITE requests that travel through the SIP Proxy are generated by the
Telephony Control Server's B2BUA host. To ensure IBM WebSphere Application
Server can approve the requests, add, the B2BUA host name to the SIP
Proxy/Registrar server's trusted IP list.
Procedure
1. Log in to the Integrated Solutions Console as the WebSphere administrator.
2. Click Servers > WebSphere application servers
Procedure
1. Set the STIForceStrictClientAuthentication. If the telephone number is not
defined at the Sametime repository set
STIForceStrictClientAuthentication=false. If the telephone number defined at
the Sametime repository set STIForceStrictClientAuthentication=true. True is
the default.
2. Set the STIClientAuthorizationInGNF. It is required only if the above
parameter is set to true. If the Telephony number is stored at the repository
with + in front, then set STIClientAuthorizationInGNF=true (send number
with +), otherwise set to false (send number without +).
Procedure
1. Open the WAS_install_root/AppServer/sutConfig/authorization.properties
file for editing.
2. In the file, locate the telephonyPrefix=value setting.
3. Enter the correct telephonyPrefix value.
You can determine the correct value as follows:
a. Look up the GNFPrefixReplacement value in the BComAdapter.
b. Look up the SoftphonePrefix, which takes the format +value.
c. The telephonyPrefix is the SoftphonePrefix with the GNFPrefixReplacement
instead of a +.
If the telephone numbers defined in the LDAP repository are identical to the
telephone numbers provisioned for each user at the Telephony Application Server,
define a login property for authenticating users in an IBM Lotus Sametime Unified
Telephony deployment.
This step is required only if the telephone number defined in the Sametime
repository is identical to the telephone number provisioned for that user at the
Telephony Application Server.
Procedure
1. Log in to the Integrated Solutions Console as the WebSphere administrator
2. Click Security > Global security.
3. Click the Configure button, and then click the name of the repository.
4. Edit Login properties to include both the telephone number and the user
identification.
The telephone number attribute must appear before the user identification. For
example, if the user identification attribute is "uid", type the attribute as:
telephoneNumber;uid.
5. Click OK.
6. Save your changes by clicking the Save link in the "Messages" box at the top of
the page.
7. Restart the WebSphere Application Server so the change can take effect.
You can create a certificate for the PBX through a trusted certificate authority.
Localizing announcements
SUT is designed to be deployed to serve several languages and cultural areas at
once. Follow these steps to test whether users hear familiar announcements.
The system must be configured so that basic calls and conference calls work
correctly and as expected. It is done during provisioning. These languages are set
up in the section Configuring the Media Server Languages.
This topic shows you how to localize a user and a subscriber for testing purposes.
There are a number of areas that can be localized.
v Localizing the user
v Localizing the subscriber
v Localizing the conference bridge
This example shows how to support two languages, English and Spanish. In
general, you must:
1. Configure the Media Server to support both the languages we require.
2. Configure the Conference bridge on the MS to also support both languages
(and optionally operate on local numbers for each country)
3. Configure the users to a specific language.
4. Configure the subscriber belonging to the user to the same language.
2. In the Languages window, the default language is set to English. Unless the
dial plan is configured to use another language, English is used. Change the
Language Mode attribute from Single to Multiple before provisioning users on
to the system.
3. To add the new languages that are not in the list, click the Add button. Click
the check boxes of the languages which you want to be available for the users
who are provisioned on the system. Click Save.
When an SUT user starts or joins a conference, announcements must in the local
language. However, the Conferencing Bridge is a number which can be dialed
publicly. There are two aspects to configuring the languages on the Media Server
conference bridge:
v setting the default language to be played when no language data is available.
v adding any additional languages which must be supported.
Procedure
1. Go to the Media Servers Node administration panel. Click the Conference
Bridge number.
Language Value
German de_de
English (Great Britain) en_gb
English (United States) en_us
Spanish es_es
French fr_fr
Italian it_it
Japanese ja_ja
Korean ko_ko
Portuguese (Brazilian) pt_br
Simplified Chinese zh_cn
3. Then, ensure that the language code is the first in the list of language codes to
appear in the Conference Service properties page.
6. The Terminal ID always begins with conferencing and ends with the start of
the language code. Click the ellipsis button, to see a list of the prepared
languages on the system. Entering application:/Terminal_ID is sufficient; for
example: application:/Conferencing#welcome_es. Substitute es with the start
of the language code being added.
Note: The Terminal ID has a ‘-' character before the language code, but the
Application has a ‘_' character.
8. In the Terminal ID field, select the Application entry created in the Terminal
tab in the previous step from the drop down menu. In the Expression field,
follow the convention of the previously created localized expressions, for
example, 997 and 998. Leave the rest of the fields in this section of the page
unchanged.
10. To test the configuration, dial the conference bridge from an SUT client where
the user was set to the newly configured language.
The call detail records can be entered into a customer's billing solution.
Note: For calls going directly to and from the PBX device, like when the user's
unpublished PBX number is called or when the user picks up the phone to make
an outgoing call, no CDR records are created in the Telephony Control Server
because the call never went through the Telephony Control Server. If needed,
custom system integrator work can provide unified CDR records for the Telephony
Control Server and the PBXs in the network.
Setting up 911
Due to regulatory requirements, enhanced 911 (E911) calls are required to allow
emergency services to accurately define the location of the caller.
After the Sametime Unified Telephony installation, the same level of functionality
must be available to the customer for dialing emergency calls as was available
before the installation. There are several scenarios to consider.
v User dials 911 from original PBX phone - The PBX may not reconfigure the
routing rules that it currently has regarding 911/E911. The LIN numbers that are
presented to the Public Safety Answering Point (PSAP) for callback and location
identification purposes must NOT be reconfigured towards the Telephony
Control Server. Because the unified number subscribers are virtual subscribers,
the Telephony Control Server does not hold any location information about a
Chapter 3. Configuring 261
subscriber. As a consequence, the Telephony Control Server cannot provide LINs
or even select the optimal PSAP for the 911/E911 call.
v User dials 911 from an associated device - The provider associated with that
device would be responsible for the emergency call and the Telephony Control
Serve would not be involved in the call.
v User dials 911 from the softclient - The 911 call should be directed to the SIP
server with which the soft client (such as Sametime Connect client) is registered.
The call should not be routed through the Telephony Application Server and the
Telephony Control Server because the SIP server has knowledge about the
location information of the client.
Note: CALEA support for conference calls is not supported in this release.
CALEA Interfaces for the ANSI market - In the ANSI market, the monitoring
process is initiated by a warrant. CALEA is then configured for the party that is to
be monitored. The wiretaps are configured on a suspect through the Unified
Number Assistant. There is a special CALEA administrator role that is made
available to the LEA, so they can view the LEA screens on the Unified Number
Assistant and configure wiretaps. When the subscriber calls or receives a call, the
LEA is notified by a CII message containing the A and B parties being sent across
the Call Data Channel to the LEA. At the same time, the media server is signaled
to conference the A and B party together with the LEA through the PSTN gateway.
A device at the LEA automatically accepts the call and begins recording the Call
Content
CALEA support for the ETSI market - In the ETSI market, the process is initiated
by an electronically transmitted warrant that is sent to the Lawful Interception
Operation System (LIOS). A wire tap is then configured on the specified subscriber
on the Telephony Control Server. When the subscriber calls or receives a call, the
LEA is notified by a call record of the A and B parties being sent to the LEA. At
the same time, the media server is signaled to conference the A and B party
together with the LEA through the PSTN gateway. A device at the LEA
automatically accepts the call and begins recording. As the speech path is set up to
the LEA, call correlation data is also signaled through the SIP interface to the SIP
gateway to correlate the call to the call record that was passed in parallel. The
PSTN gateway has to unpack this call correlation data from the SIP message and
transmits it in the corresponding TDM call setup fields. The LEA can then correlate
A typical PBX system provides the following access options for voice mail:
v Direct access - You can dial your own mailbox. Dial the service access number
for direct access and log on to the server by entering your telephone number (or
name) and password. You now have access to all messages stored in your
mailbox and to your mailbox settings. You can record messages for other users
and then send these messages.
v Guest access - You can dial an external mailbox. Dial the service access number
for guest access and dial the extension number of the required user. You can
leave a message in the user's mailbox or be transferred to a referral extension.
But, it depends on how the user has set the answering options
v Universal access - You can dial an external mailbox and access your own
mailbox. This is the same as guest access with the additional option of being
able to access your own mailbox.
v Forward access - You can redirect callers who dial your extension to your
mailbox Calls received at your extension are then forwarded to your mailbox.
Callers can leave a message for you in your mailbox and use the mailbox as an
answering machine.
v Transfer access - You can transfer callers to your mailbox. If you want to give
the caller the option of leaving a message for someone else or if the caller is
unable to enter a user's extension number or if this extension number is to
remain hidden from the caller, you can connect the caller directly to the mailbox
by dialing the transfer access number. This option is of particular interest if you
are responsible for switching calls. This feature is typically used by an
operator/attendant.
v Callback access - You can access your mailbox using the mailbox key on the
telephone if your mailbox contains new messages. This access mode skips asking
the user to enter the number/name and instead just prompts for the password.
v Out call access - A call from your mailbox automatically informs you when new
messages appear in your mailbox.
You configure multiple voice mail systems through the Common Management
Portal. These numbers can be assigned to users such that when the user's rules or
preferences forward an incoming call to voice mail, the specified voice mail system
is reached. When configuring a voice mail system through the CMP, the
administrator should provide a Forward Access number.
The administrator can then configure a voice mail target (only one) for each user
by assigning one of the configured voice mail systems to the user through the
CMP.
IBM may not offer the products, services, or features discussed in this document in
other countries. Consult your local IBM representative for information on the
products and services currently available in your area. Any reference to an IBM
product, program, or service is not intended to state or imply that only that IBM
product, program, or service may be used. Any functionally equivalent product,
program, or service that does not infringe any IBM intellectual property right may
be used instead. However, it is the user's responsibility to evaluate and verify the
operation of any non-IBM product, program, or service.
IBM may have patents or pending patent applications covering subject matter
described in this document. The furnishing of this document does not grant you
any license to these patents. You can send license inquiries, in writing, to:
For license inquiries regarding double-byte (DBCS) information, contact the IBM
Intellectual Property Department in your country or send inquiries, in writing, to:
The following paragraph does not apply to the United Kingdom or any other
country where such provisions are inconsistent with local law:
INTERNATIONAL BUSINESS MACHINES CORPORATION PROVIDES THIS
PUBLICATION “AS IS” WITHOUT WARRANTY OF ANY KIND, EITHER
EXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS
FOR A PARTICULAR PURPOSE. Some states do not allow disclaimer of express or
implied warranties in certain transactions, therefore, this statement may not apply
to you.
Any references in this information to non-IBM Web sites are provided for
convenience only and do not in any manner serve as an endorsement of those Web
sites. The materials at those Web sites are not part of the materials for this IBM
product and use of those Web sites is at your own risk.
Licensees of this program who wish to have information about it for the purpose
of enabling: (i) the exchange of information between independently created
programs and other programs (including this one) and (ii) the mutual use of the
information which has been exchanged, should contact:
IBM Corporation
5 Technology Park Drive
Westford Technology Park
Westford, MA 01886.
The licensed program described in this information and all licensed material
available for it are provided by IBM under terms of the IBM Customer Agreement,
IBM International Program License Agreement, or any equivalent agreement
between us.
All statements regarding IBM's future direction or intent are subject to change or
withdrawal without notice, and represent goals and objectives only.
All IBM prices shown are IBM's suggested retail prices, are current and are subject
to change without notice. Dealer prices may vary.
This information is for planning purposes only. The information herein is subject to
change before the products described become available.
This information contains examples of data and reports used in daily business
operations. To illustrate them as completely as possible, the examples include the
names of individuals, companies, brands, and products. All of these names are
fictitious and any similarity to the names and addresses used by an actual business
enterprise is entirely coincidental.
COPYRIGHT LICENSE:
Each copy or any portion of these sample programs or any derivative work, must
include a copyright notice as follows:
© (your company name) (year). Portions of this code are derived from IBM Corp.
Sample Programs. © Copyright IBM Corp. _enter the year or years_. All rights
reserved.
If you are viewing this information softcopy, the photographs and color
illustrations may not appear.
Trademarks
These terms are trademarks of International Business Machines Corporation in the
United States, other countries, or both:
IBM
AIX
DB2
DB2 Universal Database Domino
Domino
Domino Designer
Domino Directory
i5/OS
Lotus
Lotus Notes
Notes
OS/400
Sametime
WebSphere
AOL is a registered trademark of AOL LLC in the United States, other countries, or
both.
AOL Instant Messenger is a trademark of AOL LLC in the United States, other
countries, or both.
Google Talk is a trademark of Google, Inc, in the United States, other countries, or
both.
Java and all Java-based trademarks and logos are trademarks or registered
trademarks of Oracle and/or its affiliates.
Notices 267
Microsoft, and Windows are registered trademarks of Microsoft Corporation in the
United States, other countries, or both.
Printed in USA