Sei sulla pagina 1di 202

Avaya MultiVantage Application Enablement Services

Administration and Maintenance Guide Release 4.0.1

02-300357 Issue 7 July 2007

2005-2007 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 might be incorporated in future releases. 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 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 Avaya Support Web site: http://www.avaya.com/support License USE OR INSTALLATION OF THE PRODUCT INDICATES THE END USER'S ACCEPTANCE OF THE TERMS SET FORTH HEREIN AND THE GENERAL LICENSE TERMS AVAILABLE ON THE AVAYA WEB SITE http://support.avaya.com/LicenseInfo/ ("GENERAL LICENSE TERMS"). IF YOU DO NOT WISH TO BE BOUND BY THESE TERMS, YOU MUST RETURN THE PRODUCT(S) TO THE POINT OF PURCHASE WITHIN TEN (10) DAYS OF DELIVERY FOR A REFUND OR CREDIT. Avaya grants End User a license within the scope of the license types described below. The applicable number of licenses and units of capacity for which the license is granted will be one (1), unless a different number of licenses or units of capacity is specified in the Documentation or other materials available to End User. "Designated Processor" means a single stand-alone computing device. "Server" means a Designated Processor that hosts a software application to be accessed by multiple users. "Software" means the computer programs in object code, originally licensed by Avaya and ultimately utilized by End User, whether as stand-alone Products or pre-installed on Hardware. "Hardware" means the standard hardware Products, originally sold by Avaya and ultimately utilized by End User. License type(s) Designated System(s) License (DS). End User may install and use each copy of the Software on only one Designated Processor, unless a different number of Designated Processors is indicated in the Documentation or other materials available to End User. Avaya may require the Designated Processor(s) to be identified by type, serial number, feature key, location or other specific designation, or to be provided by End User to Avaya through electronic means established by Avaya specifically for this purpose. Concurrent User License (CU). End User may install and use the Software on multiple Designated Processors or one or more Servers, so long as only the licensed number of Units are accessing and using the Software at any given time. A "Unit" means the unit on which Avaya, at its sole discretion, bases the pricing of its licenses and can be, without limitation, an agent, port or user, an e-mail or voice mail account in the name of a person or corporate function (e.g., webmaster or helpdesk), or a directory entry in the administrative database utilized by the Product that permits one user to interface with the Software. Units may be linked to a specific, identified Server. Database License (DL). Customer may install and use each copy of the Software on one Server or on multiple Servers provided that each of the Servers on which the Software is installed communicate with no more than a single instance of the same database. CPU License (CP). End User may install and use each copy of the Software on a number of Servers up to the number indicated by Avaya provided that the performance capacity of the Server(s) does not exceed the performance capacity specified for the Software. End User may not re-install or operate the Software on Server(s) with a larger performance capacity without Avaya's prior consent and payment of an upgrade fee.

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. Third-party components Certain software programs or portions thereof included in the Product may contain software distributed under third party agreements ("Third Party Components"), which may contain terms that expand or limit rights to use certain portions of the Product ("Third Party Terms"). Information identifying Third Party Components and the Third Party Terms that apply to them is available on the Avaya Support Web site: http://support.avaya.com/ThirdPartyLicense/ Preventing toll fraud "Toll fraud" is the unauthorized use of your telecommunications system by an unauthorized party (for example, a person who is not a corporate employee, agent, subcontractor, or is not working on your company's behalf). Be aware that there can be a risk of toll fraud associated with your system and that, if toll fraud occurs, it can result in substantial additional charges for your telecommunications services. Avaya fraud intervention If you suspect that you are being victimized by toll fraud and you need technical assistance or support, call Technical Service Center Toll Fraud Intervention Hotline at +1-800-643-2353 for the United States and Canada. For additional support telephone numbers, see the Avaya Support Web site: http://www.avaya.com/support Trademarks Avaya and the Avaya logo are either registered trademarks or trademarks of Avaya Inc. in the United States of America and/or other jurisdictions. MultiVantage is a is a trademark of Avaya, Inc. DEFINITY is a registered trademark of Avaya, Inc. All other trademarks are the property of their respective owners. All other trademarks are the property of their respective owners. Downloading documents For the most current versions of documentation, see the Avaya Support Web site: http://www.avaya.com/support 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 Support Web site: http://www.avaya.com/support

Contents

About this document . . . . . . . . . . . . . . . . . . . . . . . . . . . .


Purpose. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Audience . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Reason for Reissue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Related documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . How to obtain these documents from the Web . . . . . . . . . . . . . . . Conventions Used in This Document . . . . . . . . . . . . . . . . . . . . . . . .

11
11 11 12 13 13 14

Chapter 1: Administering Communication Manager for AE Services . .


Determining if Communication Manager can support your AE Services configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . Device, Media, and Call Control capacities . . . . AE Server capacities . . . . . . . . . . . . . . Communication Manager resources . . . . . . VoIP capacities on Communication Manager . CLAN capacities on Communication Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

15
16 17 17 17 18 18 19 22 23 25 27 28 29 29 30 30 31 31 32 32 33 35 35 36 36 36 37 38

Summary of Communication Manager administrative tasks . . . . . . . . . . . . About administering network regions . . . . . . . . . . . . . . . . . . . . . Adding CLANs to the network . . . . . . . . . . . . . . . . . . . . . . . . . . . . Enabling AE Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Administering UCIDs in Communication Manager (TSAPI applications) . . . . . Setting up a CTI link . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Administering a CTI Link for a CVLAN application . . . . . . . . . . . . . . . Administering a CTI Link used for internal Avaya CVLAN applications . . . . Administering a CTI Link for an ASAI application . . . . . . . . . . . . . . . Administering a CTI Link for TSAPI, TR/87, JTAPI, Telephony Web Service, and Device, Media, and Call Control . . . . . . . . Checking the status of a Switch Connection -- from Communication Manager Device, Media, and Call Control settings. . . . . . . . . . . . . . . . Adding stations for Device, Media, and Call Control . . . . . . . Exclusive control mode . . . . . . . . . . . . . . . . . . . . . Shared control mode . . . . . . . . . . . . . . . . . . . . . . Setting up a network region for Device, Media, and Call Control About Telecommuter Mode . . . . . . . . . . . . . . . . . . . Creating the Device, Media, and Call Control codec set . . . Administering a region with a specific codec set . . . . . . . About signaling encryption . . . . . . . . . . . . . . . . . . . Administering security profiles for signaling encryption . . . Checking for media encryption . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Issue 7 July 2007

Contents

Adding the Device, Media, and Call Control softphones to the network region Adding a media gateway to the network . . . . . . . . . . . . . . . . . . . . . Consulting the Communication Manager documentation . . . . . . . . . Adding a media processor circuit pack to the network . . . . . . . . . . . . . Administering an example Device, Media, and Call Control configuration . . Sample Communication Manager administration screens . . Setting up UCIDs for TSAPI applications . . . . . . . . . Checking for IP_API_A licenses . . . . . . . . . . . . . . Adding stations . . . . . . . . . . . . . . . . . . . . . . . Configuring IP services - administering the transport link Setting up a codec set. . . . . . . . . . . . . . . . . . . . Administering a network region . . . . . . . . . . . . . . Mapping IP addresses (for API softphones) . . . . . . . . Adding a media gateway . . . . . . . . . . . . . . . . . . Adding a CLAN. . . . . . . . . . . . . . . . . . . . . . . . Listing IP interfaces . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

39 39 39 40 41 43 44 45 46 48 49 50 52 53 54 57

Chapter 2: AE Services OAM Administration and CTI OAM Admin . . .


About the OAM Web pages . . . . . . . . . . . . . . . . Before you access the OAM Web pages . . . . . . . If you use Microsoft Internet Explorer . . . . . . Logging in to OAM . . . . . . . . . . . . . . . . . OAM administrative accounts . . . . . . . . . . . . CTI OAM Admin . . . . . . . . . . . . . . . . . . User Management . . . . . . . . . . . . . . . . . Determining which services you are licensed to use . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

59
59 60 60 60 61 61 61 62 63 64 68 68 68 69 69 69 71 72 73 75 76 76

General CTI OAM Administration . . . . . . . . . . . . . . . . . . . . . . . . . . . Summary of AE Server CTI OAM administrative tasks . . . . . . . . . . . . . Administering Network Connections. . . . . . . . . . . . . . . . . . . . . NIC Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Editing the NIC configuration . . . . . . . . . . . . . . . . . . . . . Encrypted and Unencrypted DMCC Server ports . . . . . . . . . . DMCC Configuration. . . . . . . . . . . . . . . . . . . . . . . . . . Administering TCP ports on the AE Server and firewall settings . Administering the Local IP for all AE Services . . . . . . . . . . . . . Administering AE Services with CVLAN and using the Any setting Administering Switch Connections . . . . . . . . . . . . . . . . . . . Checking the status of a switch connection -- from the AE Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Link Administration - CTI Link Admin in AE Services OAM . . . . . . . . . . . . Administering CVLAN Links in AE Services OAM. . . . . . . . . . . . . . . .

4 AE Services Administration and Maintenance Guide, Release 4.0.1

Contents

Testing a CVLAN Link . . . . . . . . . . . . . . . . . . . Adding CVLAN Clients . . . . . . . . . . . . . . . . . . CVLAN implementation guidelines . . . . . . . . . . . . CVLAN applications and link management . . . . . Guidelines for setting up CVLAN Links . . . . . . . Guidelines for setting up proprietary CVLAN Links . Administering DLG Links in AE Services OAM . . . . . Administering TSAPI Links in AE Services OAM . . . .

. . . . . . . .

. . . . . . . .

. . . . . . . .

. . . . . . . .

. . . . . . . .

. . . . . . . .

. . . . . . . .

. . . . . . . .

. . . . . . . .

. . . . . . . .

. . . . . . . .

. . . . . . . .

77 78 78 78 78 79 79 80 81 82 83 84 87 89

Backing up the database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Restoring the database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Downloading and viewing log files . . . . . . . . . . . . . . . . . . . . . . . . . . Using the Service Controller . . . . . . . . . . . . . . . . . . . . . . . . . . . . . About stopping services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Changing the IP address of the AE Server. . . . . . . . . . . . . . . . . . . . . .

Chapter 3: OAM User Management Administration . . . . . . . . . . . .


Account set up . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . User Management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . AE Services that rely on User Management for authentication . . . . . . . . User Management - summary of features . . . . . . . . . . . . . . . . . . . . . . Logging in to User Management . . . . . . . . . . . . . . . . . . . . . . . . . Setting up the CTI OAM administrator as the User Management administrator List All Users . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Adding a user to the AE Services User Service database . . . . . . . . . . . Edit User . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Delete User . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Search Users . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Search tips . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Modify Default User . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Change User Password . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . If your password change is successful . . . . . . . . . . . . . . . . . . . If your password change is unsuccessful . . . . . . . . . . . . . . . . . . Service Management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Editing the Service Configuration . . . . . . . . . . . . . . . . . . . . . . . . defaultuservalues.properties . . . . . . . . . . . . . . . . . . . . . . . . . attributesmap.properties . . . . . . . . . . . . . . . . . . . . . . . . . . . attributeacl.properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . sdbdistributor.properties . . . . . . . . . . . . . . . . . . . . . . . . . . . genericldap1.properties, genericldap2.properties, replicator1.properties.

91
91 92 92 93 93 93 94 95 95 96 96 96 97 98 98 98 99 100 100 100 101 101 101

Issue 7 July 2007

Contents

rbac.properties . . . . . . . . . . . . . . . . . . . . . ldapfilter.properties . . . . . . . . . . . . . . . . . . remoteldapauthenticator.properties . . . . . . . . . user.properties . . . . . . . . . . . . . . . . . . . . . ws_cus_bootstrap.properties . . . . . . . . . . . . . Re-initializing the User Service . . . . . . . . . . . . . . Edit Service Configuration - default user values file Downloading and viewing Service Log files . . . . . . . Managing Distributors . . . . . . . . . . . . . . . . . .

. . . . . . . . .

. . . . . . . . .

. . . . . . . . .

. . . . . . . . .

. . . . . . . . .

. . . . . . . . .

. . . . . . . . .

. . . . . . . . .

. . . . . . . . .

. . . . . . . . .

. . . . . . . . .

. . . . . . . . .

101 102 102 102 102 103 103 104 105

Chapter 4: TSAPI Configuration and the Security Database . . . . . . .


Applications that use the Security Database . . . . . . . . . . . . . . . . . . . . TSAPI Configuration Settings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . About Granting Additional Permissions . . . . . Extending User Access to Other Worktops . If Extended Worktop Access is Disabled. Access Rights options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

107
108 108 110 111 111 112 113 113 116 116 117 118 119 119 120 120 120 121 121 122 123 124 125 126 126 126 126 127 128

Security Database objects . . . . . . . . . . . . . . . . . . . . CTI Users . . . . . . . . . . . . . . . . . . . . . . . . . . . . Changes to User Permissions . . . . . . . . . . . . . . Worktops . . . . . . . . . . . . . . . . . . . . . . . . . . . . Devices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Device Groups . . . . . . . . . . . . . . . . . . . . . . . . . Tlinks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Format of a Tlink name . . . . . . . . . . . . . . . . . . Tlink Groups . . . . . . . . . . . . . . . . . . . . . . . . . . How Tlinks and Tlink Groups are Used . . . . . . . . . Associating a Device with a Tlink (Switch Connection). Sample SDB Administration scenario . . . . . Procedure to add a Tlink Group . . . . . . Procedure to add a Device to the SDB . . . Procedure to add a Device Group . . . . . Procedure to add a Worktop . . . . . . . . Procedure to administer CTI User settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Setting up a permission scheme based on access rights - a sample scenario Initial Settings for the sample Help Desk group . . . . . . . . . . . . . . . Defining the capabilities of members of the Help Desk . . . . . . . . . . . Implementing the Help Desk . . . . . . . . . . . . . . . . . . . . . . . . . Creating a Worktop for each user . . . . . . . . . . . . . . . . . . . . Creating a Device Group called Help Desk. . . . . . . . . . . . . . . .

6 AE Services Administration and Maintenance Guide, Release 4.0.1

Contents

Administering Edwards user profile with greater privileges . . . . . . . . Verifying the Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Sample Configurations . . . . . . . . . . . . . . . . . Setting access privileges . . . . . . . . . . . . . . Manager/Assistant Configuration. . . . . . . . Call Monitoring Application . . . . . . . . . . . Portion of User Community Shares Worktops. Prompted Digits . . . . . . . . . . . . . . . . . Call Routing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

129 129 130 130 131 132 133 135 136

Chapter 5: Alternative AE Services Authentication Methods . . . . . .


About this chapter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . About AE Services user authentication . . . . . . . . . . . . . . . . . . . . . . . Using the User Service for authentication . . . . . . . . . . . . . . . . . . . . . . Using Linux for authentication . . . . . . . . . . . . . . . . . . . . . . . . . . . . Instating the Linux PAM file . . . . . . . . . . . . . . . . . . . . . . . . . . . . Re-instating the User Service PAM file . . . . . . . . . . . . . . . . . . . . . . Using Microsoft Active Directory Services for AE Services Authentication. . . . Integrating AE Services with ADS -- a process overview . . . . . . . . . . . . Creating an account for the AE Server on the Domain Controller . . . . . . . Generating a keytab file for the AE Server account on the Domain Controller Installing the Kerberos5 RPMs on the AE Server . . . . . . . . . . . . . . . . Editing the Kerberos 5 configuration file on the AE Server . . . . . . . . . . Importing the keytab file on the AE Server . . . . . . . . . . . . . . . . . . . Changing from User Service Authentication to Active Directory Authentication on the AE Server . . . . . . . . . . . . . . . . . . . . . . . .

137
137 138 138 139 139 140 140 141 141 142 142 143 144 144

Chapter 6: Administering AE Services from the Operating System Command Prompt. . . . . . . . . . . . .


Adding a Linux user and setting the OAM account password . . . . . . . . . . . System logins and passwords . . . . . . . . . . . . . . . . . . . . . . . . . . . . For information about AE Services security . . . . . . . . . . . . . . . . . Using Tripwire . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Reconfiguring the Tripwire database for administrative access . Routine administrative tasks for Tripwire . . . . . . . . . . . . . Running an integrity check . . . . . . . . . . . . . . . . . . . Printing reports . . . . . . . . . . . . . . . . . . . . . . . . . Updating the Tripwire database. . . . . . . . . . . . . . . . . Starting and Stopping Tripwire . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

145
146 147 148 149 149 150 150 150 150 151 152

Using the dateconfig utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Issue 7 July 2007

Contents

Setting the date or time . . . . . . . . . . . . . . . . . . . . . . . . . . . . Changing an NTP Server . . . . . . . . . . . . . . . . . . . . . . . . . . . AE Services Tools and Linux commands . . AE Services Linux based capabilities . . dateconfig . . . . . . . . . . . . . . . makecert.sh . . . . . . . . . . . . . . mvap.sh. . . . . . . . . . . . . . . . . netconfig . . . . . . . . . . . . . . . . swversion. . . . . . . . . . . . . . . . Linux commands . . . . . . . . . . . . . df . . . . . . . . . . . . . . . . . . . . ethtool . . . . . . . . . . . . . . . . . route . . . . . . . . . . . . . . . . . . scp and sftp . . . . . . . . . . . . . . service <name> start/stop/restart. . . shutdown -r now . . . . . . . . . . . . ssh . . . . . . . . . . . . . . . . . . . tethereal . . . . . . . . . . . . . . . . tripwire . . . . . . . . . . . . . . . . . Installation and upgrade logs and RPMs. Directory structure and file locations . . postgres data files . . . . . . . . . . . External scripts . . . . . . . . . . . . Environment variables. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

153 153 155 155 155 155 155 156 157 158 158 158 158 159 159 159 159 159 160 160 161 161 161 161 162 162 162

AE Services Disk Partitioning Scheme. . . . . . . . . . . . . . . . . . . . . . . . Partitioning after an upgrade . . . . . . . . . . . . . . . . . . . . . . . . . . . Guidelines for creating directories . . . . . . . . . . . . . . . . . . . . . . . .

Chapter 7: Administering SNMP . . . . . . . . . . . . . . . . . . . . . .


Before you begin - SNMP Basics . . . . . . . . . . . . . . . . . . . . . . . . . . . Setting up the AE Server in an SNMP network . . . . . . . . . . . . . . . . . . About sending traps to an Avaya SSG . . . . . . . . . . . . . . . . . . . . . If you do not have the SAC Offer . . . . . . . . . . . . . . . . . . . . . . If you provide Technical Services with modem access to the AE Server Administering AE Services to send NMS and SSG Traps . . . . . . . . . . About using AES 192 and AES 256 . . . . . . . . . . . . . . . . . . . . . Testing SNMP Traps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

163
163 164 164 164 164 165 167 167 168 169 170

How AE Services tracks alarms . . . . . . . . . . . . . . . . . . . . . . . . . . . Working with alarm reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . AE Services alarm codes and messages . . . . . . . . . . . . . . . . . . . .

8 AE Services Administration and Maintenance Guide, Release 4.0.1

Contents

Appendix A: Locations of AE Services log files. . . . . . . . . . . . . .


Device, Media, and Call Control Service . . . . . . . . . . . . . . . . . . . . . . . DLG Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . CVLAN Service. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . TSAPI Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Telephony Web Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . System Management System Web Service . . . . . . . . . . . . . . . . . . . . . User Web Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

171
171 172 172 173 173 173 174

Appendix B: Avaya Computer Telephony and CVLAN migration . . . .


TSAPI Client settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Migrating Avaya Computer Telephony Users to AE Services . . . . . . . . . . . Procedure to migrate the Avaya Computer Telephony SDB to AE Services . Adding users . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Alternative Migration Strategies for Avaya Computer Telephony Avaya Computer Telephony Bronze Level Integration . . . . How bronze-level integration works . . . . . . . . . . . . Avaya Computer Telephony Silver Level Integration . . . . . How silver-level integration works . . . . . . . . . . . . . Avaya Computer Telephony Gold Level Integration . . . . . How gold-level integration works. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

175
175 176 176 179 180 180 180 182 182 184 184 186 186 188

Migrating CVLAN to AE Services . . . . . . . . . . . . . . . . . . . . . . . . . . . Migrating CVLAN Server for Linux (Releases 9.0 and 9.1) to AE Services . . Migrating the MAPD-based CVLAN to AE Services . . . . . . . . . . . . . . .

Glossary Index

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

191 199

Issue 7 July 2007

Contents

10 AE Services Administration and Maintenance Guide, Release 4.0.1

Purpose

About this document


This document describes administrative tasks for Avaya MultiVantage Application Enablement Services (AE Services). This section, About this document, includes the following topics:

Purpose on page 11 Audience on page 11 Related documents on page 13 Conventions Used in This Document on page 14

Purpose
The purpose of this document is to provide a common reference for basic Application Enablement Services (AE Services) administrative tasks. It includes the following administrative interfaces:

Communication Manager administration from a System Administration Terminal (SAT) AE Services OAM (Operations, Administration, and Maintenance) Web-based administration Linux administration from the command prompt on the AE Services Server (AE Server)

Audience
This document is intended for a general administrative audience or anyone who is involved with the administration of an AE Services configuration.

Issue 7 July 2007

11

About this document

Reason for Reissue


The AE Services Administration and Maintenance Guide, for Release 4.0.1, is reissued to include information about the following components

Tripwire - This information applies to the Bundled Server only. For administrative access to the Tripwire database, you must manually reinstall and reconfigure it. For more information, see Using Tripwire on page 149 dateconfig - The dateconfig utility lets you configure date and time settings. For more information, see dateconfig on page 155.

12 AE Services Administration and Maintenance Guide, Release 4.0.1

Related documents

Related documents
The following documents contain additional information about Communication Manager and AE Services.

Administrator Guide for Avaya Communication Manager, 03-300509 Administration for Network Connectivity for Avaya Communication Manager, 555-233-504 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 Overview, 02-300360 Avaya MultiVantage Application Enablement Services Documentation Road Map, 02-300361 Avaya MultiVantage Application Enablement Services Implementation Guide for Microsoft Live Communications Server, 02-601893 If you are administering AE Services and Microsoft Live Communications Server you will need to use the AE Services Administration and Maintenance Guide (the document you are currently reading) as well as the AE Services Implementation Guide for Microsoft Live Communications Server. - Use the AE Services Administration and Maintenance Guide to administer Communication Manager for AE Services and to administer AE Services for Communication Manager. - Use the AE Services Implementation Guide for Microsoft Live Communications Server to administer Live Communications Server for AE Services and to administer AE Services for Live Communications Manager. For more information, see TR/87 (AE Services and Microsoft Live Communications Server integration) on page 67.

How to obtain these documents from the Web


Documents are available in Portable Document Format (.pdf) as follows:

You can find all documents listed in Related documents on the Avaya Support Centre Web Site (http://www.avaya.com/support).

Issue 7 July 2007

13

About this document

Conventions Used in This Document


The following conventions are used throughout this document. Convention bold monospace Example add station Usage Communication Manager System Administration Terminal (SAT), and AE Services Linux command line interface. Bold monospace indicates that you input (type) characters exactly as depicted. Communication Manager SAT, and AE Services Linux command line interface. Italic monospace indicates that you input (type) an appropriate substitution for the term in italics. Angle brackets are used as visual cues, do not type them. Communication Manager SAT, and AE Services Linux command line interface. Plain monospace indicates standard output from the SAT display or command prompt. AE Services OAM interface. Bold can indicate the following: Mouse and keyboard selections Web page displays Text type in a text box or a selection you make from a drop-down list. AE Services OAM interface. Bold italic indicates that you input (type) an appropriate substitution for the term in italics.

italic monospace in angle brackets

<modname>

plain monospace

Port:

bold

Start

bold italic

service name

14 AE Services Administration and Maintenance Guide, Release 4.0.1

Chapter 1: Administering Communication Manager for AE Services


This chapter describes tasks that must be performed on Avaya Communication Manager to ensure that Communication Manager can communicate with the services running on the Application Enablement Services Server (AE Server). This chapter includes the following main topics:

Determining if Communication Manager can support your AE Services configuration on page 16 Device, Media, and Call Control capacities on page 17 Summary of Communication Manager administrative tasks on page 19 Adding CLANs to the network on page 23 Enabling AE Services on page 25 Setting up a CTI link on page 28 Device, Media, and Call Control settings on page 31

Issue 7 July 2007

15

Administering Communication Manager for AE Services

Determining if Communication Manager can support your AE Services configuration


Before you start the tasks in this chapter, follow this procedure to determine if Communication Manager has the level of licensing required to support your configuration. 1. Log in to Communication Manager. Type display system-parameters customer options and browse through the Optional Features screens. Use Table 1 to make sure that the features you need are enabled. 2. If the features you need are not enabled, contact your Avaya representative to contract for those features. Table 1: Communication Manager feature checklist Feature enabled on CM AE Service Required DLG ASAI Core

Optional ASAI Plus CTI Stations Phantom Calls Increase Adjunct Routes ASAI Plus CTI Stations Phantom Calls Increase Adjunct Routes

CVLAN Non-Avaya applications

ASAI Core

CVLAN Avaya applications TSAPI/JTAPI Telephony Web Service Device, Media, and Call Control with Single-Step Conference and Snapshot Services (Snapshot Call and Snapshot Device) Device, Media, and Call Control with device and media control only

Computer Telephony Adjunct Link Computer Telephony Adjunct Link None None

Increase Adjunct Routes Increase Adjunct Routes None Increase Adjunct Routes

None

None

16 AE Services Administration and Maintenance Guide, Release 4.0.1

Device, Media, and Call Control capacities

Device, Media, and Call Control capacities


Compare the capacities listed in AE Server capacities with the capacities listed in Communication Manager resources to make sure that you have adequate Communication Manager resources for a given Device, Media, and Call Control implementation.

AE Server capacities
Per AE Server, the Device, Media, and Call Control capacities are as follows:

Exclusive Control - Server Media Configuration using G.711 Codec - 75 simultaneous sessions (calls). Exclusive Control - Server Media Configuration using G.729 Codec - 120 simultaneous sessions (calls). Exclusive Control - Client Media Configuration 1000 simultaneous sessions (calls). Exclusive Control Telecommuter Mode 1000 simultaneous sessions (calls). Shared Control 1000 simultaneous sessions (calls).

Communication Manager resources


Component Capacity

VoIP capacity - For each IP endpoint in the call, including AE Services endpoints, either one VoIP channel will be used (with a G.711 codec) or two VoIP channels will be used (with a G.729 codec) TN2302 media processor card TN2602 Crossfire media processor card MM760 VoIP card G700 media gateway motherboard VoIP G350 media gateway motherboard VoIP 64 channels 320 channels 64 channels 64 channels 32 channels

CLAN capacity - CLAN resources handle H.323 signaling traffic TN799DP CLAN card 400 Device, Media, and Call Control station registrations

Note:

Note: Using encryption can reduce capacities by 15%.

Issue 7 July 2007

17

Administering Communication Manager for AE Services

VoIP capacities on Communication Manager


The VoIP capacity of the Device, Media, and Call Control Service is based on the VoIP capacities of the following Communication Manager components:

TN2302 media processor card - 64 channels TN2602 Crossfire media processor card - 320 channels MM760 VoIP card - 64 channels G700 media gateway motherboard VoIP - 64 channels G350 media gateway motherboard VoIP - 32 channels

For each IP endpoint in the call (including AE Services endpoints), either one VoIP channel will be used (when using a G.711 codec) or two VoIP channels will be used (when using a G.729 codec).

CLAN capacities on Communication Manager


CLAN resources handle H.323 signaling traffic.

TN799DP CLAN card - 400 Device, Media, and Call Control station registrations

18 AE Services Administration and Maintenance Guide, Release 4.0.1

Summary of Communication Manager administrative tasks

Summary of Communication Manager administrative tasks


The following table provides a per-client summary of Communication Manager administrative tasks. For a high-level illustration of connectivity between Communication Manager and the AE Server, see AE Services -- dependencies at a glance on page 86. Table 2: Per-client summary of Communication Manager administrative tasks
Client Device, Media, and Call Control applications that do not use Call Information Services, Call Control or Snapshot Services Communication Manager administration tasks Add CLAN (or CLANs) If you use a media server that uses CLANs you must add CLANs to the network. See Adding CLANs to the network on page 23. See Adding stations for Device, Media, and Call Control on page 32. If an application uses shared control, you do not need to administer a station for the application. Requires network planning. See Setting up a network region for Device, Media, and Call Control on page 35. See Adding the Device, Media, and Call Control softphones to the network region on page 39. See Adding a media gateway to the network on page 39. See Adding a media processor circuit pack to the network on page 40. If you use a media server that uses CLANs you must add CLANs to the network. See Adding CLANs to the network on page 23. See Adding stations for Device, Media, and Call Control on page 32. If an application uses shared control, you do not need to administer a station for the application. Requires network planning. See Setting up a network region for Device, Media, and Call Control on page 35. See Adding the Device, Media, and Call Control softphones to the network region on page 39. See Adding a media gateway to the network on page 39. See Adding a media processor circuit pack to the network on page 40.

Add stations

Set up a network region

Add Device, Media, and Call Control softphones to the network region Add a media gateway to the network Add a media processor Device, Media, and Call Control applications that do not use Call Information Services, Call Control or Snapshot Services but do use a switch name for round-robin assignment of H.323 Gatekeepers. Add CLAN (or CLANs)

Add stations

Set up a network region

Add Device, Media, and Call Control softphones to the network region Add a media gateway to the network Add a media processor

1 of 3

Issue 7 July 2007

19

Administering Communication Manager for AE Services

Table 2: Per-client summary of Communication Manager administrative tasks (continued)


Device, Media, and Call Control applications that do use Call Information Services but do not use Call Control or Snapshot Services Add CLAN (or CLANs) If you use a media server that uses CLANs you must add CLANs to the network. See Adding CLANs to the network on page 23. Required for the transport layer. See Enabling AE Services on page 25. See Adding stations for Device, Media, and Call Control on page 32. If an application uses shared control, you do not need to administer a station for the application. Requires network planning. See Setting up a network region for Device, Media, and Call Control on page 35. See Adding the Device, Media, and Call Control softphones to the network region on page 39. See Adding a media gateway to the network on page 39. See Adding a media processor circuit pack to the network on page 40. If you use a media server that uses CLANs you must add CLANs to the network. See Adding CLANs to the network on page 23. Required for the transport layer. See Enabling AE Services on page 25. Device, Media, and Call Control applications that use Call Control (Single-Step Conference) or Snapshot Services (Snapshot Call or Snapshot Device) require a CTI Link. See Administering a CTI Link for TSAPI, TR/87, JTAPI, Telephony Web Service, and Device, Media, and Call Control on page 30. Requires network planning. See Setting up a network region for Device, Media, and Call Control on page 35. See Adding the Device, Media, and Call Control softphones to the network region on page 39. See Adding a media gateway to the network on page 39. See Adding a media processor circuit pack to the network on page 40.

Enable AE Services Add stations

Set up a network region

Add Device, Media, and Call Control softphones to the network region Add a media gateway to the network Add a media processor Device, Media, and Call Control applications that use Call Control or Snapshot Services. NOTE: These Device, Media, and Call Control applications do not need to administer a station, but they do need to administer a CTI Link. Add CLAN (or CLANs)

Enable AE Services Add a CTI Link

Set up a network region

Add Device, Media, and Call Control softphones to the network region Add a media gateway to the network Add a media processor

2 of 3

20 AE Services Administration and Maintenance Guide, Release 4.0.1

Summary of Communication Manager administrative tasks

Table 2: Per-client summary of Communication Manager administrative tasks (continued)


Telephony Web Service Add CLAN (or CLANs) If you use a media server that uses CLANs you must add CLANs to the network. See Adding CLANs to the network on page 23. Required for the transport layer. See Enabling AE Services on page 25. See Administering a CTI Link for TSAPI, TR/87, JTAPI, Telephony Web Service, and Device, Media, and Call Control on page 30. If you use a media server that uses CLANs you must add CLANs to the network. See Adding CLANs to the network on page 23. Required for the transport layer. See Enabling AE Services on page 25. See Administering a CTI Link for TSAPI, TR/87, JTAPI, Telephony Web Service, and Device, Media, and Call Control on page 30. If you use a media server that uses CLANs you must add CLANs to the network. See Adding CLANs to the network on page 23. Required for the transport layer. See Enabling AE Services on page 25. See Administering a CTI Link for TSAPI, TR/87, JTAPI, Telephony Web Service, and Device, Media, and Call Control on page 30. If you use a media server that uses CLANs you must add CLANs to the network. See Adding CLANs to the network on page 23. Required for the transport layer. See Enabling AE Services on page 25. SeeAdministering a CTI Link for a CVLAN application on page 29 and Administering a CTI Link used for internal Avaya CVLAN applications on page 29. If you use a media server that uses CLANs you must add CLANs to the network. See Adding CLANs to the network on page 23. Required for the transport layer. See Enabling AE Services on page 25. See Administering a CTI Link for an ASAI application on page 30.

Enable AE Services Add a CTI Link

JTAPI

Add CLAN (or CLANs)

Enable AE Services Add a CTI Link

TSAPI

Note: For AE Services TR/87 Implementation administer Communication Manager as you would for TSAPI.

Add CLAN (or CLANs)

Enable AE Services Add a CTI Link

CVLAN

Add CLAN (or CLANs)

Enable AE Services Add a CTI Link

DLG (ASAI based applications)

Add CLAN (or CLANs)

Enable AE Services Add a CTI Link

3 of 3

Issue 7 July 2007

21

Administering Communication Manager for AE Services

About administering network regions


When you administer a CLAN for AE Services, you must assign a network region based on your AE Services configuration. For example, if you are using Device, Media, and Call Control, you might need to assign more than one network region. For more information about administering network regions, see the following documents.

Administration for Network Connectivity for Avaya Communication Manager, 555-233-504. See the Network quality administration chapter. Administrator Guide for Avaya Communication Manager, 03-300509. See IP Network Region in the Screen Reference chapter. Avaya Communication Manager Network Region Configuration Guide

22 AE Services Administration and Maintenance Guide, Release 4.0.1

Adding CLANs to the network

Adding CLANs to the network


If you are using a media server that uses CLANs, you must add the CLANs to the Communication Manager network.

!
Important:

Important: All CLANs dedicated to AE Services should be in a separate network region. CLANs that provide connectivity for other endpoints should be in another network region.

Note:

Note: This example assumes a simple configuration with one network region. Some configurations will require more network regions, see About administering network regions on page 22. 1. Type change node-names ip. Communication Manager displays the IP NODE NAMES form. For an example, see Adding a CLAN - change node-names ip on page 55. 2. Complete the following fields on the IP NODE NAMES form.

Follow this procedure to add CLANs for AE Services.

In the Name field, type the name you want to assign to this CLAN, for example CLAN1. In the IP Address field, type the IP address you want to assign to this CLAN.

3. Type add ip-interface <board location> (where <board location> is the board location for the CLAN, for example: 1A06). Communication manager displays the IP INTERFACES form. For an example, see Adding a CLAN IP interface on page 55.

Issue 7 July 2007

23

Administering Communication Manager for AE Services

4. Complete the following fields on the IP INTERFACES form.


In the Node Name field, type <CLAN name>, for example CLAN1. In the IP Address field, accept the default. In the Subnet Mask field, type the appropriate subnet mask for your network configuration. In the Gateway Address field, type the gateway address for your network configuration. In the Enable Ethernet Port field, type y. In the Network Region field, type 1. In the VLAN field, accept the default. In the Number of CLAN Sockets Before Warning field, accept the default. In the Auto field, type y.

5. Type add data-module next. Communication Manager displays the DATA MODULE form. For an example, see Adding a CLAN - add data-module on page 54. 6. Complete the following fields on the DATA MODULE form.

In the Data Extension field, type the next available data extension. (Required) In the Type field, type ethernet. (Required) In the Port field, type the board location and port 17, for example 1D07017. In the Name field type the name you want to assign to the data module, for example: CLAN1DATA. This name is not used for further administration. It is a name you use to help you identify the data module. In the Network uses 1s for Broadcast addresses field, type y .

24 AE Services Administration and Maintenance Guide, Release 4.0.1

Enabling AE Services

Enabling AE Services
Enabling AE Services refers to administering the transport link between Communication Manager and AE Services. You need to enable AE Services services for the following applications. For more information, see Summary of Communication Manager administrative tasks on page 19.

Device, Media, and Call Control applications that use Call Information Services Device, Media, and Call Control applications that use Call Control and Snapshot Services Telephony Web Service JTAPI TSAPI CVLAN DLG (ASAI applications)

Follow this procedure to enable AE Services. 1. Type change ip-services. Communication manager displays the IP SERVICES form. For an example, see Configuring IP services on page 48 2. Complete Page 1 of the IP SERVICES form, as follows:

In the Service Type field, type AESVCS. In the Local Node field type the appropriate entry, as follows: - On an S8300 only, type procr. - On all other systems, type <nodename> (where <nodename> is the name of the CLAN board you will use on an 8500, 8700, or DEFINITY Server Csi. You can locate node names by typing display node-names ip and checking the Local Node field on the IP NODE NAMES form.

In the Local Port field, accept the default (8765).

Note:

Note: If you are adding more than one CLAN for AE Services, repeat Step 2 for each CLAN you add. 3. Complete Page 3 of the IP SERVICES form (the AE Services Administration screen), as follows. For an example, see Configuring IP services - AE Services Administration on page 48.

In the AE Services Server field, type the <name> of the AE Server, for example aeserver1.

Issue 7 July 2007

25

Administering Communication Manager for AE Services

Note:
Note:

On the AE Server you can obtain this name by typing uname -n at the command prompt. The name you use on Communication Manager must match the AE Server name exactly.

In the Password field, create a password that consists of 12 to 16 alphanumeric characters, for example aespassword1.
This is the password that the AE Services CTI OAM Administrator must set on the AE Server (Administration > Switch Connections > Edit Connection > Set Password). The passwords must exactly match on both Communication Manager and the AE Server. (CTI stands for Computer Telephony Integration, and OAM stands for Operations, Administration, and Maintenance).

Note:
Note:

Set the Enabled field to y.

26 AE Services Administration and Maintenance Guide, Release 4.0.1

Administering UCIDs in Communication Manager (TSAPI applications)

Administering UCIDs in Communication Manager (TSAPI applications)


TSAPI applications that use predictive dialing must administer the following settings in Communication Manager.

Enable the setting for creating UCIDs. Select the node number for the switch (if you have only one switch you can select 1; if you have internetworked switches, each switch must have a unique node id). Enable the setting for sending the UCID to ASAI.

Follow this procedure to administer UCIDs in Communication Manager. Keep in mind that page numbers can vary with each switch release. 1. Type change system-parameters features . 2. Complete the following fields on the FEATURE-RELATED SYSTEM PARAMETERS form: a. In the Create Universal Call ID (UCID) field , type y (Page 5). b. In the UCID Network Node ID field, type a node number that is unique to this switch in a network of switches. 3. In the Send UCID to ASAI field, type y (page 12). 4. Submit the changes. For examples of administrative screens, see the following diagrams:

Setting up UCIDs for TSAPI applications - create a UCID and assign a Node ID on page 44 Setting up UCIDs for TSAPI applications - send UCID to ASAI must be enabled on page 44

There is no charge to use these features, and they do not require any RFA (Remote Feature Administration) changes. For more information about administering UCIDs, see Administrator Guide for Avaya Communication Manager, 03-300509.

Issue 7 July 2007

27

Administering Communication Manager for AE Services

Setting up a CTI link


If you are setting up an AE Services configuration for Device, Media, and Call Control for applications that use device and media control only, you can skip this section. This section includes the following topics:

Administering a CTI Link for a CVLAN application on page 29 Administering a CTI Link used for internal Avaya CVLAN applications on page 29 Administering a CTI Link for an ASAI application on page 30 Administering a CTI Link for TSAPI, TR/87, JTAPI, Telephony Web Service, and Device, Media, and Call Control on page 30 Checking the status of a Switch Connection -- from Communication Manager on page 31

This section also includes a procedure for checking the status of a switch connection.

28 AE Services Administration and Maintenance Guide, Release 4.0.1

Setting up a CTI link

Administering a CTI Link for a CVLAN application


Follow these steps from a Communication Manager SAT to administer a CTI link type ASAI-IP (CVLAN Link) for a CVLAN application. 1. Type add cti-link <link number>, for example, add cti-link 3. 2. Follow these steps on the CTI LINK form.

In the Extension field, type <station extension>, for example, 20007. In the Type field, type ASAI-IP. In the Name field, type <name of AE Server>, for example, aeserver1.

This completes the procedure to administer a CTI Link used by CVLAN applications.

Administering a CTI Link used for internal Avaya CVLAN applications


Follow these steps from a Communication Manager SAT to administer a CTI link type ADJ-IP (Proprietary CVLAN Link) for internal Avaya CVLAN applications. 1. Type add cti-link <link number>, for example, add cti-link 3. Communication Manager displays the CTI LINK form. 2. Complete the CTI LINK form as follows:

In the Extension field, type <station extension>, for example, 30009. In the Type field, type ADJ-IP. In the Name field, type <name of AE Server>, for example, aeserver1.

This completes the procedure to administer a CTI Link used for internal Avaya CVLAN applications.

Issue 7 July 2007

29

Administering Communication Manager for AE Services

Administering a CTI Link for an ASAI application


Follow these steps from a Communication Manager SAT to administer a CTI link type ASAI-IP (DLG Link) for an ASAI application. 1. Type add cti-link <link number>, for example, add cti-link 4. Communication Manager displays the CTI LINK form. 2. Complete the CTI LINK form as follows:

In the Extension field, type <station extension>, for example, 40001. In the Type field, type ASAI-IP. In the Name field, type <name of AE Server>, for example, aeserver1.

This completes the procedure to administer a CTI link used by ASAI applications.

Administering a CTI Link for TSAPI, TR/87, JTAPI, Telephony Web Service, and Device, Media, and Call Control
The following types of applications rely on a CTI Link. For more information, see Summary of Communication Manager administrative tasks on page 19.

TSAPI Applications that use TR/87 for AE Services and Microsoft Live Communications Server integration. JTAPI Telephony Web Service Device, Media, and Call Control with Single-Step Conference and Snapshot Services (Snapshot Call and Snapshot Device),

Follow these steps from a Communication Manager SAT to administer a CTI link type ADJ-IP 1. Type add cti-link <link number>, for example, add cti-link 5. 2. Complete the CTI LINK form as follows:

In the Extension field, type <station extension>, for example, 70001. In the Type field, type ADJ-IP. In the Name field, type <name of AE Server>, for example, aeserver1.

This completes the procedure to administer a CTI link used by TSAPI applications.

30 AE Services Administration and Maintenance Guide, Release 4.0.1

Device, Media, and Call Control settings

Checking the status of a Switch Connection -- from Communication Manager


Once you have added a Switch Connection on the AE Server, you validate the switch connection by checking its status on both the AE Server and on Communication Manager. To check the status of a Switch Connection on Communication Manager, type the following command: status aesvcs link For information about checking the status of a switch connection from the AE Server, see Checking the status of a switch connection -- from the AE Server on page 75.

Device, Media, and Call Control settings


If you are setting up an AE Services configuration that supports the TSAPI, CVLAN or DLG clients, you can skip this section, This section includes the following topics:

Adding stations for Device, Media, and Call Control on page 32 Setting up a network region for Device, Media, and Call Control on page 35 Adding the Device, Media, and Call Control softphones to the network region on page 39 Adding a media gateway to the network on page 39 Adding a media processor circuit pack to the network on page 40 Administering an example Device, Media, and Call Control configuration on page 41

Issue 7 July 2007

31

Administering Communication Manager for AE Services

Adding stations for Device, Media, and Call Control


Device, Media, and Call Control applications can perform two types of station control, exclusive control and shared control. Note: Device, Media, and Call Control applications that use the Call Control (Single-Step Conference) or Snapshot Services (Snapshot Call or Snapshot Device) do not need to administer stations on Communication Manager.

Note:

Exclusive control mode


When in exclusive control mode, a Device, Media, and Call Control application has full control of the extension number associated with the application. Exclusive control must be used for any application that records and plays messages or detects DTMF digits. All the modes under exclusive control are as follows:

client media mode server media mode telecommuter mode

For more information about the types of media control, see the Media control modes section of the Capabilities of the API chapter in the Avaya MultiVantage Application Enablement Services Overview, 02-300369. Follow these steps from a Communication Manager SAT to administer an extension exclusively for the Device, Media, and Call Control softphone. For an example of the form, see Adding stations on page 46. 1. Type add station to add a station. Add as many stations as you need for your application. Communication Manager displays the STATION form. 2. Complete the STATION form as follows:

In the Type field (for station type), choose an IP set type or a DCP set type, depending on what you need. Fill in the Port field for a DCP set (for an IP set, the port automatically becomes IP) - type <port number>, if it is an actual physical set. - type x, if it is not an actual physical set. In the Security Code field, type a <numeric security code>. The security code can consist of four to eight digits. AE Services recommends that you use an eight digit code for maximum security. Additionally, AE Services recommends that you use a unique security code for each Device, Media, and Call Control station.

32 AE Services Administration and Maintenance Guide, Release 4.0.1

Device, Media, and Call Control settings

Whenever you provide a security code, make sure you maintain a secure record of it so you can use it again. You will need to use this security code when your application is registering with the Device, Media, and Call Control softphone.

In the IP SoftPhone field, type y. Administer any buttons necessary for your application.

Shared control mode


Shared control of a Device, Media, and Call Control extension number allows a Device, Media, and Call Control application to monitor and control a physical digital phone or a physical IP phone. All updates sent to the physical phone, such as lamp, ringer, or display updates, are also sent to the Device, Media, and Call Control application. Additionally, either the Device, Media, and Call Control application or the physical phone can perform actions on the physical phone such as go off-hook, go on-hook, and press buttons. If the application uses shared control, you do not need to administer an extension number for the application. An IP_API_A license is still required for the application, and you must enable the IP_Softphone field as described in Step 2.

Administering an extension number for the station the application monitors


Follow these steps from a Communication Manager SAT to administer an extension number for the physical station the application is monitoring. 1. Do not add stations. Instead, type change station nnnnn (where nnnnn is the extension number of the physical station the application is monitoring or controlling). Communication Manager displays the STATION form. 2. If the STATION form is not already administered this way, follow these steps:

In the IP Softphone field, type y. In the Security Code field, type a <numeric security code>. The security code can consist of four to eight digits. AE Services recommends that you use an eight digit code for maximum security. Additionally, AE Services recommends that you use a unique security code for each Device, Media, and Call Control station. Whenever you provide a security code, make sure you maintain a secure record of it so you can use it again. You will need to use this security code when your application is registering with the Device, Media, and Call Control softphone.

In shared control mode, the Device, Media, and Call Control extension will be registered as long as the physical phone is connected to or registered with Communication manager.

Issue 7 July 2007

33

Administering Communication Manager for AE Services

Enabling on-hook dialing


Since Shared Control Mode involves the synchronization of a Softphone application with a physical phone set, there is an inherent short network delay between actions from the software and the response from the physical set. To allow for this inherent delay, it is recommended that the client software waits, at least, 200msecs after going off-hook and before dialing digits. If the software does not wait, there is a chance that one or more of the digits may be lost. To alleviate this possibility, it is recommended that you enable the on-hook dialing feature in Communications Manager, as follows: 1. Type change system-parameters customer options . 2. Go to page 10 of the OPTIONAL FEATURES form, and enable the setting for on hook dialing on terminals, for example: On-hook Dialing on 607/2400/4600/6400/8400 Terminals? y

34 AE Services Administration and Maintenance Guide, Release 4.0.1

Device, Media, and Call Control settings

Setting up a network region for Device, Media, and Call Control


Setting up a network region requires some network planning. For a list of documents that contain information to assist you in planning see About administering network regions on page 22. You must set up Device, Media, and Call Control softphones in an IP network region that supports the set of Audio Codecs that your application supports. For example, the IP network region must support one of the following codec sets:

G.711A G.711MU G.729 G.729A

Applications can specify preferences for both the Audio Codec and the Media Encryption options that they use. The Audio Codec settings and Media Encryption settings that you administer in Communication Manager must be consistent with what your application supports

If your application supports media encryption, administer the Media Encryption setting on the IP Codec Set form with aes as the first preference and none as the second preference. If your application does not support media encryption, administer the Media Encryption setting on the IP Codec Set form as none .

Additionally, there must be a media gateway or a media processor resource in the same network region or in an interconnected network region. Otherwise, there will be problems with the talkpath. Note: Using media encryption can reduce capacity by 15%.

Note:

About Telecommuter Mode


You administer a network region and codec set for client media mode and server media mode, however you do not have to administer a codec set for the telecommuter mode. Because shared control mode does not have media for the application, you do not need to administer a network region/codec set for shared control mode.

Issue 7 July 2007

35

Administering Communication Manager for AE Services

Creating the Device, Media, and Call Control codec set


Use the change ip-codec-set command to create a codec set that uses G.711A,G.711U and G.729:

Ensure that G.711A, G.711MU, or G.729 are the only codecs administered. Verify that the Silence Suppression field is set to n. It is recommended that you accept the default packet size of 20 ms.

For an example of how to complete the form, see Setting up a codec set on page 49.

Administering a region with a specific codec set


Use the change ip-network-region command to administer a network region with that codec set:

Specify the codec set and the UDP port range (minimum and maximum) for the network region you assigned to the Device, Media, and Call Control softphones and to the media processor. The Codec Set field reflects the codec set that must be used for connections between phones within this region or between phones and media processor boards within this region.

About signaling encryption


If you do not enable signaling encryption, you increase the risk of exposing sensitive information (such as credit card or other identification numbers) to the public in TCP/IP communications. For example, if you do not use signaling encryption, and your Device, Media, and Call Control applications rely on button presses (to convey a credit card number, for example), these button presses are exposed, because DTMF digits are passed in the signaling channel.

!
Important:

Important: AE Services strongly recommends that you enable signaling encryption, which is described in the next topic, Administering security profiles for signaling encryption.

36 AE Services Administration and Maintenance Guide, Release 4.0.1

Device, Media, and Call Control settings

Administering security profiles for signaling encryption


Use the Communication Manager ip-network-region command to administer signaling encryption. Communication Manager handles signaling encryption on a per ip network region basis. Choose from the following values when you administer the Allowed Security Profiles for an ip network region (see Figure 15).

challenge (default) -- provides no H.323 signaling link encryption If a Device, Media, and Call Control endpoint is registered to an ip network region that has challenge security profile selected, it means that no H.323 signaling link encryption is provided. The challenge setting is the default for all ip-network regions in Communication Manager.

pin-eke -- provides H.323 signaling link encryption any-auth -- provides H.323 signaling link encryption If a Device, Media, and Call Control endpoint is registered to an ip network region, that has any-auth or pin-eke selected, it means that H.323 signaling link encryption is provided.

The AE Server does not provide an administrative capability for either enabling or disabling encryption for Device, Media, and Call Control Service endpoints. The only administrative interface for enabling or disabling signaling encryption is Communication Manager ip-network region administration. Note: Using encryption can reduce the H.323 signaling capacity by 15%.

Note:

Issue 7 July 2007

37

Administering Communication Manager for AE Services

Checking for media encryption


The AE Server provides media encryption for Device, Media, and Call Control applications that use Exclusive Control Server media mode. In this mode, the Device, Media, and Call Control application is responsible for decrypting incoming media and encrypting outgoing media. The Media Encryption setting on the Communication manager IP Codec Set form applies to both Client media mode and Server media mode.

In the case of Server media mode, media is terminated on the AE Server. The AE Server encrypts and decrypts media. In the case of Client media mode, media is terminated on the application machine. The application is responsible for encrypting and decrypting media. AE Services also provides a media stack in the Device, Media, and Call Control Java Client SDK that encrypts and decrypts media. The media stack can be used by applications that rely on client media mode.

To verify that media encryption is enabled on Communication Manager, follow this procedure. 1. Type change ip-codec . 2. On the IP Codec Set form, verify that Media Encryption: is set to aes. For example, Media Encryption: aes See Figure 12: setting up a codec set - media encryption set to aes on page 49.

38 AE Services Administration and Maintenance Guide, Release 4.0.1

Device, Media, and Call Control settings

Adding the Device, Media, and Call Control softphones to the network region
There are two ways to administer a network region for Device, Media, and Call Control extensions. Use the method that you prefer.

Let Device, Media, and Call Control extensions get the network region for the CLAN (or Processor CLAN) to which they are registering. Use the change ip-network-map command. On the IP ADDRESS MAPPING form, specify the IP address of the AE Server and assign a network region.

Adding a media gateway to the network


If you are using a media server (S8300/S8500/S8700/S8710) with a G700/G350 media gateway, you must add the media gateway to the Communication Manager network. For information about adding a media gateway, see Consulting the Communication Manager documentation. Here are some general guidelines about adding a media gateway.

Use the add media-gateway command to add the media gateway to the Communication Manager network. If you are adding this media gateway to the network region you created for Device, Media, and Call Control, you must type that network region number in the NetRgn field. For an example, see Adding a media gateway on page 53.

Consulting the Communication Manager documentation


For more information about adding a media gateway, see the following documents.

Administration for Network Connectivity for Avaya Communication Manager, 555-233-504. - In Chapter 3, Administering converged networks, see Adding a G250, G350, or G700 Media Gateway to an S8300 Media Server.

Installation and Upgrades for Avaya G700 Media Gateway and Avaya S8300 Media Server, 555-234-100. - In Chapter 4, Installing a New G700 without an S8300, see Administering an S8500 or S8700-series primary controller. Note: If you need to add a CLAN to the network, see Adding CLANs to the network on page 23.

Note:

Issue 7 July 2007

39

Administering Communication Manager for AE Services

Adding a media processor circuit pack to the network


If you are using a media server that uses a media processor (MEDPRO) circuit pack, you must add the media processor circuit pack to the Communication Manager network. Follow these steps to add a media processor to the network: 1. Type change node-names ip. For an example, see Adding a CLAN - change node-names ip on page 55. For a screen reference, see IP Node Names in the Screen Reference chapter of the Administrator Guide for Avaya Communication Manager, 03-300509. 2. Type change ip-interface <board location> (where <board location> is the board location for the media processor, for example, 1A05). If you are adding this media processor to the network region you created for Device, Media, and Call Control, you must type that network region number in the NetRgn field. For an example, see Adding a media processor on page 56.

40 AE Services Administration and Maintenance Guide, Release 4.0.1

Device, Media, and Call Control settings

Administering an example Device, Media, and Call Control configuration


The sample configuration depicted by Figure 1 includes the following components:

Communication Manager components: - An S8700/8710 media server with a CLAN circuit card and a media processor circuit card - A G700 media gateway AE Services Device, Media, and Call Control components: - The AE Server - One or more Device, Media, and Call Control softphones - The application on a separate application machine

Also, the sample configuration depicted by Figure 1 includes following network regions:

Network region 1 - Includes IP phones - Supports codec Set, G.711A/MU Network region 2 - Includes G700 media gateway, CLAN, media processor - Supports codec sets G.711A/MU and G.729 Network region 3 - Includes Device, Media, and Call Control softphones - Supports G.711A/MU and G729

To get an idea of how you would need to set up Communication Manager to support the example configuration depicted in Example Device, Media, and Call Control configuration on page 42, refer to Sample Communication Manager administration screens on page 43 and follow Figure 4 through Figure 23.

Issue 7 July 2007

41

Administering Communication Manager for AE Services

Figure 1: Example Device, Media, and Call Control configuration

Central Office

Analog

S8700/S8710 (st1) Port network (st1) NR 2 G729, G711A/MU 192.11.12.1 192.11.12.2 media processor G700 Media Gateway 192.11.12.3 NR 2 G729, G711A/MU

DCP D4 (25532)

D6 DCP (25534) D5 DCP (25533)

CLAN

DCP D3 (25531)

Application on separate application machine

AE Server 192.11.12.10 NR 3 G711/A/MU/G729

ISDN

IP3 IP4 (25511) (25512) 192.11.12.4 192.11.12.5

IP5 (25513) 192.11.12.6

IP100 IP6 (xxxxx) (25514) 192.11.12.7 xxx.xx.xx.x

Device, Media, and Call Control IP Softphones S1...S30 (23200).............(23274)

42 AE Services Administration and Maintenance Guide, Release 4.0.1

Sample Communication Manager administration screens

Sample Communication Manager administration screens


Use this section as a reference for performing the following administrative tasks on Communication Manager:.

Setting up UCIDs for TSAPI applications on page 44 Checking for IP_API_A licenses on page 45 Adding stations on page 46 Configuring IP services - administering the transport link on page 48 Administering a network region on page 50 Mapping IP addresses (for API softphones) on page 52 Adding a media gateway on page 53 Adding a CLAN on page 54 Listing IP interfaces on page 57

Issue 7 July 2007

43

Administering Communication Manager for AE Services

Setting up UCIDs for TSAPI applications


TSAPI applications that use predictive dialing must enable the setting for creating UCIDs, select a unique node number for the switch (see Figure 2), and enable the setting for Send UCID to ASAI (see Figure 3). Figure 2: Setting up UCIDs for TSAPI applications - create a UCID and assign a Node ID
change system parameters features Page 5 of 17

FEATURE-RELATED SYSTEM PARAMETERS

SYSTEM PRINTER PARAMETERS: Endpoint:_________ Lines Per Page: 60 SYSTEM-WIDE PARAMETERS: Switch Name:

Emergency Extension Forwarding min): 10 Enable Inter-Gateway Alternate Routing? n MALICIOUS CALL TRACE PARAMETERS APPLY WCT Warning Tone? n SEND ALL CALLS OPTIONS Send All Call Applies to: station UNIVERSAL CALL ID Create Universal Call ID (UCID)? y MCT Voice Recorder Trunk Group: Auto Inspect on Send All Calls? n UCID Network Node ID: 1

Figure 3: Setting up UCIDs for TSAPI applications - send UCID to ASAI must be enabled
change system parameters features AGENT AND CALL SELECTION: Page 12 of 17

FEATURE-RELATED SYSTEM PARAMETERS

ASAI

MIA Across Splits or Skills? n ACW Agents Considered Idle? n Call Selection Measurement: current-wait-time Service Level Supervisor Call Selection Override? n Auto Reserve Agents: none

Copy ASAI UUI During Conference/Transfer? n Call Classification After Answer Supervision? n Send UCID to ASAI? y CALL MANAGEMENT SYSTEM Reporting Adjunct Release: BCMS/VuStats LoginIDs? BCMS/VuStats Measurement Interval: BCMS/VuStats Abandon Call Timer (seconds): Validate BCMS/VuStats Login IDs? Clear VuStats Shift Data? Remove Inactive BCMS/VuStats Agents? y hour n on-login n

44 AE Services Administration and Maintenance Guide, Release 4.0.1

Sample Communication Manager administration screens

Checking for IP_API_A licenses


You must have an IP_API_A license for each Device, Media, and Call Control softphone run by your application. To verify that you have a sufficient number of licenses, type display system-parameters customer-options. Go to the MAXIMUM IP REGISTRATIONS BY PRODUCT ID screen (page 9 or 10) and check the IP_API_A field. See Figure 4. Figure 4: Checking for IP_API_A licenses
MAXIMUM IP REGISTRATIONS BY PRODUCT ID Product ID IP_API_A IP_Agent IP_Phone IP_ROMax IP_Soft IP_eCons Rel. Limit Used : 1000 0 : 0 0 : 1000 104 : 50 15 : 500 0 : 5 0 : 0 0 : 0 0 : 0 0 : 0 0 : 0 0 : 0 0 : 0 0 : 0 0 : 0 0 (NOTE: You must logoff & login to effect the permission changes.)

Issue 7 July 2007

45

Administering Communication Manager for AE Services

Adding stations
Add as many stations as you need for your Device, Media, and Call Control based application. See Figure 5, Figure 6, Figure 7, and Figure 8. Figure 5: Adding a station, Page 1 of the STATION screen
add station 23200 Extension: Type: Port: Name: 23200 4624 S00142 cmapi ip-softphone 23200 Page 1 of 5

STATION Lock Messages? n Security Code: * Coverage Path 1: Coverage Path 2: Hunt-to Station:

BCC: 0 TN: 1 COR: 1 COS: 1

STATION OPTIONS Loss Group: 19 Speakerphone: 2-way Display Language: english

Personalized Ringing Pattern: 1 Message Lamp Ext: 23200 Mute Button Enabled? y Media Complex Ext: IP SoftPhone? y

Figure 6: Adding a station, Page 2 of the STATION screen


add station 23200 FEATURE OPTIONS LWC Reception: LWC Activation? LWC Log External Calls? CDR Privacy? Redirect Notification? Per Button Ring Control? Bridged Call Alerting? Active Station Ringing: spe y n n y n n single Page 2 of 5 n y none n n

STATION

Auto Select Any Idle Appearance? Coverage Msg Retrieval? Auto Answer: Data Restriction? Idle Appearance Preference?

Restrict Last Appearance? y Per Station CPN - Send Calling Number? Audible Message Waiting? Display Client Redirection? Select Last Used Appearance? Coverage After Forwarding? n n n s

H.320 Conversion? n Service Link Mode: as-needed Multimedia Mode: enhanced MWI Served User Type: AUDIX Name: IP Emergency Calls: extension Emergency Location Ext: 23200

Direct IP-IP Audio Connections? y IP Audio Hairpinning? y

46 AE Services Administration and Maintenance Guide, Release 4.0.1

Sample Communication Manager administration screens

Figure 7: Adding a station, Page 3 of the STATION screen


add station 23200 SITE DATA Room: change sta Jack: Cable: Floor: Building: Page Headset? Speaker? Mounting: Cord Length: Set Color: n n d 0 3 of 5

STATION

ABBREVIATED DIALING List1: BUTTON ASSIGNMENTS 1: call-appr 2: call-appr 3: call-appr 4: 5: 6:

List2: 7: 8: 9: 10: 11: 12:

List3:

Figure 8: Adding a station, Page 4 of the STATION screen


add station 23200 FEATURE BUTTON ASSIGNMENTS 13: 14: 15: 16: 17: 18: 19: 20: 21: 22: 23: 24: Page 4 of 5

STATION

Issue 7 July 2007

47

Administering Communication Manager for AE Services

Configuring IP services - administering the transport link


Configuring IP services administers the transport link between Communication Manager and AE Services. Use the change ip services command, and administer settings on the IP SERVICES screen (Figure 9) and the AE Services Administration screen (Figure 10). Figure 9: Configuring IP services
change ip-services change ip-services Service Service Type Type SAT SAT DAPI AESVCS Enabled Enabled y y y y Local Local Node Node st1-clan st1-clan st1-clan2 st1-clan IP SERVICES IP SERVICES Local Remote Local Remote Port Node Port Node 9000 any 9000 any 0 8765 192.11.12.1 0 Page Page Remote Remote Port Port 0 0 0 1 of 1 of 2 3

Note:

Note: For an S8710/S8500, type the CLAN name as the Local Node. For an S8300, type procr as the Local Node.

Figure 10: Configuring IP services - AE Services Administration


change ip-services change ip-services Service Enabled Local Type Node Server ID AE Services SAT y Server st1-clan DAPI 1: y aeserver1 st1-clan2 2: __________________ 3: __________________ Page 1 of Page 3 of 2 3 AE IP SERVICES Services Administration Local Remote Remote Port Node Port Password Enabled Status 9000 any 0 0 aespassword1 192.11.12.1 0 0 _________________ _ _________________ _

48 AE Services Administration and Maintenance Guide, Release 4.0.1

Sample Communication Manager administration screens

Setting up a codec set


Use the change ip-codec set command for setting up a codec set that uses G.711A, G.711U and/or G.729. See Figure 11. Figure 11: setting up a codec set - media encryption set to none
change ip-codec-set 3 IP Codec Set Codec Set: 3 Audio Codec 1: G.711MU 2: G.711A 3: G.729 4: 5: 6: 7: Silence Suppression n n n Frames Per Pkt 2 2 2 Packet Size(ms) 20 20 20 Page 1 of 1

Media Encryption: none

Figure 12: setting up a codec set - media encryption set to aes


change ip-codec-set 3 IP Codec Set Codec Set: 3 Audio Codec 1: G.711MU 2: G.711A 3: G.729 4: 5: 6: 7: Silence Suppression n n n Frames Per Pkt 2 2 2 Packet Size(ms) 20 20 20 Page 1 of 1

Media Encryption: aes

Issue 7 July 2007

49

Administering Communication Manager for AE Services

Administering a network region


For this example network, you will administer the following codec connectivity within each network region and between network regions:

network region 3 -> network region 1: codec 2 network region 3 -> network region 2: codec 2 network region 3 <-> network region 3: codec 3

See Figure 13 and Figure 14. Figure 13: Administering a network region, IP NETWORK REGION screen, page 1
change ip-network-region 3 Region: 3 Location: Name: AUDIO PARAMETERS Codec Set: 3 UDP Port Min: 2048 UDP Port Max: 65535 DIFFSERV/TOS PARAMETERS Call Control PHB Value: 34 Audio PHB Value: 46 802.1P/Q PARAMETERS Call Control 802.1p Priority: 7 Audio 802.1p Priority: 6 H.323 IP ENPOINTS H.323 Link Bounce Recovery? y Idle Traffic Interval (sec): 20 Keep-Alive Interval (sec): 5 Keep-Alive Count: 5 IP NETWORK REGION Home Domain: Intra-region IP-IP Direct Audio: no Inter-region IP-IP Direct Audio: no IP Audio Hairpinning? n RTCP Reporting Enabled? y RTCP MONITOR SERVER PARAMETERS Use Default Server Parameters? y Page 1 of 19

AUDIO RESOURCE RESERVATION PARAMETERS RSVP Enabled? n

50 AE Services Administration and Maintenance Guide, Release 4.0.1

Sample Communication Manager administration screens

Figure 14: Administering a network region, IP NETWORK REGION screen, page 1


change ip-network-region 3 Page 3 of 19

Inter Network Region Connection Management src rgn 3 3 3 3 3 3 3 3 3 3 3 3 3 3 3 dst codec direct rgn set WAN 1 2 2 2 y 3 3 4 5 6 7 8 9 10 11 12 13 14 15 Dynamic CAC Gateway

WAN-BW-limits NoLimit

Intervening-regions

Figure 15: Administering a network region, IP NETWORK REGION screen, page 2


change ip-network-region 3 IP NETWORK REGION INTER-GATEWAY ALTERNATE ROUTING Incoming LDN extension: Conversion to Full Public Number - Delete: Maximum Number of Trunks to Use: LSP NAMES IN PRIORITY ORDER 1 2 3 4 Page 2 of 19

Insert: ALLOWED SECURITY PROFILES 1.any-auth 2. 3. 4.

Issue 7 July 2007

51

Administering Communication Manager for AE Services

Mapping IP addresses (for API softphones)


Use the change-ip network-map command, and specify the IP address of the AE Server and assign a network region. See Figure 16. Figure 16: Mapping IP addresses (for API softphones)
change ip-network-map IP ADDRESS MAPPING From IP Address 192.11 .12 .4 192.11 .12 .10 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . (To IP 192.11 192.11 . . . . . . . . . . . . . . Address .12 .7 .12 .10 . . . . . . . . . . . . . . . . . . . . . . . . . . . . Subnet or Mask) Region 1 3 VLAN n n n n n n n n n n n n n n n n Page 1 of 32

52 AE Services Administration and Maintenance Guide, Release 4.0.1

Sample Communication Manager administration screens

Adding a media gateway


If you are using a media server (S8300/S8500/S8700/S8710) with a G700/G350 media gateway, you must add the media gateway to the Communication Manager network. For information about adding a media gateway, see Consulting the Communication Manager documentation. Note: If you are using a media gateway, and your application needs media encryption, you must set Encrypt Link to y. If you do not enable this setting, your application will not get a talk-path.

Note:

Figure 17: Adding a media gateway


add media-gateway 1 Number: Type: Name: Name: Serial Number: Network Region: Registered? Slot V1: V2: V3: V4: V5: V6: V7: V9: Page 1 of 1

5 g350 ST1 MG1 30N73 Denver Branch NNNNNNNNNNNNNN 3 n

MEDIA GATEWAY

Module Type S8300 MM710

IP address: 192.11.12 .3 FW Version/HW Vintage: MAC address: Encrypt Link? y Location: 1 Controller IP Address: Site Data: Denver Name ICC MM DS1 MM

MM312 virtual-analog gateway-announcements

DCP MM ANA VMM ANA VMM

Issue 7 July 2007

53

Administering Communication Manager for AE Services

Adding a CLAN
When you are using a media server that uses CLANs, you must add the CLANs to the Communication Manager network. The procedure for adding a CLAN uses the following commands.

add data-module (see Figure 18) change node-names ip (see Figure 19) change ip-interface - to add the following: - a CLAN (see Figure 20) - a MEDPRO circuit pack (see Figure 21) - a PROCR (see Figure 22)

Figure 18: Adding a CLAN - add data-module


add data-module 44444 Data Extension: 44444 Type: ethernet Port: 17D0717 Page 1 of 1

DATA MODULE Name:CLAN1

Network uses 1s for Broadcast Addresses?

54 AE Services Administration and Maintenance Guide, Release 4.0.1

Sample Communication Manager administration screens

Figure 19: Adding a CLAN - change node-names ip


change node-names ip Name CLAN1 CLAN2 IP Address 192.11 .12 .1 192.11 .12 .2 Page IP Address . . . . . . 1 of 1

IP NODE NAMES Name

Figure 20: Adding a CLAN IP interface


add ip-interface 1A06 IP INTERFACES Page 1 of 1

Type: Slot: Code/Suffix: Node Name: IP Address: Subnet Mask: Gateway Address: Enable Ethernet Port? Network Region: VLAN:

C-LAN 01A06 TN799 D sraychk-clan1 192.11 .12 .1 255.255.255.0 135.9 .71 .254 y 1 0

Number of CLAN Sockets Before Warning: 400

Issue 7 July 2007

55

Administering Communication Manager for AE Services

Figure 21: Adding a media processor


change ip-interface 1A17 IP INTERFACES Page 1 of 1

Type: Slot: Code/Suffix: Node Name: IP Address: Subnet Mask: Gateway Address: Enable Ethernet Port? Network Region: VLAN:

MEDPRO 01A17 TN2302 sraychk-prw1 192.11 .12 .2 255.255.255.0 135.9 .71 .254 y 1 0

Figure 22: Adding a processor CLAN (procr)


change ip-interface procr IP INTERFACES Page 1 of 1

Type: PROCR Node Name: procr IP Address: 135.9 .71 .180 Subnet Mask: 255.255.255.0 Enable Ethernet Port? y Network Region: 1

56 AE Services Administration and Maintenance Guide, Release 4.0.1

Sample Communication Manager administration screens

Listing IP interfaces
Use the list ip-interface command to view the IP interfaces you have administered, as illustrated by Figure 23. Figure 23: Listing IP interfaces
list ip-interface IP INTERFACES ON Type y C-LAN y MEDPRO y C-LAN y MEDPRO Slot 01A06 01A17 02A06 01A16 Code Sfx TN799 D TN2302 TN799 C TN2302 Node Name sraychk-clan1 sraychk-prw1 sraychk-clan1 sraychk-prw2 Subnet Mask 255.255.255.0 255.255.255.0 255.255.255.0 255.255.255.0 Gateway Address 135.9 .71 .254 135.9 .71 .254 135.9 .71 .254 135.9 .71 .254 Net Rgn 1 1 1 1 VLA n n n n

Issue 7 July 2007

57

Administering Communication Manager for AE Services

58 AE Services Administration and Maintenance Guide, Release 4.0.1

About the OAM Web pages

Chapter 2: AE Services OAM Administration and CTI OAM Admin


This chapter describes some of the general administrative capabilities available through the Avaya MultiVantageTM Application Enablement Services (AE Services) Web-based OAM (Operations, Administration, and Maintenance) interface. This chapter includes the following topics:

About the OAM Web pages on page 59 General CTI OAM Administration on page 63 Link Administration - CTI Link Admin in AE Services OAM on page 76 Backing up the database on page 81 Using the Service Controller on page 84

About the OAM Web pages


The administrative interface for the AE Services server (referred to as the AE Server) is the Web based OAM interface. Note: The AE Services Bundled Server does not provide a web browser, and the AE Services Software-Only solution does not assume that you will install one. To administer AE Services, you need an administrative workstation -- a computer running a browser with network access to the AE Server.

Note:

Issue 7 July 2007

59

AE Services OAM Administration and CTI OAM Admin

Before you access the OAM Web pages


Before you attempt to access the AE Services OAM pages use one of the following methods to set up your browser.

Turn off your browsers proxy settings. Include the IP address or host name (or DNS name) of the AE Server in the Proxy Exceptions box.

If you do not set up your browser appropriately, your browser might display an error message such as the following.
Access Denied (connect_method_denied) Your request attempted a CONNECT to a port 8443 that is not permitted by default. This is typically caused by an HTTPS URL that uses a port other then the default of 443. For assistance, contact your network support team.

If you use Microsoft Internet Explorer


Follow this procedure to set up Microsoft Internet Explorer 6. 1. Select Tools > Internet Options > Connections > LAN Settings > Advanced. 2. In the Exception box, type the <IP Address> or the <Host Name> (whichever you use) of the AE Server.

Logging in to OAM
To access the AE Services OAM Web based interface, start your browser (after reading Before you access the OAM Web pages) and type the appropriate URL based on this example: https:// <aeserver>:<port_no>/MVAP where: aeserver is the name or IP address of your AE Server. port_no is the port number (8443 is the default).

60 AE Services Administration and Maintenance Guide, Release 4.0.1

About the OAM Web pages

OAM administrative accounts


OAM includes two separate administrative accounts. Your organization can set these up to be managed by the same administrator or different administrators.

CTI OAM Admin User Management

CTI OAM Admin


Log in using the Linux-based user name and password. See Adding a Linux user and setting the OAM account password on page 146. If you want the CTI OAM Admin administrator to manage the User Management account, you must add a user as described in Adding a Linux user and setting the OAM account password on page 146. Note: Chapter 2: AE Services OAM Administration and CTI OAM Admin focuses on administration using the CTI OAM Admin account.

Note:

User Management
User Management provides you with tools for managing user-related information for AE Services. You log in to User Management with the User Management user name and password. Logins for User Management are authenticated with the AE Services User Service database rather than the Linux password file. For information about the User Management account, see Chapter 3: OAM User Management Administration on page 91.

Issue 7 July 2007

61

AE Services OAM Administration and CTI OAM Admin

Determining which services you are licensed to use


Follow this procedure to see which services you are currently licensed to use. 1. Log in to OAM. 2. From the main menu, select CTI OAM Administration. OAM displays the CTI OAM Home page. The CTI OAM Home page lists each service and its current state, which can be any of the following:

Running Stopped No License

A status of No License indicates that your configuration does not support a particular service. If you are not sure what licenses your configuration is supposed to support, check with your Account Representative or your Avaya Partner representative. Note: Because Device, Media, and Call Control licensing is handled by Avaya Communication Manager, it does not appear in this list.

Note:

For more information about licensing, see Chapter 4, Installing Licenses in either of the following documents.

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

62 AE Services Administration and Maintenance Guide, Release 4.0.1

General CTI OAM Administration

General CTI OAM Administration


Use this section when you need to administer settings for Local IPs, Switch Connections, and Links. Use the CTI OAM Admin account to carry out the administrative tasks described in the following sections.

Summary of AE Server CTI OAM administrative tasks on page 64 Administering the Local IP for all AE Services on page 71 Administering Network Connections on page 68 Administering Switch Connections on page 73 Checking the status of a switch connection -- from the AE Server on page 75 Administering CVLAN Links in AE Services OAM on page 76 Adding CVLAN Clients on page 78 Administering DLG Links in AE Services OAM on page 79 Administering TSAPI Links in AE Services OAM on page 80 Restoring the database on page 82

Issue 7 July 2007

63

AE Services OAM Administration and CTI OAM Admin

Summary of AE Server CTI OAM administrative tasks


Table 3 provides a per-client summary of AE Services administrative tasks. For a high-level illustration the AE Server, see AE Services -- dependencies at a glance on page 86. Table 3: Per-client summary of AE Server CTI OAM administration tasks
Client Device, Media, and Call Control applications that do not use Call Information Services, Call Control or Snapshot Services NOTE: These applications do not use the Call Information Link. Users of these applications are authenticated by the User Service. They are not administered as CT Users, however, and they do not derive authorization from the SDB CTI OAM Administration tasks Local IP Ports Required. See Administering the Local IP for all AE Services on page 71. Not required. You can use the default settings. NOTE: If you have a firewall, you might need to change these settings. See Administering TCP ports on the AE Server and firewall settings on page 69. IMPORTANT: If you have a Release 3.0 Device, Media, and Call Control application, see Encrypted and Unencrypted DMCC Server ports on page 69. Not required.You can use the default media properties. See DMCC Configuration on page 69. Not applicable. Not applicable. These applications use Real Time Transport Protocol (RTP) for media control and H.323 Control Channel Message Set (CCMS) for device control. Required. See Administering the Local IP for all AE Services on page 71. Not required. You can use the default settings. NOTE: If you have a firewall, you might need to change these settings. See Administering TCP ports on the AE Server and firewall settings on page 69. IMPORTANT: If you have a Release 3.0 Device, Media, and Call Control application, see Encrypted and Unencrypted DMCC Server ports on page 69. Not required. you can use the default media properties. See DMCC Configuration on page 69. Required. The Transport Layer Service is not used, but the Switch Connection Name is used for round-robin assignment of H.323 Gatekeepers. You must continue with the step to Edit an H.323 Gatekeeper. See Administering Switch Connections on page 73. Not applicable.These applications use Real Time Transport Protocol (RTP) for media control and H.323 Control Channel Message Set (CCMS) for device control.

DMCC Configuration Switch Connection CTI Link Administration

Device, Media, and Call Control applications that do not use Call Information Services, Call Control or Snapshot Services, but do use a switch name for round-robin assignment of H.323 Gatekeepers NOTE: These applications do not use the Call Information Link. Users of these applications are authenticated by the User Service. They are not administered as CT Users, however, and they do not derive authorization from the SDB.

Local IP Ports

DMCC Configuration Switch Connection

CTI Link Administration

1 of 4

64 AE Services Administration and Maintenance Guide, Release 4.0.1

General CTI OAM Administration

Table 3: Per-client summary of AE Server CTI OAM administration tasks (continued)


Client Device, Media, and Call Control applications that do use Call Information Services but do not use Call Control or Snapshot Services You have the option of adding H.323 Gatekeepers. If you want to use the round-robin assignment of IP addresses to softphones based on a Connection name, set up a connection and then use the H.323 Gatekeeper feature to associate a list of H.323 Gatekeepers with the switch connection name. NOTE: These applications use the Call Information Link. Users of these applications are authenticated by the User Service. They are not administered as CT Users, however, and they do not derive authorization from the SDB. Device, Media, and Call Control applications that use Call Control or Snapshot Services NOTE: These applications rely on the TSAPI Service. Users of these applications are authenticated by the User Service. They are administered as CT Users, and they derive authorization from the SDB. DMCC Configuration Switch Connection CTI Link Administration CTI OAM Administration tasks Local IP Ports Required. See Administering the Local IP for all AE Services on page 71. Not required. You can use the default settings. NOTE: If you have a firewall, you might need to change these settings. See Administering TCP ports on the AE Server and firewall settings on page 69. IMPORTANT: If you have a Release 3.0 Device, Media, and Call Control application, see Encrypted and Unencrypted DMCC Server ports on page 69. Not required. You can use the default media properties. See DMCC Configuration on page 69. Required. The Transport Layer is used. See Administering Switch Connections on page 73. Not applicable. The Call Information Link is automatically established for any administered switch.

DMCC Configuration Switch Connection CTI Link Administration

Local IP Ports

Required. See Administering the Local IP for all AE Services on page 71. Not required. You can use the default settings. NOTE: If you have a firewall, you might need to change these settings. See Administering TCP ports on the AE Server and firewall settings on page 69. IMPORTANT: If you have a Release 3.0 Device, Media, and Call Control application, see Encrypted and Unencrypted DMCC Server ports on page 69. Not required. You can use the default media properties. See DMCC Configuration on page 69. Required. The Transport Layer is used. See Administering Switch Connections on page 73. Required (TSAPI Link). Device, Media, and Call Control applications that use Call Control (Single-Step Conference) or Snapshot Services (Snapshot Call or Snapshot Device) rely on the TSAPI Service. See Administering TSAPI Links in AE Services OAM on page 80.

2 of 4

Issue 7 July 2007

65

AE Services OAM Administration and CTI OAM Admin

Table 3: Per-client summary of AE Server CTI OAM administration tasks (continued)


Client Telephony Web Service NOTE: These applications rely on the TSAPI Service. Users of these applications are authenticated by the User Service. They are administered as CT Users, and they derive authorization from the SDB. CTI OAM Administration tasks Local IP Ports Required. See Administering the Local IP for all AE Services on page 71. Not required. You can use the default settings. NOTE: If you have a firewall, you might need to change these settings. See Administering TCP ports on the AE Server and firewall settings on page 69. Not applicable. Required, the Transport Layer is used. See Administering Switch Connections on page 73. Required (TSAPI Link). See Administering TSAPI Links in AE Services OAM on page 80. Required. See Administering the Local IP for all AE Services on page 71. Not required. You can use the default settings. NOTE: If you have a firewall, you might need to change these settings. See Administering TCP ports on the AE Server and firewall settings on page 69. Not applicable. Required. The Transport Layer is used. See Administering Switch Connections on page 73. Required (TSAPI Link). See Administering TSAPI Links in AE Services OAM on page 80. Required. See Administering the Local IP for all AE Services on page 71 Not required. You can use the default settings. NOTE: If you have a firewall, you might need to change these settings. See Administering TCP ports on the AE Server and firewall settings on page 69. Not applicable. Required. The Transport Layer is used. See Administering Switch Connections on page 73. Required (TSAPI Link).See Administering TSAPI Links in AE Services OAM on page 80. Required. See Administering the Local IP for all AE Services on page 71. Not applicable. Set to 9999. Not applicable. Required. The Transport Layer is used. See Administering Switch Connections on page 73. Required (CVLAN Link). See Adding CVLAN Clients on page 78.

DMCC Configuration Switch Connection CTI Link Administration

JTAPI These applications rely on the TSAPI Service. NOTE: Users of these applications are authenticated by the User Service. They are administered as CT Users, and they derive authorization from the SDB.

Local IP Ports

DMCC Configuration Switch Connection CTI Link Administration

TSAPI NOTE: Users of these applications are authenticated by the User Service. They are administered as CT Users, and they derive authorization from the SDB.

Local IP Ports

DMCC Configuration Switch Connection CTI Link Administration CVLAN NOTE: Users of these applications are not authenticated by the User Service, and they do not derive authorization from the SDB. Local IP Ports DMCC Configuration Switch Connection CTI Link Administration

3 of 4

66 AE Services Administration and Maintenance Guide, Release 4.0.1

General CTI OAM Administration

Table 3: Per-client summary of AE Server CTI OAM administration tasks (continued)


Client DLG (ASAI based applications) NOTE: Users of these applications are not authenticated by the User Service, and they do not derive authorization from the SDB. CTI OAM Administration tasks Local IP Ports DMCC Configuration Switch Connection CTI Link Administration TR/87 (AE Services and Microsoft Live Communications Server integration) NOTE: Administering AE Services for Microsoft Office Live Communications Server requires the same basic administration as TSAPI, with additional steps for Certificate Management and TR87 Configuration. Local IP Ports DMCC Configuration Switch Connection CTI Link Administration Certificate Management Required. See Administering the Local IP for all AE Services on page 71. Not applicable. Set to 5678. Not applicable. Required. The Transport Layer is used. See Administering Switch Connections on page 73. Required (DLG Link). See Administering DLG Links in AE Services OAM on page 79. Required. See Administering the Local IP for all AE Services on page 71 Required. You must enable the TR87 LCS Port (4723). By default this port is disabled in OAM. Not applicable. Required. The Transport Layer is used. See Administering Switch Connections on page 73. Required (TSAPI Link).See Administering TSAPI Links in AE Services OAM on page 80. Required - See the Application Enablement Services TR/87 Implementation Guide, 02-601893 for information about setting up server certificates and trusted certificates. Required - See the Application Enablement Services TR/87 Implementation Guide, 02-601893 for information about configuring active directory settings and dial plan settings in AE Services OAM.

TR87 Configuration

4 of 4

Issue 7 July 2007

67

AE Services OAM Administration and CTI OAM Admin

Administering Network Connections


The Network Configuration pages in AES OAM let you configure all network access on the AE Server. From the Network Settings section you have access to the following capabilities: Local IP -- Lets you specify the NIC used for client, switch or media connectivity. For information about these settings, see Administering the Local IP for all AE Services on page 71. NIC Configuration -- Provides the ability to change the auto-negotiation, speed, and duplex settings for a specific NIC. For information about changing these NIC settings, see Editing the NIC configuration on page 68. Ports -- Provides the ability to view and specify the port assignments for AE Server services. For information about port assignments, see Administering TCP ports on the AE Server and firewall settings on page 69.

NIC Configuration
The AE Services OAM NIC Configuration page lets you view settings of the NICs on the AE Server. The values that are initially displayed on the NIC configuration page reflect the negotiated values between the NICs on the AE Server and the Ethernet switch on your network. Avaya recommends that you have two NICs installed (eth0 and eth1) on the AE Server. The recommended settings for both NICs are as follows:

Auto-negotiation (autoneg) - off Speed - 100 Duplex - full

The AE Services Bundled Installer defaults to auto-negotiation mode and it negotiates the network speed and duplex mode with the Ethernet switch. This means that a machine at the far end could auto-negotiate a session that sets the NICs on the AE Server with speed and duplex settings that are not recommended for AE Services. See Editing the NIC configuration on page 68 to set up the NICs with the recommended settings.

Editing the NIC configuration


The AE Services Edit NIC Configuration lets you change the settings for the NIC you selected on the NIC Configuration page. The recommended settings are as follows:

Auto-negotiation (autoneg) - off Speed - 100 Duplex - full

68 AE Services Administration and Maintenance Guide, Release 4.0.1

Administering Network Connections

Changing the settings for a NIC will cause the NIC to restart. Once you change the settings they remain in effect until you reset them. Rebooting the AE Server will not reset any of the values.

Encrypted and Unencrypted DMCC Server ports


Device, Media, and Call Control applications connect to a secure, encrypted port (4722) on the AE Server. The encrypted port is enabled, by default. AE Services also provides an unencrypted port (4721). This port is provided for backward compatibility with applications that were developed prior to AE Services 3.1 (Communication Manager API applications, for example). The unencrypted port is disabled by default.

!
Important:

Important: If you have a Device, Media, and Call Control application that was developed prior to AE Services 3.1 and you use an unencrypted port, you must enable the unencrypted port (4721) in OAM Administration. Log in to CTI OAM, and select Administration > Ports. On the Ports page, in the DMCC Server Ports section, locate the Unencrypted Port field, and select the Enabled option button.

DMCC Configuration
If you use Device, Media, and Call Control, and your applications use device and media control, use the Media Properties Web page in OAM to change the default media properties if necessary.

To access the Media Properties page, log in to CTI OAM and select Administration > DMCC Configuration > Media Properties.

Administering TCP ports on the AE Server and firewall settings


If you use a firewall, you must make sure that the TCP port settings on your firewall are consistent with the TCP port settings on the AE Server. See Table 4 for information about TCP Port settings. Use the Ports Web page in OAM to change the default TCP port settings if necessary.

To access the Ports page, log in to CTI OAM and select Administration > Ports.

Issue 7 July 2007

69

AE Services OAM Administration and CTI OAM Admin

Table 4: TCP ports on the AE Server


Port type
CSTA Tlinks TCP Ports CSTA Tlinks TCP Ports apply to the following:

Default settings
TCP Port Min 1050 TCP Port Max 1065

Guidelines
For CSTA Tlinks you need 1 port per Communication Manager connection. The maximum number of switch connections is 16. You can use the entire range of TCP port numbers from 1024 to 65,535, but the settings for the CSTA Tlink TCP ports can not conflict with the settings for H.323 TCP ports. There can not be any duplicate numbers or overlapping ranges.

Device, Media, and Call Control applications that use Call Control and Snapshot Services Telephony Web Services applications JTAPI applications TSAPI applications

H.323 TCP Ports H.323 TCP Ports apply to the following: Device, Media, and Call Control applications that use device and media control

TCP Port Min 3000 TCP Port Max 4100

You can use the entire range of TCP port numbers from 1024 to 65,535, but the settings for the H.323 TCP ports can not conflict with the settings for CSTA Tlink TCP ports.There can not be any duplicate numbers or overlapping ranges.

70 AE Services Administration and Maintenance Guide, Release 4.0.1

Administering Network Connections

Administering the Local IP for all AE Services


Administering a Local IP refers to specifying the network interfaces that the AE Server uses for connectivity. You use the same basic procedure for all of the AE Services. For connections to Communication Manager, a hub or data switch is required. A crossover cable is not supported. Note: With reference to the Ethernet settings of the network interfaces, AE Services has been tested at 100BaseT full duplex. These are the required speed and duplex mode settings for both network interfaces (eth0 and eth1).

Note:

If you are using CVLAN in combination with other services, see Administering AE Services with CVLAN and using the Any setting on page 72. Any other variations for specific services are described within the procedure. Follow this procedure to administer a Local IP. 1. From the CTI OAM main menu select Administration > Local IP. OAM displays the Local IP page. 2. Complete the Local IP page as follows: a. In the Client Connectivity field, select the local IP address that clients or applications will use to connect to the AE Server

In a dual NIC configuration, for all services, use the IP address of the network interface (eth0) that connects to the production LAN/WAN. See also, Table 5: Dual NIC configuration - summary of settings on page 72. In a single NIC configuration, for all services, use the IP Address of the only NIC on the server or choose Any. The Any setting uses the wild card IP address, 0.0.0.0, which means that all services on the AE Server will listen on all interfaces. For the CVLAN Service use the IP address of the interface that connects to CVLAN client applications (if you want to use the Any setting with CVLAN, see Administering AE Services with CVLAN and using the Any setting on page 72).

b. In the Switch Connectivity field, select the local IP address the AE Server will use to connect to Communication Manager.

In a dual NIC configuration, use the IP Address of the network interface (eth1) that connects to the private, isolated LAN. See also, Table 5: Dual NIC configuration summary of settings on page 72. In a single NIC configuration, use the IP Address of the only network interface on the server or choose Any. The Any setting uses the wild card IP address, 0.0.0.0, which means that all services on the AE Server will listen on all interfaces.

Issue 7 July 2007

71

AE Services OAM Administration and CTI OAM Admin

c. In the Media Connectivity field, select the local IP address that Device, Media, and Call Control applications will use for Media Connectivity. For all other services, accept the default, Any.

In a dual NIC configuration, use the IP Address of the network interface (eth0) connecting to the production LAN/WAN. See also, Table 5: Dual NIC configuration summary of settings. In a single NIC configuration, use the IP Address of the only network interface on the server or choose Any. The Any setting uses the wild card IP address, 0.0.0.0, which means that all services on the AE Server will listen on all interfaces.

Table 5: Dual NIC configuration - summary of settings Client Connectivity Switch Connectivity Media Connectivity eth0:IP_address eth1:IP_address eth0:IP_address production LAN, VLAN, or WAN private isolated LAN or VLAN production LAN, VLAN, or WAN

This completes the procedure for Administering the Local IP for all AE Services.

Administering AE Services with CVLAN and using the Any setting


Keep this rule in mind, if you are administering an AE Server configured with a single network interface that supports CVLAN and other services, and you want to use the Any setting for Client Connectivity. Note: The /etc/hosts file must contain the IP address of the subnet that the CVLAN clients are on. 1. Log in as root. 2. From the command prompt type, uname n. Linux displays the network node hostname, which refers to the AE Sever name, for example: aeserver1.

Note:

Follow this procedure to use the Any setting for Client Connectivity.

Make a note of the AE Server name.

3. Type ifconfig eth0, to get the IP address of the host (this step assumes that you are using eth0 for client connectivity).

Make a note of the IP address of the AE Server, for example: inet addr: 192.168.123.44 Make sure that the /etc/hosts file contains the AE Server name along with its IP address (see Figure 24).

4. Use a text editor to open the /etc/hosts file.

72 AE Services Administration and Maintenance Guide, Release 4.0.1

Administering Network Connections

5. If the /etc/hosts file does not contain this AE Server name and IP address entry, add it to the file. Figure 24: sample /etc/hosts file
# Do not remove the following line, or various programs # that require network functionality will fail. 127.0.0.1 localhost.localdomain localhost 192.168.123.44 aeserver1 192.168.123.64 anosrv ~

Administering Switch Connections


You must administer a Switch Connection for all of the following types of applications. For more information see Summary of AE Server CTI OAM administrative tasks on page 64.

Device, Media, and Call Control with Call Information Services Device, Media, and Call Control with Single-Step Conference and Snapshot Services (Snapshot Call and Snapshot Device) Telephony Web Services TSAPI JTAPI CVLAN DLG (ASAI applications) Tip:

Tip:

If you are setting up an AE Server to support Device, Media, and Call Control applications that use device and media control only, and you do not want to take advantage of the feature to assign H.323 IP addresses, skip this procedure. Note: AE Services recommends that you use at least two CLANs per Switch Connection. 1. From the CTI OAM main menu select Administration > Switch Connections. OAM displays the Switch Connections page.

Note:

Follow this procedure to administer Switch Connections.

Issue 7 July 2007

73

AE Services OAM Administration and CTI OAM Admin

2. In the Add Connection field, type Switch Connection name (for example Switch1) and click Add Connection. The Switch Connection Name can be any name you want to use, but it must consist of alphanumeric characters only. OAM displays the Set Password - Switch1 page. a. Select the appropriate switch connection type from the drop down list box. Selections for the Switch Connection Type are as follows:

CTI/Call Information - This is the default setting. Select CTI/Call Information if you are adding a switch connection for applications that use any of the following: Device, Media, and Call Control (with Call Information Services or Call Control and Snapshot Services), Telephony Web Services, JTAPI, TSAPI, CVLAN or DLG. H323 Gatekeeper - Select H323 Gatekeeper for applications that use Device, Media, and Call Control with device and media control only.

b. In the Switch Password field, type the password that the Communication Manager administrator assigned when the node name of the AE Server on the IP-Services form was administered. (If you use Device, Media, and Call Control without Call Information Services and you are setting up a Switch Connection to use the round-robin assignment of H.323 Gatekeepers, you can use an arbitrary password). c. In the Confirm Switch Password field, re-type the password. d. In the SSL check box accept the default (it is checked, or enabled by default) for all Communication Manager Servers except DEFINITY Server G3csi. If you are using a DEFINITY Server G3csi, this box should be unchecked. SSL is not supported by DEFINITY Server G3csi. e. Click Apply. OAM adds the switch connection and returns you to the Switch Connections page, with the new switch connection name added to the Connection Name column. 3. From the Switch Connections page, select the connection name you just added (Switch1, for example), and click Edit CLAN IPs. Skip this step if you use Device, Media, and Call Control without Call Information Services. OAM displays the Edit CLAN IPs - Switch1 page. 4. In the Add Name or IP field, type the <Host Name> or the <IP Address>, and click Add Name or IP (use the Host Name or IP address of either the Processor CLAN or the TN799DP CLAN). Note: For systems with multiple TN799DP CLANs, repeat this step for each TN799DP CLAN. When you add multiple TN799DP CLANs for a Switch Connection, each Host Name or IP address is added as the last item in the Name or IP Address list.

Note:

The following steps apply only to Device, Media, and Call Control applications that use device and media control. For more information, see Summary of AE Server CTI OAM administrative tasks on page 64.

74 AE Services Administration and Maintenance Guide, Release 4.0.1

Administering Network Connections

5. Click Switch Connections from the main menu. OAM displays the Switch Connections page. 6. Select the Connection Name you want to associate with the H.323 Gatekeeper, and click Edit H.323 Gatekeeper. OAM displays the Edit H.323 Gatekeeper - Switch1 page. 7. In the Add Name or IP field, type the <Host Name> or <IP address> of the Processor CLAN or the TN799DP CLAN you want to use.

If you are adding multiple H.323 Gatekeepers (TN799DP CLANs), repeat this step for each H.323 Gatekeeper. When you add multiple H.323 Gatekeepers for a Switch Connection, each Host Name or IP address is added as the last item in the Name or IP Address list.

This completes the procedure for Administering Switch Connections.

Checking the status of a switch connection -- from the AE Server


Follow this procedure to get the Status of a Switch Connection from the AE Server to Communication Manager. 1. From the CTI OAM main menu, select Status and Control > Switch Conn Summary. OAM displays the Switch Connections Summary page. 2. Select the Switch Connection you just added (Switch1, for example), and click Switch Connection Details. 3. Review the information on the Switch Connection Details page. 4. Check the status of the switch connection on Communication Manager. See Checking the status of a Switch Connection -- from Communication Manager on page 31.

Issue 7 July 2007

75

AE Services OAM Administration and CTI OAM Admin

Link Administration - CTI Link Admin in AE Services OAM


This section describes how to administer the following links in AE Services OAM.

CVLAN Links - see Administering CVLAN Links in AE Services OAM on page 76. For related procedures on Communication Manager, see the following sections: - Administering a CTI Link for a CVLAN application on page 29 - Administering a CTI Link used for internal Avaya CVLAN applications on page 29 DLG Links - see Administering DLG Links in AE Services OAM on page 79. For the related procedure on Communication Manager, see Administering a CTI Link for an ASAI application on page 30.

TSAPI Links - see Administering TSAPI Links in AE Services OAM on page 80. For the related procedure on Communication Manager, see Administering a CTI Link for TSAPI, TR/87, JTAPI, Telephony Web Service, and Device, Media, and Call Control on page 30.

Administering CVLAN Links in AE Services OAM


CVLAN Links are used by CVLAN applications and internal Avaya CVLAN applications. For more information about setting up CVLAN Links, see CVLAN implementation guidelines on page 78. Note: In the context of CVLAN Links, the terms link and signal are synonymous. 1. From the CTI OAM main menu select Administration > CTI Link Admin > CVLAN Links. OAM displays the CVLAN Links page. 2. On the CVLAN Links page, click Add Link. OAM displays the Add / Edit CVLAN Link page. 3. Follow these steps to complete the Add / Edit CVLAN Link page. a. In the Signal field, select a signal number. The signal number used by the CVLAN Link and the CVLAN application must match. Note: Prior to CVLAN R9 and AE Services 3.0, the range of CVLAN signals (links) was 1 through 8 instead of 1-16. If you select 9 through 16, make sure your application is not hard coded to use signals 1 through 8 only.

Note:

Follow this procedure to administer a CVLAN Link in AE Services OAM.

Note:

76 AE Services Administration and Maintenance Guide, Release 4.0.1

Link Administration - CTI Link Admin in AE Services OAM

b. Leave the check box for Proprietary unselected (the default). Only check proprietary when the CVLAN Link will be used by internal Avaya CVLAN applications. c. In the Switch Connection field, select the switch connection that will be used, for example, Switch1. d. In the Switch CTI link Number field, select the switch CTI link number administered on Communication Manager for this CVLAN Link. e. In the Version field, select the highest ASAI link version the CVLAN application will support. f. In the Heartbeat check box, choose the setting appropriate for the configuration:

Enable the setting (checked) to designate the CVLAN service as the ASAI Heartbeat server. Disable the setting (not checked) to designate the CVLAN application as the ASAI Heartbeat server.

g. Click Apply Changes. OAM displays the Apply Changes to Link page. 4. Click Apply. 5. Restart the CVLAN Service as follows: a. Select Maintenance > Service Controller. b. From the Service Controller page, select CVLAN Service, and click Restart Service. The CVLAN Service has successfully restarted when the Controller Status displays Running. This completes the procedure to administer a CVLAN Link on AE Services.

Check the status of the link on Communication Manager (see Checking the status of a Switch Connection -- from Communication Manager on page 31). Check the status of the link on AE Services (see Checking the status of a switch connection -- from the AE Server on page 75).

Testing a CVLAN Link


Follow this procedure to test a CVLAN Link in AE Services OAM. 1. From the CTI OAM main menu select Utilities > ASAI Test. OAM displays the ASAI Test page. 2. Select the link number you want to test and click Test. OAM displays the ASAI Test Result page, which indicates if the test is successful.

Issue 7 July 2007

77

AE Services OAM Administration and CTI OAM Admin

Adding CVLAN Clients


Follow this procedure to add a CVLAN Client. 1. From the CTI OAM main menu select Administration > CTI Link Admin > CVLAN Links. OAM displays the CVLAN Links page. 2. Select the Signal (link) that you want to administer and click Edit Client. OAM displays the Edit Clients page. 3. In the Add Client field, type the <IP Address> or the <Host Name> of the CVLAN client, and click Add Client. Repeat this step for each client that you want to add.

CVLAN implementation guidelines


When you are setting up CVLAN with AE Services, use the following guidelines based on your application requirements.

CVLAN applications and link management


Applications use separate links to avoid conflicts and control load. For example, by using two separate links you can avoid problems with two applications that register as routing servers. When setting up a link, either a CVLAN Link or a proprietary CVLAN Link, bear in mind that only one application at a time can register as either a heartbeat server or a routing server. For more information about heartbeat messages and route requests, see the Avaya MultiVantage Application Enablement Services CVLAN Programmers Reference, 02-300546.

Guidelines for setting up CVLAN Links


To set up a CVLAN Link that allows multiple clients (up to 60) to share the same CVLAN Link (signal), follow these guidelines.

On Communication Manager, administer the CTI link as ASAI-IP, as described in Administering a CTI Link for a CVLAN application on page 29. In AE Services OAM, administer the CVLAN Link with the Proprietary setting disabled, as described in Administering CVLAN Links in AE Services OAM on page 76. In AE Services OAM, administer the CVLAN clients (up to 60) for a specific CVLAN Link, as described in Adding CVLAN Clients on page 78.

78 AE Services Administration and Maintenance Guide, Release 4.0.1

Link Administration - CTI Link Admin in AE Services OAM

Guidelines for setting up proprietary CVLAN Links


To set up a proprietary CVLAN Link (signal), follow these guidelines:

On Communication Manager, administer the CTI link as ADJ-IP, as described in Administering a CTI Link used for internal Avaya CVLAN applications on page 29. In AE Services OAM, administer the CVLAN Link with the Proprietary setting enabled. See Administering CVLAN Links in AE Services OAM on page 76. In AE Services OAM, administer only one CVLAN client for each CVLAN Link. See Adding CVLAN Clients on page 78.

AE Services provides proprietary links for Avaya applications. As a result, AE Services limits the way that proprietary links can be used. For example, AE Services allows only one proprietary link to be opened for one CVLAN client IP address.

Administering DLG Links in AE Services OAM


DLG Links are used by ASAI applications. Follow this procedure to administer a DLG Link in AE Services OAM. 1. From the CTI OAM main menu select Administration > CTI Link Admin > DLG Links. OAM displays the DLG Links page. 2. From the DLG Links page, click Add Link. 3. OAM displays the Add / Edit DLG Links page. 4. Follow these steps to complete the Add / Edit DLG page. a. In the Connection field, select the Switch Connection that you want to use (Switch1, for example). b. In the Switch CTI Link Number field, select the Switch CTI link number administered on Communication Manager for this DLG link. c. In the Client Hostname or IP field, type the <Host Name> or <IP address> of the client application. d. In the Client Link Number field, type the <link number> of the client application. e. Click Apply Changes. OAM displays the Apply Changes to Link page to confirm your selection. 5. Click Apply.

Issue 7 July 2007

79

AE Services OAM Administration and CTI OAM Admin

This completes the procedure to administer a DLG link on AE Services.

Check the status of the link on Communication Manager (see Checking the status of a Switch Connection -- from Communication Manager on page 31). Check the status of the link on AE Services (see Checking the status of a switch connection -- from the AE Server on page 75).

Administering TSAPI Links in AE Services OAM


TSAPI Links are used by TSAPI applications, JTAPI applications, Telephony Web Service applications, and Device, Media, and Call Control applications that use Call Control or Snapshot Services, and TR/87 applications. For more information, see Summary of AE Server CTI OAM administrative tasks on page 64). The TSAPI Service allows you to administer only one TSAPI Link to Communication Manager. You can have up to 8 links to 8 different Communication Manager servers. Load balancing and link redundancy are handled by the Transport Layer service, thereby eliminating any practical necessity for multiple TSAPI links to one Communication Manager server. Follow this procedure to administer a TSAPI Link in AE Services OAM. 1. From the CTI OAM main menu select Administration > CTI Link Admin > TSAPI Links. OAM displays the TSAPI Links page. 2. From the TSAPI Links page, click Add Link. OAM displays the Add / Edit TSAPI Links page. 3. Complete the Add / Edit TSAPI Links page as follows: a. In the Link field, select the link number. b. In the Switch Connection field, select the Switch Connection that you want to use. c. In the Switch CTI Link Number field, select the Switch CTI link number administered on Communication Manager for this TSAPI link. d. Click Apply Changes. OAM displays the Apply Changes to a Link page. 4. Click Apply to apply the changes. 5. Run a service refresh, by following Step a or b, to based how the TSAPI link is used in your configuration: a. If the TSAPI Link is used in a TR/87 configuration (AE Services and Live Communications Server integration) you must restart the AE Server. To restart the AE Server, select Maintenance > Service Controller. From the Service Controller page, click Restart AE Server.

80 AE Services Administration and Maintenance Guide, Release 4.0.1

Backing up the database

b. If the TSAPI Link is used in a configuration that supports CVLAN or DLG, just start and stop the TSAPI Service -- that is, do not restart the AE Server. Select Maintenance > Service Controller. From the Service Controller page, select TSAPI Service, and click Stop. After the TSAPI Service is stopped, click Start to start the TSAPI service again. To check status of the service. Select Status and Control > Services Summary. When you Stop the TSAPI service, its status is DOWN. When you start the TSAPI service again, its status is ONLINE. This completes the procedure to administer a TSAPI link on AE Services. Follow these procedures to check the status of a link.

Check the status of the link on Communication Manager (see Checking the status of a Switch Connection -- from Communication Manager on page 31). Check the status of the link on AE Services (see Checking the status of a switch connection -- from the AE Server on page 75).

Backing up the database


Follow this procedure to back up the AE Services database, which includes configuration data files, the AE Services user database, certificates, and the license file. 1. From the CTI OAM main menu, select Maintenance > Service Controller > Backup Database. OAM displays the Database Backup page with the following message.

The backup file can be downloaded from here

2. Click the here link. The system displays the File Download dialog box, which identifies the file name (mvapdbddmmyyyy.tar.gz), and prompts you to save the file. 3. Click Save. The system displays the Save As dialog box. 4. Browse to the location on the computer that you want to use for storing the AE Services database backup, and click Save. Your computer stores the AE Services database backup file in the location you specified.

!
Important:

Important: After your system saves the backup file, locate the file and verify that it has been saved with the .tar.gz extension. If it does not have the .tar.gz extension, rename the file and add the .tar.gz extension (for example, mvapdb05052007.tar.gz).

This completes the procedure to backup the database. For information about restoring the database, see Restoring the database on page 82.

Issue 7 July 2007

81

AE Services OAM Administration and CTI OAM Admin

Restoring the database


Restoring the database involves restoring a copy of the AE Services database and restarting Linux. The AE Services database includes configuration data files, the AE Services user database, certificates, and the license file. Follow this procedure to restore the database. 1. From the CTI OAM main menu, select Maintenance > Restore Database. OAM displays the Restore Database Configuration page. The initial state of the Restore Database page provides you with two basic functions:

a text box with the Browse button, which provides the means to select a backup file to use for the Restore process. Alternatively, you can type a fully qualified name of the backup file in the text box. a Restore button, which starts the Restore process

2. Click Browse and locate the AE Services database backup file that you intend to use (mvapdb10012006.tar.gz, for example).

!
Important:

Important: Make sure that the database backup file has the .tar.gz extension. Recall that Step 4 of Backing up the database on page 81 instructs you to rename the file if your system does not save it with a .tar.gz extension. If you did not rename the file when you ran the backup, be sure to rename it with the .tar.gz extension before you continue with Step 3 to restore the database.

3. Click Restore. OAM redisplays the Restore Database Configuration page, with the following message. A database restore is pending. You must restart the Database Service and the AE Server for the restore to take effect.To restart these services now, click the Restart Services button below. 4. Click Restart Services. AE Services restarts the Database Service and the AE Server, thereby completing the Restore process. This completes the procedure to restore the AE Services database.

! CAUTION:
CAUTION:

If you make any OAM changes during the interval between clicking Restore and Restart Services, these changes will be lost.

82 AE Services Administration and Maintenance Guide, Release 4.0.1

Downloading and viewing log files

Downloading and viewing log files


The OAM Web pages provide only the means to locate and download log files. To read any log you must download it, uncompress it, and then open it with a text editor. Follow this procedure to download and view a log file. 1. From the CTI OAM main menu, select the appropriate link for the log file (or files) you want to download as follows:

To download the Error Log, select Logs > Error Log. To download the Client Access Log, select Logs > Security Logs > Client Access Logs. To download the System Reset Log, select Logs > Security Logs > System Reset Log. To download the Command Logs, select Logs > Security Logs > Command Logs.

OAM displays the appropriate Log page, based on your selection. 2. Select the check box next to the log file (you can select multiple check boxes for the Error Log, the Client Access Logs, and the Command Logs) you want to download, and click Download. OAM displays the Download page, with the following message, Click here to Download. 3. Click the here link. The system displays the File Download dialog box, which prompts you to save the file. 4. Click Save. The system displays the Save As dialog box. 5. Browse to the location on your local PC that you want to use for storing the file, and click Save. The system stores the compressed error log file in the location you specified. 6. Change to the directory where you stored the log file. Uncompress the log file and use a text editor to view the error log. This completes the procedure to download and view a log file.

Issue 7 July 2007

83

AE Services OAM Administration and CTI OAM Admin

Using the Service Controller


Use the Service Controller to start, stop, and restart any of the following services. From the CTI OAM main menu, select Select Maintenance > Service Controller to access the Service Controller. To perform an action on a service, select the check box for a service (you can select more than one service) and click the appropriate button (Start, Stop, or Restart Service).

ASAI Link Manager DMCC Service (Device, Media, and Call Control) CVLAN Service DLG Service Transport Layer Service TSAPI Service

Additionally, AE Services provides you with the means to restart all AE Services or the Linux operating system with the following buttons.

Restart AE Server Restart Linux

!
WARNING:

WARNING: It is generally understood that stopping and restarting a service is potentially disruptive to applications upstream. Doing so can result in dropped connections and lost associations.

See AE Services -- dependencies at a glance on page 86 for an illustration of the service dependencies. Service Controller page elements Element Check box Service Description Use the check box to select a service or multiple services. The Service column lists the following AE Services:

ASAI Link Manager DMCC Service (Device, Media, and Call Control) CVLAN Service DLG Service Transport Layer Service TSAPI Service 1 of 2

84 AE Services Administration and Maintenance Guide, Release 4.0.1

Using the Service Controller

Service Controller page elements (continued) Element Status Description The Status column lists the current status of each service, as follows: Running Stopped No License

Start

Select Start to start the service or services you select. When you click Start, OAM starts only the services that you select. Starting a service does not trigger the start of a dependent service. Select Stop to stop the service or services you select.

Stop

!
WARNING:

WARNING: If you stop a service, other services might be affected. See About stopping services on page 87.

When you click Stop, OAM stops the service or services you select. Select Service to restart the service or services you have selected.

Restart Service

!
WARNING:

WARNING: Restarting a service results in dropping all existing connections and losing all associations.

Restart AE Server

Select Restart AE Server to restart all AE Services ASAI Link Manager DMCC Service (Device, Media, and Call Control) CVLAN Service DLG Service Transport Layer Service TSAPI Service

!
WARNING:

WARNING: Restarting AE Services results in dropping all existing connections and losing all associations.

Restart Linux

Select Restart Linux to restart the operating system.

!
WARNING:

WARNING: Restarting Linux results in dropping all existing connections and losing all associations. 2 of 2

Issue 7 July 2007

85

AE Services OAM Administration and CTI OAM Admin

Figure 25: AE Services -- dependencies at a glance

AE Server
Telephony Web Service

TR87

Tr

SIP user User agent Agent Device, Media, and Call Control (DMCC) Call Control Call Device Media Information Control and Control Snapshot Services Services

TSAPI Service

CVLAN Service

DLG Service

ASAI Link Layer


DAPI

Transport Layer Service

Communication Manager
Note: This diagram depicts only a subset of the services that AE Services provides.

Note:

86 AE Services Administration and Maintenance Guide, Release 4.0.1

Using the Service Controller

About stopping services


Use the following table, Service dependencies, to see the effects of stopping the services listed on the Service Controller Page. Service dependencies Service DMCC Service (Device, Media, and Call Control) Impact of stopping the service If you stop the DMCC Service, you lose functionality of the following: Device, Media, and Call Control with Single-Step Conference and Snapshot Services (Snapshot Call and Snapshot Device) Device, Media, and Call Control with Call Information Services Device, Media, and Call Control without Call Information Services. All other AE Services continue to operate. If you stop the DLG Service, you lose DLG functionality, but all other AE Services continue to operate. If you stop the CVLAN Service, you lose CVLAN functionality, but all other AE Services continue to operate. If you stop the TSAPI Service, you lose TSAPI functionality and the following clients can not communicate with the switch: TSAPI JTAPI Telephony Web Service Device, Media, and Call Control with Single-Step Conference and Snapshot Services (Snapshot Call and Snapshot Device) All other AE Services continue to operate. 1 of 2

DLG Service CVLAN Service TSAPI Service

Issue 7 July 2007

87

AE Services OAM Administration and CTI OAM Admin

Service dependencies (continued) Service ASAI Link Manager Impact of stopping the service

If you stop the ASAI Link Manager, you lose ASAI Link level functionality. The TSAPI Service and the CVLAN Service continue to run, but they can not communicate with the Transport Layer and Communication Manager. - DLG and Device, Media, and Call Control applications that use device and media control only can continue to communicate with Communication Manager. - Device, Media, and Call Control with Single-Step Conference and Snapshot Services (Snapshot Call and Snapshot Device) can not communicate with Communication Manager. If you restart the ASAI Link Manager you do not have to restart the TSAPI Service, the CVLAN Service, Telephony Web Service, or the Device, Media, and Call Control Service -- they will recover. All of their clients, however, would need to reconnect. If you stop Transport Layer Services, the following services continue to run: the ASAI Link Manager, the TSAPI Service, JTAPI, the CVLAN Service, the DLG Service, Device, Media, and Call Control with Call Information Services, and Device, Media, and Call Control with Single-Step Conference and Snapshot Services (Snapshot Call and Snapshot Device), but they can not communicate with Communication Manager. Device, Media, and Call Control applications that use device and media control only continue to operate and can communicate with Communication Manager. If you restart the Transport Layer Service, you do not have to restart the ASAI Link Manager, the TSAPI service, the CVLAN, service and the Device, Media, and Call Control Service -- they will recover. You will, however, need to restart the DLG Service. Also if you restart the transport Layer Service, clients of the following services would need to reconnect: TSAPI, Telephony Web Service, Device, Media, and Call Control with Call Information Services, Device, Media, and Call Control with Single-Step Conference and Snapshot Services (Snapshot Call and Snapshot Device), CVLAN, DLG. 2 of 2

Transport Layer Service

88 AE Services Administration and Maintenance Guide, Release 4.0.1

Changing the IP address of the AE Server

Changing the IP address of the AE Server


To avoid error conditions, follow this procedure to change the IP address of the AE Server. 1. Log in to the AE Server as a user and follow Step a or b, based on the AE Server offer you have. a. If you have the Software-Only server, type the following command to become a super user with root privileges, su - root . b. If you have the Bundled server, type the following command to become a super user with root privileges, su - sroot . 2. From the command line type the following command to stop the AE Server: service mvap stop 3. Using a text editor, update the /etc/hosts file with the new IP address, for example: 192.168.123.44 . 4. From AE Services OAM, select CTI OAM > Administration > Network Configuration > Local IP 5. On the Local IP Page verify that the Client Connectivity field displays either of the following:

If your AE Server has only one NIC, the field displays the IP address you just entered in the etc/hosts file, for example: 192.168.123.44 . If your AE Server has more than one NIC, select one of the valid IP addresses or ANY.

Note:

Note: If the server has a SAMP card (Bundled Server only), it is strongly recommended that you specify a valid IP address. 6. Click Apply changes . 7. From the command line type the following command to start the AE Server: service mvap start

Issue 7 July 2007

89

AE Services OAM Administration and CTI OAM Admin

90 AE Services Administration and Maintenance Guide, Release 4.0.1

Account set up

Chapter 3: OAM User Management Administration


This chapter describes the Application Enablement Services (AE Services) OAM (Operations, Administration, and Maintenance) capabilities that are provided by the OAM User Management account. This chapter includes the following topics:

Account set up on page 91 User Management - summary of features on page 93. Service Management on page 99.

Account set up
For information about accessing User Management and setting up the CTI OAM Administrator as the User Management Administrator (when you want one common administrator for AE Services), see the following sections.

Logging in to User Management on page 93 Setting up the CTI OAM administrator as the User Management administrator on page 93

Issue 7 July 2007

91

OAM User Management Administration

User Management
User Management provides you with tools to add, change, or delete a user in AE Services User Service database.

AE Services that rely on User Management for authentication


The following types of AE Services users are authenticated by the AE Services User Service database.

TSAPI - Users of these applications are authenticated by the User Service. They are administered as CT Users, and they derive authorization from the Security Database (SDB). JTAPI - Users of these applications are authenticated by the User Service. They are administered as CT Users, and they derive authorization from the SDB. Telephony Web Service - Users of these applications are authenticated by the User Service. They are administered as CT Users, and they derive authorization from the SDB. Device, Media, and Call Control Service users. All Device, Media, and Call Control based applications rely on the User Service: - Applications that use Device control services, Media Control services, and Call Control Services (CSTA III Snapshot Call, Snapshot Device, and Single-Step Conference). Users of these applications are authenticated by the User Service. They are administered as CT Users, and they derive authorization from the SDB. - Applications that use Device control services, and Media Control services. Although these users rely on the User Service for authentication, these users are not administered in the Security Database. That is, they are not administered as CT Users in the User Service, and they do not derive authorization from the SDB.

See also, Table 3: Per-client summary of AE Server CTI OAM administration tasks on page 64.

92 AE Services Administration and Maintenance Guide, Release 4.0.1

User Management - summary of features

User Management - summary of features


From the OAM User Management Web page you have access to the following capabilities for managing users in the AE Services User Service database.

List All Users - for more information, see List All Users on page 94. Add User - for more information, see Adding a user to the AE Services User Service database on page 95. Search Users - for more information, see Search Users on page 96. Modify Default User - for more information, see Modify Default User on page 97. Change User Password - for more information, see Change User Password on page 98.

Logging in to User Management


Log in using the User Management user name and password. The default user name and password is avaya and avayapassword.

!
SECURITY ALERT:

SECURITY ALERT: Change the default user name and password immediately.

Setting up the CTI OAM administrator as the User Management administrator


If you want the same person to be the both the CTI OAM Admin administrator and the User Management administrator, follow this procedure. 1. Log in to User Management with the default user name and password (avaya and avayapassword). 2. From the User Management main menu, select User Management > Add User. OAM displays the Add User page. 3. Complete the Add User page as follows:

Add the appropriate information in all required fields. Required fields are marked with an asterisk (*). Follow these steps specifically. - In the User Id field, type the OAM administrators user id, which is a Linux user id. - In the Avaya Role field, select user.service.useradmin.

Issue 7 July 2007

93

OAM User Management Administration

Click Apply. OAM displays the Add User Results page, indicating that the user was created successfully.

4. From the main menu select List All Users. 5. OAM displays the List All Users page. 6. Select the avaya user (avaya appears in the User Id, Common Name and Surname fields), and click Delete. 7. OAM displays the Delete User page. 8. Click Delete.

List All Users


The List All Users page displays a list of the user IDs and Common names of all AE Services users in the AE Services User Service database. AE Services users include CT Users, the CTI enabled users who are maintained in the TSAPI Security Database. The AE Services List All Users page provides you with access to the following administrative functions for managing users in the AE Services User Service database.

Edit Delete Details List All (displays all users on one page instead of 100 users per page)

94 AE Services Administration and Maintenance Guide, Release 4.0.1

User Management - summary of features

Adding a user to the AE Services User Service database


AE Services User Management provides you with a means to add users to the AE Services User Service database. Follow this procedure to add a user to the AE Services User Service database. Note: This example depicts adding a user who will be a member of the TSAPI Service Security Database. 1. From the OAM main menu, select User Management > Add User. OAM displays the Add User page. 2. Complete following fields (the required fields are marked with an asterisk) for the user you are adding. a. In the * User id field, type the user id you are assigning to the user (jdoe, for example). b. In the * Common Name field, type the users common name (Jane, for example). c. In the * Surname field, type the surname (Doe, for example). d. In the * User Password field type the password you are assigning to the user. e. In the * Confirm Password field, re-type the assigned password. f. In the CT User field accept the default (no) unless the user is a member of the TSAPI Service Security Database (SDB). If the user is a member of the TSAPI Service SDB, select yes. For more information about CT Users, see CT User on page 192. 3. Click Apply. OAM displays the Add User Results page with the following message: User created successfully!

Note:

Edit User
Use Edit User to change information about users in the AE Services User Service database. Follow this procedure to edit a user in AE Services User Service database. 1. From the OAM main menu, select User Management > List All Users. OAM displays the List All Users page. 2. Select the User Id you want to edit, jdoe for example, and click Edit. 3. Select the fields you want to change, for example, in departmentnumber, type 100887700. 4. Click Apply. OAM displays the Edit User page, asking you to confirm that you want to change user data.

Issue 7 July 2007

95

OAM User Management Administration

5. Click Apply Changes. OAM displays the Message page with the following message: User edited successfully!

Delete User
Follow this procedure to delete a user from the AE Services User Service database. 1. From the OAM main menu, select User Management > List All Users. OAM displays the List All Users page. 2. Select the User Id you want to delete, jdoe for example, and click Delete. 3. OAM displays the Delete User page, asking you to confirm that you want to delete this user. 4. Click Delete. OAM deletes the user, and displays the message, User deleted successfully!

Search Users
Follow this procedure to search for a user in AE Services User Service database. 1. From the OAM main menu, select User Management > Search Users. OAM displays the Search Users page. 2. In the Search Attribute field, select one of the following, User ID, Surname, or Common Name. 3. In the Search value field, type the search value, as follows:

If you select User ID, type a User ID (jdoe for example). If you select Surname, type the users last name (doe for example). If you select Common Name, type the users first name and last name (Jane Doe for example).

OAM displays the Search Results page. If your search yields a match (or a list of matches), OAM displays the User ID, Common Name, and Surname of the user (or users).

Search tips
Here are a few basic search tips.

OAM searches are not case sensitive. For example, you can use all lower case characters on a surname, such as doe, and get a successful result for Doe. Use the asterisk (or wildcard) when you know only part of the first or last name or User ID Usually, wildcard searches result in multiple names.

96 AE Services Administration and Maintenance Guide, Release 4.0.1

User Management - summary of features

Modify Default User


The Modify Default User Web page is closely tied to the Add User Web page. When you have large groups of people who share common attributes, you can use the Modify Default User page to simplify the process of adding users. Keep in mind, however, that if you do plan use Modify Default User page in this way, you must manage the process carefully. Here is a simple example that demonstrates how the Modify Default User page can be used to administer 60 users for two different departments, sales and support. Each department consists of 30 people. 1. Select User Management > Modify Default User. OAM displays the Modify Default User page. 2. In the Business Category field, type Sales. 3. In the Department Number field, type 30756032100 (the department number for sales). 4. Click Apply. 5. From the User Management menu select Add User. OAM displays the Add User page. 6. For each user in the Sales department you would need to enter specific information for the required fields (User Id, Common Name, Surname, User Password, and Confirm Password), but the following fields, which you administered on the Modify Default User page, would already be complete.

Business Category Sales Department Number 30756032100

7. Once you have completed the Add User page each of the 30 users in the Sales group, select Modify Default User. OAM displays the Modify Default User Page. 8. In the Business Category field, type Support. 9. In the Department Number field, type 30747912100 (the department number for Support). 10. Click Apply. 11. From the User Management menu select Add User. OAM displays the Add User page. 12. For each user in the Support department you would need to enter specific information for the required fields (User Id, Common Name, Surname, User Password, and Confirm Password), but the following fields, which you administered on the Modify Default User page, would already be complete.

Business Category Support Department Number 30747912100

Issue 7 July 2007

97

OAM User Management Administration

13. Once you have completed Add User page for all 30 users in the Support group, select Modify Default User. OAM displays the Modify Default User Page. 14. Clear the Business Category and Department fields, and click Apply.

!
Important:

Important: When you are using the Modify Default User page to administer groups of users with common settings, be sure to clear the settings once you have completed the process of administering all groups.

Change User Password


Follow this procedure to change your User Management password. 1. From the OAM main menu, select User Management > Change User Password. OAM displays the Change User Password page. 2. Complete the Change User Password page, as follows:

In the User Id field, type your User Id. In the New Password field, type a newpassword. In the Confirm New Password field, re-type the newpassword, and click Submit.

If your password change is successful


If your password change is successful OAM displays a message to indicate the change is successful.

If your password change is unsuccessful


If any errors are detected, OAM displays an appropriate error message, such as:

The two new password fields dont match. In this case OAM redisplays the Change administrator password page, and you can repeat Step 2. The process did not complete. Invalid credentials. In this case OAM displays an Error page, and you must repeat Steps 1 and 2.

98 AE Services Administration and Maintenance Guide, Release 4.0.1

Service Management

Service Management
Service Management provides you the following set of operations for controlling the User Service.

Edit Service Configuration - see Editing the Service Configuration on page 100. Re-initialize Service - see Re-initializing the User Service on page 103. View Service Log - see Downloading and viewing Service Log files on page 104. Manage Distributors - see Managing Distributors on page 105.

The User Service is a shared service component that allows you to manage user profile data in a common user store. The User Service provides the ability for web services applications to authenticate users against an LDAP data store of authorized users and to receive notification of additions or changes to user profiles. For more information about taking advantage of the capabilities of the User Service, see the Avaya MultiVantage Application Enablement Services Web Services Programmers Guide, 02-300362.

Issue 7 July 2007

99

OAM User Management Administration

Editing the Service Configuration


Service Management provides you with configuration files that enable you to control the User Service, (for more information, see the User Service on page 197). All configuration files contain parameters that are expressed as name-value pairs in the following format: name=value. For example, cn=common name.

! CAUTION:
CAUTION:

Unless you are an advanced administrator, do not change any settings in these files.

defaultuservalues.properties attributesmap.properties attributeacl.properties sdbdistributor.properties genericldap1.properties genericldap2.properties replicator1.properties rbac.properties ldapfilter.properties remoteldapauthenticator.properties user.properties ws_cus_bootstrap.properties

defaultuservalues.properties
This file is not normally edited by hand. This file is updated by working through the Modify Default User form under User Service. There is no need to re-initialize User Service if the file is edited by the web form or by hand.

attributesmap.properties
This file is used to map raw (LDAP oriented) User attribute names to friendly display names. For example, the file maps the attribute named uid to User ID. There is no need to re-initialize the User Service if this file is edited.

100 AE Services Administration and Maintenance Guide, Release 4.0.1

Service Management

attributeacl.properties
This file allows fine tuning of the attribute level Access Control List (ACL) enforced by the User Service. This file is generally only altered for customization purposes. For changes to this file to take effect, the User Service must be re-initialized. See Re-initializing the User Service on page 103.

sdbdistributor.properties
This file is the configuration file for the SDB Distributor. This Distributor supports synchronization of the User Service with the TSAPI Security Database. For changes to this file to take effect, the User Service must be re-initialized. See Re-initializing the User Service on page 103.

genericldap1.properties, genericldap2.properties, replicator1.properties


These three files are for reference only. The genericldap property files demonstrate two examples of configuring an LDAP distributor and serve as models for setting up an LDAP Distributor, post-installation. Changes to these files are unnecessary unless a like named Distributor is configured to run in the user.properties file (distributors section). When a corresponding Distributor is being run, and changes are made to its property file, the changes will not take effect until the User Service is re-initialized. See Re-initializing the User Service on page 103. Note: The replicator1.properties file is a place holder for a replication Distributor that is not available in the initial release of the User Service.

Note:

rbac.properties
This file maps User Service operation names to a list of roles that give access to the specified operation. It would be very unusual to reconfigure this file in the field. For changes to this file to take effect, the User Service must be re-initialized. See Re-initializing the User Service on page 103.

Issue 7 July 2007

101

OAM User Management Administration

ldapfilter.properties
This file configures the LDAP Authentication filter. When the User Service receives an operation request, the service validates the callers credentials against the LDAP service indicated in this file. The settings in this file should reflect the mode of authentication that the User Service is running in (see user.properties security section). For example, if the User Service is running with remote authentication, the ldapfilter.properties should be set to the same remote LDAP service. If the User Service is running with basic (local) authentication, then the properties should specify the User Services underlying LDAP service. For changes to this file to take effect, the User Service must be re-initialized. See Re-initializing the User Service on page 103.

remoteldapauthenticator.properties
If the User Service is running with remote authentication (see user.properties security section) then this file specifies the location of the remote LDAP service. If this file is in use, the settings will normally match those of the ldapfilter.properties file. For changes to this file to take effect, the User Service must be re-initialized. See Re-initializing the User Service on page 103.

user.properties
This is the main configuration file for the User Service service. It controls:

Primary LDAP interface settings Distributor settings Logging settings Supported attributes and their types The definition of protected users (from deletion during synchronizations) Security Advertising of internal user roles (for OAM support)

For changes to this file to take effect, the User Service must be re-initialized. See Re-initializing the User Service on page 103.

ws_cus_bootstrap.properties
This file contains the essential bootstrap parameters for the service, and is not normally altered post-installation. If the file is altered, it must be manually copied to the <TOMCAT_HOME>/ webapps/axis/WEB-INF folder. Then, for changes to this file to take effect, the User Service must be re-initialized. See Re-initializing the User Service on page 103.

102 AE Services Administration and Maintenance Guide, Release 4.0.1

Service Management

Re-initializing the User Service


Many of the service configuration files require you to re-initialize the User Service before your changes take effect. Re-initializing the service is a non-blocking feature. AE Services continues to operate when you use this feature. Follow this procedure to re-initialize the User Service. 1. From the main menu, click Re-initialize Service. OAM displays the Reinitialize service page, which asks you to confirm that you want to reinitialize the service. 2. Click Reinitialize to re-initialize the User Service.

Edit Service Configuration - default user values file


The default user values properties file (defaultuservalues.properties) determines which values appear as the default values on the Add User page, in User Management (see Adding a user to the AE Services User Service database on page 95). All parameters in the defaultuservalues.properties file are expressed as name-value pairs, in the following format: name=value, for example cn=common name. Here is a scenario for editing a service configuration and putting the changes into effect. 1. From the main menu select Service Management > Edit Service Configuration. 2. OAM displays the Edit Service Configuration page with the contents of the service configuration file displayed in the text box. 3. Add preferredlanguage=English as a user attribute in the defaultuservalues.properties file, and click Submit. 4. OAM displays the Message page with the following message. Service configuration edited successfully. If you edited service configuration, you may have to reinitialize the service for changes to be effective. Note: After you edit a service configuration file, you do not have to reinitialize the service. 5. From the main menu, click Add User. OAM displays the Add User page, which displays English in the preferredlanguage field. 6. To change the value of preferred language (from English to Spanish, for example), select Modify Default User from the main menu.

Note:

Issue 7 July 2007

103

OAM User Management Administration

7. From the Default User page, change value of preferred language to Spanish. 8. Select Service Management > Reinitialize Service. OAM displays the message, Service Initiated successfully. 9. From the main menu, click Add User and on the Add User page, verify that preferred language is Spanish.

Downloading and viewing Service Log files


Service logs contain up-to-date information about Service Management activities and errors. Note: You can not view Service Logs from the Service Log page. You must download them to your computer, uncompress them, and use a text editor to view them. 1. From the OAM User Management main menu, select Service Management > View Service Log. OAM displays the Service Log page. 2. Select the check box (or check boxes) next to the log file (ws_cus_authentication.log ws_cus_cmd.log, ws_cus.log, and ws_cusdistributor_sdbdistributor.log) you want to download, and click Download. OAM displays the Download page, with the following message, Click here to Download. 3. Click the here link. The system displays the File Download dialog box, which prompts you to save the file. 4. Click Save. The system displays the Save As dialog box. 5. Browse to the location on your local PC that you want to use for storing the file, and click Save. The system stores the compressed error log file in the location you specified. 6. Change to the directory where you stored the log file. Uncompress the log file and use a text editor to view the error log. This completes the procedure to download and view a log file.

Note:

Follow this procedure to download and view Service Management log files.

104 AE Services Administration and Maintenance Guide, Release 4.0.1

Service Management

Managing Distributors
When you select Manage Distributors from the main menu, OAM displays the Distributor List. Use the Distributor List page to do the following.

View a summary of the last synchronization. Check the Last synchronization result column to see the last synchronization for each distributor. Synchronize on an on-demand basis. Select a distributor and click Synchronize. Here are a few situations that call for an on-demand synchronization: - Recovery of AE Services after a User Service failure or a maintenance shutdown. For information about shutting down services, Using the Service Controller on page 84. - Recovery of AE Services after a client application failure or a maintenance shutdown - After adding a new client application that relies on the User Service capabilities Edit a configuration file. Select a file and click Configure to open a configuration file in edit mode.

Issue 7 July 2007

105

OAM User Management Administration

106 AE Services Administration and Maintenance Guide, Release 4.0.1

Chapter 4: TSAPI Configuration and the Security Database


The Security Database (SDB) stores information about users and the devices they control. The TSAPI Service uses this information in its permission checking. This chapter includes the following topics:

Applications that use the Security Database on page 108 TSAPI Configuration Settings on page 108 About Granting Additional Permissions on page 110 Security Database objects on page 113 Sample SDB Administration scenario on page 121 Setting up a permission scheme based on access rights - a sample scenario on page 126 Sample Configurations on page 130 Note: In the context of this chapter, the term user does not necessarily refer to an actual person. It can be an application that logs into the TSAPI Service with its own login and password.

Note:

Issue 7 July 2007

107

TSAPI Configuration and the Security Database

Applications that use the Security Database


The following AE Services applications rely on the TSAPI Security Database for determining users access privileges. These users are administered as CT Users in the AE Services User Service database.

TSAPI JTAPI Telephony Web Service Device, Media, and Call Control with Single-Step Conference and Snapshot Services (Snapshot Call and Snapshot Device).

See also, Summary of AE Server CTI OAM administrative tasks on page 64.

TSAPI Configuration Settings


The TSAPI Service Configuration settings apply globally to the TSAPI Service SDB. If you plan to assign worktops to each user, and use the settings in the SDB to effect permission levels, you will probably want to use the default TSAPI Configuration settings. Table 6 summarizes the TSAPI Configuration Settings and what effect they have.

To access TSAPI Configuration from CTI OAM Admin, select Administration > TSAPI Configuration. OAM displays the TS Configuration page. CTI stands for Computer Telephony Integration and OAM stands for Operations, Administration, and Maintenance). If you change these settings you must restart the TSAPI Service before the changes take effect.

Table 6: TS Configuration page settings Attribute TCP Preferred Naming Format Description By default this field is set to IP Address. You have the option of setting it to Host Name. This setting determines whether Auto Admin of LAN Addresses will use Host Names or IP addresses. This setting also determines the name of the field label that appears on the Add / Edit Worktop OAM page. 1 of 2

108 AE Services Administration and Maintenance Guide, Release 4.0.1

TSAPI Configuration Settings

Table 6: TS Configuration page settings (continued) Extended Worktop Access By default this setting is disabled. This is a system wide feature that affects all users. If you enable it, a CTI User can log in to any worktop and control all the devices on that worktop. If you want most of your CTI Users to be restricted to the devices assigned to their worktops, you would not enable this feature. If you have users who need additional access you can use a permission scheme based on User Access Rights. For more information, see Setting up a permission scheme based on access rights - a sample scenario on page 126. By default this setting is disabled. This means that you must administer an IP address (or Host Name) for each worktop. If your AE Services TSAPI configuration consists of a significant number of users, you can enable this setting, and AE Services will automatically add LAN addresses for all worktops (the LAN address is either a Host Name or IP address, depending on what you selected for TCP Preferred Naming Format). If you enable this setting, you can still override it on a per-worktop basis, by typing an IP address (or Host Name) in the IP Address field on the Add / Edit Worktop page in OAM. By default this setting is enabled. Disable the SDB only if you do not intend to use the TSAPI Service Security Database. Click Apply Changes when you make changes that you want to put into effect. Note: You must restart the TSAPI Service to put your changes into effect. For more information about restarting the TSAPI Service, see Using the Service Controller on page 84. 2 of 2

Auto Admin of LAN Addresses

Enable SDB

Apply Changes

Note:

Issue 7 July 2007

109

TSAPI Configuration and the Security Database

About Granting Additional Permissions


The SDB provides you with the following ways to grant permissions to users.

Assign a worktop to a user. This a typical method of assigning permissions to a user. By default a user assigned to a worktop has permission to access only the devices associated with that worktop for the following types of requests: - Call Origination and Termination - Device/Device monitoring requests Administer access rights for a user. The following access rights settings provide permission to access specific devices for each of the following types of requests. - Call Origination and Termination - for more information, see Call Origination and Termination on page 112. - Device/Device monitoring - for more information, see Device/Device Monitoring on page 112. - Call/Device monitoring - a CTI User Access Rights option. For more information, see Call/Device Monitoring on page 112. - Call/Call monitoring - a CTI User Access Rights option. For more information, see Call/ Call Monitoring on page 112. - Routing - a CTI User Access Rights option. For more information, see Routing on page 112.

Enable the Extended Worktop Access check box on the TS Configuration page. This allows users to roam to other worktops. For example, when a user logs in to another users workstation, the TSAPI Service checks the Security Database for a worktop with the same LAN address as the workstation where the user is attempting to log in. If a match is found, the user is given Call Origination and Termination permissions and Device/Device monitoring permissions for any of the devices associated with that worktop.

110 AE Services Administration and Maintenance Guide, Release 4.0.1

About Granting Additional Permissions

Extending User Access to Other Worktops


Users can always control all the devices on their worktop and in their own call control Access Rights device group. Extended Worktop Access is a Security Database-wide administration setting that affects all users. Extended Worktop access allows users to roam to other desktops. If this setting is enabled, a user can log in from any worktop and control the devices on that worktop. Note: LAN address information is used when the Extended Worktop Access setting is enabled. It enables the TSAPI Service to determine from which worktop the user is logged in and which devices are associated with that worktop.

Note:

If Extended Worktop Access is Disabled


If the Extended Worktop Access setting is disabled, a user can control only the following devices:

Primary device on the worktop Any device in the secondary device group associated with the worktop Any device in the call control Access Rights group

If a user logs in from another worktop while this option is disabled, the user can not control the devices on that worktop. The user can still control the devices on his or her worktop and the devices in his or her call control Access Rights. See Access Rights options on page 112. If most users should be restricted to the devices associated with their assigned worktop but specific users must control other devices, you can still disable the Extended Worktop Access feature. You can use user level access rights to allow these users to control additional devices. See Setting up a permission scheme based on access rights - a sample scenario on page 126.

Issue 7 July 2007

111

TSAPI Configuration and the Security Database

Access Rights options


For users who need additional access, you can use the following user level Access Rights permissions settings. Even with the Extended Worktop Access system option disabled, these users will be able to control the necessary devices. For settings that apply to these options, see CTI User Settings on page 114.

Call Origination and Termination Call Origination and Termination permissions include any operation that the user could perform manually, using their telephone. The user (or application) can originate calls and activate features such as call forwarding, call transfer, and so on. By default, all users have this permission for the devices associated with their worktop.

Device/Device Monitoring An application places a Device/Device monitor on a specific device so it can receive an event report any time an event occurs at that device. For example, if the device receives an incoming call or originates an outgoing call, the application receives an event report. Device/Device monitors are the most commonly used monitor. By default, all users have this permission for the devices associated with their worktop.

Call/Device Monitoring Call/Device monitors are placed to track events for a call once it reaches the device being monitored. Unlike Device/Device monitors, events for a call continue to be received even after the call leaves the device. A common usage of this monitor is to place it on the extension that incoming calls to a call center reach before being distributed to an agent. Once the call reaches this first extension, all further events (such as transfers to queues and disconnects) are sent to the application that requested the monitor. This type of monitor is commonly used by applications that track the efficiency of a call center operation. Supervisors may use this type of application to decide how to best allocate inbound call agents.

Call/Call Monitoring Call/Call monitors work differently from the device and call/device monitors previously mentioned. Those monitors are based on a device ID. Call/Call monitors are tracked based on a call ID (a unique identifier of the call being handled by Communication Manager). Users either have or do not have this permission; you do not need to create a device group for these Access Rights.

Routing When a routing application is started, it sends route registration requests to Communication Manager. Each request contains a device ID. This instructs Communication Manager to send all incoming calls for these devices to the TSAPI Service (and then on to the application) for routing. Communication Manager does not route these calls. Before the route registration request is passed to Communication Manager, the TSAPI Service checks that the user (in this case, the routing application) has permission to route calls for this device.

112 AE Services Administration and Maintenance Guide, Release 4.0.1

Security Database objects

Security Database objects


All the information that Telephony Services needs for routing messages and controlling access to the telephony network is stored in the Security Database in terms of the following objects:

CTI Users on page 113 Worktops on page 116 Devices on page 117 Device Groups on page 118 Tlinks on page 119 Tlink Groups on page 120

CTI Users
A CTI user is a person (or an application) administered as a CT User in the AE Services User Service database who logs in and runs a TSAPI Service application. The settings in the TSAPI Service Security Database determine what the user is allowed to do. Table 7 summarizes the SDB settings for a CTI user. A CT User can be any of the following:

a person or application that uses the TSAPI Service a person or application that uses the JTAPI Service a person or application that uses Telephony Web Service a person or application that uses Device, Media, and Call Control with Single-Step Conference and Snapshot Services (Snapshot Call and Snapshot Device) Note: You can not add or create users in the Security Database. You must use the User Management service add or create users. For more information see Adding a user to the AE Services User Service database on page 95.

Note:

Issue 7 July 2007

113

TSAPI Configuration and the Security Database

For a sample procedure that depicts administering a CTI Users settings, see Procedure to administer CTI User settings on page 125. Table 7: CTI User Settings Attribute User ID Description The User ID refers to the users identity in AE Services User Service database. CT Users (users who have the CT User flag set to yes) are members of the Security Database. The common name refers to a users Common name in AE Services User Service database. The Worktop Name specifies the users worktop. A user can always control and monitor all the devices associated with this worktop, regardless of which worktop the user is currently using. A worktop may be assigned to more than one user. A user does not need to have a worktop. A user with no worktop, however, requires Access Rights permissions in order to access the TSAPI Service. When this setting is enabled, the user has unrestricted access to each class of service type.

Common Name Worktop Name

Unrestricted Access

!
SECURITY ALERT:

SECURITY ALERT: Be aware that if an application login to the TSAPI Service has Unrestricted Access Rights enabled, it might impact the security of the entire system. For example, some voice recording applications can record conversations on any of the devices on Communication Manager if the application logs in as a user with Unrestricted Access Rights.

Call Origination and Termination (This field does not display if the user has unrestricted access).

Call Origination and Termination refers to the ability to perform operations from a phone (such as originating calls, activating features, and so forth). A user (or an application) can perform call origination and termination for a device or a device group. Select one of the following. None - The default. The user has Call Origination and Termination privileges from the devices on the users own Worktop only. Any - The user has Call Origination an Termination privileges from any device. device group - The user has Call Origination and Termination privileges for any device in the named device group. For more information, see Call Origination and Termination on page 112. 1 of 2

114 AE Services Administration and Maintenance Guide, Release 4.0.1

Security Database objects

Table 7: CTI User Settings (continued) Attribute Device / Device (This field does not display if the user has unrestricted access). Description Device / Device (as in Device / Device monitoring) refers to the ability to get event reports for a device any time an event occurs at the device (such as receiving a call). A user (or an application) can perform Device / Device monitoring for a device or a device group. Select one of the following: None - The default. The user has Device / Device monitoring privileges from the devices on the users own Worktop only. Any -The user has Device / Device monitoring privileges from any device. device group -The user has Device / Device monitoring privileges for any device in the named device group. For more information, see Device/Device Monitoring on page 112. Call / Device (as in Call / Device monitoring) refers to the ability to get event reports for a call once it arrives at the device and after it leaves the device. A user (or an application) can perform Call / Device monitoring for a device or a device group. Select one of the following: None - The default. - The user has Call / Device monitoring privileges from the devices on the users own Worktop only. Any -The user has Call / Device monitoring privileges from any device. device group -The user has Call / Device monitoring privileges for any device in the named device group. For more information, see Call/Device Monitoring on page 112 Call / Call (as in Call / Call monitoring) refers to the ability to get event reports for a call on the basis of call ID (a unique identifier generated by Communication Manger) for the lifetime of the call. The check box is not selected (no check mark) by default. Select the check box to enable Call / Call monitoring (visible check mark). For more information, see Call/Call Monitoring on page 112. Allow Routing on Listed Device refers to the ability to register with Communication Manager to route calls (as in adjunct routing). A user (or an application) can perform routing for a device or a device group. Select one of the following: None - The default. The user has Routing privileges from the devices on the users own Worktop only. Any - The user has Routing privileges from any device. device group - The user has Routing privileges for any device in the named device group. For more information, see Routing on page 112. 2 of 2

Call / Device (This field does not display if the user has unrestricted access)

Call / Call (This field does not display if the user has unrestricted access) Allow Routing on Listed Device (This field does not display if the user has unrestricted access)

Issue 7 July 2007

115

TSAPI Configuration and the Security Database

Changes to User Permissions


If you make changes to a users permissions, the user must close any active applications and restart them before the changes take effect. This is because user permission information is saved in memory when the users application first opens a connection to the TSAPI Service. Any subsequent changes to the SDB are not reflected in the saved information.

Worktops
A Worktop refers to a collection of devices. It can consist of a telephone (the primary device) and additional telephony devices, such as fax machines or modems (secondary devices). In more technical terms, it is the abstraction of a workstation (see Workstation on page 197).

Worktops are identified by a name and a TCP/IP network address (or a Host name). Users can always control and monitor all the devices associated with their worktop, even if they are logged in from a different worktop. Table 8 summarizes the SDB settings for a worktop. More than one user can be assigned to a worktop. For example, if your organization runs three shifts, and you want three different users to use the same worktop on a per-shift basis, you would assign all three users to the same worktop.

For a sample procedure that depicts adding a worktop, see Procedure to add a Worktop on page 124. Table 8: Worktop settings Attribute Worktop Name Description The worktop name uniquely identifies a worktop. You can name a worktop by its function or by the person who normally uses the worktop. For example, you could name the worktop Joes Worktop or help desk 1." The primary device ID is the Communication Manager extension of the telephone on the worktop. This is a group of devices (in addition to the primary device) that are associated with the worktop or are shared among several worktops, such as fax machines. Users assigned to this worktop have permission to control and monitor all devices in this group. Type the IP address or Host Name of the computer designated as the worktop. Note: If you enabled Auto Admin of LAN Addresses on the TS Configuration page, the AE Server automatically adds the IP address or Host Name to this field.

Primary Device ID Secondary Device Group

IP Address or Host Name Note: This field label is determined by the TCP Preferred Naming Format you select in TSAPI Configuration.

116 AE Services Administration and Maintenance Guide, Release 4.0.1

Security Database objects

Devices
A device can be a telephone, a fax machine, a modem, an ACD, a VDN, or an agent ID that Communication Manager controls. Table 9 summarizes the SDB settings for a device. For a sample procedure that depicts adding a device to the SDB, see Procedure to add a Device to the SDB on page 122. Table 9: Device settings Attribute Device ID Description The Device ID is the identity of a device as it is known on Communication Manager. For example a 2 to 7 digit number to identify each telephone, modem or other telephony device. (This is not the full 7 or 10 digit number used by the public network.) The location is an optional name you use to specify the location of the device. The SDB uses the Device type to make device identification easier. Valid device types are PHONE, FAX, MODEM, ACD, VDN, and AGENT ID. The default value is PHONE. The Tlink Group refers to a name for a collection of Tlinks. Tlink groups are useful when you have a configuration that supports more than one Switch Connection. Tlink Group names provide you with a means of associating a device with a switch connection. For more information, see Tlink Groups on page 120.

Location Device Type

Tlink Group

Issue 7 July 2007

117

TSAPI Configuration and the Security Database

Device Groups
A device group refers to the name of a group and the devices that make up the group. A device group might be a group of devices as follows:

in a call center or help desk operation for which an application provides call routing for which an application tracks incoming call statistics controlled by a user such as a fax or modem You assign a device group to a user when you want to provide the user with permissions for controlling specific devices as well as assign the type of control that the user can exert. This type of control is called Access Rights. Device groups are used in the worktop object to indicate resources that are shared among the worktop objects that contain the device group.

Device groups can be assigned to either a user or a worktop.

Table 10 summarizes the Device Group settings. Table 10: Device Group settings Attribute Device Group Exception Group Description The device group is an arbitrary name you assign to a collection of devices. The exception setting lets you determine whether the device group is an exception group. If the group is designated as an exception group, the TSAPI Service treats the entire group as if it contained every device except for those devices in the device group. See Exception group on page 193

118 AE Services Administration and Maintenance Guide, Release 4.0.1

Security Database objects

Tlinks
Tlinks are service identifiers (names) dynamically created by the TSAPI Service. When you associate a device with a Tlink, a user can issue call control requests only for the device on a connection set up on that Tlink.

Format of a Tlink name


Format AVAYA#SCNAME#CSTA#AESVRNAME Example AVAYA#SWITCH1#CSTA#AESERVER1

Note:

Note: This format is a restatement of the format that Avaya Computer Telephony used, which is: VENDOR#DRIVER#SERVICE#SERVERNAME AVAYA is a fixed constant. SCNAME is a variable for the Switch Connection name, which you determine. The TSAPI Service gets this information from the database. CSTA is a fixed constant. AESVRNAME is a variable for the AE Server name, which you (or a Linux administrator) determine during installation. The TSAPI Service gets this information from the operating system.

where:

Issue 7 July 2007

119

TSAPI Configuration and the Security Database

Tlink Groups
A Tlink Group is a name you assign to one or more Tlinks. If you have more than one switch, you can use Tlink Groups to control access to a specific set of Tlinks (or Switch Connections). When you associate a device with a Tlink Group, a user can issue call control requests only for the device on a Tlink in the Tlink Group. If you do not need to restrict access to a specific Switch Connection, you can assign the default Tlink Group, Any, to all devices as you add them to the SDB.

How Tlinks and Tlink Groups are Used


The TSAPI Service uses Tlinks and Tlink Groups to advertise (to clients) which Switch Connection or set of Switch Connections it supports. When a user starts an application at a client workstation, the application specifies which Tlink it should use. It may present a list of Tlinks to the user and prompt the user for a choice, or it may get the correct Tlink from an initialization file. The application then includes this Tlink in the request to establish a connection. When the TSAPI Service receives the establish connection request, it saves the Tlink name. Future application requests to control devices using this Tlink are checked by the TSAPI Service. If the device can be accessed by this Tlink, the request goes through. If not, the request is rejected. If you need the type of checking just described, you need to create groups of Tlinks. Each group is called a Tlink Group. You then associate a particular Tlink Group with each device, thus limiting access to the device to the Tlinks that are in that group. The following sections contain examples of how Tlink Groups are used.

Associating a Device with a Tlink (Switch Connection)


The TSAPI Service SDB lets you use Tlink Groups as a way to associate devices with a particular Switch Connection (which represents a switch). You can associate a group of devices to a Tlink Group. This has two advantages:

You know, by looking at the device object, which switch the device is connected to. If a user inadvertently selects the wrong Tlink when opening a connection, the TSAPI Service returns an error immediately indicating that the Tlink cannot control the device. If this control were not in place, the request would be forwarded all the way to Communication Manager before the error could be detected.

120 AE Services Administration and Maintenance Guide, Release 4.0.1

Sample SDB Administration scenario

Sample SDB Administration scenario


Use the sample procedures in this section to become familiar with a few basic SDB administration tasks. If you are adding many new objects to the SDB, you may want to group the objects by object type and add them in the following order: 1. Add a Tlink Group, see Procedure to add a Tlink Group on page 121. Note: If your configuration uses only one Tlink (Switch Connection), it is not necessary to add a Tlink Group. 2. Add Devices, see Procedure to add a Device to the SDB on page 122. 3. Add Device Groups, see Procedure to add a Device Group on page 123. 4. Add Worktops, see Procedure to add a Worktop on page 124. 5. Administer CTI user settings, see Procedure to administer CTI User settings on page 125. Note: You can not add users to the SDB using SDB administration, you must add them from the OAM User Management service.

Note:

Note:

Procedure to add a Tlink Group


Add any Tlink Groups you may need. The TSAPI Service creates the default Tlink Group Any. Follow these steps to add a Tlink Group 1. From the CTI OAM main menu, select Administration > Security Database > Tlink Groups. OAM displays the Tlink Groups page. 2. Type the name that you want to assign to a Tlink Group, newgroupA, for example, and click Add Tlink Group. OAM displays the Add / Edit Tlink Group page, with newgroupA in the Tlink Group field along with a list of Tlinks. 3. Select one or more Tlinks and click Apply Changes. OAM displays the Apply Changes to Tlink Group Properties page, which asks you to confirm your changes. 4. Click Apply. OAM displays Tlink Groups page with newgroupA listed under the Tlink Group column. This completes the procedure to add a Tlink Group. Continue with the next task, Procedure to add a Device to the SDB on page 122.

Issue 7 July 2007

121

TSAPI Configuration and the Security Database

Procedure to add a Device to the SDB


Follow these steps to add a Device to the SDB. 1. From the CTI OAM main menu, select Administration > Security Database > Devices. OAM displays the Devices page. 2. In the Add Device field, type the extension number for a specific device, for example 7788, and click Add Device. OAM displays the Add / Edit Device page, with 7788 in the Device ID field. 3. Complete the Add / Edit Device page, as follows: a. In the Location field, type in a location name, metro, for example (this field is optional). b. In the Device Type field, select the appropriate device type, for example, PHONE. c. In the Tlink Group field, select the appropriate Tlink Group, for example newgroupA (the default is Any). d. Click Apply Changes. OAM displays the Apply Changes to Device Properties page, which asks if you are sure you want to apply the changes. 4. Click Apply. OAM displays the Devices page, as follows (based on the examples used in these procedures). It displays 7788 under the Device ID column; newgroup under the Tlink Group column; PHONE under the Device Type column, and metro under the Location column. This completes the procedure to add a device. Continue with the next task, Procedure to add a Device Group on page 123.

122 AE Services Administration and Maintenance Guide, Release 4.0.1

Sample SDB Administration scenario

Procedure to add a Device Group


Follow this sample procedure to add a Device Group. 1. From the CTI OAM main menu, select Administration > Security Database > Device Groups. OAM displays the Device Groups page. 2. In the Add Device Group field, type the name of the device group you want to use, metrophone, for example and click Add Device Group. OAM displays the Add / Edit Device Group page, with metrophone in the Device Group field. 3. Complete the Add / Edit Device Group page as follows: a. Leave the Exception Group check box blank (the default setting). b. From the Device list, select the Devices you want to include in this Device Group. c. Click Apply Changes. OAM displays the Apply Changes to Device Group Properties page, which asks if you are sure you want to apply the changes. 4. Click Apply. This completes the procedure to add a Device Group. Continue with the next task, Procedure to add a Worktop on page 124.

Issue 7 July 2007

123

TSAPI Configuration and the Security Database

Procedure to add a Worktop


Follow this sample procedure to add a Worktop. 1. From the CTI OAM main menu, select Administration > Security Database > Worktops. OAM displays the Worktops page. 2. In the Add Worktop field, type the name of the worktop you want to use, sgreen, for example and click Add Worktop. OAM displays the Add / Edit Worktop page, with sgreen in the Worktop Name field. 3. Complete the Add / Edit Worktop page as follows: a. In the Primary Device ID field, type the appropriate device ID for the worktop, 7788, for example. b. In the Secondary Device Group field, select the appropriate device group, for example metrophone. c. In the IP Address (or Host Name) field, type the IP address (or Host Name) of the computer designated as the worktop. d. Click Apply Changes. OAM displays the Apply Changes to Worktop Properties page, which asks if you are sure you want to apply the changes. 4. Click Apply OAM displays the Worktops page, as follows (based on the examples used in these procedures). It displays sgreen under the Worktop Name column; 7788 under the Device ID column; and metrophone under the Device Group column. This completes the procedure to add a Worktop. Continue with the next task, Procedure to administer CTI User settings on page 125.

124 AE Services Administration and Maintenance Guide, Release 4.0.1

Sample SDB Administration scenario

Procedure to administer CTI User settings


Recall that you can not add or create a user in the SDB, you must use the User Management service. For more information see Adding a user to the AE Services User Service database on page 95. Follow this sample procedure to administer CTI User settings. 1. From the CTI OAM main menu, select Administration > Security Database > CTI Users > List All Users. OAM displays the CTI Users page. 2. From the CTI Users page select S. Green, and click Edit. OAM displays the Edit CTI User page. 3. Complete the Edit CTI User page as follows: a. In the Worktop Name field, select sgreen. b. Do not change the setting for unrestricted access. It is disabled by default (the button labeled Enable puts unrestricted access into effect). c. In the Call Origination and Termination field, select an appropriate device group, metrophone, for example. d. In the Device / Device field, select an appropriate device group, metrophone, for example. e. In the Call / Device field, select an appropriate device group, metrophone, for example. f. Leave the check box for Call / Call unchecked. g. In the Allow Routing on Listed Device field, select an appropriate device group, metrophone, for example. 4. Click Apply Changes. OAM displays the Apply Changes to CTI User Properties page, which asks if you are sure you want to apply the changes. 5. Click Apply. OAM displays the CTI Users page. This completes the procedure to add a CTI user. Now that you have some practice working with OAM screens, you can continue with Setting up a permission scheme based on access rights a sample scenario on page 126.

Issue 7 July 2007

125

TSAPI Configuration and the Security Database

Setting up a permission scheme based on access rights - a sample scenario


If you have users who need additional access you can use a permission scheme (a simple hierarchy) based on User Access Rights. Here is an example that demonstrates how to administer different permission levels for different users, and allow one user greater access than others. This example achieves this by using the Access Rights settings at the user level (see Access Rights options on page 112).

Initial Settings for the sample Help Desk group


Assume that you have four CTI Users (Edward, Michael, Sue, and Tom), who are initially administered with default profiles. If you were to select Administration > Security Database > CTI Users > List All Users and then select a user from the CTI Users page, the settings on the Edit CTI User page (for each user) would be identical except for the User ID and Common Name.

Defining the capabilities of members of the Help Desk


Next, assume that you want to set up a simple Help Desk function for a supervisor (Edward) and the group of people he manages (Michael, Sue, and Tom). You want Edward to be able to make calls and to receive calls from any of the phones in the Help Desk group, and you want him to be able to monitor and track calls associated with each of these phones. You want Michael, Sue, and Tom to be able to use only the phones on their desktops.

Implementing the Help Desk


This section describes the process of implementing this hypothetical Help Desk using OAM. The process consists of the following procedures.

Creating a Worktop for each user on page 127 Creating a Device Group called Help Desk on page 128 Administering Edwards user profile with greater privileges on page 129 Verifying the Settings on page 129

126 AE Services Administration and Maintenance Guide, Release 4.0.1

Setting up a permission scheme based on access rights - a sample scenario

Creating a Worktop for each user


The first procedure in this implementation scenario is to create a Worktop for each user. Since the procedure is the same for each user, this example will depict setting up Edwards worktop. Follow this procedure to set up a worktop for each user (Edward, Michael, Sue, and Tom) 1. From the CTI OAM main menu, select Administration > Security Database > Worktops. OAM displays the Worktops page. 2. In the Add Worktop field, type Edwards Wktp, and click Add Worktop. OAM displays the Add / Edit Worktop page 3. Complete the Add / Edit Worktop page as follows: a. In the Primary Device ID field, type 14088. b. Leave the Host Name (or IP Address) field as is (assume that Auto Admin of LAN Addresses is in effect). c. Click Apply Changes OAM displays the Apply Changes to Worktop Properties page. 4. Click Apply. Repeat this procedure, for Michael, Sue, and Tom. Keep in mind that each user will have a different worktop name (Michaels Wktp, Sues Wktp, and Toms Wktp) and a different Primary Device ID (Michaels Primary Device ID is 14124; Sues Primary Device ID is 14127, and Toms Primary Device ID is 14138).

Issue 7 July 2007

127

TSAPI Configuration and the Security Database

Creating a Device Group called Help Desk


The next procedure in this implementation scenario is to create a Device Group called HELP DESK. 1. From CTI OAM main menu, select Administration > Security Database > Device Group. OAM displays the Device Groups page. 2. On the Device Groups page, type HELP DESK, and click Add Device Group. OAM displays the Add / Edit Device Group page. 3. Complete the Add / Edit Device Group page, as follows: a. Leave the Exception Group unchecked. b. From the list of Devices, select the following check boxes.

14088 (Edwards Primary Device ID) 14124 (Michaels Primary Device ID) 14127 (Sues Primary Device ID) 14138 (Toms Primary Device ID)

c. Click Apply Changes. OAM displays the Apply Changes to Device Group Properties page. 4. Click Apply.

128 AE Services Administration and Maintenance Guide, Release 4.0.1

Setting up a permission scheme based on access rights - a sample scenario

Administering Edwards user profile with greater privileges


The next procedure in this implementation scenario is to administer Edwards user profile with greater privileges. Recall that you want Edward to be able to make calls and to receive calls from any of the phones in the Help Desk group, and you want him to be able to monitor and track calls from each of their phones 1. From the CTI OAM main menu, select Administration > Security Database > CTI Users > List All Users. 2. On the CTI Users page, select Edward, and click Edit. 3. Complete Edit CTI User page (for User ID Edward), as follows: a. In the Call Origination and Termination field, select Any (lets Edward make calls and receive calls from any of the phones in the Help Desk group). b. In the Device / Device field, select HELP DESK (lets Edward monitor calls that arrive at any of the phones in the HELP DESK device group). c. In the Call / Device field, select HELP DESK (lets Edward track calls that are transferred any of the phones in the HELP DESK device group). d. Leave the check box for Call / Call unchecked. e. In the Allow Routing on Listed Device field, accept the default (None). f. Click Apply Changes. OAM displays the Apply changes to CTI User Properties page. 4. Click Apply.

Verifying the Settings


The last procedure is to verify the administration of the Help Desk you just put into effect. Follow this procedure to verify the settings. 1. From OAM Admin, select Administration > Security Database > Worktops. OAM displays the Worktops page. 2. Click Device Group (the heading). OAM sorts the listings in the device group column. 3. Verify the following settings. 4. The Device Group should list HELP DESK as the Device Group for the Worktop Names, Edwards Wktp (Device ID 14088), Michaels Wktp (Device ID 14124), Sues Wktp (Device ID 14127), and Toms Wktp (Device ID 14138).

Issue 7 July 2007

129

TSAPI Configuration and the Security Database

Sample Configurations
This section describes operations at a fictional organization, the ACME company. It is a mail order company that sells seeds and garden equipment. Each of the following sections explores part of the operation and describes the administration required to implement it. The ACME corporation has disabled the Extended Worktop Access feature. This limits each user to their own worktop, but as you will see, some users are given permission to monitor other devices or control calls at those devices. This is accomplished by creating device groups for these devices and associating those groups with each user. Note: The type of permissions you need to give each user depends on the applications that the user is running. Before you assign permissions, check your applications to see what permissions they require to work properly.

Note:

Setting access privileges


The ACME corporation has two inbound call groups: one group handles calls for the seed catalog and the second group handles calls for the tools catalog. Members of each group have their own desks and do not run TSAPI Service applications from any desk other than their own. The basic permissions granted to a user are enough for these users, even with the Extended Worktop Access option disabled. Table 11: Basic Permissions Worktop Administration Worktop Name Tools1 Tools2 Seeds1 Seeds2 Device ID 7701 7702 7711 7712 Secondary Device Group Not applicable (N/A) N/A N/A N/A

130 AE Services Administration and Maintenance Guide, Release 4.0.1

Sample Configurations

Table 12: Basic Permissions User Administration User ID Michael Sally Juan Marie Worktop Name Tools1 Tools2 Seeds1 Seeds 2 Call Orig&Term Not applicable (N/A) N/A N/A N/A Device/Device Monitor N/A N/A N/A N/A Call/Device Monitor N/A N/A N/A N/A Routing N/A N/A N/A N/A

Manager/Assistant Configuration
ACME has a president, two vice presidents, and a single assistant who handles all incoming calls to the executives (the president and vice presidents). The president and vice presidents handle only their own phones. Since the president and vice presidents use only the phones at their desks, you do not need to grant additional access to these users. However, in order for their assistant to be able to control and monitor their phones, you must create a device group containing the device IDs of their telephones and assign this group to the assistant. The following tables summarize the types of administration you can set up. Table 13: Manager/Assistant Device Group Administration Device Group Name EXEC LIST Device IDs 7911, 7912, 7913

Table 14: Manager/Assistant Worktop Administration Worktop Name PRESIDENT WKTP VP WKTP1 VP WKTP2 ASSISTANT WKTP Device ID 7911 7912 7913 7914 Secondary Device Group Not applicable (N/A) N/A N/A N/A

Issue 7 July 2007

131

TSAPI Configuration and the Security Database

Table 15: Manager/Assistant User Administration User ID President VP1 VP2 Exec Assistant Worktop Name PRESIDENT WKTP VP WKTP1 VP WKTP2 ASSISTANT WKTP Call Orig&Term Not applicable (N/A) N/A N/A EXEC LIST Device Monitoring N/A N/A N/A EXEC LIST Call/Device Monitoring N/A N/A N/A N/A Routing N/A N/A N/A N/A

You can get the same results as the above example by assigning the EXEC LIST to the secondary device group on the assistants worktop. Table 16: Manager/Assistant Assistant Worktop Administration Worktop Name ASSISTANT WKTP Device ID 7914 Secondary Device Group EXEC LIST

Table 17: Manager/Assistant User Administration User ID Exec Assistant Worktop Name ASSISTANT WKTP Call Orig&Term Not applicable (N/A) Device Monitoring N/A Call/Device Monitoring N/A Routing N/A

Call Monitoring Application


The inbound call agents are monitored by their supervisor, Martha. Martha has one application that collects call handling statistics and a second application that lets her join a call in progress at an agents desk. To run these applications, Martha must be given call control privileges and Device/Device monitor, call/device monitor and Call/Call monitor privileges on the phones used by the agents. A device group containing the device IDs of the agents is created and entered in Marthas user profile, and a worktop called ACD SUPV is created. Table 18: Call Monitoring Device Group Administration Device Group Name ACD AGENTS Device IDs 7701,7702,7711,7712

132 AE Services Administration and Maintenance Guide, Release 4.0.1

Sample Configurations

Table 19: Call Monitoring User Administration User ID Martha Worktop Name ACD SUPV Call Orig&Term ACD AGENTS Device Monitoring ACD AGENTS Call/Device Monitoring ACD AGENTS Call/Call Monitoring Enabled

These permissions might also be required by applications that bill based on telephone usage.

Portion of User Community Shares Worktops


Two regular employees, Tom and Lalitha, normally sit at their own desks to perform their job, but may occasionally act as an in-bound call agent when a regular agent is out sick or on vacation. ACME handles this situation by creating a device group, ACD Substitutes, and assigning it to the worktops used by Tom and Lalitha. Table 20: Shared Worktop Device Group Administration Device Group Object ACD Substitutes Device IDs 7701,7702,7711,7712

Table 21: Shared Worktop Worktop Administration Worktop Name WKTP1 WKTP2 Device ID 7801 7802 Secondary Device Group ACD Substitutes ACD Substitutes

Table 22: Shared Worktop User Administration User ID Tom Lalitha Worktop Name WKTP1 WKTP2 Call Orig&Term Not applicable (N/A) N/A Device Monitoring N/A N/A Call/Device Monitoring N/A N/A Routing N/A N/A

As an alternative, you could allow Michael, Sally, Juan, and Marie (the inbound call agents) to switch desks by assigning the ACD Substitutes list to the secondary device group on each worktop or by assigning the list to the Call Origination and Termination group and Device groups in each of their user profiles.

Issue 7 July 2007

133

TSAPI Configuration and the Security Database

ACME also shares a worktop in its shipping department where Louise, Frank, and Susan work. There is only one worktop in this department and all three share it. Table 23: Shared Worktop Secondary Device Worktop Administration Worktop Name Shipping Device ID 7810 Secondary Device Group Not applicable (N/A)

Table 24: Shared Worktop Secondary Device User Administration User ID Louise Frank Susan Worktop Name SHIPPING SHIPPING SHIPPING Call Orig&Term Not applicable (N/A) N/A N/A Device Monitoring N/A N/A N/A Call/Device Monitoring N/A N/A N/A Routing N/A N/A N/A

134 AE Services Administration and Maintenance Guide, Release 4.0.1

Sample Configurations

Prompted Digits
ACME has a telephony-enabled application that can pop-up information about a customer using the customers account number. Customers call a vector directory number (VDN), where a recorded announcement prompts them to enter their account number on their touch tone phone. The call is then directed to a customer service representative. By monitoring the VDN, ACMEs application is able to retrieve the collected digits and display the customer information at the customer service representatives PC. The extension associated with the VDN is 7800. The application must perform both Device/ Device monitoring (on the customer service representatives phone) and call/device monitoring (on the VDN). Therefore, the customer service representatives must be given call/device monitoring permissions. A device group, CSR VDN, is created containing the VDN. This device group is then assigned to the customer service representatives in their Access Rights options. Table 25: Prompted Digits Device Group Administration Device Group Name CSR VDN Table 26: Prompted Digits User Administration User ID Beth Sally Dave Worktop Name WKTPA WKTPB WKTPC Call Orig&Term Not applicable (N/A) N/A N/A Dev/Device Monitoring N/A N/A N/A Call/Device Monitoring CSR VDN CSR VDN CSR VDN Routing N/A N/A N/A Device IDs 7800

Issue 7 July 2007

135

TSAPI Configuration and the Security Database

Call Routing
ACME has a server application that routes all calls to the call center based on the number called, the availability of agents and other criteria. The extension of the incoming calls are 7700 (seeds) and 7710 (tools). The user in this case is the routing application (Routing App), not a person. The routing application logs in to the TSAPI Service just as a person would and has the same types of privileges. When the routing application begins, it sends a routing registration request to Communication Manager, requesting that incoming calls to extensions 7700 and 7710 be directed to it (the routing application). When the routing application determines which agent should get the call, it tells Communication Manager where to connect the call. The routing application must be given routing permissions for devices 7700 and 7710. Notice that the user, Routing App, has no associated worktop. Table 27: Call Routing Device Group Administration Device Group Name ACD ROUTE Device IDs 7700,7710

Table 28: Call Routing User Administration User ID Routing App Worktop Name Call Orig&Term Dev/Device Monitoring Call/Device Monitoring Routing ACD ROUTE

136 AE Services Administration and Maintenance Guide, Release 4.0.1

About this chapter

Chapter 5: Alternative AE Services Authentication Methods


Use this chapter if you need to use an alternative to the User Service for authenticating your AE Services users. This chapter includes the following topics:

About this chapter on page 137 About AE Services user authentication on page 138 Using the User Service for authentication on page 138 Using Linux for authentication on page 139 Using Microsoft Active Directory Services for AE Services Authentication on page 140 Note: Authentication is independent of authorization. You can elect to use SDB for authorization -- by administering CT Users in the User Service -- or you can elect not to use the Security Database (SDB) -- by omitting User Service administration altogether. If you plan to use Active Directory Services instead of the User Service for authentication, and you want to use the AE Services SDB for authorization, see Appendix B: Avaya Computer Telephony and CVLAN migration on page 175.

Note:

About this chapter


The information in this chapter is provided in the spirit of suggested practices. Although the procedures have been validated, they are simply recommendations. Additionally, the file locations, the commands, and the Kerberos related information are subject to change. If you use these alternative strategies, you must ensure the integrity of your system and maintain compliance with Kerberos on an ongoing basis.

Issue 7 July 2007

137

Alternative AE Services Authentication Methods

About AE Services user authentication


AE Services users can be administered with any of the following methods of user authentication.

User Service authentication (default configuration) - AE Services users are authenticated against the User Service database. See Using the User Service for authentication on page 138. Local Linux authentication - AE Services users are authenticated against the local Linux server accounts. See Using Linux for authentication on page 139. Windows Active Directory authentication - AE Services users are authenticated against the enterprise Windows Active Directory. See Using Microsoft Active Directory Services for AE Services Authentication on page 140.

Using the User Service for authentication


The following AE services users rely on the User Service for authentication. See also, Summary of AE Server CTI OAM administrative tasks on page 64.

TSAPI, JTAPI, and Telephony Web Service users. Users of these applications are authenticated by the User Service. They are administered as CT Users, and they derive authorization from the SDB.

Device, Media, and Call Control Service users. All Device, Media, and Call Control based applications rely on the User Service: - Device, Media Control, and Call Control Services with Call Control (Single-Step Conference) or Snapshot Services (Snapshot Call or Snapshot Device). Users of these applications are authenticated by the User Service. They are administered as CT Users, and they derive authorization from the SDB. - Device, Media Control, and Call Control Services that do not use Call Control or Snapshot Services. Users of these applications are authenticated by the User Service. They are not administered as CT Users, however, and they do not derive authorization from the SDB. Note: In the context of this chapter, the term AE Services Users refers to TSAPI users, JTAPI users, Telephony Web Service users, and Device Media and Call Control users. This chapter does not apply to CVLAN Service or DLG Service users.

Note:

138 AE Services Administration and Maintenance Guide, Release 4.0.1

Using Linux for authentication

AE services users are authenticated by the AE Services User Service database (as opposed to Linux). AE services users, as such, can not log in to Linux and can not access AE Services OAM (Operations, Administration, and Maintenance).

To be able to log in to AE Services OAM, a user must be administered as a Linux user (see Adding a Linux user and setting the OAM account password on page 146).

Using Linux for authentication


When Linux is the AE Services authentication authority, AE Services users are authenticated against the Linux accounts created on the AE Server. This means that AE Services users have access rights to AE Services OAM and can log into the AE Server.

If you want to use Linux instead of the User Service for AE Services authentication, you will need to carry out the following procedures: - Instate the Linux PAM file instead of the User Service PAM file, see Instating the Linux PAM file. - Set up a Linux user account for each AE Services Service user, see Adding a Linux user and setting the OAM account password on page 146. - Additionally, if you plan to use the Security Database, you will need to add each user to the User Service database. Although you are not using the User Service database for authentication, you must use it to populate the Security Database. See Adding a user to the AE Services User Service database on page 95.

If you need to revert back to using the User Service for authentication, you will need to re-instate the User Service PAM file, see Re-instating the User Service PAM file on page 140.

Instating the Linux PAM file


Follow this procedure to instate the Linux PAM file. 1. Log into AE Services, and su to root or sroot. 2. Type the following command: cp /opt/mvap/tsapi/tsapi_service.linux /etc/pam.d/tsapi_service

Issue 7 July 2007

139

Alternative AE Services Authentication Methods

Re-instating the User Service PAM file


Use this procedure only if you are reverting from Linux authentication back to the User Service. To re-instate the User Service PAM file, follow this procedure. 1. Log into the server and su to root or sroot. 2. Type the following command: cp /opt/mvap/tsapi/tsapi_service.ldap /etc/pam.d/tsapi_service

Using Microsoft Active Directory Services for AE Services Authentication


When Microsoft Active Directory Services (ADS) is the AE Services authentication authority, AE Services users are authenticated against a Domain Controller. ADS AE Services authentication requires integrating the AE Server into ADS as a Kerberos client (using Kerberos5).

With this authentication method, AE Services users do not have access rights to AE Services OAM and can not log into the AE Server (Linux). If the SDB is enabled, the AE Services user must also have an account administered in the User Service. The AE Server will authenticate using Kerberos5.

!
Important:

Important: The following examples assume that the Microsoft Active Directory Domain Controller supports Kerberos5. Tip:

Tip:

The time differential between the Domain Controller and the AE Server must be less than 2 minutes.

140 AE Services Administration and Maintenance Guide, Release 4.0.1

Using Microsoft Active Directory Services for AE Services Authentication

Integrating AE Services with ADS -- a process overview


The following sections depict a process that involves procedures carried out by an AE Services administrator and a Windows Domain Controller administrator.

Creating an account for the AE Server on the Domain Controller on page 141 Generating a keytab file for the AE Server account on the Domain Controller on page 142 Installing the Kerberos5 RPMs on the AE Server on page 142 Editing the Kerberos 5 configuration file on the AE Server on page 143 Importing the keytab file on the AE Server on page 144 Changing from User Service Authentication to Active Directory Authentication on the AE Server on page 144

Creating an account for the AE Server on the Domain Controller


On the Domain Controller, follow this procedure to create a user account where the AE Server is designated as an Active Directory user. Note: To perform this procedure you must be a member of the Admin Group in Windows. 1. From your desktop, select Start > Settings > and click Control Panel. 2. From the Control Panel, double-click Administrative Tools. 3. From Administrative Tools, double-click Active Directory Users and Computers. 4. Click Users in the left pane, to display the list of users. Move your cursor to the right pane, and right-click. From the right-click menu, select New > User. Windows displays the New Object - User dialog box. 5. Complete the New Object - User dialog box as follows:

Note:

In the First name field, type a user name, for example: aeserver. Skip the Initials and Last Name fields. In the Full name field, type aeserver. Complete the two-part User logon name field, as follows: - In the first field, type aeserver. - in the next field type the address of the Domain Controller, for example: @dcserver1.xyz.com.

In the User logon name (pre Windows 2000) field, type: aeserver.

Issue 7 July 2007

141

Alternative AE Services Authentication Methods

6. Click Next. The system displays the next New Object User dialog box.

In the Password field, type aespassword. In the Confirm password field, retype aespassword. Click Next and Finish on the remaining screens to complete the procedure.

Generating a keytab file for the AE Server account on the Domain Controller
This procedure is carried out by an administrator on the Windows Domain Controller. After you create the AE Server account on the Windows Domain Controller, generate a keytab file for the AE Server account as follows: Note: This example uses the aeserver user account name to generate a keytab file called aeserver.keytab.

Note:

From the Windows command prompt type: Ktpass princ aeserver/aeserver@dcserver1.xyz.com -mapuser aeserver pass aespassword out aeserver.keytab

Installing the Kerberos5 RPMs on the AE Server


This procedure is carried out by an administrator on the AE Server. Follow this procedure to determine if the pam_krb5 package and the krb5 workstation package are installed on the AE Server. 1. Login as root or sroot and type the following command: rpm -qa | grep krb If the Kerberos5 RPMs are installed, you will see output similar to the following display:
rb5-devel-1.2.7-31.i386.rpm krb5-libs-1.2.7-31.i386.rpm krb5-workstation-1.2.7-31.i386.rpm pam_krb5-1.73-1.i386.rpm

2. Download and Install any missing Kerberos5 RPMs. This completes the procedure for installing the Kerberos5 RPMs on the AE Server. Continue with Editing the Kerberos 5 configuration file on the AE Server on page 143.

142 AE Services Administration and Maintenance Guide, Release 4.0.1

Using Microsoft Active Directory Services for AE Services Authentication

Editing the Kerberos 5 configuration file on the AE Server


This procedure is carried out by an administrator on the AE Server. After the Kerberos RPMs are properly installed, follow this procedure to edit the Kerberos 5 configuration file on AE Server (Kerberos 5 client): 1. Log in as root or sroot, and type cd /etc. 2. With a text editor, open the krb5.conf file, for example: vi krb5.conf. The system displays the contents of krb5.conf. 3. Change the fields that are depicted in bold:
[libdefaults] default_realm = dcserver1.xyz.com dns_lookup_realm = true dns_lookup_kdc = true default_tkt_enctypes = des-cbc-md5 default_tgs_enctypes = des-cbc-md5 [realms] MNO.XYZ.COM= { kdc = dc-sername.dcserver1.xyz.com:88 kpasswd_server = dc-sername.dcserver1.xyz.com:88 } [domain_realm] .xyz.com = MNO.XYZ.COM

4. Save your changes. This completes the procedure for editing the configuration file. Continue with the next procedure, Importing the keytab file on the AE Server on page 144.

Issue 7 July 2007

143

Alternative AE Services Authentication Methods

Importing the keytab file on the AE Server


This procedure is carried out by an administrator on the AE Server. After you configure the /etc/krb5.conf file, you must import the keytab file that was generated on the Windows Domain Controller (see Generating a keytab file for the AE Server account on the Domain Controller on page 142). Follow this procedure to import the keytab file from the Windows Domain Controller to the AE Server. 1. Log in as root or sroot. 2. From the command line, type ktutil. The system displays the following prompt, ktutil:. 3. From the ktuil prompt, type the following command to have the ktuility read in the keytab file. rkt aeserver.keytab The ktutility reads in the keytab file, and upon completion, displays the ktutil prompt. 4. Type the following command to merge the imported key into the /etc/krb5.keytab file. wkt /etc/krb5.keytab 5. Type q to exit ktutil. The system displays the command prompt. 6. From the command prompt, type kinit. This utility will obtain and cache the Kerberos ticket-granting ticket from the Domain Controller. This completes the procedure for importing the keytab file. Continue with the next procedure, Changing from User Service Authentication to Active Directory Authentication on the AE Server on page 144.

Changing from User Service Authentication to Active Directory Authentication on the AE Server
This procedure is carried out by an administrator on the AE Server. Follow this procedure to change from User Service authentication to Active Directory authentication 1. Log into the AE Server as root or sroot. 2. At the command prompt, type the following command: cp /opt/mvap/tsapi/tsapi_service.ads /etc/pam.d/tsapi_service

144 AE Services Administration and Maintenance Guide, Release 4.0.1

Chapter 6: Administering AE Services from the Operating System Command Prompt


This chapter describes AE Services Server (AE Server) administrative capabilities that you have through the Linux operating system at the command prompt. This chapter includes the following topics:

Adding a Linux user and setting the OAM account password System logins and passwords AE Services Tools and Linux commands

! CAUTION:
CAUTION:

Do not attempt any of the commands listed in this chapter unless you have a thorough understanding of Linux administration.

Issue 7 July 2007

145

Administering AE Services from the Operating System Command Prompt

Adding a Linux user and setting the OAM account password


The CTI (Computer Telephony Integration) OAM (Operations, Administration, and Maintenance) Admin account password is set up in the Linux operating system during installation. Use this procedure to set up the CTI OAM Admin account password. 1. Follow Step a if you have the Software-Only Offer. Follow Step b if you have the Bundled Server offer. a. Log in as root. b. Log in with your user account and then become the superuser (su sroot). 2. Type groupadd groupname to add a name for a group (mygroup, for example). 3. Type useradd -g mygroup username to add a user name. Tip:
Tip:

The useradd and adduser commands are equivalent. You can use either command, and both commands accept the same arguments. 4. Type passwd username to display the password prompt. 5. At the password prompt, type a password, and press Enter. Linux prompts you to re-enter your new password. 6. At the prompt to re-enter your password, type the password you just created, and press Enter. 7. Log out, and then log in with the new user credentials.

146 AE Services Administration and Maintenance Guide, Release 4.0.1

System logins and passwords

System logins and passwords


The following table describes system logins and passwords for AE Services Bundled Server. The root account is disabled by default during installation. If this account has not been activated, contact Avaya Services or your Business Partner. If you have the Software-Only offer, only the cust and avaya accounts are installed by default. To get the sroot and craft, accounts, you must install the Avaya Services Package (cs-service), which can be installed even if you do not have a Services contract. The rasaccess account is manually created by Avaya Services technicians when you purchase a Service contract. For information about installing the Avaya Services Package (cs-service), see the Avaya MultiVantage Application Enablement Services Installation Guide Software-Only Offer. Login cust Password custpw Group avaya Usage Customer Comments Customer Linux login. Be sure to change this default user name and password immediately. OAM User Service access. Be sure to change this default user name and password immediately. The AE Server can not be directly accessed through ssh. This login is for Avaya Services technicians only. This login is for modem access only. It is Manually created by Avaya Services technicians

avaya

avayapassword

avaya

Customer

sroot

root

Avaya Services and customers Administrative for Avaya Services For inbound modem access

craft

avaya

rasaccess

avaya

Issue 7 July 2007

147

Administering AE Services from the Operating System Command Prompt

!
SECURITY ALERT:

SECURITY ALERT: Change the default user names and passwords immediately.

For information about AE Services security


For information about AE Services security, see White-paper on Security in Application Enablement Services for Bundled and Software only solutions. This document is located on the on the Avaya Support Centre Web Site (http://www.avaya.com/support).

148 AE Services Administration and Maintenance Guide, Release 4.0.1

Using Tripwire

Using Tripwire
This section applies to the AE Services Bundled server only. Tripwire is configuration auditing software that is installed and initially configured on the AE Server. This section describes how to configure Tripwire for administrative access and how to use the various features of Tripwire.

Reconfiguring the Tripwire database for administrative access


Because it is installed by an automated procedure, the Tripwire database is set up with passphrases that are not resuable. For administrative access to the Tripwire database, you must manually reinstall and reconfigure it. Follow this procedure to reconfigure the Tripwire database for administrative access. 1. Log in as root. 2. Stop the Tripwire service by typing the following command: service tripwire stop . 3. Delete the Tripwire configuration file, the policy file, and all key files by typing the following commands: rm /etc/tripwire/tw.cfg rm /etc/tripwire/tw.pol rm /etc/tripwire/*.key 4. Delete the Tripwire database file by typing the following command: rm /var/lib/tripwire/*.twd 5. Configure Tripwire by typing the following command: etc/tripwire/cmds/twinstall.sh 6. When Tripwire prompts you, type unique passphrases for the site key and the local key. Each passphrase must consist of at least eight alphanumeric and symbolic characters (quotation marks should not be used). The maximum length of a passphrase is 1023 characters. 7. Reinitialize the tripwire database, by typing the following command (ignore "No such file or directory" messages). tripwire --init 8. Start the tripwire service, by typing the following command: service tripwire start This completes the procedure for reconfiguring Tripwire for administrative access.

Issue 7 July 2007

149

Administering AE Services from the Operating System Command Prompt

Routine administrative tasks for Tripwire


Perform any of these routine administrative tasks from the command prompt.

Running an integrity check


AE Services runs a Tripwire integrity check daily at 4.a.m. If Tripwire detects any changes to the database files, it generates an alarm and creates a report file. Use the following command to manually run an integrity check. tripwire --check Tripwire displays the report on your terminal screen and prints a copy of the output in a report file that you can review when the integrity check is complete.

Printing reports
If Tripwire detects any database changes or security violations when it runs the integrity check, it generates a report, located in /var/lib/tripwire/report. To print a report use the following command: twprint -m r --twrfile /var/lib/tripwire/report/<filename>.twr Changes to monitored files should be expected. File changes, additions, or deletions that are not expected could indicate a compromised system. Review the Tripwire report and investigate each file identified. If the change is not expected, take corrective action.

Updating the Tripwire database


Once a file monitored by Tripwire changes, it will be flagged in every integrity check until the Tripwire database is updated. After you have taken the necessary corrective action, update the Tripwire database using the report file as follows: tripwirem u twrfile /var/lib/tripwire/report/<filename>.twr This updates the Tripwire database so the modified files are not flagged in the next integrity check.

150 AE Services Administration and Maintenance Guide, Release 4.0.1

Using Tripwire

Starting and Stopping Tripwire


When Tripwire is installed, it will be configured as a service. To start or stop Tripwire, simply treat it as any other service.

To start Tripwire, type the following command: service tripwire start To start Tripwire, type the following command: service tripwire stop

Issue 7 July 2007

151

Administering AE Services from the Operating System Command Prompt

Using the dateconfig utility


This information about the dateconfig utility applies to the Bundled Server only. AE Services provides a customized version of the dateconfig utility, which is located in /opt/ mvap/bin. The dateconfig utility lets you set the following:

Date - sets the date used by the system Time - sets the time used by the system Time zone - sets the time zone used by the system NTP server IP address - sets the address of a time server that the system uses for synchronizing its time clock

!
WARNING:

WARNING: Changing any of the dateconfig settings on a live AE Server can bring down a CTI link.

152 AE Services Administration and Maintenance Guide, Release 4.0.1

Using the dateconfig utility

Setting the date or time


To set the date or time of your system you must first run dateconfig to disable the Network Time Protocol (NTP) daemon, if you have not already done so. After you disable the NTP daemon, then run dateconfig again, to set the date or time of your system. Follow these steps to set the date and time of your system. 1. Log in as root . 2. Type dateconfig . AE Service displays the Date/Time Initialization screen, with the first box of the Date field initially selected. Note: By default an NTP Server IP is administered as 127.127.0.1. This setting must be removed before you can set the date and time. 3. Using the Tab key, go to the NTP Server field. 4. With your cursor in NTP Server field use the Backspace key to remove the host name or IP address of the NTP Server. After you have removed the host name or IP Address of the NTP server, press the space bar once to enter a blank space in the NTP server field. 5. Press the Tab key to move to the OK box. Press Enter to select OK and exit dateconfig. 6. Type dateconfig to run the dateconfig utility again. AE Service displays the Date/Time Initialization screen. 7. Verify that the NTP Server field is blank. Using the Tab key to move from field to field, change any of the date and time settings that you need to change. Note: If the NTP Server field is not blank, repeat Steps 3, 4, 5, and 6. 8. After you have completed your date and time changes, the Tab key to move to the OK box. Press Enter to select OK and exit dateconfig.

Note:

Note:

Changing an NTP Server


This example assumes that your server uses an NTP server for time synchronization. Note: If you change the NTP Server, or if you change the Timezone of an NTP Sever, you must restart the ntpd service. 1. Log in as root .

Note:

Follow this procedure to change the NTP server.

Issue 7 July 2007

153

Administering AE Services from the Operating System Command Prompt

2. Type dateconfig . AE Service displays the Date/Time Initialization text box, with the first box of the Date field initially selected. 3. Press the Tab key to move to the NTP Server field. Use the Backspace key to remove the current IP address and then type in the <IP address> or <host name> of another NTP server. 4. Press the Tab key to move to the OK box. Press Enter to select OK. 5. At the command prompt, type service ntpd restart

154 AE Services Administration and Maintenance Guide, Release 4.0.1

AE Services Tools and Linux commands

AE Services Tools and Linux commands


This section describes AE Services Linux based capabilities and a few Linux commands that are available at the command prompt.

AE Services Linux based capabilities


AE Services provides the following Linux based capabilities.

dateconfig
See Using the dateconfig utility on page 152.

makecert.sh
A tool that allows you to create a unique Secure Sockets Layer (SSL) keystore for this installations Apache Tomcat server.

!
Important:

Important: The makecert.sh script is a tool that you use with two of the AE Services Web Services Interfaces, the Telephony Web Service and the User Web Service.

The makecert.sh script is automatically run at start time to generate a unique certificate (private key) for the system. If you want to create a new certificate at any point, you can run this script again. Located in /usr/share/tomcat5/bin

mvap.sh
Provides a way for system administrators to get a list of services running in the server and to start, stop and restart all services as a whole. Additionally, it can invoke any exposed methods on any individual service. Note: The AE Services OAM Service Controller (Maintenance > Service Controller) provides equivalent functionality. Use OAM as your primary tool. Use mvap.sh only when necessary.

Note:

Located in /opt/mvap/bin Syntax


mvap.sh <command name> [<service name>] | <method name> <service name> <argument-list>

Issue 7 July 2007

155

Administering AE Services from the Operating System Command Prompt

where: <command name> info - lists info name value pairs of <service name> status - lists state of <service name> start - invokes start on <service name> stop - invokes stop on <service name> restart - attempts to restart <service name>> suspend - attempts to suspend <service name> resume - attempts to resume <service name> <service name> CmapiService - Device, Media, and Call Control Service CvlanService - CVLAN Service TsapiService - TSAPI Service DlgService - DLG Service AsaiLinkManager - ASAI Link Manager TransportService - Transport Service Note: If you omit the service name, the command assumes all service names. mvap.sh info CvlanService

Note:

Example:

netconfig
Allows you to set the following:

Host name Domain name Domain name server IP address and network mask for eth0 IP address and network mask for eth1 IP address and network mask for eth2 Default Gateway IP address

Located in /opt/mvap/bin

156 AE Services Administration and Maintenance Guide, Release 4.0.1

AE Services Tools and Linux commands

swversion
There are two forms of the swversion command. The first form, swversion lists the following:

Offer type Server type Software version number Operating system (kernel) version Offer type Server type Software version number Operating system (kernel) version List of AE Services RPMs List of third-party RPMs

The second form swversion -a lists the following:


Located in /opt/mvap/bin

Issue 7 July 2007

157

Administering AE Services from the Operating System Command Prompt

Linux commands
This section describes a few Linux commands that are useful for working with AE Services.

df
Allows you to check the disk capacity and partitions of the AE Server.

ethtool
Allows you to query or change the settings of an Ethernet device (a network interface device, sometimes referred to as a NIC, or Network Interface Card). Use ethtool to view or change the settings of the network interfaces on the AE Server. When you use ethtool to change the network interface settings, the changed settings will not persist after rebooting the AE Server. To make network interface settings permanent, you will need to edit an AE Services script file. For information about which script file to edit, see "Network interface - speed and duplex settings" in the Avaya MultiVantage Application Enablement Services Installation and Upgrade Guide for a Bundled Server, 02-300356. The following list provides a few usage examples for AE Services.

ethtool eth0 (Displays the settings of eth0). ethtool -s eth0 autoneg off (Turns off auto-negotiation for eth0. When you want to change the settings of a network interface, such as the network speed or the duplex mode, you must turn off auto-negotiation first.) ethtool -s eth1 speed 100 (Sets the network speed of eth1 to 100 Mbs. This is the required speed for AE Services.) ethtool -s eth1 duplex full (Sets the duplex mode to full for eth1. This is the required duplex mode for AE Services.) ethtool -s eth1 speed 100 duplex full (Sets the network speed and duplex mode for eth1 with a single command entry.) Note: For more information about ethtool command syntax, see the Linux manual page for ethtool.

Note:

route
Allows you to administer static routes. To use this command: 1. Log in as root (sroot/init). 2. Type route to view or configure IP routes.

158 AE Services Administration and Maintenance Guide, Release 4.0.1

AE Services Tools and Linux commands

For information on the different options of the route command, see the Linux manual page for route.

scp and sftp


Use the scp and sftp commands to copy files to and from the Bundled Server.

service <name> start/stop/restart


The service command is exclusive to the Software-Only Offer. You must be logged in as root to use it. Syntax: service <name> [start | stop | restart | status] where <name> is:

mvap - refers to all AE Services (ASAI Link Manager, CMAPI Service, CVLAN Service, DLG Service, TSAPI Service, and the Transport Layer Service). DBService - refers to the Postgres database. tomcat5 - refers to the Tomcat Web application server.

shutdown -r now
Reboots the AE Server.

ssh
The telnet command is disabled on the Bundled Server for both incoming and outgoing connections. Use the ssh command instead (ssh uses port 22). If you are using a Windows machine to connect to the server, use a secure shell (SSH) client such as PuTTY to connect.

tethereal
This tool is a sniffer that allows you to sniff packets to and from the AE Server. The tethereal command is very useful for debugging network traffic. Located in /usr/sbin

Issue 7 July 2007

159

Administering AE Services from the Operating System Command Prompt

Example tethereal command lines: tethereal -i eth0 -V -x > /tmp/sniff.out Sniffs packets on the eth0 NIC in verbose mode and dumps all raw bytes into /tmp/sniff.out. tethereal -i eth1 -V -x " -R ip.addr==136.1.1.1" > /tmp/sniff.out Sniffs packets to and from IP address 136.1.1.1 on the eth1 network interface in verbose mode and dumps all raw bytes into /tmp/sniff.out. tethereal -i lo -V -x " -R (ip.addr==136.1.1.1) && (udp.port==6661 || tcp.port==7772) > /tmp/sniff.out Sniffs packets to and from IP address 136.1.1.1 and udp port 6661 or tcp port 7772 on NIC lo (loopback) in verbose mode and dumps all raw bytes into /tmp/sniff.out.

tripwire
See Using Tripwire on page 149.

Installation and upgrade logs and RPMs


The Installation/upgrade logs are located in: /var/disk/logs/upgrade.out-xxxx Copies of RPMs for each release that is installed (up to 2 installs) are located in: /var/disk/Releases/r3-xxxx

160 AE Services Administration and Maintenance Guide, Release 4.0.1

AE Services Tools and Linux commands

Directory structure and file locations


Root installs the AE Services directory, /opt/mvap, with the following subdirectories

asailink - ASAI specific files bin - executables and scripts cmapi - Device, Media, and Call Control specific files conf - User Service files config - configuration files cvlan - CVLAN specific files deploy - CMAPI hot deploy directory dlg - DLG specific files dms - Database Monitoring Service specific files lib - shared libraries, jars licenses - license files logs - log files (logs/common - call control trace files) transport - Transport Service specific files tsapi - TSAPI specific files web - Web Service files alarming - alarm log files resources - system and user resource files

postgres data files


The default directory for postgres data files is /var/mvap/database.

External scripts
External scripts, tools or binary executables are in /opt/mvap/bin.

Environment variables
Environment variables are set at login and defined in /etc/profile.d/mvap.sh.

Issue 7 July 2007

161

Administering AE Services from the Operating System Command Prompt

AE Services Disk Partitioning Scheme


This section about disk partitioning applies to the Bundled Server only. It is important to understand the disk partitioning scheme of the AE Server before you create directories or files on the AE Server. The AE Server has a SATA drive with an 80GB capacity. Once AE Services is installed, it has three disk partitions. / - the active partition, with approximately 18.5 GB of space /root2 - the inactive or offline partition, with approximately 18.5 GB of space /var - the common partition, with approximately 37 GB of space The remaining space is allocated for cache and other uses.

Partitioning after an upgrade


The AE Services software is installed on the / partition when it is initially installed. When an upgrade of AE Services software is performed, the upgrade script installs the new version of AE Services software on the /root2 inactive partition first. The upgrade script then reboots the AE Server server. Upon reboot the / and /root2 partitions are switched. So, the new version of AE Services software is now on / active partition and the old version is on the /root2 partition.

Guidelines for creating directories


If you want to create directories or files on AE Server, it is strongly recommended that you create in the /var common partition. Otherwise any directory or file created in the / active partition will be moved to the /root2 partition upon an upgrade of AE Services software. One exception is any directory or file created in the /home directory under any of the logins such as sroot, craft, and so on, are always copied over during an upgrade. Because copying large files such as media files or databases, is time consuming, it can delay the upgrade process if these files are stored in the /home directory of any login. To summarize, it is highly recommended that any user level files including media files and databases be stored in the /var partition.

162 AE Services Administration and Maintenance Guide, Release 4.0.1

Before you begin - SNMP Basics

Chapter 7: Administering SNMP


Use this chapter to set up the AE Services Server (AE Server) in an SNMP managed network.

Before you begin - SNMP Basics


If you are not familiar with Simple Network Management Protocol (SNMP), read this section to learn a few basic concepts. Simple Network Management Protocol (SNMP) - SNMP is a standard network management protocol that is used to remotely monitor and manage network-capable devices such as computers, switches, and gateways. SNMP provides a way for monitored objects (SNMP agents) and monitoring objects (SNMP managers) to exchange status messages. SNMP Agents - SNMP agents collect and store status information and make it available to SNMP managers. In terms of the AE Services implementation, the AE Server is an SNMP agent. Whenever a significant event such as a disk failure occurs, the SNMP agent sends a notification to the SNMP manager. Notifications can be sent using either the SNMP trap command or the SNMP inform command.

Notifications sent with the trap command do not require a confirmation from the receiver. All versions of SNMP support trap notifications. Notifications sent with the inform command require a confirmation from the receiver. Only SNMP versions 2c and 3 support inform notifications.

By default, AE Services uses the trap command to send notifications. In general usage, the term trap refers to an unsolicited notification from an SNMP agent to an SNMP manager. SNMP managers - SNMP managers collect and store status information received from SNMP agents. In terms of the AE Services implementation, SNMP managers are either Avaya Secure Services Gateways (SSG) or Network Management System (NMS) devices (IBM Tivoli or HP Openview, for example). SNMP managers get information by either issuing a request (solicited information) or by receiving a notification whenever an event occurs (unsolicited information). Traps (whether generated by the trap or inform command) are unsolicited notifications. Management Information Base (MIB) - The MIB defines (by way of data structures) the information an SNMP agent is capable of reporting. MIBs vary one vendor to another, and AE Services publishes the "Application Enablement Services MIB" on the Avaya Support Web site. The "Application Enablement Services MIB" describes SNMP trap notifications for selected platform entities, including disk, CPU, modem, and the watchdog process.

Issue 7 July 2007

163

Administering SNMP

Setting up the AE Server in an SNMP network


In terms of SNMP, the AE Server is an SNMP agent. When the AE Server detects a problem (a disk failure, for example) it sends a trap to an SNMP manager. For AE Services, an SNMP manager can be either a Network Management System (NMS) station or an Avaya Secure Services Gateway (SSG). In some AE Services configurations, you can use both NMS devices and SSG devices. For more information, see About sending traps to an Avaya SSG. Note: The SNMP Agent for AE Services 3.1 provides limited agent functionality. AE Services does not respond to solicited SNMP GetRequests, which an SNMP Manager can use for polling. AE Services issues only traps to a manager.

Note:

From the viewpoint of the AE Server, the primary administrative task is specifying the SNMP manager (or managers) that is to receive traps from the AE Server.

About sending traps to an Avaya SSG


If you have the AE Services Bundled Server, and you have purchased an agreement with Avaya Technical Services for either the Secure Access and Control Basic Offer or the Secure Access and Control Premium Offer, you can send traps to an SSG device and a local NMS device. For more information about Secure Access and Control (SAC), see: http://support.avaya.com/sac. Traps sent to an SSG result in Initialization and Administrative System (INADS) notifications. INADS notifications, in turn, generate trouble tickets with Avaya Services. Note: Traps such as tripwire notifications and login failures are not sent to an SSG. When you are administering the AE Server to send traps, you will want to send these traps to a local NMS. For more information about how traps are routed, see How AE Services tracks alarms on page 168.

Note:

If you do not have the SAC Offer


If you do not have the SAC Offer, you can send traps to a local NMS only. The SAC offer is available with the AE Services Bundled Server only. If you use the AE Services Software-Only server, the SAC offer does not apply.

If you provide Technical Services with modem access to the AE Server


If you provide Technical Services with modem access to the AE Server for maintenance, there is no provision for alarming. You must contact Avaya Services to report problems.

164 AE Services Administration and Maintenance Guide, Release 4.0.1

Setting up the AE Server in an SNMP network

Administering AE Services to send NMS and SSG Traps


Follow this procedure to send traps from the AE Server to an SNMP manager, which can be either a local NMS device or an Avaya SSG. 1. From the CTI OAM menu, select Alarms > SNMP Traps. 2. From the SNMP Traps Web page, select Add and complete the Add SNMP Trap page. If you are using SNMP Version 1 or 2c, complete Steps 3 through 10. If you are using SNMP Version 3, complete Steps 3 through 15. 3. Leave the Enabled check box selected (the default). 4. In the Device field, select the type of monitoring device that is to receive traps.

Select NMS to send traps to a local NMS device (IBM Tivoli or HP Openview, for example). If you are administering a Software-Only server, the Device setting is restricted to NMS. Select SSG to send traps to an Avaya Secure Services Gateway. Keep in mind that only an SSG is capable of generating INADS notifications. This option is available only to Avaya Services accounts with craft log in.

5. In the IP address field, type the host name IP address of the device to receive the traps. 6. In the Port field type the TCP/UDP port number that AE Services is to use for sending traps. Keep in mind that the port number you specify must match the port number administered on the SNMP manager that is to receive the notification. The default is 162. 7. In the Notification Type, select Trap, which is the default. 8. Select the SNMP Version that is appropriate for your SNMP managed network. The default is 3. If you are sending Traps to an SSG, select 2c. 9. Type the Security Name that is appropriate for your SNMP network, as follows: For devices that use SNMP version 1 or 2c, type the community name that the SNMP administrative domain uses for authentication. For devices that use SNMP version 3, type the Security name that the SNMP administrative domain uses for authentication. You can not leave this field blank or use the terms public or private. 10. Follow a or b based on what version of SNMP you are using. a. If you are using SNMP version 1 or 2c, you have completed all the necessary fields. Click Apply to put your settings into effect. b. If you are using SNMP version 3, you must complete Steps 11 through 15.

Issue 7 July 2007

165

Administering SNMP

11. Select the option for the Authentication Protocol, if any, that your SNMP managed network uses:

None - indicates that the network does not perform authentication. This is the default. HMAC-MD5 - indicates that the network uses the HMAC-MD5 authentication protocol (not available for the Bundled Server). HMAC-SHA - indicates that the network uses the HMAC-SHA authentication protocol (not available for the Bundled Server). None - indicates that the network does not use a privacy protocol and does not perform any encryption. This is the default. DES - indicates that the network uses the DES encryption protocol. AES128 - indicates that the network uses the AES128 encryption protocol. AES192 - indicates that the network uses the AES192 encryption protocol (not available for the Bundled Server). AES256 - indicates that the network uses the AES256 encryption protocol (not available for the Bundled Server).

12. Select the option for the Privacy Protocol, if any, that your SNMP managed network uses:

Note:

Note: AES192 and AES256 are not enabled during a standard OS installation and are controlled under U.S. federal export laws. For more information, see About using AES 192 and AES 256. 13. Type an Authentication Password. This password can be a 6- to 32-character string. Validate the Authentication Password by retyping it the Confirm Password field. 14. Type a Privacy Password. This password can be a 6- to 32-character string. Validate the Privacy Password by retyping it in the Confirm Password field. 15. Click Apply to put your settings into effect.

166 AE Services Administration and Maintenance Guide, Release 4.0.1

Setting up the AE Server in an SNMP network

About using AES 192 and AES 256


This information does not apply to the AE Services Bundled Server. If you have the AE Services Software-Only Offer, and you plan to use AES 192 or AES 256 to encrypt SNMP message traffic, you will need to set up the AE Server to use these high encryption levels. Follow these guidelines for setting up the AE Server to use AES 192 or AES 256.

Install Third Party Software that provides the Strong Encryption Package. For information about getting the software, use the following links: http://www.gnupg.org/ http://www.jus.uio.no/lm/electronic.commerce/cryptography.encryption Configure the AE Servers operating system to allow for these high encryption levels. Administer AE Services to use SNMP version 3 and a Privacy Protocol of either AES 192 or AES256 by following the procedure described in Administering AE Services to send NMS and SSG Traps on page 165.

Testing SNMP Traps


The following procedure provides you with a way to verify that you are able to receive a trap locally (on the AE Server) and remotely (on a remote NMS device). 1. From AE Services OAM add two SNMP traps. Set up one trap as the AE Server (local trap) and set up the other trap as a remote SNMP manager. The procedures for adding traps are described in Administering AE Services to send NMS and SSG Traps on page 165. 2. As a root user on the AE Server, start the trap listener by typing the following command: snmptrapd f S0 3. Open another window as a root user on the AE Server and type the command: logger t mon i High CPU 4. Verify in the listener xterm window that the SNMP notification is received 5. Verify that your remote SNMP Manager received the same trap. 6. Use the OAM Alarm Viewer to clear the alarms you just generated. For information about removing alarms, see Working with alarm reports on page 169.

Issue 7 July 2007

167

Administering SNMP

How AE Services tracks alarms


AE Services tracks alarms by event type. Table 29 describes which events are trapped and how traps are routed. Table 29: AE Services notifications -- NMS or SSG Sent to an NMS station (Software Only Solution or Bundled Solution without SAC)
Disk Notification events disk full/high utilization events CPU Utilization Notifications Process Notifications (abnormal process termination). AE Services detects these and maps them to watchdog events. This applies to TSAPI, Device Media and Call Control, DLG, CVLAN, ASAILINK, TRANSPORT and POSTGRES. Network Interface Failures (A network connection data link down is treated as a Network Interface Failure. This does not include the AE Services link or the CTI link.) Login Security Events Linux login failures Tripwire Security Notifications Tripwire security event, This is provided by core services via syslog bridge.

Sent to an SSG (Bundled Solution with SAC)


Disk Notification events disk full/high utilization events CPU Utilization Notifications Process Notifications (abnormal process termination). AE Services detects these and maps them to watchdog events. This applies to TSAPI, Device Media and Call Control, DLG, CVLAN, ASAILINK, TRANSPORT and POSTGRES. Network Interface Failures (A network connection data link down is treated as a Network Interface Failure. This does not include the AE Services link or the CTI link.)

168 AE Services Administration and Maintenance Guide, Release 4.0.1

How AE Services tracks alarms

Working with alarm reports


The following procedure demonstrates how to set up and generate a log report. For a listing of error codes that appear in an alarm report, see AE Services alarm codes and messages on page 170. 1. From the CTI OAM main menu, select Alarms > Alarm Viewer. OAM displays the Alarm Manager Web page. 2. In System Name(s) field keep the default setting, All Systems. For AE Services this is the default. It refers to the AE Server. 3. In the Search Keyword(s): field, enter a term that appears in the alarm message records, such as CPU Utilization, login attempts, and so forth. 4. In the Status field select the status indicator you want to use for setting up your report. 5. In the Sort By field, you can select to view alarms in terms of time, severity, category, status, or system name. For example, to see a report that starts with the highest severity alarms, select Severity: highest first. 6. Use the Date and Time selections to determine the range of dates and times that are in your report. For example, to see a report of errors in the last five days, select the option button for the Last number of days, and enter 5. 7. Use the Categories and Severities to determine whether your report includes platform errors, critical errors, major, errors, or minor errors. For example, to see a report of critical platform alarms, select the check boxes for Platform and Critical, and uncheck the selections that you do not want in the report. You must select Platform and at least one severity level (Critical, Major, or Minor) to generate a report. 8. Click OK to generate a report. OAM displays the Alarm Report Web page with a display of all the types of alarms you specified on the Alarm Manager Web page. 9. On the Alarm Report page, review the alarms that are displayed. Follow these steps to clear an alarm. a. Go to the end of the Alarm Report page and locate the Change Alarm Status settings. b. Select the option button for Selected Alarms. In the check boxes to the left of the alarm, select the alarms you want to clear. c. In the New Status field, select RETIRED, and click SUBMIT. AE Services redisplays the Alarm Report page. The alarms you cleared as displayed as hyperlinks (RETIRED). d. Click RETIRED to display the Alarm History page, which provides a history of the alarm. Note: Once you have cleared an alarm, you can not change its status. The RETIRED alarm will be cleared by the alarm service.

Note:

Issue 7 July 2007

169

Administering SNMP

AE Services alarm codes and messages


AE Services provides the following alarm codes and messages. Recall from How AE Services tracks alarms on page 168 that AE Services tracks alarms by event type and not product type.

Disk Notification Events


ACORE00001 Disk: timed out getting disk status. ACORE00002 Disk: sda drive not ready. ACORE00003 Disk: reset timed out. ACORE00004 Disk: reset master error. ACORE00005 Disk: sda lost interrupt. ACORE00006 Disk: disk has failed ACORE00007 Disk: status error. ACORE00008 Disk: disk usage exceeded 80% ACORE00009 Disk: disk is full. ACORE00010 Disk: MBE detected. ACORE00021 CPU: CPU utilization exceeded 80% ACORE00072 Watchdog: Process is dead. ACORE00993 Link down (Network Interface(s)) ACORE00041 Security: There have been 3 unsuccessful login attempts. The account is locked out for 30 minutes. ACORE00043 Security: Linux login failure - access through illegal port (access denied) ACORE00044 Security: a file has been modified illegally. ACORE00045 Security: a file has been removed illegally. ACORE00046 Security: a file has been added to the system in an illegal directory. ACORE00047 Security: tripwire failed to initialize the tripwire database.

CPU Utilization Notifications

Process Notifications

Network Interface Failures

Login Security Events (sent to an NMS only)


Tripwire Security Notifications (sent to an NMS only)

170 AE Services Administration and Maintenance Guide, Release 4.0.1

Device, Media, and Call Control Service

Appendix A: Locations of AE Services log files


This chapter provides information about the location of logs for the following services.

Device, Media, and Call Control Service on page 171 DLG Service on page 172 CVLAN Service on page 172 TSAPI Service on page 173 Telephony Web Service on page 173 System Management System Web Service on page 173 User Web Service on page 174

Device, Media, and Call Control Service


All logs are in /opt/mvap/logs, as follows:

mvap-api.log.xx (where xx is a number from 0 to 19) mvap-error.log.xx (where xx is a number from 0 to 19) mvap-trace.log.xx (where xx is a number from 0 to 19) mvap-wrapper.log.x (where x is a number from 1 to 4; the first wrapper log, mvap-wrapper.log, is not numbered) database.log reset.log

Issue 7 July 2007

171

Locations of AE Services log files

DLG Service
AE Services provides the same logs that were provided with the MAPD-based DLG. All logs, except the trace log, are in /opt/mvap/logs as follows:

Security (client) log (sec.yyyymmdd, for example sec.20050622) Error log (log.yyyymmdd, for example log.20050622) Command log (cmd.yyyymmdd, for example cmd.20050622) Reset log (reset.log) Trace log (/opt/mvap/logs/common/trace.out)

CVLAN Service
AE Services provides the same logs that were provided with the MAPD-based CVLAN and CVLAN Release 9 and Release 9.1 for Linux. All logs, except the trace log, are in /opt/mvap/logs as follows:

Security (client) log (sec.yyyymmdd, for example sec.20050622) Error log (log.yyyymmdd, for example log.20050622) Command log (cmd.yyyymmdd, for example cmd.20050622) Reset log (reset.log) Trace log (/opt/mvap/logs/common/trace.out)

172 AE Services Administration and Maintenance Guide, Release 4.0.1

TSAPI Service

TSAPI Service
All logs, except the trace log and the G3trace log, are in /opt/mvap/logs as follows:

Security (client) log (sec.yyyymmdd, for example sec.20050622) Error log (log.yyyymmdd, for example log.20050622) Command log (cmd.yyyymmdd, for example cmd.20050622) Reset log (reset.log) Trace log Trace log (/opt/mvap/logs/common/trace.out) G3trace logs are located in /opt/mvap/log/TSAPI (g3trace-switchname-n.trace.out, for example: g3trace-switch1-1.trace.out) Import SDB log (importsdb.log)

Telephony Web Service


The Telephony Web Service infrastructure includes Tomcat, Axis, and the TSAPI Service. Any major failure in either Tomcat or the TSAPI Service will affect the Telephony Web Service. All logs are in /opt/mvap/logs/tomcat as follows:

ws-telsvc-api.log ws-telsvc-error.log ws-telsvc-trace.log

System Management System Web Service


The System Management Service uses the Linux syslog and Apache logs.

Issue 7 July 2007

173

Locations of AE Services log files

User Web Service


All logs are in /opt/mvap/logs/tomcat as follows:

ws_cus.log ws_cus_authentication.log ws_cus_cmd.log ws_cusdistributor_sdbdistributor.log

174 AE Services Administration and Maintenance Guide, Release 4.0.1

TSAPI Client settings

Appendix B: Avaya Computer Telephony and CVLAN migration


This appendix applies to Avaya Computer Telephony users and CVLAN users who are migrating to Application Enablement Services (AE Services). Avaya Computer Telephony clients are, in terms of AE Services, TSAPI Service clients.

TSAPI Client settings on page 175 Migrating Avaya Computer Telephony Users to AE Services on page 176 Alternative Migration Strategies for Avaya Computer Telephony on page 180 Migrating CVLAN to AE Services on page 186

TSAPI Client settings


If you are migrating from Avaya Computer Telephony, and you are using an IP address for the AE Services Server (AE Server) that is different than the IP address you used for the Avaya Computer Telephony Windows-based server, you must make sure that your clients can access the AE Services Server. Depending on how you implemented your configuration, you might have to change your client configuration files. For information about editing client configuration files see the Avaya MultiVantage Application Enablement Services TSAPI, JTAPI, and CVLAN Client Installation Guide, 02-300543. Note: If you are editing client template files (TSLIB.INI file for Windows or tslibrc for UnixWare, Solaris, and HP-UX) make sure that the address in the template file uses the externally facing IP address of your firewall instead of the IP address of the AE Server. For information about editing client configuration files see the Avaya MultiVantage Application Enablement Services TSAPI, JTAPI, and CVLAN Client and SDK Installation Guide, 02-300543.

Note:

Issue 7 July 2007

175

Avaya Computer Telephony and CVLAN migration

Migrating Avaya Computer Telephony Users to AE Services


The AE Services OAM Import SDB capability is designed to use the flat file created by backing up the Avaya Computer Telephony SDB. For more information about creating a flat file and backing up the Avaya Computer Telephony SDB, refer to Chapter 5, Bulk Administration, in the Avaya Computer Telephony 1.3, Telephony Services Administration and Maintenance Guide (this document is not included with AE Services, it is included with Avaya Computer Telephony Releases 1.2 and 1.3).

Procedure to migrate the Avaya Computer Telephony SDB to AE Services


Follow this procedure to migrate your Avaya Computer Telephony SDB to AE Services. This is a one-time only procedure that you run when you are ready to migrate all members. See Figure 26: Importing the Avaya Computer Telephony SDB to the TSAPI Service SDB on page 178 for an illustration of the procedure. 1. From your Avaya Computer Telephony administrative workstation, use TSA 32 to create a flat file from the Avaya Computer Telephony SDB, as follows: Select Admin > Bulk Admin > Create Flat file from SDB. 2. From the CTI OAM Admin menu, select Maintenance > Import SDB. 3. OAM displays the Import SDB page. 4. Click Browse. 5. From the Choose file dialog (or the dialog that your operating system displays), browse to the location of your Avaya Computer Telephony SDB backup file, and select Open. OAM displays the file you selected in the Browse field. 6. Click Import. OAM does the following:

It updates the AE Services User Service database with your users (in effect, it adds your users with the CT User flag set to yes). It updates the TSAPI Service SDB with the permission settings for worktops, devices, device groups, and Tlink groups. It does not, however, import user passwords and Tlinks.

Note:

Note: Because Tlinks are not imported, the Tlink Groups are empty. Follow these steps to administer them in AE Services.

176 AE Services Administration and Maintenance Guide, Release 4.0.1

Migrating Avaya Computer Telephony Users to AE Services

7. From the CTI OAM main menu, select Administration > Tlink Groups. OAM displays the Tlink Groups page, with a list of Tlink Groups. 8. Select a Tlink Group, and click Edit Tlink Group. OAM displays the Add / Edit Tlink Group page, displaying a list of Tlinks. 9. Select the Tlinks that you want to add to the Tlink Group, and click Apply Changes. OAM displays the Apply Changes to Tlink Group properties page. 10. Select Apply. This completes the procedure for migrating your Avaya Computer Telephony users to the AE Services Security database.

Issue 7 July 2007

177

Avaya Computer Telephony and CVLAN migration

Figure 26: Importing the Avaya Computer Telephony SDB to the TSAPI Service SDB

! Use TSA 32 to backup the Avaya Computer Telephony security database.


Bulk Admin > Create Flat File From SDB SDB
INFORM1 INFORM2 ADD ADD ADD ADD 1 1 1 1 1 100 JED5 TBR3 101 102 Name Worktop J..... W401 T..... W411 W402 W421

User Login

BWN7 B.... RON2 R....

select Admin " In OAMthe SDBCTI OAMServices.> Maintenance > Import SDB. Import into AE I. The Import capability automatically updates AE Services User Service database and TSAPI Service SDB. User Login Name
INFORM1 INFORM2 ADD ADD ADD ADD 1 1 1 1 1 100 JED5 TBR3 User Login 101 102 Name Worktop J..... W401 T..... W411 W402 W421

AE Svcs User Service database

BWN7 B.... RON2 R....

Worktop Dev Mon Grp Call/Dev MonGrp

SDB

When you have completed the Import, migration is complete.

178 AE Services Administration and Maintenance Guide, Release 4.0.1

Migrating Avaya Computer Telephony Users to AE Services

Adding users
When you want to add a CTI user to AE Services, you must use the OAM User Management administrative account and the Add User feature. You can not add a user to the TSAPI Service SDB. See Adding a user to the AE Services User Service database on page 95. Service Management (which controls the User Service) periodically runs a synchronization process to update the TSAPI Service SDB. When the newly added user appears in the TSAPI Service SDB, you can assign user permissions for the newly added user. See Procedure to administer CTI User settings on page 125.

Issue 7 July 2007

179

Avaya Computer Telephony and CVLAN migration

Alternative Migration Strategies for Avaya Computer Telephony


If you plan to use another source of authority (Windows Active Directory Services) for user authentication, but you want to use the TSAPI Service Security Database (SDB) for user authorization, you will need to add your users to the AE Services User Service database. The AE Services User Service database is the means for populating the SDB. For information about adding users to the AE Services User Service database, see Adding a user to the AE Services User Service database on page 95. Note: If you plan to use Active Directory Services for user authentication and you do not plan to use the SDB, you can skip this appendix.

Note:

In terms of integrating with AE Services, the strategies are presented from the lowest level of integration to the highest. Bronze represents the lowest level of integration, Silver represents intermediate integration, and Gold represents complete integration. This appendix includes the following topics:

Avaya Computer Telephony Bronze Level Integration on page 180 Avaya Computer Telephony Silver Level Integration on page 182 Avaya Computer Telephony Gold Level Integration on page 184

Avaya Computer Telephony Bronze Level Integration


Bronze level integration is the lowest level of integration. Essentially it requires manually maintaining two sets of the same data.

How bronze-level integration works


Here is a high-level description of how bronze level integration works for adding a new user. For an illustration see, Bronze Level Integration with Active Directory Services on page 181.

Provisioning: - Add the user to the authoritative source (Windows Active Directory Services). - Add the user to AE Services User Service database with the CT User flag set to yes. This will effect an update to the AE Services SDB.

Authentication - A user attempts to log in (as a client of the TSAPI Service). - The user is authenticated against the Windows Active Directory Services based user service. - User permissions are derived from the AE Services SDB.

180 AE Services Administration and Maintenance Guide, Release 4.0.1

Alternative Migration Strategies for Avaya Computer Telephony

Figure 27: Bronze Level Integration with Active Directory Services

!Administrator enters new user in enterprise


data store (first entry)

Legacy Data Store


Active Directory Services

" Administrator enters new user in AE Svcs OAM


(second entry) User Management > Add User (CT User) Add User
AE Svcs User Service Database

AE Svcs

sdbdistributor

SDB

CT User

CT User yes
AE Services User Service database automatically updates CTI OAM Security database

# Administrator uses CTI OAM administration


to set up user permissions in SDB
Administration > Security Database > CTI Users > List All Users > Edit CTI User Add to device groups

Requires double entry (manual synchronization) between Legacy data store and AE Services User Database.

Issue 7 July 2007

181

Avaya Computer Telephony and CVLAN migration

Avaya Computer Telephony Silver Level Integration


Silver level integration represents a tighter coupling between your enterprise database (Windows Active Directory Services) and AE Services User Service database.

How silver-level integration works


Here is a high-level description of how silver level integration works for adding a new user. For an illustration see, Figure 28: Silver Level Integration with Active Directory Services on page 183.

Provisioning: - Add the user to the authoritative source (Windows Active Directory Services). - Do either of the following:

Add the user to AE Services User Service database with the CT User flag set to yes. This will effect an update to the AE Services SDB (double-entry). From OAM User Management run ldapdistributor, which imports the user information from Windows Active Directory Services (manual synchronization). OAM stands for Operations, Administration, and Maintenance.

Authentication: - A user attempts to log in (as a client of the TSAPI Service). - The user is authenticated against Windows Active Directory services based user service. - User permissions are derived from the AE Services SDB (which is created by virtue of either double-entry or synchronization).

182 AE Services Administration and Maintenance Guide, Release 4.0.1

Alternative Migration Strategies for Avaya Computer Telephony

Figure 28: Silver Level Integration with Active Directory Services

!Administrator enters new user in enterprise


data store (first entry)

Legacy Data Store Active Directory Services

" Admin can use method A or B


A Double entry Admin enters new user in AE Svcs OAM (second entry) User Management > Add User (CT User) B Single entry

Admin uses Service Management and distributor to propagate change from ADS to SDB. Service Management > Manage Distributor > Synchronize

ldapdistributor

sdbdistributor

AE Svcs User Service Database

AE Svcs SDB

CT User CT User yes


AE Services User database automatically updates CTI OAM Security database

#Administrator uses CTI OAM administration


to set up user permissions in SDB
Administration > Security Database > CTI Users > List All Users > Edit CTI User Add to device groups

Either double entry (manual) or single entry (automatic).

Issue 7 July 2007

183

Avaya Computer Telephony and CVLAN migration

Avaya Computer Telephony Gold Level Integration


Gold level integration means complete integration between your enterprise database, and AE Services. A single entry in your enterprise database automatically results in an entry in the AE Services SDB. Gold level integration, however, does require that you develop a solution. In effect you develop your own distributor.

How gold-level integration works


Here is a high-level description of how gold level integration works for adding a new user. For an illustration see, Figure 29: Gold Level Integration with Active Directory Services on page 185.

Provisioning: - Add the user to your enterprise user management system. - Your enterprise system contacts AE Services User Services via Simple Object Access Protocol (SOAP) interface, as a normal processing activity, to provide the update.

Your enterprise_distributor updates the AE Services User Service database. The AE Services sdbdistributor updates the SDB.

Authentication: - A user attempts to log in (as a client of the TSAPI Service). - The user is authenticated against the enterprise user management system. - User permissions are derived from the AE Services SDB.

184 AE Services Administration and Maintenance Guide, Release 4.0.1

Alternative Migration Strategies for Avaya Computer Telephony

Figure 29: Gold Level Integration with Active Directory Services

! Administrator enters new user


in their enterprise data store. Enterprise Data Store Add User enterprise_distributor
AE Svcs User Service Database

Enterprise database automatically updates AE Services User Service Database


AE Svcs SDB

CT User yes sdbdistributor


AE Services User Service database automatically updates CTI OAM Security database

CT User

"

Administrator uses CTI OAM administration to set up user permissions in SDB


Administration > Security Database > CTI Users > List All Users > Edit CTI User Add to device groups

Single entry, complete integration requires developing an enterprise_distributor.

Issue 7 July 2007

185

Avaya Computer Telephony and CVLAN migration

Migrating CVLAN to AE Services


This section describes the following migration scenarios:

Migrating CVLAN Server for Linux (Releases 9.0 and 9.1) to AE Services on page 186 Migrating the MAPD-based CVLAN to AE Services on page 188

Migrating CVLAN Server for Linux (Releases 9.0 and 9.1) to AE Services
AE Services does not provide a tool for migrating CVLAN Server for Linux (Releases 9.0 and 9.1) to AE Services. Migration CVLAN Server R9.0 or 9.1means that you are replacing a CVLAN R9.0 or R9.1 Server with the AE Services 3.1 CVLAN Service for connectivity to Communication Manager 3.x. Follow the procedures in these sections to migrate CVLAN R9.0 or R9.1 to AE Services 3.1.

On the Communication Manager 2.x server on page 186 On the CVLAN R9.0 or R9.1 Server for Linux on page 186 On the AE Server on page 187

On the Communication Manager 2.x server


1. From the System Administration Terminal, type change ip-services. 2. From the IP Services screen, go to the DLG Administration screen. 3. Make a note of the CTI Link number and the corresponding Client Link number. You will administer this information in AE Services OAM, when you administer the CVLAN Service. (See Step 4a in On the AE Server on page 187).

On the CVLAN R9.0 or R9.1 Server for Linux


1. From your CVLAN Server (R9.0 or R9.1) select Administration > Links and follow these steps for each link. a. Select each link and click Edit Clients. b. From the Edit Clients page make a note of the Name or IP Address of each client associated with the CVLAN Link you selected.

186 AE Services Administration and Maintenance Guide, Release 4.0.1

Migrating CVLAN to AE Services

On the AE Server
1. From the AE Server with an active license for the CVLAN service, administer the CVLAN Service for connectivity to Communication Manager by following these steps. Note that the page numbers correspond to the topic headings. Some procedures continue to subsequent pages. a. Administer the NICs, see Administering the Local IP for all AE Services on page 71. b. Administer the Switch Connections, see Administering Switch Connections on page 73. c. Administer the CVLAN Links, see Administering CVLAN Links in AE Services OAM on page 76. When you carry out this procedure in AE Services OAM, follow these steps:

In the Signal field, use the Client Link number you noted on the Communication Manager 2.x DLG Administration Screen in Step 1. In the Switch CTI Link number field, use the CTI Link number you noted on the Communication Manager 2.x DLG Administration Screen in Step 1.

d. Test the CVLAN Links, Testing a CVLAN Link on page 77. e. Administer the CVLAN clients, see Adding CVLAN Clients on page 78. When you carry out this procedure, use the CVLAN client information you noted in Step 2. This completes the procedure to migrate the CVLAN Server for Linux to AE Services.

Issue 7 July 2007

187

Avaya Computer Telephony and CVLAN migration

Migrating the MAPD-based CVLAN to AE Services


AE Services does not provide a tool for migrating the MAPD-based CVLAN to AE Services. Migration for the MAPD-based CVLAN means that you are replacing a MAPD-based CVLAN Server with the AE Services 3.1 CVLAN Service for connectivity to Communication Manager 3.0. Follow the procedures in these sections to migrate the MAPD-based CVLAN to AE Services.

On the MAPD on page 188 On the AE Server on page 189

On the MAPD
1. Log in to the MAPD. For example, telnet <host name or IP address of MAPD>, and supply the MAPD log in and password. 2. From the system prompt, type eth_oam to start the CV/LAN screens. From the Main Menu, select CV/LAN Administration. From the CV/LAN Administration screen, follow these steps:

From the Node ID column, make a note of the signal numbers (signal01, signal02 and so on). From the Number of Clients column, select each client number (1, 2 and so on), and make a note of the <IP address> of each client.

188 AE Services Administration and Maintenance Guide, Release 4.0.1

Migrating CVLAN to AE Services

On the AE Server
1. From the AE Server with an active license for the CVLAN service, administer the CVLAN Service for connectivity to Communication Manager by following these steps. Note that the page numbers correspond to the topic headings. Some procedures continue to subsequent pages. a. Administer the NICs, see Administering the Local IP for all AE Services on page 71. b. Administer the Switch Connections, see Administering Switch Connections on page 73. c. Administer the CVLAN Links, see Administering CVLAN Links in AE Services OAM on page 76. When you carry out this procedure in AE Services OAM, follow these steps:

In the Signal field, use the Client Link number you noted on the Communication Manager 2.x DLG Administration Screen in Step 1. In the Switch CTI Link number field, use the CTI Link number you noted on the Communication Manager 2.x DLG Administration Screen in Step 1.

d. Test the CVLAN Links, see Testing a CVLAN Link on page 77. e. Administer the CVLAN clients, see Testing a CVLAN Link on page 77 When you carry out this procedure, use the CVLAN client information you noted in Step 2. This completes the procedure to migrate the MAPD based CVLAN Server to AE Services.

Issue 7 July 2007

189

Avaya Computer Telephony and CVLAN migration

190 AE Services Administration and Maintenance Guide, Release 4.0.1

Glossary
A
Admin access group A TSAPI SDB term. An admin access group is a group of TSAPI Service users with administration privileges. Group members have permission to administer either all TSAPI service components or some TSAPI service components. Advanced Encryption Standard. The Advanced Encryption Standard (AES) is a Federal Information Processing Standard (FIPS) Publication (FIPS-197) that specifies a cryptographic algorithm for use by U.S. Government organizations to protect sensitive (unclassified) information.The AES specifies three key sizes: 128, 192 and 256 bits. A character string that is a combination of letters of the alphabet and numbers. Application Programming Interface. Software that applications use to interact with network services, telephony services, and so forth. The process of validating the identity of a user by means of user profile attributes. The process of granting a user the ability to carry out certain activities based on permissions.

AES

Alphanumeric API Authentication Authorization

B
Breadcrumb trail Refers to the navigation bar on a Web site that displays the names of pages you have visited. On the AE Services OAM Web pages, for example, a breadcrumb trail would display as, You are here: Administration > Switch Connections.

C
Call/call monitor A TSAPI SDB term. A call/call monitor is software that tracks call activity on the basis of a call ID (a unique identifier of the call being handled by Communication Manager). Users either have or do not have call/call monitoring permission; you do not need to create a device group for call/call monitoring access rights. Contrast with device monitors and call/device monitors, which are based on a device ID. Call/device monitor A TSAPI SDB term. Call/Device monitors are used to track events for a call once it reaches the device being monitored. Unlike Device/Device monitors, events for a call continue to be received even after the call leaves the device. The name a user prefers to use (such as a first name, a middle name, another form of the first or middle name, a nickname, and so forth).

Common name

Issue 7 July 2007

191

Common User Store

Common User Store

The pool of shared user profile attributes maintained in the Lightweight Directory Access Protocol (LDAP) database. In other words, a common repository of user profiles. See also, Profile. The Device, Media, and Call Control API supersedes Communication Manager API (or CMAPI). Communication Manager API is the former name of a service that provided connectivity between applications (that provide device and media control) and Communication Manager. Abbreviated as CTI. The integration of services provided by a computer and a telephone. In simplest terms it means connecting a computer to a communications server (or switch) and having the computer issue commands that control calls. See Switch Connection Name. Call Control refers to the group of services that enable a telephony client application to control a call or connection on Communication Manager. These services are typically used for placing calls from a device and controlling any connection on a single call as the call moves through Communication Manager. The CVLAN Service, the DLG Service and the TSAPI Service (which includes the Telephony Web Service and JTAPI) provide client applications with call control capabilities. An abbreviation for Computer Telephony User. A user (or an application) administered in the AE Services User Service as a CT User derives authorization from the Security Database. CT Users include the following users or applications: TSAPI Service users (including JTAPI users), Telephony Web Service users, and Device, Media and Call Control users who use the Call Control Services (CSTA III Single-Step Conference, Snapshot Call, and Snapshot Device). The term CTI link refers to a generic link type that is used in the context of Communication Manager administration. As a generic link type, it can refer to any of the following AE Services links: CVLAN Links, DLG links, and TSAPI links (the Call Control Services, the Telephony Web Service, and JTAPI use the TSAPI Service). When an OAM Web page, such as TSAPI Service Summary, displays a column heading for a CTI link type, it is referring to TSAPI link as it is administered on Communication Manager.

Communication Manager API

Computer Telephony Integration Connection Name Call Control

CT User

CTI Link

CTI User

Computer Telephony Integration user (synonymous with CT User). See CT User.

D
Device A TSAPI SDB term. A device can be a telephone, an ACD, a VDN, or an agent ID that Communication Manager controls. In the Security Database, a device has the following attributes: Device ID (which is administered on Communication Manager, see Device ID), Location, Device Type, and Tlink Group.

192 AE Services Administration and Maintenance Guide, Release 4.0.1

Exception group

Device, Media, and Call Control

Device, Media, and Call Control refers to the API that provides Device and Media Control as well as Call Information Services, Call Control (CSTA III Single-Step Conference) and Snapshot Services (CSTA III Snapshot Call and Snapshot Device). Device, Media, and Call Control is the successor to Communication Manager API. Data Encryption Standard or (DES) is a United States Government Sanctioned encryption algorithm described in Federal Information Processing Standards Publication, FIPS PUB 46-1 or ANSI Standard X3.92. DES uses 64 bit keys of which 56 bits are used by the algorithm and 8 are used for error detection. A TSAPI SDB term. A device group refers to a named list of devices in the Security Database. You can assign device groups to users and worktops. A TSAPI SDB term. Device/device refers to either a device/device monitor or a device/device monitoring group in the Security Database. An application places a device monitor on a specific device so it can receive an event report any time an event occurs at that device. For example, if the device receives an incoming call or originates an outgoing call, the application receives an event report. Device monitors are the most commonly used monitor. By default, all users have this permission for the devices associated with their worktop.

DES

Device group Device/device

Device ID

A TSAPI SDB term. A Device ID is a 2 to 7-digit number for a phone, fax, modem, acd, vdn, or agent id that is administered on Communication Manager. This is not the full 7 or 10 digit number used by the public network. Components of User Management that propagate changes, such as additions, changes or deletions from an application to the AE Services User Service database. The AE Services provides two distributors, the SDB distributor and the Generic LDAP distributor. See also Synchronize. Microsoft Windows based term for computer running XP Server that uses a common directory for storing account information for a complete domain. DTMF is the acronym for Dual-Tone Multifrequency. DTMF is a generic term for the method of pushbutton signaling from voice terminals using the voice transmission path. The code for DTMF Signaling provides 16 distinct signals, each composed of 2 voiceband frequencies (one from each of 2 mutually exclusive frequency groups of 4 frequencies each).

Distributors

Domain Controller DTMF

E
Exception group A TSAPI SDB term. An exception group is a way of managing a large list by using the principle of exclusion. An exception group contains only the excluded members or the exceptions. For example, suppose Mary is a supervisor with permission to control all of the phones in the organization, except those that belong to the president and the vice president. Instead of setting up a device group that contains all of the devices except the presidents phone and the vice-presidents phone, you could set up an exception group and assign it to Mary. This exception group would contain the phones of the president and vice president

Issue 7 July 2007

193

Heartbeat

H
Heartbeat The heartbeat capability allows a client to query the server for the status of an CTI link. Heartbeat is a two-way capability. Communication Manager (as the client) can issue the heartbeat to the AE Server, or the AE Server (as the client) can issue a heartbeat to Communication Manager. In OAM you can set heartbeat state to Off or On.If heartbeat is set to off, Communication Manager initiates a heartbeat request.If the heartbeat is set to on, AE Server initiates the heartbeat request.

J
JTAPI JTAPI is the acronym for Java Telephony Application Programming Interface. JTAPI is an API that provides access to the complete set of Third Party call control features provided by the TSAPI Service. JTAPI uses the TSAPI Service for communication with Avaya Communication Manager.

K
Kerberos Keystore Kerberos is a network authentication protocol that lets users authenticate themselves using a secure server. A file that contains public and private keys.

L
LDAP LDAP is the acronym for Lightweight Directory Access Protocol, which defines a standard protocol for organizing directory hierarchies and a standard interface for clients to access directory servers.

M
MIB Management Information Base A component of SNMP. It defines what information a devices SNMP agent is capable of reporting. It is a list of all the types of information an SNMP manager can poll an SNMP agent for, as well as the traps an SNMP agent can send to an SNMP manager. The Application Enablement Services MIB resides on the AE Server. A TSAPI SDB term. A monitor is a TSAPI Service capability that watches for activity on a call or a device. A monitor placed on a device or a call causes reports of changes in the status of the device or call to be sent to the client requesting the monitor. If your application places a device monitor on your phone, your application is notified of any change in your phones status (for example an incoming call has been received, a call has ended, and so forth). Many applications rely on monitors to provide this type of information.

Monitor

194 AE Services Administration and Maintenance Guide, Release 4.0.1

Secondary Device Group

O OAM P
PAM Private Data Primary Device ID Profile PAM is the acronym for Pluggable Authentication Module, which is software that accommodates different authentication methods. Private data is a switch-specific software implementation that provides value added services. A TSAPI SDB term. The primary device ID is the primary device at a users worktop. Usually it is the extension of the telephone on the worktop. A set of attributes that represents a specific user in the AE Services User Service database. Operations, Administration, and Maintenance. The administrative interface for the Application Enablement Services platform.

R
Routing In the sense of adjunct routing, routing is a capability for selecting a appropriate path for a call. When a routing application is started, it sends route registration requests, which contain a device ID, to Communication Manager. Routing requests instruct Communication Manager to send all incoming calls to these device IDs (in the TSAPI Service). The TSAPI Service sends the call to the application for routing. Communication Manager does not route these calls. Also referred to as adjunct routing. In terms of access privileges (Allow Routing on Listed Device), routing refers to the ability to register with Communication Manager to route calls (as in adjunct routing). A user (or an application) can perform routing for a device or a device group. Routing privileges can be granted only by administering access privileges (Allow Routing on Listed Device).

S
SATA SDB Security Database Serial ATA (Serial Advanced Technology Attachment). See Security Database. The Security Database is a database that stores information about CT Users and the devices they control. The TSAPI Service uses this information in its permission checking. Administrators can control user access to the TSAPI Service by placing restriction on the types of request users can make. The TSAPI Service uses the Postgres database for the Security Database. A TSAPI SDB term. A group of devices (in addition to the primary device) that are associated with the worktop or are shared among worktops. Users assigned to this worktop have permission to control and monitor all devices in this group.

Secondary Device Group

Issue 7 July 2007

195

Service Management

Service Management Simple Network Management Protocol

A set of operations in OAM that provide you with the ability to manage the User Service. Abbreviated as SNMP. SNMP is a standard network management protocol that is used to remotely monitor and manage network-capable devices such as computers, switches, and gateways. SNMP provides a way for monitored objects (SNMP agents) and monitoring objects (SNMP managers) to exchange status messages. The component in an SNMP managed network that collects and stores status information and makes it available to the SNMP manager. One of its capabilities is to send traps (alarm notifications) to an SNMP agent when a device failure occurs. The SNMP manager is the component in an SNMP managed network that communicates with SNMP agents. It can issue requests for information and it can receive unsolicited notifications from SNMP agents. Unsolicited notifications are referred to as traps. A Switch Connection Name is a term that refers to either of the following: For the TSAPI Service, the Telephony Web Service, the CVLAN Service, and the DLG Service, a collection of Host Names or IP addresses associated with one (and only one) switch.

SNMP Agent

SNMP Manager

Switch Connection Name

!
Important:

Important: If you use multiple Switch Connection Names, the total number of IP addresses and Host Names can not exceed 64 for a given AE Services Server. That is, if you use two Switch Connection Names, SCA and SCB, the total number of names and IP addresses (or Host Names) can not exceed 64.

Synchronize

For the Device, Media, and Call Control Service, a collection of H.323 Gatekeepers that are associated with one (and only one) switch. In the context of User Management, the Synchronize feature is used to trigger a synchronization of user data between the User Service database (LDAP based) and an application user space (for example, the TSAPI Security Database) through a Distributor connection. The Synchronize button on the Distributor List page provides administrators with a way to trigger the synchronization behavior of a particular Distributor. See also, Distributors.

T
Telephony Web Service TLS The Telephony Web Service is an API that provides access to basic subset of Third Party call control features of Communication Manager. It relies on the TSAPI Service to communicate with Communication Manager. Abbreviation for Transport Layer Security, a protocol that guarantees privacy and data integrity between client and server components communicating over the Internet. The CSTA-based third party call control services provided by AE Services.

TSAPI Service

196 AE Services Administration and Maintenance Guide, Release 4.0.1

Worktop

U
User A person or an application administered in the AE Services User Service database. For example, a TSAPI application would be administered as an AE Services user with the CT User field set to Yes. A set of attributes that represent a specific user in the AE Services User Service database. OAM Web pages that provide you with capabilities for managing AE Services user profiles. User Management relies on the User Service to authenticate users. The User Service is a shared service component that provides capabilities for managing user profile data in the AE Services User Service database. The User Service interface provides two sets of operations. One set of operations provides an application with the ability to list, search, add, modify and delete users in the User Service database. In terms of AE Services OAM this is User Management. The other set of operations provides a means of controlling the User Service itself. These operations include the ability to re-initialize the service with configuration settings and operations to manage any configured distributors. In terms of AE Services OAM this is Service Management.

User Profile User Management

User Service

W
Workstation A TSAPI SDB term. A workstation is the client computer that has either a Host Name or an IP address. It is represented in the Security Database by a Host Name or IP Address. A TSAPI SDB term. A worktop is a Security Database entity (object) that refers to a device, or a collection of devices, that are associated with the Host Name or IP address of a workstation. A worktop can consist of a client telephone (the worktops Primary device) and any number of additional telephony devices (such as fax machines or modems), which are specified through the worktops Secondary Device list. The telephone extension is usually the Primary Device ID attribute in the Worktop object.

Worktop

Issue 7 July 2007

197

Worktop

198 AE Services Administration and Maintenance Guide, Release 4.0.1

Index

Index
administering a region with . . . . . . . . . . . codec set, that uses (G.711A,G.711U and G.729) . Communication Manager administering for AE Services . . . . . . . . . Configuring IP services . . . . . . . . . . . . . . control modes exclusive . . . . . . . . . . . . . . . . . . . shared . . . . . . . . . . . . . . . . . . . . CT User field . . . . . . . . . . . . . . . . . . . CT Users . . . . . . . . . . . . . . . . . . . . CTI link for TSAPI, JTAPI or Telephony Web Service CTI OAM administration. . . . . . . . . . . . . . CTI Users . . . . . . . . . . . . . . . . . . . . CVLAN clients, adding . . . . . . . . . . . . . . CVLAN Link, testing . . . . . . . . . . . . . . . CVLAN Links, administering . . . . . . . . . . . . CVLAN, administering a CTI link . . . . . . . . . . CVLAN, Local IP administration and the Any setting CVLAN, s, starting, stopping, and restarting . . . .

A
add data-module command . . . . . . . . . . . . . 24 add station command . . . . . . . . . . . . . . . 32 Adding a CLANs . . . . . . . . . . . . . . . . . . 23 Adding AE Services users Users, AE Services, adding . . . . . . . . . . . 95 Administering a CTI link for an ASAI application . . . 30 Administering a CTI link for CVLAN . . . . . . . . . 29 Administering a CTI link for internal Avaya CVLAN applications . . . . . . . . . . . . . . . . . . . 29 administering a network region . . . . . . . . . . . 39 Administering CVLAN Links . . . . . . . . . . . . 76 Administering Local IP . . . . . . . . . . . . . . . 71 Administering Switch Connections . . . . . . . . . 73 AE Server, restarting . . . . . . . . . . . . . . . . 84 AE Services database backup . . . . . . . . . . . 81 AE Services Database, restoring . . . . . . . . . . 82 AE Services User Service database . . . . . . . . 93, 95 AE Services users, adding . . . . . . . . . . . . . 95 AE Services users, editing . . . . . . . . . . . . . 95 AE Services, Stopping . . . . . . . . . . . . . . . 84 Alarms, clearing . . . . . . . . . . . . . . . . . . 169 Alarms, how AE services tracks . . . . . . . . . . . 168 Application, and device monitoring . . . . . . . . . 112 ASAI application, administering a CTI link . . . . . . 30 ASAI Link Manager starting, stopping, and restarting . . . . . . . . . 84 attributeacl.properties . . . . . . . . . . . . . . . 101 attributesmap.properties . . . . . . . . . . . . . . 100

. 36 . 36 . 15 . 25 . 32 . 33 . 95 . 94 . 30 . 63 . 113 . 78 . 77 . 76 . 29 . 72 . 84

D
database . . . . . . . . . . . . . . . . . . . . . 150 Database (AE Services), restoring . . . . . . . . . . 82 Database Backup (AE Services) . . . . . . . . . . . 81 Default passwords . . . . . . . . . . . . . . . . 147 defaultuservalues.properties . . . . . . . . . . . 100 Delete AE Services user . . . . . . . . . . . . . . 96 Device and Media Control codec set . . . . . . . . . 36 Device and Media Control extensions, administering a network region . . . . . . . . . . . . . . . . . . 39 Device group object . . . . . . . . . . . . . . . . 118 Device/device monitoring . . . . . . . . . . . . . . 112 Distributor, when to run on-demand Synchronize . . 105 DLG Service, starting, stopping, and restarting . . . . 84 DMCC . . . . . . . . . . . . . . . . . . . . . . . 69 Downloading and viewing Service Log files . . . . . 104

B
Backup, AE Services database . . . . . . . . . . . 81

C
Call monitoring application, sample configuration Call routing, in sample configuration . . . . . . . Call/call monitors . . . . . . . . . . . . . . . Call/device monitor. . . . . . . . . . . . . . . change ip-codec-set command . . . . . . . . . change ip-interface command . . . . . . . . . change ip-network-region command . . . . . . change node-names ip command . . . . . . . . CLAN, adding . . . . . . . . . . . . . . . . . Clearing alarms . . . . . . . . . . . . . . . . CMAPI Service, starting, stopping, and restarting codec set

. . 132 . . 136 . . 112 . . 112 . . 36 . . 40 . . 36 . 23, 40 . . 23 . . 169 . . 84

E
example configuration . . . . . figure . . . . . . . . . . . . Exclusive . . . . . . . . . . . exclusive control . . . . . . . . Exclusive control mode . . . . . Extended worktop access and LAN address information if disabled . . . . . . . . . .

. . . . .

. . . . .

. . . . .

. . . . .

. . . . .

. . . . .

. . . . .

. . . . .

. . . . .

. . . . .

41 42 32 32 32

. . . . . . . . . . 111 . . . . . . . . . . 111

Issue 7 July 2007

199

Index

G
genericldap1.properties . . . . . . . . . . . . . . 101 Glossary . . . . . . . . . . . . . . . . . . . . . 191

S
Sample configuration assigning permissions . . . . . . . . . . . . call monitoring . . . . . . . . . . . . . . . manager/assistant . . . . . . . . . . . . . . sdbdistributor.properties . . . . . . . . . . . . Search user, feature . . . . . . . . . . . . . . Secure Services Gateway (SSG) sending traps to Service Configuration, editing . . . . . . . . . . Service Controller . . . . . . . . . . . . . . . Shared control . . . . . . . . . . . . . . . . . Shared control mode . . . . . . . . . . . . . . Shared worktop device group administration . . . Single account administration, OAM . . . . . . . SNMP agent . . . . . . . . . . . . . . . . . . SNMP manager . . . . . . . . . . . . . . . . SNMP manager, NMS or SSG. . . . . . . . . . SNMP, AE Server as agent . . . . . . . . . . . SNMP, basic information . . . . . . . . . . . . softphones adding to network region . . . . . . . . . . . Station control (device and media control) . . . . stations, adding . . . . . . . . . . . . . . . . Stopping AE Services . . . . . . . . . . . . . . Switch Connection status . . . . . . . . . . . . Switch Connection status (AE Services) . . . . . Switch Connections, administering . . . . . . . .

H
Home page User Management . . . . . . . . . . . . . . . 93

I
IP services, configuring . . . . . . . . . . . . . . . 25

L
LAN address information, and Extended Worktop Access 111 ldapfilter.properties. . . . . . . . . . . . . . . . . 102 Links, CVLAN . . . . . . . . . . . . . . . . . . . 78 Links, TSAPI . . . . . . . . . . . . . . . . . . . 80 Linux, restarting . . . . . . . . . . . . . . . . . . 84 List All Users . . . . . . . . . . . . . . . . . . . 94 Local IP, administering . . . . . . . . . . . . . . . 71

. . . . . . . . . . . . . . . . . . . . . . . .

130 132 131 101 . 96 164 100 . 84 . 33 . 33 133 . 93 163 163 164 164 163

M
media gateway, adding . . . . . . . . . . . . . . . 39 media processor, adding . . . . . . . . . . . . . . 40 Modify Default User . . . . . . . . . . . . . . . . 97

. . . . . . .

39 32 32 84 31 75 73

T
Tlink group defined . . . . . . . . . . . . . . . Transport Layer Service starting, stopping, and restarting . . . Tripwire running an integrity check . . . . . . Tripwire (Bundled Server only) printing a report . . . . . . . . . . . reconfiguring for administrative access updating the database . . . . . . . . TSAPI Links, administering . . . . . . . TSAPI Service starting, stopping, and restarting . . .

N
network region adding softphones . . . . . . . . . . . . . . . 39 setting up . . . . . . . . . . . . . . . . . . . 35 Network regions, administering . . . . . . . . . . . 22

. . . . . 120 . . . . . . 84 . . . . . 150 . . . . . . . . . . . . . . . . . . . .
150 149 150 . 80

P
Password, User Management . . . . . . . . . . . 98 Passwords, default . . . . . . . . . . . . . . . . . 147

. . . . . . 84

R
rbac.properties . . . . . . . . . . . . . . Reinitializing the User Service . . . . . . . remoteldapauthenticator.properties . . . . . replicator1.properties . . . . . . . . . . . . RETIRED alarm status, clearing alarms . . . Routing application, when started . . . . . . Routing, when a routing application is started

. . . . . . .

. . . . . . .

. . . . . . .

. 101 . 103 . 102 . 101 . 169 . 112 . 112

U
User access, extending to other worktops User Management, logging in . . . . . . User Management, password . . . . . . User permissions changes to . . . . . . . . . . . . . User Service, reinitializing . . . . . . . . User, AE Services, deleting. . . . . . . .

. . . . . . 111 . . . . . . 93 . . . . . . 98 . . . . . . 116 . . . . . 103 . . . . . . 96

200 AE Services Administration and Maintenance Guide, Release 4.0.1

Index
user.properties . . . . . . . . . . . . . . . . . . 102 Users, AE Services, editing . . . . . . . . . . . . . 95

V
VDN (vector directory number), usage example . . . 135

W
ws_cus_bootstrap.properties . . . . . . . . . . . . 102

Issue 7 July 2007

201

Index

202 AE Services Administration and Maintenance Guide, Release 4.0.1

Potrebbero piacerti anche