Avaya Multivantage

Avaya MultiVantage Application Enablement Services
Installation Guide Software-Only Offer R3.1.2
02-300355 Issue 2.3 September 2006
2006 Avaya Inc. All Rights Reserved Notice While reasonable efforts were made to ensure that the information in this document was complete and accurate at the time of printing, Avaya Inc. can assume no liability for any errors. Changes and corrections to the information in this document may be incorporated in future releases. For full support information, please see the complete document, Avaya Support Notices for Software Documentation, document number 03-600758. To locate this document on our Web site, simply go to http:// www.avaya.com/support and search for the document number in the search box. Documentation disclaimer Avaya Inc. is not responsible for any modifications, additions, or deletions to the original published version of this documentation unless such modifications, additions, or deletions were performed by Avaya. Customer and/or End User agree to indemnify and hold harmless Avaya, Avaya's agents, servants and employees against all claims, lawsuits, demands and judgments arising out of, or in connection with, subsequent modifications, additions or deletions to this documentation to the extent made by the Customer or End User. Link disclaimer Avaya Inc. is not responsible for the contents or reliability of any linked Web sites referenced elsewhere within this documentation, and Avaya does not necessarily endorse the products, services, or information described or offered within them. We cannot guarantee that these links will work all of the time and we have no control over the availability of the linked pages. Warranty Avaya Inc. provides a limited warranty on this product. Refer to your sales agreement to establish the terms of the limited warranty. In addition, Avayas standard warranty language, as well as information regarding support for this product, while under warranty, is available through the following Web site: http://www.avaya.com/support. Copyright Except where expressly stated otherwise, the Product is protected by copyright and other laws respecting proprietary rights. Unauthorized reproduction, transfer, and or use can be a criminal, as well as a civil, offense under the applicable law. Avaya support Avaya provides a telephone number for you to use to report problems or to ask questions about your product. The support telephone number is 1-800-242-2121 in the United States. For additional support telephone numbers, see the Avaya Web site: http://www.avaya.com/support.
Contents
About this Book . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Intended audience . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Summary of information in this book . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Conventions used in this documentation set . . . . . . . . . . . . . . . . . . . . . . . . . . . Application Enablement Services documents . . . . . . . . . . . . . . . . . . . . . . . . . . . Related documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . CSTA References for AE Services programmers . . . . . . . . . . . . . . . . . . . . . . . Related Communication Manager documents . . . . . . . . . . . . . . . . . . . . . . . . Avaya security and toll fraud . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Documentation feedback . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
7
7 7 8 8 9 9 10 10 10
Chapter 1: Prerequisites for AE Services . . . . . . . . . . . . . . . . . . . . . . . .

AE Services server hardware requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . Platform and third-party software required for AE Services server . . . . . . . . . . . . . . . . Software platform . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Third-party software . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Client application machine requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Communication Manager and media server requirements . . . . . . . . . . . . . . . . . . . . Required network characteristics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Network interface configurations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Supported network configurations. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Network interface speed and duplex settings . . . . . . . . . . . . . . . . . . . . . . . . . IP Migration Readiness and Optimization analysis . . . . . . . . . . . . . . . . . . . . . .
11
11 12 12 12 14 15 15 15 16 16 16
Chapter 2: Installing the Linux platform software . . . . . . . . . . . . . . . . . . . . Chapter 3: Installing the server software and third-party software . . . . . . . . . .
Obtaining the server software ISO image . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Installing and configuring the server software . . . . . . . . . . . . . . . . . . . . . . . . . . . Installing the ISO image . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Running the AE Services installer . . . . . . . . . . . . . . . . . . . . . . . . . . . . Installed files. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Locations of Installation/Upgrade logs and RPMs . . . . . . . . . . . . . . . . . . . . . . . . . Uninstalling the AE Services RPMs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Installation problems. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
17 19
19 19 19 20 26 27 27 27
Issue 2.3 September 2006
Chapter 4: Installing licenses . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Installing the Application Enablement Services license file . . . . . . . . . . . . . . . . . . . . Troubleshooting the AE Services license installation . . . . . . . . . . . . . . . . . . . . . . . If you receive error messages from WebLM . . . . . . . . . . . . . . . . . . . . . . . . . If you do not have a license . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Identifying the MAC address . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
29
29 31 31 31 32
Chapter 5: Initial administration for AE Services . . . . . . . . . . . . . . . . . . . .

Administering Communication Manager for AE Services . . . . . . . . . . . . . . . . . . . . . Administering AE Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Where to go from here. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
33
33 35 36
Chapter 6: Testing connectivity. . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Running tests from the OAM pages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Testing connectivity by running the sample application . . . . . . . . . . . . . . . . . . . . . .
37
37 38
Chapter 7: Upgrading and updating the AE Services software. . . . . . . . . . . . .

Upgrade considerations for RFA license . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Upgrading the software . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Before you begin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Performing the upgrade . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Installing a new license . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Updating the software . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Installing updates and patches . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Uninstalling updates and patches . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Uninstalling the AE Services software . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
39
39 39 40 41 43 44 44 45 46
Chapter 8: Security considerations and guidelines . . . . . . . . . . . . . . . . . . . Appendix A: Running the sample application (Device, Media, and Call Control only) . . . . . . . . . . . . . . . . . .
Before you begin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . The sample application files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Administer AE Services for the sample application . . . . . . . . . . . . . . . . . . . . . . . . Administer Communication Manager for the sample application . . . . . . . . . . . . . . . . . Administer a station . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Administer network region/gateway configuration (if needed) . . . . . . . . . . . . . . . . Edit the tutorial properties file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Running the sample application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Troubleshooting the sample application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
47 49
49 49 50 50 51 51 51 52 53
4 Application Enablement Services Installation Guide
Appendix B: Setting up for remote access (serial modem only) . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Setting up the Linux PC for remote access . . . . . . . . . . . . . . . . . . . . . . . . . . . . Before You Begin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Installing the additional software components . . . . . . . . . . . . . . . . . . . . . . . . Configuring the Linux PC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Editing the inittab file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Editing the login.config file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Editing the pap-secrets file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Checking the PPP options file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Editing the options.tty file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Setting up the client to dial in to the server . . . . . . . . . . . . . . . . . . . . . . . . . . . . Windows clients . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Linux clients . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Connection Requirements. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
55
55 55 56 56 57 57 57 58 58 58 59 59 59
Appendix C: Configuring an LDAP server for Common User Service utilization . . .

Prerequisites. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Configure the LDAP server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Create an LDAP User account . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
61
61 61 62
Appendix D: AE Services WAN requirements . . . . . . . . . . . . . . . . . . . . . . Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
65 67
About this Book
Intended audience
Developers performing the installation of the Application Enablement Services server software. These can be independent software vendors, enterprise application developers, and Avaya partners. Communication Manager administrators to administer Communication Manager for AE Services, if necessary
Summary of information in this book

Prerequisites for running the AES server Installing software on the AES server Installing the AE Services license Administering AE Services and Communication Manager for connectivity Checking connectivity Upgrading and updating AE Services servers (For Device, Media, and Call Control only) Running a sample application
This book does not tell how to migrate from Avaya CT or CVLAN R9. That information is provided in the administration and maintenance guide. Note: AE Services provides some pre-existing Avaya application enablement APIs (TSAPI, JTAPI, CVLAN, and Communication Manager API) For customers who have previously used these APIs, they are often referred to by name. However, Communication Manager API is now named Device, Media, and Call Control.
Note:
Conventions used in this documentation set

The following typefaces are used in the AE Services documentation set: Matter Commands Typeface and syntax
Example 1. Start your browser and type the appropriate URL based on this example: https://aeshostname:port/WebLM where:
This bold font for literals This bold italic for variables
aeshostname is your AE Services servers host name port is your AE Services servers port number (the default port number is 8443)
ASCII output Filenames/ pathnames Field names
ASCII output
Wait for the Installation/Update completed message. This choice configures an LDAP in the default location of /etc/openldap. Select Install to proceed with the installation.
Normal font Bold
Application Enablement Services documents

These books comprise the Application Enablement Services document set (including this book):

Avaya MultiVantage Application Enablement Services Overview (02-300360) Avaya MultiVantage Application Enablement Services Installation Guide Software-Only Offer (02-300355) Avaya MultiVantage Application Enablement Services Installation and Upgrade Guide for a Bundled Server (02-300356) Avaya MultiVantage Application Enablement Services Administration and Maintenance Guide (02-300357) Avaya MultiVantage Application Enablement Services Device, Media, and Call Control Java Programmer Guide (02-300359) Avaya MultiVantage Application Enablement Services Device, Media, and Call Control Java Programmer Reference (Javadoc)
Related documents
Avaya MultiVantage Application Enablement Services Device, Media, and Call Control XML Programmer Guide (02-300358) Avaya MultiVantage Application Enablement Services Device, Media, and Call Control XML Programmer Reference (XMLdoc) Avaya MultiVantage Application Enablement Services Web Services Programmers Guide ((02-300362) Avaya MultiVantage Application Enablement Services Documentation Road Map (02-300361) Avaya MultiVantage Application Enablement Services OAM Help (HTML) Avaya MultiVantage Application Enablement Services TSAPI Exerciser Help (.pdf) Avaya MultiVantage Application Enablement Services 3.1 TSAPI, JTAPI, and CVLAN Client and SDK Installation Guide (02-300543) Avaya MultiVantage Application Enablement Services 3.1 TSAPI for Avaya Communication Manager Programmer Reference (02-300545) Avaya MultiVantage Application Enablement Services 3.1 TSAPI Programmer Reference (02-300545) Avaya MultiVantage Application Enablement Services 3.1 CVLAN Programmer Reference (02-300546) Avaya MultiVantage Application Enablement Services 3.1 ASAI Technical Reference (03-300549) Avaya MultiVantage Application Enablement Services 3.1 ASAI Protocol Reference (03-300550)
You can find all these documents online on the Avaya Support Centre Web Site (http://www.avaya.com/support).
Related documents
CSTA References for AE Services programmers
For CSTA details not found in the programmers references or the programmers guides, see the following CSTA documents. They are in the Publications section of the ECMA Web Site (http://www.ecma-international.org/):
ECMA-269: Services for Computer Supported Telecommunications Applications (CSTA) Phase III
ECMA-323: XML Protocol for Computer Supported Telecommunications Applications (CSTA) Phase III ECMA Technical Report TR/72: Glossary of Definitions and Terminology for Computer Supported Telecommunications Applications (CSTA) Phase III ECMA-354 Application Session Services
Related Communication Manager documents

The following books from the Communication Manager documentation set provide additional information about administering Communication Manager for Application Enablement Services. They are on the Avaya Support Centre Web Site (http://www.avaya.com/support).
Administrators Guide for Avaya Communication Manager (Issue 11 for CM 3.1), 03-300509) Administration for Network Connectivity for Avaya Communication Manager (Issue 11 for CM 3.1), 555-233-504_11)
Avaya security and toll fraud

For information about the secure configuration of your equipment and the mitigation of toll fraud threats, see the Avaya Toll Fraud and Security Handbook 555-025-600. It can be found online at: http://support.avaya.com/elmodocs2/comm_mgr/r3/pdfs/025600_10.pdf
Documentation feedback
Let us know what you like or do not like about this book. Although we cannot respond personally to all your feedback, we promise we read each response we receive. Please email feedback to [email protected]
Chapter 1: Prerequisites for AE Services

This section explains the prerequisites for running Application Enablement Services. These prerequisites include:

AE Services server hardware requirements on page 11 Platform and third-party software required for AE Services server on page 12 Client application machine requirements on page 14 Communication Manager and media server requirements on page 15 Required network characteristics on page 15
Before installing the AE Services software, make sure your system meets the following hardware, software, and network requirements.
AE Services server hardware requirements

The AE Services server must be a 2.4-GHz or better single-processor Pentium IV class machine with:

1GB RAM (required) 10 GB free disk space (after installing Linux) Hard disk drive with at least 7200 rpm rating 512 KB L2 cache 100BaseT Ethernet NIC (should be set to full duplex) Avaya strongly recommends two NICs.
CD-ROM drive Note: The hostname of the AE Services server must be 15 characters or less. To determine the hostname associated with an AE Services server, run the following Linux command from the command line: uname n
Note:
11
Prerequisites for AE Services
Platform and third-party software required for AE Services server

Software platform
Red Hat Enterprise Linux ES 3.0 (32-bit Standard Edition) Update 5 Note: Check the latest AE Services release notes for the latest update supported.
Note:
Third-party software
The following table shows the required third-party software packages. The table also tells which services in AE Services requires this software package. The AE Services installer installs and configures all of the required third-party packages. We strongly recommend that you accept this option when installing the server software. Table 1: Required third-party software Name/Minimum Version Supported by AE Services Apache Http Server 2.0.46 Apache mod_ssl 2.0.46 Note: Axis 1.1-13The Axis RPM supplied by Avaya when you install third-party software using the installer is: avaya-coreservices-axis 1.1 Curl 7.10.6 Dialog 0.9b Ethereal 0.10.11 PHP Installer Avaya Services if you have a Services contract 1 of 3 Required by SMS SMS User Service, Telephony Web Service
Note:
Platform and third-party software required for AE Services server
Table 1: Required third-party software (continued) Name/Minimum Version Supported by AE Services gdb 6.3.0.0.0 J2SDK 1.5 Kerberos (krb5) 1.2.7: krb5-devel, krb5-libs, krb5-workstation Kerberos (pam_krb5) 1.75-1 libpcap 0.7.2 libxml2 2.5.10 net-snmp 5.0.9 net-snmp-libs 5.0.9 OpenLDAP 2.1.22 OpenLDAP clients 2.1.22 OpenLDAP servers 2.1.22 Openssl 0.9.7a pdksh 5.2.14 PHP 4.3.2 PHP Pear 4.3.2 PostgresSQL 7.3.10 PostgresSQL-libs 7.3.10 Required by (a debugger) Device, Media, and Call Control, OAM TSAPI TSAPI Ethereal SMS Ethereal Ethereal User Service User Service User Service SMS, Transport Layer DLG, Call Control SMS SMS TSAPI Service, CVLAN, CMAPI, OAM TSAPI Service, CVLAN, CMAPI, OAM 2 of 3
13
Table 1: Required third-party software (continued) Name/Minimum Version Supported by AE Services PostgresSQL-server 7.3.10-1 Tomcat 5.0.28 or later Note: The Tomcat RPM supplied by Avaya when you install third-party software using the installer is: avaya-coreservices-tomcat 5.0.28 3 of 3 Note: There are numerous scripts in AE Services that use the perl package which is part of the Red Hat ES 3.0 Linux distribution. The perl package is also available for download also from http://www.perl.com. Required by TSAPI Service, CVLAN, CMAPI, OAM WebLM, OAM, User Service, Telephony Web Service
Note:
Note:
You are responsible for your license agreements with companies of the third-party software.
Client application machine requirements

You must provide a client application machine for your AE Services system. Device, Media, and Call Control applications can be developed and executed on any machine that is capable of running the Java 2 Platform, Standard Edition (J2SE) 1.5 or later. For the other AE Services clients, refer to the Application Enablement Services 3.1 TSAPI, JTAPI, and CVLAN Client and SDK Installation Guide.
Communication Manager and media server requirements
Communication Manager and media server requirements

You must have the official Communication Manager R3.0/3.1 running on an IP-enabled media server. Note: Only Communication Manager 3.1 provides the Enhanced Link Bounce Resiliency feature.
Note:
AE Services supports all media servers and gateways that support Communication Manager 3.0/3.1.
Required network characteristics

Network interface configurations
With one exception, Avaya Services recommends that you configure AE Services to use dual NICs (eth0 and eth1).
Single NIC The application machine, AE Services server, and Communication Manager server reside on a private LAN, virtual LAN (VLAN), or WAN. Note: The single NIC configuration is recommended for most S8300, S8400, and S8500c servers that use a Processor Ethernet interface because the IP interface for these servers must be publicly accessible for registration of IP endpoints.
Note:
Dual NIC (recommended) In a dual NIC configuration, one interface is for the communication channel between the AE Services server and the application, and the second interface is for the communication channel between the AE Server and the Communication Manager CLAN. - The application and the AE Server are on a LAN (production LAN or VLAN) or WAN. - The AE Services server and the Communication Manager CLAN interfaces are on a private LAN or VLAN.
15
Supported network configurations

Regardless of whether a LAN, VLAN or WAN is used, The TCP/IP links between the AE Services server and Avaya Communication Manager can be connected with the following network latency requirements:
No more than a 200ms average round trip packet delivery time as measured with ping over every one-hour time period Periodic spiked delays of no more than two seconds while maintaining the 200ms average round trip delivery time as measured with ping over every one-hour time period
These requirements are to maintain the AE Services communication channel with CM (CLANs) over a LAN/VLAN or WAN.
Network interface speed and duplex settings

AE Services has been tested at 100BaseT full duplex, and these are the required speed and duplex mode settings. The NIC settings should be verified before installing AE Services.
IP Migration Readiness and Optimization analysis

We also recommend that you use the Avaya IP Migration Readiness and Optimization services to help you safely implement IP-based solutions in a stable, optimized infrastructure. These services include a two-phased, detailed analysis of the entire network to help assess whether you can deploy a converged IP solution such as AE Services without adversely affecting your existing network applications and services. The first phase of this analysis is the Customer Infrastructure Readiness Survey (CIRS). Certified Avaya engineers conduct a high-level evaluation of the local and wide area network infrastructure to identify any significant network issues that must be resolved prior to deploying the proposed IP solution. Phase 2 of this analysis, Network Analysis/Network Optimization (NANO) is required when the CIRS indicates that the network will not support the proposed IP solution at the desired performance levels. Starting with the information and data gathered for the CIRS, Avaya engineers perform problem diagnosis to get at the root causes of network issues. They also provide functional requirements and recommendations for a network design that optimizes all of the resources needed to support the IP solution.
Chapter 2: Installing the Linux platform software

You must obtain and install the Linux platform software. Avaya does not provide a Linux RPM or a Linux installation script. You must install Linux before you install the Application Enablement Services server software because the installation script also configures Linux for AE Services. To install Redhat Enterprise Linux ES 3.0 update 5: 1. Follow the instructions of the Red Hat installation utility to install your system. 2. Follow these additional guidelines we provide for installation:
Select the minimum install for Linux. Performing a complete install may result in version conflicts with some of the third-party software packages required by AE Services. For security reasons, you should enable only a specific list of ports on the server firewall. This list includes all of the ports that the AE Services software uses. For a list of these ports, see the White-paper on Security in Application Enablement Services for Bundled and Software only solutions. Use the Linux default partitioning.
3. Complete the Linux installation and reboot the system. 4. To the /etc/hosts file, add a separate line that specifies the IP address of the AES server. For example:
127.0.0.1 135.9.30.106 localhost dr-dfla0 dr-dfla0.dr.avaya.com
Under some circumstances, Apache httpd may need this line. If this file contains an incorrect address, AE Services will not start.
17
Installing the Linux platform software
Chapter 3: Installing the server software and third-party software

This chapter explains how to install all of the AE Services software on the AES server machine. The installation script also optionally performs these recommended tasks:

Configures Linux Installs the third-party software packages required by AES Configures the third-party software packages for AE Services.
We recommend that you select these options in the installation script.
Obtaining the server software ISO image

Obtain the server ISO image from one of these sources:

The AE Services CD-ROM that was shipped to you The Avaya DevConnect site
Installing and configuring the server software

Installing the ISO image
To install from the ISO image, you can either:
Create a CD-ROM from the ISO image and install from the CD-ROM or
Download and mount the ISO image and install from the mounted image You must Install the server software from a window that emulates xterm or is recognized by Linux. If you install the software from a DOS window, you may have display problems.
19
Installing the server software and third-party software
Perform these steps: 1. Log in as a user with root privileges. 2. Mount the drive or the image:
Insert the CD-ROM into the CD-ROM drive and mount the drive: mount /mnt/cdrom or
Download the ISO image to the /tmp directory of the AE Services server and mount the image as a CD-ROM: mount -t iso9660 -o loop /tmp/xxxx.iso /mnt/cdrom where xxxx = is the name of the ISO image.
3. If AE Services is installed, stop the mvap, DBService, and tomcat5 services. 4. Run the installer script (it may run automatically). /mnt/cdrom/install The installer script starts.
Running the AE Services installer

The startup screen provides a guide for navigating through the dialog boxes.
To proceed with the installation: 1. Press Enter to continue. The Loss of Data Warning screen appears:
If you are upgrading from a previous release and have not backed up your database, a. Select No to quit this installation b. Back up your database. c. Restart the installer.
Select Yes if you do not need to back up a database (either you arent upgrading or you already backed up the database.
The Select Installation Media screen appears.
Note:
Note: The rest of these installation instructions assume that you will know when to select OK and press Enter to continue.
21
2. On the Select Installation Media screen, select the media from which to install: Note: If you used /mnt/cdrom, select CDROM even if you downloaded the script. The Enter RPM URL screen appears.
Note:
3. Select the RPM URL. The default entry is correct if you used /mnt/cdrom. The Select Release Version screen appears.
4. Select the release version you are installing The Co-residency warning page appears. This page warns you that running applications co-resident on the AE Services server is not supported.
5. Respond to this warning:

Select Yes to acknowledge the warning and continue. Select No to abort the installation.
The Choose Installation Method screen appears.
6. Select Install to proceed with the installation. The Choose Installation Packages screen appears.
23
7. Select both packages. The Optional Packages screen appears.
This screen lists the optional packages that you can install. 8. Select the optional packages that you want to install.
mvap-linuxconfig This choice installs the Linux configuration package. We strongly recommend that you configure Linux by selecting mvap-linuxconfig on this screen.
mvap-cusldap This choice configures an LDAP in the default location of /etc/openldap. We recommend that you configure LDAP by selecting mvap-cusldap on this screen.
mvap-services Installs the Avaya Services package for AE Services. Select this package if you have a Services contract with Avaya. This package provides tools and information, including Services login, to the Avaya Services personnel.
The Last Chance to Abort -- Ready to Proceed? warning screen appears.
9. Select yes. The installation continues. The system displays the status of the installation. For example:
Wait for the Installation/Update completed message.
25
10. Select Exit. The Successful completion screen appears:
Note:
Note: If the installation fails, a similar screen appears that says Installation Failed. 11. To run AE Services after the installation, either reboot the system or manually restart DBService, mvap, and tomcat5 by running the following commands: /sbin/service DBService start /sbin/service mvap start /sbin/service tomcat5 start
See Chapter 4: Installing licenses for information about installing the appropriate licenses.
Installed files
As the AE Services Installer installs and unpacks the RPMs, it creates these directories and files:
The main server directory /opt/mvap Note: Do not replace any of the directories under /opt/mvap with a symbolic link to another directory. This may result in breakage and is not a supported configuration.
Note:
The AES server startup configuration file /etc/sysconfig/mvap
Log files /opt/mvap/logs
Locations of Installation/Upgrade logs and RPMs
The installation log files /var/disk/logs/update.out-timestamp
The AE Services certificate /etc/opt/avaya/certs/private/server.pkcs12
Locations of Installation/Upgrade logs and RPMs
The Installation/upgrade log files are in: /var/disk/logs/update.out-xxxx where xxxx = a time stamp (for example, /var/disk/logs/update.out-2005-0307-0951)
Copies of RPMs for each release that is installed (up to two installs) are kept in: /var/disk/Releases/r3-xxx where r3-xxx is the release number. Note: For a list of all the RPMs you have installed, run swversion -a.
Note:
Uninstalling the AE Services RPMs

To uninstall all of the AE Services RPMs, run the command: swuninstall. This script is located in /opt/mvap/bin.
Installation problems
If you have problems installing the AE Services software, call 1-800-344-9670, prompt 2. or contact your local Avaya distributor.
27
Chapter 4: Installing licenses

All AE Services 3.1 users must install a license file, This section explains how to install the AE Services license.
Installing the Application Enablement Services license file

The AE Services license file is distributed separately in an email from Avaya. If you have not received a license file from Avaya, see If you do not have a license on page 31.
!
Important:
Important: The WebLM Server and the AE Services server must be running on the same machine. This is the default configuration. To check this, type:
https://aeshostname:port/WebLM
The WebLM page should come up. Follow these steps to install the license file: 1. Locate the email containing the AE Services license file. Detach the license file from the email, and store it locally on a PC. The PC that the license file is stored on does not have to be same PC that the AE Services server is installed on. 2. Start your browser and type the appropriate URL based on this example: https://aeshostname:port/WebLM where:

For example: https://myaessrv.abc.com:8443/WebLM or https://192.168.1.1:8443/WebLM Note: You can also shorten the URL by leaving out the port number: https://aeshostname/WebLM/
Accept the SSL certificate that is presented. After accepting the certificate, your browser displays
Note:
the WebLM Administrator Login page.
29
Installing licenses
3. Accept the default User name (admin) and type the default password: weblmadmin. Then click Continue. Your browser displays the Change Administrator Password page. Note: WebLM issues the Change Administrator Password page the first time you log in to WebLM. If you get a new license, you do not have to change your password the next time you log in to WebLM. 4. Complete the Change Administrator Password page and click Change Password. The browser goes back to the login page. 5. Log in as admin with the new password you specified. Your browser displays the Install License page. 6. Under Enter License Path, click Browse and locate the AE Services license file. Once you have located the license file, click Install. WebLM uploads the license file from your PC to the WebLM server and displays the following message: License File is installed successfully. If you do not receive this message, see Troubleshooting the AE Services license installation. 7. Log out of WebLM and restart AE Services to use the capabilities of the new license. Note: The hostname of the AE Services server must not be associated with the loop back address 127.0.0.1. The hostname of the AE Services server should be associated with the IP address of eth0
Note:
Note:
This completes the AE Services license installation.
Troubleshooting the AE Services license installation
Troubleshooting the AE Services license installation

Use the information in this section to troubleshoot problems you might encounter during installation of the license. It covers the following topics:

If you receive error messages from WebLM If you do not have a license
If you receive error messages from WebLM

If your browser displays the following messages, contact your Avaya representative. Message License file is invalid or not created for this server. License file was NOT installed. Attempting to install a license file that is currently installed. License file was NOT installed No valid license file found Explanation The file is corrupt or the MAC address in the license file does not match the MAC address in the server. The license has already been activated.
This WebLM message may appear after AES provides this successful license installation message: "license file installed successfully" If this happens, make sure that in step 2 in Installing the Application Enablement Services license file on page 29, aeshostname is your AE Services servers host name (not the IP address).
If you do not have a license

If you discover that you have not received the AE Services license file in an email from Avaya, contact your Avaya representative or Avaya Partner representative. To ensure that your request is processed as quickly as possible, be ready to provide the information listed in Required information for requesting a license file.
31
Installing licenses
Note:
Note: You must send a separate request for each license file.
Table 2: Required information for requesting a license file Required information Return email address Description Avaya emails this license file to you. You must provide a secure email address where you want to receive the license file. For more information, see Identifying the MAC address.
MAC Address of the NIC
Identifying the MAC address

If you have already installed AE Services, use WebLM to identify the MAC address of the NIC by following step 2 of Installing the Application Enablement Services license file on page 29. As an alternate method (if you have not installed AE Services), you can use the Linux ifconfig command to identify the MAC address of the NIC on your PC. 1. From the Linux command prompt, type the following command: ifconfig Linux displays the current information about the network interface. For example: eth0 Link encap:Ethernet HWaddr 00:B0:D0:44:9F:A1 Mask:255.0.0.0
inet addr:10.10.10 Bcast:10.255.255.255
In this example, the MAC address (which corresponds to the HWaddr) is 00B0D0449FA1 (when specifying a MAC address do not include colons). 2. Provide the MAC address to your service representative when you request a license.
!
Important:
Important: If your server is configured with multiple NICs, provide the MAC address of the first NIC. If your server is configured with a dual port NIC, provide the address of the first port.
Chapter 5: Initial administration for AE Services

You must administer both Communication Manager and AE Services to complete the installation of AE Services. This chapter provides tables of these administration procedures, which:

Establish initial connectivity between AE Services and Communication Manager: Allow Communication Manager to interact with Application Enablement Services client applications.
The tables direct you to the appropriate section or sections in the Application Enablement Services Administration and Maintenance Guide.The tables also explain the services for which you perform each procedure.
Administering Communication Manager for AE Services

Procedure Check for call control features licensed on Communication Manager Set up a transport link Performed if you use these services Call Control Where to find in AE Services Admin Guide Checking for call control features licensed on Communication Manager, in Chapter 1, Administering Communication Manager for AE Services Configuring IP Services in Chapter 1, Administering Communication Manager for AE Services Call Control Settings in Chapter 1, Administering Communication Manager for AE Services
Set up a CTI link
Check the referenced sections in the Administration and Maintenance Guide to decide which links you need to set up.
33
Initial administration for AE Services
Procedure Check for appropriate VOIP resources Check for IP_API_A licenses Add stations for a Device, Media, and Call Control application Configure Communication Manager for signaling and media encryption
Performed if you use these services Device, Media, and Call Control
Where to find in AE Services Admin Guide Checking for appropriate VOIP resources in Chapter 1, Administering Communication Manager for AE Services Checking for IP_API_A licenses in Chapter 1, Administering Communication Manager for AE Services Adding stations for the application in Chapter 1, Administering Communication Manager for AE Services
For signaling encryption: Administering a network region in Chapter 1, Administering Communication Manager for AE Services See also the White-paper on Security in Application Enablement Services for Bundled and Software only solutions. This white paper is available on the Avaya support site along with the customer documents.
For media encryption: Checking for media encryption in Chapter 1, Administering Communication Manager for AE Services
Administering AE Services
Administering AE Services
Procedure Create a user account for OAM access Perform procedure If using: All (without a services contract) Where to find in AE Services Admin Guide Adding a Linux user and setting the OAM account password in Chapter 7, Administering AE Services from the Operating System Command Prompt Adding a CT User to the AE Services User Service database in Chapter 3, AE Services OAM administration and CTI OAM Administration Administering the local IP for all AE Services in Chapter 3, AE Services OAM administration and CTI OAM Administration Administering Switch Connections, in Chapter 2, AE Services OAM Administration and CTI OAM Administration Administering Switch Connections, in Chapter 2, AE Services OAM Administration and CTI OAM Administration Link Administration - CTI Link Admin on AE Services OAM in Chapter 2, AE Services OAM Administration and CTI OAM Administration
Administer CT users
TSAPI, JTAPI and Device, Media, and Call Control
Specify NICs for AE Services
All
Administer transport link connectivity to Communication Manager C-LAN/P-CLAN
Check the referenced sections in the Administration and Maintenance Guide to decide when to administer a transport link. Device, Media, and Call Control
Administer H.323 Gatekeepers
Administer links
All call control
35
Initial administration for AE Services
Procedure Check application link encryption
Perform procedure If using: Device, Media, and Call Control Services
Where to find in AE Services Admin Guide Checking application link encryption in Chapter 2, AE Services OAM Administration and CTI OAM Administration Chapter 5, TSAPI Configuration and the Security Database
Administer the Security Database settings
TSAPI or Telephony Web Services
After completing all installation and configuration procedures, you should restart AE Services.
Where to go from here

You have now completed the AE Services installation and the administrative tasks for achieving connectivity between the AE Services server, Communication Manager (if necessary) and the client. Chapter 6: Testing connectivity explains how to test the connectivity.
You can test connectivity from the OAM Utilities pages. See Running tests from the OAM pages on page 37.
If you are using Device, Media, and Call Control, you can also test the connectivity using the provided sample application. All necessary files for this application are included in the Application Enablement Services RPM. For instructions on running the sample application, see: Appendix A: Running the sample application (Device, Media, and Call Control only)
Chapter 6: Testing connectivity

You can test the connectivity between AE Services and Communication Manager in several ways, depending on which capabilities you are using.

You can run tests from the OAM pages. You can run a sample application (Device, Media, and Call Control only).
Running tests from the OAM pages

You can use the following OAM Utilities pages to check connectivity:

ASAI Test - to test ASAI links Ping Host - to ping a host name IP address TSAPI Test - to place a test phone call
The following table shows which OAM Utilities page can be used for which tools: ASAI Test Call Control (CVLAN/TSAPI) DLG Device, Media, and Call Control Call Control (TSAPI) Telephony Web Service The location of these screens in the OAM are:

Ping Host X X X
TSAPI Test
X X
Utilities > ASAI Test Utilities > Ping Host Utilities > TSAPI Test
For information about running these tests, see the OAM Help pages.
37
Testing connectivity
Testing connectivity by running the sample application

If you are using the Device, Media, and Call Control Services, you can also set up and use the sample application created for these services. Running this application tests that the server files are installed correctly and that you have achieved connectivity with Communication Manager. See Appendix A: Running the sample application (Device, Media, and Call Control only).
Upgrade considerations for RFA license
Chapter 7: Upgrading and updating the AE Services software

This section explains:

When you need to obtain a new RFA license while upgrading from 3.0 to 3.1 How to upgrade the AE Services software How to apply updates and patches For an explanation of the differences between updates and patches, see Updating the software on page 44.
Upgrade considerations for RFA license

AE Services 3.1 can operate with an AE Services 3.0 license under many circumstances. However, an AE Services 3.1 license is required in order to take advantage of new features and capabilities. We strongly recommend that you obtain a new 3.1 license even if you do not purchase any changes to licensed features. This will ensure that any new features or capabilities that you may use in the future will be supported without having to regenerate the license at that time. You must acquire a new license when you upgrade to AE Services 3.1 if you are:
Running Device, Media, and Call Control applications or
Running TSAPI Service with existing TSAPI Advanced User license
We recommend that you obtain the 3.1 RFA license before performing the upgrade.
Upgrading the software

This section provides the procedure for upgrading from AE Services 3.0 to AE Services 3.1 or upgrading to a new 3.1 load. There are some differences in these procedures. These differences are noted in the appropriate sections. Note: Upgrades can be performed only on a server that already has a version of AE Services installed on it.
Note:
39
Upgrading and updating the AE Services software
Before you begin

Before an upgrade or update is performed: 1. Log in to the AE Services OAM pages. a. Start your browser and type the appropriate URL based on this example: https://aeshostname:port/MVAP where:

b. Log in. The OAM Home Page opens. 2. Select CTI OAM Admin. The CTI OAM Home Page opens. 3. Perform a backup from the OA&M Web pages to generate a 3.0 configuration data backup file. a. From the CTI OAM Main menu, select Maintenance > Backup Database. b. On the Backup Database screen, click on here and select the Save button. c. Save the database backup file to a safe location that will not be affected by the AE Services 3.1 installation. The backup file is stored at that location under the name mvapdbddmmyyyy.tar.gz For more information, see the section Backing up the database in Chapter 2, AE Services OAM Administration and CTI OAM Admin in the Application Enablement Services Administration and Maintenance Guide. 4. Make sure you also back up any files in directories that are not automatically preserved. This includes the home directories of accounts created by the previous installation (for example, craft, avaya, sroot). 5. From the CTI OAM Main menu, select Administration > Local IP and record the Local IP settings listed on the Local IP screen.
!
Important:
Important: This following step is an important precaution in case the upgrade fails.
6. To maintain a synchronized LDAP and Postgres database. a. Log in to the 3.0 AE Services server and su to a user with root privileges (for example, use su - root). b. From the command line, execute the following commands: cd /var/lib/ldap tar -cvf tar_file_name.tar *.dbb c. Save the tar file in a safe location that will not be affected by the 3.1 installation. 7. (Only if upgrading from AE Services 3.0) Update Linux to Linux ES 3.0 update 5: a. Insert the first Linux CD and reboot. b. From the boot prompt: type linux upgrade. c. Follow the screens to one that says: Perform an upgrade of an existing installation Update boot loader configuration You may see this message: Upgrades for this version of Red Hat Enterprise Linux ES are only supported from Red Hat Linux 6.2 or highter. This appears to be an older system. Do you wish to continue the upgrade. d. Select OK.
Performing the upgrade

You can upgrade AE Services from a CD or from an ISO image. This section explains these procedures. To upgrade the software: 1. Log in to the server as a non-Avaya user and su to an account with root privileges (for example, using the command su - root). 2. From the command line, stop tomcat: service tomcat4 stop Note: If you are upgrading from one 3.1 load to another, you do not need to stop tomcat.
Note:
41
3. From the command line, uninstall the AE Services 3.0 software: swuninstall Note: If you are ugrading from one 3.1 load to another, you do not need to uninstall. 4. From the command line, remove third-party software packages that are different in 3.0 and 3.1. rpm -e avaya-axis rpm -e avaya-tomcat rpm -e j2sdk-1_4_2_07-linux.i586.rpm 5. Run the installer by performing the appropriate steps from the following table. For a complete explanation of running the installer, including example screens, see Running the AE Services installer on page 20. If upgrading from a CD a. Insert the CD containing the AE Services 3.1 and third-party RPMs software. b. Start the AE Services Installer. - If the Autorun RPM is already installed and configured on your machine, the AE Services installer starts automatically. - If the Autorun RPM was not already installed and configured on your machine, first mount the CD ROM and then run the AE Services Installer. Use these commands: mount /mnt/cdrom /mnt/cdrom/install If upgrading from an ISO image a. Download the ISO image to the /tmp directory on the AE Services server. b. Using the following command, mount the ISO image: mount -t iso9660 -o loop XXX.iso /mnt/cdrom Where XXX = the AE Services ISO Image Build version. c. Launch the Software-Only installer: /mnt/cdrom/install
Note:
6. From the command line, start these services in this order: service service service service service ldap start DBService start mvap start httpd start tomcat5 start
7. Verify that the upgrade was successful.
From the command line run swversion and verify that the version number and build number are correct. Validate the configuration data: a. Log in to the AE Services OAM. For more information, see step 1 in Before you begin on page 40. b. Select CTI OAM Admin > Administration. c. Check all of the OAM pages listed under Administration on the Administration page. Verify that the information is complete and correct.
Perform these additional steps if all of the data is not there or if any of the data is incorrect. 8. Restore the database from the OAM: a. From the CTI OAM Main menu, select Maintenance > Restore Database. b. Follow the instructions on the Restore Database page. 9. Log in to the 3.1 AE Services sever and su to a user with root privileges (for example, using the command su - root). 10. Copy the saved tar file to /var/lib/ldap. 11. From the command line, execute the following commands: cd /var/lib/ldap tar -xvf tar_file_name.tar rm tar_file_name.tar service ldap restart
Installing a new license

We recommend that you install a new AE Services 3.1 license when you upgrade to AE Services 3.1. See Upgrade considerations for RFA license on page 39 for more information. See Chapter 4: Installing licenses for information about installing licenses. Whenever you install a new license, you must restart AE Services to get the new capabilities. To restart AE Services: 1. Log in to the AE Services OAM. For more information, see step 1 in Before you begin on page 40. 2. Select CTI OAM Admin > Maintenance > Service Controller. 3. Click the Restart AE Server button.
43
Updating the software

Avaya provides updates and patches for updating the software.
An update provides new features or enhancements to the AE Services platform. An update may also include bug fixes. Updates are released only on an as-needed basis for critical fixes. Avaya tests updates before releasing them. A patch addresses a specific issue to a specific component or a set of components in the AE Services platform. We do not test patches before releasing them. The install script installs the new version of the RPMs in /var/disk/rpms. Note: /var/disk/rpms also contains all of the previous versions of the RPMs.
Note:
The update script backs up the current version before installing the new version of the RPM.
The next two sections explain how to install or uninstall updates or patches on an AE Services server.
Installing updates and patches

Updates and/or patches are organized as ZIP files of RPMs. Multiple updates or patches can be applied to the system.
!
Important:
Important: Always use this procedure, not an RPM command, to install AE Services updates or patches.
You should check the Avaya DevConnect site (www.devconnectprogram.com) or the Avaya support site (support.avaya.com) periodically to see if there is a new patch. If there is, install the new updates and/or patches: Note: You should always perform a backup of the database before installing an update.
Note:
Updating the software
To install an update or a patch: 1. Log in to the AE Services server and su to a user with root privileges (for example, using the command su - root). 2. Download any new patches (xxxx.zip) to the current directory. 3. From the command line, enter update -u xxxx.zip The update/patch ID and the RPMs contained in the package are displayed and the system prompts you to confirm the installation of the RPMs.
If you enter y, the installation of the updates/patches proceeds: - AE Services, Tomcat service, and DBService are stopped. - RPMs contained in the package are installed. - AE Services, Tomcat service, and DBService are restarted.
If you enter n, the installation of the updates/patches aborts.
Use swversion -a if you want to look at all the updates/patches installed in the system.
Uninstalling updates and patches

Note:
Note: The directory /opt/mvap/resources/patch-update contains the patchnumber.txt files. RPMs installed in each update/patch are listed in this patchnumber.txt file. Use swversion if you want to look at all the updates/patches installed in the system.
To uninstall updates or patches: 1. Log in to the server machine where AE Services and patches are already installed. 2. su to a user with root privileges (for example, using the command su - root). 3. Use swversion -a to find out the number of the update/patch you want to remove. 4. From the command line, enter: update -e patchnumber. The screen displays a list of all the RPMs to be uninstalled, and the system prompts you for confirmation before uninstalling these RPMs.
If you enter y, the system uninstalls the updates/patches by performing these tasks: - AE Services, Tomcat service, and DBService are stopped. - RPMs specified in patchnumber.txt are rolled back to the previous version. - AE Services, Tomcat service, and DBService are restarted.
If you enter n, the upgrade script exits.
45
Uninstalling the AE Services software

To uninstall the AE Services software: 1. Uninstall all of the AE Services RPMs: swuninstall. This script is located in /opt/mvap/bin.
!
Important:
Important: If you have any patches installed, you must first remove them before running swuninstall.
Note:
Note: swuninstall also removes the users (for example, avaya, craft, user). 2. After uninstalling the software, some configuration and log files will remain in the /opt/mvap and /opt/ecs directories. You may remove these directories and their contents. Be sure to save any configuration, properties or log files to a safe place before removing these directories. 3. Stop tomcat5: /sbin/service tomcat5 stop
Chapter 8: Security considerations and guidelines

For a complete discussion of the security considerations and guidelines for AE Services, see the White-paper on Security in Application Enablement Services for Bundled and Software only solutions. This white paper is available on the Avaya support site along with the customer documents.
47
Security considerations and guidelines
Appendix A: Running the sample application (Device, Media, and Call Control only)
If you are using the Device, Media, and Call Control capabilities of AE Services, the files for running several sample applications were installed. This section explains how to administer and run one of these sample applications (the Tutorial application) in order to:

Test connectivity between AE Services and Communication Manager Perform the various steps involved in running an application Learn which files are involved in running an application See some of the capabilities of an AE Services Device, Media, and Call Control application Note: The Tutorial application is the only application that should be run directly on the AE Services Server. All other applications should be run on another machine.
Note:
Before you begin

Before you can run the sample application, you must:

Administer AE Services for the sample application Administer Communication Manager for the sample application Edit the tutorial properties file
You will need to know the dial plan and which Communication Manager extensions are available.
The sample application files

The following sample application and sample application-related files are included on the AE Services server:
The application properties file for the sample application (the tutorial properties file) /opt/mvap/cmapi/cmapijava-sdk/examples/resources/tutorial.properties
49
Running the sample application (Device, Media, and Call Control only)
The sample application media files /opt/mvap/cmapi/cmapijava-sdk/examples/media/0001.wav /opt/mvap/cmapi/cmapijava-sdk/examples/media/0002.wav opt/mvap/cmapi/cmapijava-sdk/examples/media/0003.wav /opt/mvap/cmapi/cmapijava-sdk/examples/media/0004.wav
A README file containing a description of how to set up and run the sample application. /opt/mvap/cmapi/cmapijava-sdk/examples/bin/README.txt
These files are referred to throughout the following procedures.
Administer AE Services for the sample application

Note:
Note: This is a change for Device, Media, and Call Control Services, which previously was known as Communication Manager API. In Communication Manager API, you specified configuration and application properties in the configuration properties file. Now all properties are specified through the OAM.
To administer AE Services for the sample application: 1. Ensure that you have specified the same directory for these fields on the OA&M Media Properties screen: - Player Directory - Recorder Directory Note: The default value for both fields is /tmp. 2. Copy the application media files (listed in The sample application files on page 49) into the directory you have specified for Player Directory and Recorder Directory.
Note:
Administer Communication Manager for the sample application

To run the sample application, you must administer the following on Communication Manager:

Administer a station to use with the application (If needed) Administer out-of-band digit detection (If not already configured) Configure network region and gateway configuration
Edit the tutorial properties file
Administer a station
Use the Communication Manager add station command to add a station. For instructions on adding a station (including an example screen for AE Services), see Adding stations for the API application in Chapter 1, Administering Communication Manager for AE Services in Application Enablement Services 3.0 Administration and Maintenance Guide. For a screen reference, see Station in the Screen Reference chapter of the Administrator Guide for Avaya Communication Manager, 03-300509 (For Communication Manager 3.0).
Administer network region/gateway configuration (if needed)

See the section Setting up a network region for Device, Media, and Call Control and Adding a media gateway to the network, in Chapter 1, Administering Communication Manager for AE Services in Application Enablement Services 3.0 Administration and Maintenance Guide.
Edit the tutorial properties file

Before you can run the sample application, you must edit the tutorial properties file (tutorial.properties) to provide information specific to your configuration. To edit the tutorial properties file: 1. Open tutorial.properties: /opt/mvap/cmapi/cmapijava-sdk/examples/resources/tutorial.properties This is the text of tutorial.properties:
# IP address of Communication Manager (CLAN) callserver=nnn.nnn.nnn.nnn extension=nnnn password=nnnn # codec choices: g711U, g711A, g729, g729A codec=g711U # encryption choices: aes, none encryption=none # IP address of AE Server cmapi1.server_ip=nnn.nnn.nnn.nnn cmapi1.username=<user_id> cmapi1.password=<user_password> # Port for client to connect to AE Server cmapi1.server_port=4722 # Port 4722 is encrypted cmapi1.secure=true #cmapi.trust_store_location=sdk/build/mvsdk/cmapijava-sdk/examples/resources/avaya.jks
51
2. Replace the ns with the following values, using the text editor of your choice: a. For callserver, enter the IP address of the media server for Communication Manager, either. - (with an S8300 media server) The IP address of the media server or - (with any other media server) The IP address of the C-LAN b. For extension, enter the extension number of the station that you administered for this application. See Administer a station on page 51. c. For password, enter the security code you administered for that station. See Administer a station on page 51. 3. Save and close tutorial.properties.
Running the sample application

Note:
Note: The AE Services server must be running before you can run an application.
To run the sample application: 1. ssh into the AE Services server. 2. On the AE Services server change to the directory where the demonstration application run script resides: cd /opt/mvap/cmapi/cmapijava-sdk/examples/bin 3. Run Ant on the tutorial application: /opt/mvap/cmapi/cmapijava-sdk/examples/bin/ant.sh runTutorial (./ant.sh runTutorial) The application starts running. This application acts as a softphone and waits for calls. When the extension is called from any other phone, it answers with a recorded greeting that prompts you to record a message. 4. You can experiment with this application: a. Call the extension and listen to the recorded greeting. b. Follow the prompts to record a message and have it played back to you.
Troubleshooting the sample application
Note:
Note: The sample application can only play the last recorded message on a given call. If you make a new call, you will not hear a recording from a previous call. All the recorded files are saved in the directory you have specified in the OAM as the location of the recorded files. Note: There are also other sample applications installed with the server. After you have checked the AES server/Communication Manager connectivity by running this application, you may want to run those applications from an application machine.
Note:
Troubleshooting the sample application

If the application does not run or does not run as expected:
Check the log files on the server in /opt/mvap/logs: - mvap-trace.log.x - mvap-error.log.x - mvap-api.log.x - mvap-wrapper.log The best log file to check for Exceptions when troubleshooting is the mvap-error.log.0 file (The.0 file is the latest log file).
Check for application error messages: Troubleshooting procedure Ensure that the extension number in tutorial.properties corresponds to a correctly administered extension number in Communication Manager. Verify that the password in tutorial.properties matches the password administered in Communication Manager for the station.
Application error message: Registration failed because Gatekeeper Reject reason: terminalExcluded Registration failed because Gatekeeper Reject reason: securityDenial
53
Application error message: Registration failed because Protocol Timeout: reason: GRQ timer, tried 3 times Connection refused
Troubleshooting procedure Verify that the IP address in tutorial.properties for the call server (media server) is correct. Ensure that you can ping the media server from the AE Services server.
Check the tutorial.properties file to make sure that the IP address of the AE Services server is correct. Check for network problems between the application machine and the AE Services server. One way to check this is to ping the AE Services server from the application server. Check the /etc/hosts files to verify that you have included a line that explicitly lists the IP address of the AE Services server, in addition to the localhost line.
For information about creating and deploying Device, Media, and Call Control applications for AE Services, see the following books:
Application Enablement Services Device, Media, and Call Control Java Programmer Guide (02-300359) Application Enablement Services Device, Media, and Call Control Java Programmer Reference (Javadoc) Application Enablement Services Device, Media, and Call Control XML Programmer Guide (02-300358) Application Enablement Services Device, Media, and Call Control XML Programmer Reference (XMLdoc)
Setting up the Linux PC for remote access
Appendix B: Setting up for remote access (serial modem only)

This information is required if you have contracted with Avaya for maintenance and/or service. Avaya Services personnel require remote access to the Linux PC to install, administer, and maintain the AES server. This appendix includes the following topics.

Setting up the Linux PC for remote access on page 55 Setting up the client to dial in to the server on page 58
Remote access arrangement
Administration
inittab login.config pap-secrets ppp options options ttyname
AES Server
Linux ppp mgetty
PSTN
Windows

Setting up a Linux PC for remote access requires a modem and installing two software components (ppp and mgetty). This appendix describes how to install ppp and mgetty and how to configure the PC after you have installed these two software components.
Before You Begin

If you have a Linux PC with the default Red Hat Enterprise Linux software components already installed, the only additional requirements are as follows

Red Hat Enterprise Linux-compatible modem ppp -- Point-to-Point Protocol software mgetty -- a program that handles modem communications
55
Setting up for remote access (serial modem only)
Use this checklist to make sure you are ready to start.

You are logged in as root. You are at the command prompt. You have the complete Red Hat Enterprise Linux ES CD-ROM set on hand.
Installing the additional software components

From the command prompt, follow this procedure to install ppp and mgetty. 1. Insert the Red Hat Enterprise Linux Installation CD-ROM disk 2 into the CD-ROM drive, and type the following command to mount the file system: mount /mnt/cdrom/ 2. Type the following command to change to the directory containing the RPM packages: cd /mnt/cdrom/RedHat/RPMS 3. Type the following command to install ppp. rpm -i ppp-2.4.1-14.1.i386.rpm 4. Type the following command to install mgetty. rpm -i mgetty-1.1.30-3.i386.rpm This completes the procedure to install ppp and mgetty. Continue with Configuring the Linux PC on page 56.
Configuring the Linux PC

Once you have the installed necessary software, carry out the tasks described in the following sections to configure the Linux PC.

Editing the inittab file on page 57 Editing the login.config file on page 57 Editing the options.tty file on page 58 Checking the PPP options file on page 58 Editing the options.tty file on page 58 Note: All of these procedures assume that you are using a text editor such as vi or emacs.
Note:
Editing the inittab file

Edit the /etc/inittab file, and add one line for each modem you plan to use. For example:
S0:2345:respawn:/sbin/mgetty -D ttyS0
-D ttyS0
is the parameter for a data modem is the device identifier (Varies according to your hardware. For example, ttyS0 is associated with COM1 and ttyS1 is associated with COM2)
Editing the login.config file

Edit the /etc/mgetty+sendfax/login.config file by uncommenting the AutoPPP line and editing it to include a reference to the options file (by specifying file /etc/ppp/options), as shown below: /AutoPPP/ - a_ppp /usr/sbin/pppd file /etc/ppp/options
Editing the pap-secrets file

For PAP (Password Authentication Protocol) authentication, edit the /etc/ppp/pap-secrets file, so that it consists of one line containing the following characters: * * " " * For example:
# Secrets for authentication using PAP # client server secret * * *
IP address ""
These settings enable any registered user to log in. (Alternatively, you could specify user names, passwords and IP addresses.)
57
Checking the PPP options file

Check the /etc/ppp/options file and make sure the following options are specified. Table 3: PPP options lock -detach Creates a lock file that has exclusive access to a specific device. Prohibits the pppd process from forking and becoming a background process (this happens when a serial device is specified). Sets up the server to use modem control lines. The client waits for a signal from the modem before opening a serial device (default) behavior. You can change this handshake if necessary. Specifies hardware flow control. Lets the client appear as if it is on the same LAN as its peers. Prohibits the pppd process from setting up and using escape control sequences.
modem
crtscts proxyarp asyncmap 0
Editing the options.tty file

Edit the options file for the modem to include a <serverIP>:<clientIP> entry for each tty. For example if your modem is connected to ttys0, edit /etc/ppp/options.ttyS0 as follows (be sure to include the colon between the server IP address and the client IP address). The default <serverIP>:<clientIP> entry for each tty is: Server IP Client IP
192.168.25.10:192.168.25.20
Setting up the client to dial in to the server

This section contains some basic tips for setting up the two most frequently used clients:

Windows Linux
It also includes connection requirements, which apply to both.
Setting up the client to dial in to the server
Windows clients
From a Windows client, use Windows Dial-up Network Connections to establish a PPP connection to the AES server.
Linux clients
From a Linux client, use either the GNOME or KDE Dialer to establish a PPP connection to the AES server.
Connection Requirements
Verify the PPP connection requirements and administer accordingly, for example:
You may need to administer a login and password for the client connection. By default, no login and password are administered on the AES server. You will need to administer an IP address for the client connection. The default Client IP address is 192.168.25.20.
59
Appendix C: Configuring an LDAP server for Common User Service utilization

This appendix explains how to manually configure an LDAP Server for Common User Service utilization. These instructions assume that the target LDAP is an OPEN LDAP server of version 2.1.22-28 or later.
Prerequisites
the mvap-userservice RPM must be installed (the mvap-cusldap RPM is not needed) before you can configure the LDAP server. The mvap-userservice RPM was installed with the third-party RPMs when you installed the server software:
Configure the LDAP server

To manually configure your LDAP Server for Common User Service utilization: 1. Copy the mvapus schema file (mvapus.schema) from /var/mvap/config/cus to the LDAP schema directory (/etc/openldap/schema) 2. Edit the /etc/openldap/schema/core.schema file: a. Locate the userid attribute specification section. b. Add the following specification element: ORDERING caseIgnoreOrderingMatch after the EQUALITY caseIgnoreMatch line. c. Save the file. 3. Edit the /etc/openldap/slapd.conf file 4. Add the following include statement to the already existing set of \include statements: include /etc/openldap/schema/mvapus.schema 5. Note the suffix value used in the current slapd.conf file 6. Save and close the slapd.conf file.
61
Configuring an LDAP server for Common User Service utilization
7. Modify the init.ldif file to match the chosen organizationalUnit for the \users and the existing suffix used by the enterprise: a. Eliminate the first entry in the init.ldif file. b. Revise the second entry to reflect the desired organizationalUnit \(ex. ou=users) c. Revise the DN attribute of the next two entries to reflect the chosen organizationalUnit and suffix in use in the enterprise. 8. Save and close the init.ldif file. 9. Restart the LDAP server. 10. Use the ldapadd tool or equivalent to add the entries in the ldif.init file into the LDAP server: ldapadd -x -D bind credentials DN -W -f init.ldif
Create an LDAP User account

You must now create an LDAP user account for the User Service. This account must have privileges to add, modify, and delete avayauser class entries in the specified region of the Directory Information Tree (DIT). To create and administer an LDAP User account: 1. Open the /var/mvap/config/cus/user.properties file for editing 2. Edit he LDAP storage section to reflect the LDAP configuration work completed in Configure the LDAP server on page 61: a. Set the LDAP provider to the correct host and suffix combination. b. Set the userroot property to the suffix value in use. c. Set the principal to the DN of the LDAP you created in Configure the LDAP server on page 61. d. Set the password attribute to the generated encrypted value. Run /usr/share/tomcat5/webapps/axis/WEB-INF/lib/makepassword.sh against the plain text password furnished by the enterprise LDAP administrator for the User account you created. e. Set the orgunit property to the organizationalUnit selected for the user data space. 3. Save and close the modified user.properties file. 4. Make identical changes to the corresponding properties in the var/mvap/config/cus/ldapfilter.properties file.
Create an LDAP User account
5. If the User Service has not already been deployed by the relevant Tomcat/Axis server, then deploy the service: a. Make sure the Tomcat service is running. b. Go to: /usr/share/tomcat5/webapps/axis/WEB-INF/lib/ c. Run the org.apache.axis.client.AdminClient application against the cusdeploy.wsdd file. For example: java -classpath Axis jar files org.apache.axis.client.AdminClient cusdeploy.wsdd 6. Restart the Tomcat service that is the container for the User Service.
63
Configuring an LDAP server for Common User Service utilization
Appendix D: AE Services WAN requirements

The WAN requirements changed in AE Services 3.1 This section details the requirements for the customers network to support CTI links over a WAN/VLAN/LAN. These are links, connected via a WAN/VLAN/LAN, between the AE Services server machine and the CLAN(s) in a Communication Manager (CM).
No more than a 200ms average round trip packet delivery time as measured with ping over every one-hour time period Periodic spiked delays of no more than two seconds while maintaining the 200ms average ound trip delivery time as measured with ping over every one-hour time period
These requirements are to maintain the CTI link over a WAN/VLAN/LAN. If the implementation is going to issue route requests, then the associated "wait" step must always have a value greater than the largest "periodic spiked delay". With a maximum of 2 seconds allowed (as stated above) your wait step should be greater than 2 seconds. If you can guarantee "periodic spiked delays" less than 2 seconds, then you can reduce the wait step time-out accordingly. If no response to a route select is received by the switch, the call will follow the remaining vector steps in this specific vector. In other words, you will program the vector to deal with this condition. If you cannot guarantee "periodic spiked delays" of less than two seconds, then it is important to note the following condition: If you are using AE Services 3.1 and encounter "periodic spiked delays" greater than two seconds, then messages will either be:
Stored and retransmitted after recovering from a short network outage or
Dropped during a long network outage.
65
AE Services WAN requirements
Index
Index
A
administering CT users . . . . . . . . . . . . . . . . . H.323 Gatekeepers . . . . . . . . . . . . links . . . . . . . . . . . . . . . . . . . Security Database settings . . . . . . . . transport link connectivity . . . . . . . . . administration procedures AE Services . . . . . . . . . . . . . . . Communication Manager . . . . . . . . . AE Server machine minimum hardware specifications . . . . . AE Services uninstalling . . . . . . . . . . . . . . . . application link encryption, checking . . . . . application properties file for sample application Avaya Support Centre website . . . . . . . .
E
. . . . . . . . . . . . . . .
35 35 35 36 35 encryption application link . . . . . . . . . . . . . . . . . 36 Enter RPM URL screen . . . . . . . . . . . . . . . 22
F
files installed . . . . . . . . . . . . . . . . . . . . 26
. . . 35 . . . 33 . . . .11 . . . . . . . . . . . .
27 36 49 . 9
H
H.323 Gatekeepers administering . . . . . . . . . . . . . . . . . . 35
I
inittab file editing for remote access installation logs . . . . . . . installing AE Services license file . license file . . . . . . . updates and patches . . ISO image obtaining . . . . . . . .
C
checking application link encryption . . . . . . . Choose Installation Method screen . . . . . . . client setting up for remote access . . . . . . . . . client application machine . . . . . . . . . . . Communication Manager administration adding stations . . . . . . . . . . . . . . . checking for appropriate VOIP resources . . . checking for call control features . . . . . . . checking for IP_API_A licenses . . . . . . . configuring for signaling and media encryption setting up transport link . . . . . . . . . . . table of tasks . . . . . . . . . . . . . . . . connectivity testing OAM tests . . . . . . . . . . . . . . . Co-residency warning page . . . . . . . . . . . creating a user account . . . . . . . . . . . . CT users administering . . . . . . . . . . . . . . . .
. . . . . . . . . . . . 57 . . . . . . . . . . . . 27 . . . . . . . . . . . . 29 . . . . . . . . . . . . 29 . . . . . . . . . . . . 44 . . . . . . . . . . . . 19
. . 36 . . 23 . . 58 . . 14 . . . . . . . . . . . . . .
34 34 33 34 34 33 33
L
Last Chance to Abort screen . . . . . . LDAP configuring for Common User Service creating User account . . . . . . . . license file error messages . . . . . . . . . . . installing . . . . . . . . . . . . . . requesting . . . . . . . . . . . . . required information . . . . . . . . . troubleshooting . . . . . . . . . . . links administering . . . . . . . . . . . . Linux operating system . . . . . . . . . log files for sample application . . . . . . . . login.config file editing for remote access . . . . . .
. . . . . . 24 . . . . . . 61 . . . . . . 62 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
31 29 32 32 31
. . 37 . . 23 . . 35 . . 35
. . . . . . 35 . . . . . . 17 . . . . . . 53 . . . . . . 57
D
directories installed . . . . . . . . . . . . . . . . 26
67
Index
logs installation . . . . . . . . locating . . . . . . . . . upgrade . . . . . . . . . Loss of Data Warning screen screens Loss of Data Warning .
. . . . . . . . . . . 27 . . . . . . . . . . . 27 . . . . . . . . . . . 27 . . . . . . . . . . . 21
M
MAC address for WebLM . . . maintaining security . . . . . media files sample application . . . . media server requirements . . mgetty installing for remote access
. . . . . . . . . . . 32 . . . . . . . . . . . 47 . . . . . . . . . . . 50 . . . . . . . . . . . 15 . . . . . . . . . . . 56
remote access, (continued) installing mgetty . . . . installing ppp . . . . . setting up client . . . . setting up the Linux PC requirements AE Server machine . . media server . . . . . network characteristics PPP connection . . . . WAN . . . . . . . . .
. . . . . . . . .
. . . . . . . . .
. . . . . . . . .
. . . . . . . . .
. . . . . . . . .
. . . . . . . . .
. . . . . . . . .
. . . . . . . . .
. . . . . . . . .
. . . . . . . . .
. . . . . . . . .
. . . . . . . . .
. . . . . . . . .
56 56 58 55 11 15 15 59 65
S
sample application . . . . . . . . . application error messages . . . application properties file. . . . . log files . . . . . . . . . . . . . media files . . . . . . . . . . . running . . . . . . . . . . . . . troubleshooting . . . . . . . . . tutorial properties file . . . . . . screens Choose Installation Method screen Co-residency warning page . . . Enter RPM URL . . . . . . . . . Last Chance to Abort . . . . . . Optional Packages . . . . . . . Select Installation Media . . . . . Select Release Version screen . . status of the installation . . . . . successful completion . . . . . . secure configuration . . . . . . . . security . . . . . . . . . . . . . . Security Database settings administering . . . . . . . . . . Select Installation Media screen . . . Select Release Version screen . . . server software configuring . . . . . . . . . . . installing . . . . . . . . . . . . ISO image . . . . . . . . . . . obtaining ISO image . . . . . . . software platform . . . . . . . . . . software requirements third-party . . . . . . . . . . . . specifying NICs for AE Services . . . status of the installation screens . . . successful completion screen . . . .
N
network requirements for AE Services . . . . . . . . 15 NICs specifying for AE Services . . . . . . . . . . . . 35
. . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . .
38 53 49 53 50 52 53 51 23 23 22 24 24 21 22 25 26 10 47
O
Optional Packages screen . . . . . . . . . . . . . 24 options.tty file editing for remote access . . . . . . . . . . . . 58
P
packet delivery time . . . . . pap-secrets file editing for remote access . periodic spiked delays . . . . Ping Host . . . . . . . . . . PPP checking options file . . . connection requirements . installing for remote access prerequisites. . . . . . . . .
. . . . . . . . . . . 65 . . . . . . . . . . . 57 . . . . . . . . . . . 65 . . . . . . . . . . . 37 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
58 59 56 .11
. . . . . . . . 36 . . . . . . . . 21 . . . . . . . . 22 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
19 19 19 19 12 12 35 25 26
R
Red Hat Linux . . . . . . . . . remote access checking the PPP options file configuring the Linux PC . . editing inittab file . . . . . . editing login.config file . . . editing options.tty file . . . . editing pap-secrets file . . .
. . . . . . . . . . 17 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
58 56 57 57 58 57
Index
T
testing connectivity OAM tests . . . . . . . . . Ping Host . . . . . . . . . running sample application . test phone call . . . . . . . third-party software requirements toll fraud information . . . . . . transport link connectivity administering . . . . . . . . tutorial properties file for sample application . . . . tutorial.properties file . . . . . .
V
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
37 37 38 37 12 10 verification application running . . . . . . . . . . . . . . . . . . . . . 52 troubleshooting . . . . . . . . . . . . . . . . . 53
W
WAN requirements WebLM error messages page . . . . . Server . . . . troubleshooting
. . . . . . . . . . . . . . . . . 65 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
31 29 29 31
. . . . . . . . . . 35 . . . . . . . . . . 51 . . . . . . . . . . 51
U
uninstalling AE Services . . . . updates and patches Updating AES software . upgrade logs . . . . . upgrading from a CD . . . . . from a DVD . . . . from an ISO image . user account, creating .
. . . . . . . .
. . . . . . . .
. . . . . . . .
. . . . . . . .
. . . . . . . .
. . . . . . . .
. . . . . . . .
. . . . . . . .
. . . . . . . .
. . . . . . . .
. . . . . . . .
. . . . . . . .
. . . . . . . .
. . . . . . . .
27 45 44 27 42 41 42 35
69
Index

Avaya Multivantage

Uploaded by

Copyright:

Available Formats

Avaya Multivantage

Uploaded by

Document Information

Original Title

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

Avaya Multivantage

Uploaded by

Copyright:

Available Formats

Avaya MultiVantage Application Enablement Services

Installation Guide Software-Only Offer R3.1.2

02-300355 Issue 2.3 September 2006

Chapter 1: Prerequisites for AE Services . . . . . . . . . . . . . . . . . . . . . . . .

Issue 2.3 September 2006

Chapter 4: Installing licenses . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Chapter 5: Initial administration for AE Services . . . . . . . . . . . . . . . . . . . .

Chapter 6: Testing connectivity. . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Chapter 7: Upgrading and updating the AE Services software. . . . . . . . . . . . .

4 Application Enablement Services Installation Guide

Appendix B: Setting up for remote access (serial modem only) . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Appendix C: Configuring an LDAP server for Common User Service utilization . . .

Appendix D: AE Services WAN requirements . . . . . . . . . . . . . . . . . . . . . . Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Issue 2.3 September 2006

6 Application Enablement Services Installation Guide

About this Book

Summary of information in this book

Issue 2.3 September 2006

Conventions used in this documentation set

ASCII output Filenames/ pathnames Field names

Normal font Bold

Application Enablement Services documents

8 Application Enablement Services Installation Guide

Issue 2.3 September 2006

Related Communication Manager documents

Avaya security and toll fraud

10 Application Enablement Services Installation Guide

Chapter 1: Prerequisites for AE Services

AE Services server hardware requirements

Issue 2.3 September 2006

Prerequisites for AE Services

Platform and third-party software required for AE Services server

12 Application Enablement Services Installation Guide

Platform and third-party software required for AE Services server

Issue 2.3 September 2006

Prerequisites for AE Services

Client application machine requirements

14 Application Enablement Services Installation Guide

Communication Manager and media server requirements

Communication Manager and media server requirements

Required network characteristics

Issue 2.3 September 2006

Prerequisites for AE Services

Supported network configurations

Network interface speed and duplex settings

IP Migration Readiness and Optimization analysis

16 Application Enablement Services Installation Guide

Chapter 2: Installing the Linux platform software

Issue 2.3 September 2006

Installing the Linux platform software

18 Application Enablement Services Installation Guide

Chapter 3: Installing the server software and third-party software

We recommend that you select these options in the installation script.

Obtaining the server software ISO image

Installing and configuring the server software

Issue 2.3 September 2006

Installing the server software and third-party software

Running the AE Services installer

20 Application Enablement Services Installation Guide