Cisco Unified Communications Manager Adapter User Guide

Transcription

1 IBM Security Identity Manager Version 6.0 Cisco Unified Communications Manager Adapter User Guide SC

2

3 IBM Security Identity Manager Version 6.0 Cisco Unified Communications Manager Adapter User Guide SC

4 Note Before using this information and the product it supports, read the information in Notices on page 27. Edition notice Note: This edition applies to version 6.0 of IBM Security Identity Manager (product number 5724-C34) and to all subsequent releases and modifications until otherwise indicated in new editions. Copyright IBM Corporation US Government Users Restricted Rights Use, duplication or disclosure restricted by GSA ADP Schedule Contract with IBM Corp.

5 Contents Figures v Tables vii Preface ix About this publication ix Access to publications and terminology..... ix Accessibility x Technical training x Support information x Statement of Good Security Practices x Chapter 1. Introduction to the Cisco Unified Communications Manager Adapter Chapter 2. Checklist for configuring IBM Security Identity Manager to run the adapter Chapter 3. User account management tasks Preparation for the adapter operations Reconciling support data without reconciling user accounts Reconciling a single user account Addition of user accounts Specification of the required attributes Specification of the mobility attributes Specification of support data attributes Modification of user accounts Modification of support data attributes Password change of user accounts Deletion of user accounts Chapter 4. Troubleshooting Techniques for troubleshooting problems Error logs Error messages and warnings Appendix A. Attributes of the Cisco Unified Communications Manager Adapter Appendix B. APIs used by the adapter 17 Appendix C. Definitions for ITDI_HOME and ISIM_HOME directories Appendix D. Support information Searching knowledge bases Obtaining a product fix Contacting IBM Support Appendix E. Accessibility features for IBM Security Identity Manager Notices Index Copyright IBM Corp iii

6 iv IBM Security Identity Manager: Cisco Unified Communications Manager Adapter User Guide

7 Figures Copyright IBM Corp v

8 vi IBM Security Identity Manager: Cisco Unified Communications Manager Adapter User Guide

9 Tables 1. Checklist for configuring IBM Security Identity Manager Modifying support data attributes Adapter error messages, warnings, and corrective actions Account form attributes APIs for user account operations Copyright IBM Corp vii

10 viii IBM Security Identity Manager: Cisco Unified Communications Manager Adapter User Guide

11 Preface About this publication The Cisco Unified Communications Manager Adapter User Guide provides information that you need to manage user accounts. You can use IBM Security Identity Manager to manage accounts on various operating systems such as: v Windows v AIX v HP-UX v Linux v Solaris IBM Security Identity Manager was previously known as Tivoli Identity Manager. Access to publications and terminology This section provides: v A list of publications in the IBM Security Identity Manager library. v Links to Online publications. v A link to the IBM Terminology website on page x. IBM Security Identity Manager library For a complete listing of the IBM Security Identity Manager and IBM Security Identity Manager Adapter documentation, see the online library ( com.ibm.isim.doc_6.0/ic-homepage.htm). Online publications IBM posts product publications when the product is released and when the publications are updated at the following locations: IBM Security Identity Manager library The product documentation site ( infocenter/tivihelp/v2r1/index.jsp?topic=/com.ibm.isim.doc_6.0/ichomepage.htm) displays the welcome page and navigation for the library. IBM Security Systems Documentation Central IBM Security Systems Documentation Central provides an alphabetical list of all IBM Security Systems product libraries and links to the online documentation for specific versions of each product. IBM Publications Center The IBM Publications Center site ( linkweb/publications/servlet/pbi.wss) offers customized search functions to help you find all the IBM publications you need. Copyright IBM Corp ix

12 IBM Terminology website The IBM Terminology website consolidates terminology for product libraries in one location. You can access the Terminology website at software/globalization/terminology. Accessibility Technical training Support information Accessibility features help users with a physical disability, such as restricted mobility or limited vision, to use software products successfully. With this product, you can use assistive technologies to hear and navigate the interface. You can also use the keyboard instead of the mouse to operate all features of the graphical user interface. For technical training information, see the following IBM Education website at IBM Support provides assistance with code-related problems and routine, short duration installation or usage questions. You can directly access the IBM Software Support site at Appendix D, Support information, on page 21 provides details about: v What information to collect before contacting IBM Support. v The various methods for contacting IBM Support. v How to use IBM Support Assistant. v Instructions and problem-determination resources to isolate and fix the problem yourself. Note: The Community and Support tab on the product information center can provide additional support resources. Statement of Good Security Practices IT system security involves protecting systems and information through prevention, detection and response to improper access from within and outside your enterprise. Improper access can result in information being altered, destroyed, misappropriated or misused or can result in damage to or misuse of your systems, including for use in attacks on others. No IT system or product should be considered completely secure and no single product, service or security measure can be completely effective in preventing improper use or access. IBM systems, products and services are designed to be part of a comprehensive security approach, which will necessarily involve additional operational procedures, and may require other systems, products or services to be most effective. IBM DOES NOT WARRANT THAT ANY SYSTEMS, PRODUCTS OR SERVICES ARE IMMUNE FROM, OR WILL MAKE YOUR ENTERPRISE IMMUNE FROM, THE MALICIOUS OR ILLEGAL CONDUCT OF ANY PARTY. x IBM Security Identity Manager: Cisco Unified Communications Manager Adapter User Guide

13 Chapter 1. Introduction to the Cisco Unified Communications Manager Adapter The Cisco Unified Communications Manager Adapter provides connectivity between the IBM Security Identity Manager server and the Cisco Unified Communications Manager server. The adapter runs as a service, independently of whether you are logged on to IBM Security Identity Manager. The Cisco Unified Communications Manager Adapter automates the following user account management tasks: v Reconciling user accounts and support data v Adding user accounts v Modifying user account attributes v v v v Changing user account passwords and the personal identification number (PIN) of the user Deleting user accounts Associating user accounts with devices, device profiles, single primary extension, and groups Adding and deleting remote destination profiles (RDP) Note: The Cisco Unified Communications Manager server does not support the Suspend and Restore user account operations. There is no provision on the Cisco Unified Communications Manager server to suspend a user account. The adapter contains Tivoli Directory Integrator assembly lines that serve one or more user account operations. When the first request is sent from IBM Security Identity Manager, the required assembly line is loaded into Tivoli Directory Integrator. The same assembly line is then cached to serve subsequent operations of the same type. The adapter uses the Administrative XML Layer (AXL) API to establish communication with the Cisco Unified Communications Manager server. The AXL API provides a mechanism for adding, retrieving, updating, and removing data from the Cisco Unified Communications Manager database. For more information about the Cisco Unified Communications Manager server, see Copyright IBM Corp

14 2 IBM Security Identity Manager: Cisco Unified Communications Manager Adapter User Guide

15 Chapter 2. Checklist for configuring IBM Security Identity Manager to run the adapter Use this checklist to configure IBM Security Identity Manager to run the adapter. Table 1 provides an overview of the process to configure IBM Security Identity Manager. Table 1. Checklist for configuring IBM Security Identity Manager Task See this documentation: Install the Cisco Unified Communications Manager Adapter Import the adapter profile into IBM Security Identity Manager Create a service for the Cisco Unified Communications Manager Adapter Configure the Cisco Unified Communications Manager Adapter Perform a reconciliation operation to retrieve user accounts and store them in the IBM Security Identity Manager server Adopt orphan accounts on IBM Security Identity Manager Installing the Cisco Unified Communications Manager Adapter in the Directory Integrator-Based Cisco Unified Communications Manager Adapter Installation and Configuration Guide Importing the adapter profile into the IBM Security Identity Manager server in the Directory Integrator-Based Cisco Unified Communications Manager Adapter Installation and Configuration Guide Creating the service in the Directory Integrator-Based Cisco Unified Communications Manager Adapter Installation and Configuration Guide Note: After you create a Cisco Unified Communications Manager Adapter service, the IBM Security Identity Manager server creates a default provisioning policy for the adapter service. You can customize a provisioning policy for the Cisco Unified Communications Manager Adapter service according to th requirements of your organization. For more information, see the section about customizing a provisioning policy in the IBM Security Identity Manager product documentation. Configuring the Cisco Unified Communications Manager Adapter in the Directory Integrator-Based Cisco Unified Communications Manager Adapter Installation and Configuration Guide Managing reconciliation schedules in the IBM Security Identity Manager product documentation Assigning an orphan account to a user in the IBM Security Identity Manager product documentation Copyright IBM Corp

16 4 IBM Security Identity Manager: Cisco Unified Communications Manager Adapter User Guide

17 Chapter 3. User account management tasks The Cisco Unified Communications Manager Adapter manages user accounts for a specific person, a service instance, or specific accounts using the search function of IBM Security Identity Manager. The reconciliation operation retrieves the user account information from the Cisco Unified Communications Manager server and stores it in the directory server of IBM Security Identity Manager. You can schedule reconciliation to run at specific times and to return specific parameters. Running a reconciliation before its schedule time does not cancel the scheduled reconciliation. For more information about scheduling reconciliation and running a scheduled reconciliation, see the IBM Security Identity Manager product documentation. This section includes the following topics: v Preparation for the adapter operations v Reconciling support data without reconciling user accounts v Reconciling a single user account on page 6 v Addition of user accounts on page 7 v Specification of the required attributes on page 7 v Specification of the mobility attributes on page 7 Preparation for the adapter operations Before performing any operation using the adapter, you must complete several tasks. 1. Perform the steps in Chapter 2, Checklist for configuring IBM Security Identity Manager to run the adapter, on page Run the Remote Method Invocation (RMI) Dispatcher. The RMI Dispatcher in turn runs the Cisco Unified Communications Manager Adapter. See the section about running the adapter service in the Directory Integrator-Based Cisco Unified Communications Manager Adapter Installation and Configuration Guide. Reconciling support data without reconciling user accounts Perform support data reconciliation when you want an updated list of devices, device profiles, extensions, and groups that are available on the server. About this task When you perform support data reconciliation, the adapter retrieves the support data information without processing the user account information from the server. Support data for the Cisco Unified Communications Manager server user account includes the following attributes: v Controlled Devices v Controlled Device Profiles v Primary Extension Copyright IBM Corp

18 v Groups You can add, modify, or delete devices, device profiles, extensions, and groups directly on the managed resource. To reconcile only the support data without reconciling user accounts: Procedure 1. Log on to IBM Security Identity Manager as an administrator. 2. In the My Work pane, click Manage Services to display the Manage Services page. 3. Select CiscoUniComMgr Profile from the Service type list and click Search. 4. Select the name of the service that you created for the Cisco Unified Communications Manager Adapter. 5. Click the View popup menu icon. 6. Select Reconcile Now from the popup menu to display the Reconcile Now page. 7. Click Define query. 8. Select the Reconcile supporting data only check box and click Submit. Reconciling a single user account Reconciling a single user account means performing a filter reconciliation. About this task Filter reconciliation takes less time than reconciling all the user accounts. Perform filter reconciliation when you want to: v Modify a specific user account v Obtain information about a specific user account To reconcile and manage a single user account without reconciling all user accounts: Procedure 1. Log on to IBM Security Identity Manager as an administrator. 2. In the My Work pane, click Manage Services to display the Manage Services page. 3. Select CiscoUniComMgr Profile from the Service type list and click Search. 4. Select the name of the service that you created for the Cisco Unified Communications Manager Adapter. 5. Click the View popup menu icon. 6. Select Reconcile Now from the popup menu to display the Reconcile Now page. 7. Click Define query. 8. In the Reconcile accounts that match this filter field, type the following syntax. (eruid=userid) UserID is the name of the user account that you want to reconcile. 9. Click Submit. 6 IBM Security Identity Manager: Cisco Unified Communications Manager Adapter User Guide

19 Addition of user accounts You can add user accounts at any time for either an existing person or a new person in the organization. This section describes the adapter attributes that define the accounts on the account form. For specific procedures, see the IBM Security Identity Manager product documentation. This section includes the following topics: v Specification of the required attributes v Specification of the mobility attributes v Specification of support data attributes on page 8 v Group assignment to a user account on page 9 Specification of the required attributes To add user accounts to the Cisco Unified Communications Manager server, specify the following required attributes on the account form: User ID The login ID of the user account. For example, enter samy_bob. Note: v The User ID attribute is case sensitive. v You can enter numbers for defining the User ID attribute. v You can use special characters such as *, &, %, and so on for defining the User ID attribute. v The number of permissible character limit for the User ID attribute is 128. Last Name The family name of the user. For example, enter Smith for the user John Smith. You can also specify the other optional attributes, such as mobility attributes, on the account form. Specification of the mobility attributes Specify the mobility attributes to establish remote telephone communications. You can specify these mobility attributes in addition to the required attributes: Enable Mobility Select this check box to originate a call from a remote destination. You can also divert the in-progress calls on the desktop phone and cellular phone to the specified primary extension number. For information about specifying the Primary Extension attribute, see the Specification of support data attributes on page 8. When you select the Enable Mobility check box on the account form and perform the add operation, the adapter creates the user account and sets the value of the Enable Mobility attribute to TRUE on the server. Enable Mobile Voice Access Select this check box to originate a voice access call from a remote Chapter 3. User account management tasks 7

20 destination. You can access the Mobile Voice Access integrated voice response (IVR) system to initiate Mobile Connect calls and activate or deactivate Mobile Connect capabilities on the server. When you select the Enable Mobile Voice Access check box on the account form and perform the add operation, the adapter creates the user account and sets the value of the Enable Mobile Voice Access attribute to TRUE on the server. Specification of support data attributes Specify the support data attributes to associate the devices, device profiles, extensions, and groups with the user accounts on the Cisco Unified Communications Manager server. Specifying the Controlled Devices attribute Gives the user control of the devices that are available on the server. The adapter associates the devices that are selected from the list on the account form with the user account. You can assign multiple devices to a single user account. When you assign a device to a user account: v The user gains control of the selected device and its settings, such as speed dialing, call forwarding, and so on. v The adapter creates the user account on the server and sets the value of the Controlled Devices attribute. Specifying the Controlled Device Profiles attribute Associates the user account with the attributes of the device profile that is selected from the list on the account form. When a device profile is loaded on a device, the device adopts the attributes of that device profile. A device profile includes information about: v Phone template v User locale v Subscribed services v Speed dials When you assign a device profile to a user account, the adapter: v Associates the device profile attributes with the user account v Creates the user account on the server and sets the value of the Controlled Device Profiles attribute Specifying the Primary Extension attribute Sets the number that is selected from the list on the account form as the primary extension number. You can use this extension as the primary extension to receive or initiate calls. When you associate a primary extension number with a user account, the adapter creates the user account on the server and sets the selected number as the primary extension number. For example, If you select the Controlled Device attribute as SEP001E7A2446FA, then select the Primary Extension as :SEP001E7A2446FA, where is the directory number that is associated with the controlled device. Specifying the Groups attribute Associates groups that are selected from the list on the account form with the user account. When you associate a group with a user account, the user account gains privileges that are available to that group. 8 IBM Security Identity Manager: Cisco Unified Communications Manager Adapter User Guide

21 When you assign a group to a user account: v The user becomes a member of that group. v The adapter creates the user account on the Cisco Unified Communications Manager server and sets the value of the Groups attribute. Group assignment to a user account You can assign groups to a user account on the Cisco Unified Communications Manager server. To assign groups to a user account, select the groups that are listed on the account form. For example, you can select the Standard CCM Super Users to associate a user with this group and to grant full administrative permissions. You can assign multiple groups to a user account. When you do so, the adapter creates the user account and associates the user with the selected groups. For more information about specifying the Groups attribute, see the Specification of support data attributes on page 8. Modification of user accounts You can modify user account attributes at any time in IBM Security Identity Manager. This section describes the adapter attributes that you can use to modify the user accounts. See the IBM Security Identity Manager product documentation. The User ID attribute is the only non-modifiable attribute on the account form. You can modify all the other attributes of a user account. This section includes the following topics: v Modification of support data attributes v Password change of user accounts on page 10 Modification of support data attributes Modify the support data attributes of a user account to assign or unassign devices, device profiles, extensions, or groups that are available on the Cisco Unified Communications Manager server. For more information about assigning devices, device profiles, extensions, and groups to a user account, see the Specification of support data attributes on page 8. Table 2 describes the support data attributes that you can use to modify the user accounts. Table 2. Modifying support data attributes Support data attribute Task Result Controlled Devices Unassign controlled devices from a user account When you unassign a controlled device from a user account, the adapter removes the control of the device from the user account. Chapter 3. User account management tasks 9

22 Table 2. Modifying support data attributes (continued) Support data attribute Task Result Controlled Device Profiles Primary Extension Groups Unassign controlled device profiles from a user account Change the primary extension number of a user account Unassign groups from a user account When you unassign a controlled device profile from a user account, the adapter removes any connection between the user account and the selected device profile. When you change the primary extension number of a user account, the adapter replaces the primary extension number with the newly selected directory number. Note: The newly selected directory number is set as the primary extension number. When you unassign a group from a user account: v The user account no longer remains a member of that group v The adapter removes the value of the Groups attribute from the server. Password change of user accounts You can change the password of any of the Cisco Unified Communications Manager accounts that exist on IBM Security Identity Manager. Deletion of user accounts For information about changing passwords, see the IBM Security Identity Manager product documentation. Use the deprovision feature of IBM Security Identity Manager to delete user accounts. For more information about deleting user accounts, see the IBM Security Identity Manager product documentation. When you delete a user account, the adapter: v Removes the user account from the Cisco Unified Communications Manager database. You can no longer manage the user account. v Removes any connection between the user account and the devices, device profiles, extensions, and groups. v Deletes the Remote Destination Profiles (RDP) created for that user from the Cisco Unified Communications Manager database. 10 IBM Security Identity Manager: Cisco Unified Communications Manager Adapter User Guide

23 Chapter 4. Troubleshooting This section provides information about the Cisco Unified Communications Manager Adapter error messages and warnings and the actions that you can take to resolve the errors. Techniques for troubleshooting problems Troubleshooting is a systematic approach to solving a problem. The goal of troubleshooting is to determine why something does not work as expected and how to resolve the problem. Certain common techniques can help with the task of troubleshooting. The first step in the troubleshooting process is to describe the problem completely. Problem descriptions help you and the IBM technical-support representative know where to start to find the cause of the problem. This step includes asking yourself basic questions: v What are the symptoms of the problem? v Where does the problem occur? v When does the problem occur? v Under which conditions does the problem occur? v Can the problem be reproduced? The answers to these questions typically lead to a good description of the problem, which can then lead you to a problem resolution. What are the symptoms of the problem? When starting to describe a problem, the most obvious question is What is the problem? This question might seem straightforward; however, you can break it down into several more-focused questions that create a more descriptive picture of the problem. These questions can include: v Who, or what, is reporting the problem? v What are the error codes and messages? v How does the system fail? For example, is it a loop, hang, crash, performance degradation, or incorrect result? Where does the problem occur? Determining where the problem originates is not always easy, but it is one of the most important steps in resolving a problem. Many layers of technology can exist between the reporting and failing components. Networks, disks, and drivers are only a few of the components to consider when you are investigating problems. The following questions help you to focus on where the problem occurs to isolate the problem layer: v v v Is the problem specific to one platform or operating system, or is it common across multiple platforms or operating systems? Is the current environment and configuration supported? Do all users have the problem? Copyright IBM Corp

24 v (For multi-site installations.) Do all sites have the problem? If one layer reports the problem, the problem does not necessarily originate in that layer. Part of identifying where a problem originates is understanding the environment in which it exists. Take some time to completely describe the problem environment, including the operating system and version, all corresponding software and versions, and hardware information. Confirm that you are running within an environment that is a supported configuration; many problems can be traced back to incompatible levels of software that are not intended to run together or have not been fully tested together. When does the problem occur? Develop a detailed timeline of events leading up to a failure, especially for those cases that are one-time occurrences. You can most easily develop a timeline by working backward: Start at the time an error was reported (as precisely as possible, even down to the millisecond), and work backward through the available logs and information. Typically, you need to look only as far as the first suspicious event that you find in a diagnostic log. To develop a detailed timeline of events, answer these questions: v Does the problem happen only at a certain time of day or night? v How often does the problem happen? v What sequence of events leads up to the time that the problem is reported? v Does the problem happen after an environment change, such as upgrading or installing software or hardware? Responding to these types of questions can give you a frame of reference in which to investigate the problem. Under which conditions does the problem occur? Knowing which systems and applications are running at the time that a problem occurs is an important part of troubleshooting. These questions about your environment can help you to identify the root cause of the problem: v Does the problem always occur when the same task is being performed? v Does a certain sequence of events need to happen for the problem to occur? v Do any other applications fail at the same time? Answering these types of questions can help you explain the environment in which the problem occurs and correlate any dependencies. Remember that just because multiple problems might have occurred around the same time, the problems are not necessarily related. Can the problem be reproduced? From a troubleshooting standpoint, the ideal problem is one that can be reproduced. Typically, when a problem can be reproduced you have a larger set of tools or procedures at your disposal to help you investigate. Consequently, problems that you can reproduce are often easier to debug and solve. However, problems that you can reproduce can have a disadvantage: If the problem is of significant business impact, you do not want it to recur. If possible, 12 IBM Security Identity Manager: Cisco Unified Communications Manager Adapter User Guide

25 re-create the problem in a test or development environment, which typically offers you more flexibility and control during your investigation. v Can the problem be re-created on a test system? v Are multiple users or applications encountering the same type of problem? v Can the problem be re-created by running a single command, a set of commands, or a particular application? Error logs When an operation fails, the corresponding error messages and warnings are logged in the ibmdi.log file. This file is located in the adapter solution\logs directory. You can display the error logs in the user interface by running the Dispatcher from the command prompt. You can also configure logging information for the adapter. For more information, see the sections about configuring logging information for the adapter in the Dispatcher Installation and Configuration Guide. Error messages and warnings A warning or error message might be displayed in the user interface to provide information about the adapter or when an error occurs. Table 3 lists the error messages and warnings for the Cisco Unified Communications Manager Adapter user tasks. Table 3. Adapter error messages, warnings, and corrective actions Message number Error message Corrective action CTGIMT002E CTGIMT005E CTGIMT205E No login or an invalid credential was supplied in the request. A required field does not have a specified value. The specified name has invalid characters or is not formatted correctly for this device type. Explanation: This error occurs when the value of the User ID attribute exceeds 128 characters. Make sure you typed the following values accurately on the service form: v Service name v Cisco Server IP Address v Cisco Server IP Port v Administrator Name v Administrator Password Specify the user ID and the last name of the user. Note: The User ID and the Last Name attributes are required attributes on the account form. Specify a User ID that does not exceed the 128 character limit. Chapter 4. Troubleshooting 13

26 Table 3. Adapter error messages, warnings, and corrective actions (continued) Message number Error message Corrective action CTGIMT003E The account already exists. Perform one of the following steps: v CTGIMT009E CTGIMT015E Explanation: This error occurs when: v A request is made to add a user account that already exists. v The server and IBM Security Identity Manager are not synchronized. The account user ID cannot be modified because it does not exist. Explanation: This error occurs when an attempt is made to modify or change the password of a user account. An error occurred while deleting the user ID account because the account does not exist. Explanation: An attempt is made to delete a user account that does not exist on the managed resource. v Create a user account with another user ID. For information about creating a user account, see the IBM Security Identity Manager product documentation. Schedule a reconciliation between the managed resource and IBM Security Identity Manager. For more information about scheduling a reconciliation, see the IBM Security Identity Manager product documentation. If you believe that the user account already exists: v v Make sure that the location specified for the managed resource on the service form is correct. The user account is created and it exists on the managed resource. If the user account does not already exist, create it on the Cisco Unified Communications Manager server and perform the reconciliation operation. If you believe that the user account already exists: v v Make sure the location specified for the managed resource on the service form is correct. The user account is created and it exists on the managed resource. If the user account does not exist on the Cisco Unified Communications Manager server, no action is required. 14 IBM Security Identity Manager: Cisco Unified Communications Manager Adapter User Guide

27 Appendix A. Attributes of the Cisco Unified Communications Manager Adapter The Cisco Unified Communications Manager Adapter uses attributes on the Cisco Unified Communications Manager account form. Table 4 provides information about the adapter attributes on the Cisco Unified Communications Manager account form. Table 4. Account form attributes Attribute name on the Cisco Unified Communications Manager server account form on IBM Security Identity Manager Attribute name on the Tivoli Directory Server Attribute name on the Cisco Unified Communications Manager server User ID eruid User ID Pin ercucmpwdpin PIN First Name givenname First name Last Name sn Last name Telephone Number ercucmtelephonenumber Telephone Number Manager ID ercucmmanagerid Manager User ID Department ercucmdepartment Department User Locale ercucmuserlocale User Locale Associated PC ercucmassociatedpc Associated PC Digest Credentials ercucmpwddigestcredentials Digest Credentials Controlled Devices ercucmdevices Controlled Devices Controlled Device Profiles ercucmdeviceprofiles Controlled Profiles Primary Extension ercucmline Primary Extension Groups ercucmassociatedgroups Groups Roles ercucmroles Roles Allow Control of Devices from ercucmenablecti Allow Control of Device from CTI CTI Enable Mobility ercucmenabmobility Enable Mobility Enable Mobile Voice Access ercucmenabmobvoiceaccess Enable Mobile Voice Access Maximum Wait Time For Desk Pick Up ercucmmaxwaittimefordeskpickup Maximum Wait Time For Desk Pick Up Remote Destination Limit ercucmremdestlimit Remote Destination Limit Remote Destination Profile ercucmremdestprofilenames Remote Destination Profiles Access List ercucmaccesslist Access Lists Copyright IBM Corp

28 16 IBM Security Identity Manager: Cisco Unified Communications Manager Adapter User Guide

29 Appendix B. APIs used by the adapter The adapter uses APIs to perform user account operations. Table 5 lists APIs used to perform user account operations. Table 5. APIs for user account operations Cisco Unified Communications Manager Adapter API Operation adduser Adds the user to the Cisco Unified Communications Manager server updateuser Updates the specified user in the Cisco Unified Communications Manager database getuser Retrieves the specified user from the Cisco Unified Communications Manager database removeuser Removes the user from the Cisco Unified Communications Manager database listuserbyname Lists all the users in the Cisco Unified Communications Manager database getphone Retrieves the specified phone from the Cisco Unified Communications Manager database listphonebyname Lists all the phones in the Cisco Unified Communications Manager database getdeviceprofile Retrieves the specified device profile from Cisco Unified Communications Manager database listdevicebynameandclass Lists all the device profiles in the Cisco Unified Communications Manager database getline Retrieves the specified line in the Cisco Unified Communications Manager database addremotedestinationprofile Adds the specified Remote Destination Profile (RDP) in the Cisco Unified Communications Manager database getremotedestinationprofile Retrieves the specified RDP from the Cisco Unified Communications Manager database removeremotedestinationprofile Removes the specified RDP from the Cisco Unified Communications Manager database updateusergroup Updates the specified group in the Cisco Unified Communications Manager database getusergroup Retrieves the specified group from the Cisco Unified Communications Manager database Copyright IBM Corp

30 18 IBM Security Identity Manager: Cisco Unified Communications Manager Adapter User Guide

31 Appendix C. Definitions for ITDI_HOME and ISIM_HOME directories ITDI_HOME is the directory where Tivoli Directory Integrator is installed. ISIM_HOME is the directory where IBM Security Identity Manager is installed. ITDI_HOME This directory contains the jars/connectors subdirectory that contains files for the adapters. Windows drive\program Files\IBM\TDI\ITDI_VERSION For example the path for version 7.1: C:\Program Files\IBM\TDI\V7.1 UNIX /opt/ibm/tdi/itdi_version For example the path for version 7.1: /opt/ibm/tdi/v7.1 ISIM_HOME This directory is the base directory that contains the IBM Security Identity Manager code, configuration, and documentation. Windows path\ibm\isim UNIX path/ibm/isim Copyright IBM Corp

32 20 IBM Security Identity Manager: Cisco Unified Communications Manager Adapter User Guide

33 Appendix D. Support information Searching knowledge bases You have several options to obtain support for IBM products. v Searching knowledge bases v Obtaining a product fix on page 22 v Contacting IBM Support on page 22 You can often find solutions to problems by searching IBM knowledge bases. You can optimize your results by using available resources, support tools, and search methods. About this task You can find useful information by searching the product documentation for IBM Security Identity Manager. However, sometimes you must look beyond the product documentation to answer your questions or resolve problems. Procedure To search knowledge bases for information that you need, use one or more of the following approaches: 1. Search for content by using the IBM Support Assistant (ISA). ISA is a no-charge software serviceability workbench that helps you answer questions and resolve problems with IBM software products. You can find instructions for downloading and installing ISA on the ISA website. 2. Find the content that you need by using the IBM Support Portal. The IBM Support Portal is a unified, centralized view of all technical support tools and information for all IBM systems, software, and services. The IBM Support Portal lets you access the IBM electronic support portfolio from one place. You can tailor the pages to focus on the information and resources that you need for problem prevention and faster problem resolution. Familiarize yourself with the IBM Support Portal by viewing the demo videos ( about this tool. These videos introduce you to the IBM Support Portal, explore troubleshooting and other resources, and demonstrate how you can tailor the page by moving, adding, and deleting portlets. 3. Search for content about IBM Security Identity Manager by using one of the following additional technical resources: v IBM Security Identity Manager version 6.0 technotes and APARs (problem reports). v IBM Security Identity Manager Support website. v IBM Redbooks. v IBM support communities (forums and newsgroups). 4. Search for content by using the IBM masthead search. You can use the IBM masthead search by typing your search string into the Search field at the top of any ibm.com page. 5. Search for content by using any external search engine, such as Google, Yahoo, or Bing. If you use an external search engine, your results are more likely to Copyright IBM Corp

34 Obtaining a product fix include information that is outside the ibm.com domain. However, sometimes you can find useful problem-solving information about IBM products in newsgroups, forums, and blogs that are not on ibm.com. Tip: Include IBM and the name of the product in your search if you are looking for information about an IBM product. A product fix might be available to resolve your problem. About this task Contacting IBM Support You can get fixes by following these steps: Procedure 1. Obtain the tools that are required to get the fix. You can obtain product fixes from the Fix Central Site. See 2. Determine which fix you need. 3. Download the fix. Open the download document and follow the link in the Download package section. 4. Apply the fix. Follow the instructions in the Installation Instructions section of the download document. IBM Support assists you with product defects, answers FAQs, and helps users resolve problems with the product. Before you begin After trying to find your answer or solution by using other self-help options such as technotes, you can contact IBM Support. Before contacting IBM Support, your company or organization must have an active IBM software subscription and support contract, and you must be authorized to submit problems to IBM. For information about the types of available support, see the Support portfolio topic in the Software Support Handbook. Procedure To contact IBM Support about a problem: 1. Define the problem, gather background information, and determine the severity of the problem. For more information, see the Getting IBM support topic in the Software Support Handbook. 2. Gather diagnostic information. 3. Submit the problem to IBM Support in one of the following ways: v Using IBM Support Assistant (ISA): Any data that has been collected can be attached to the service request. Using ISA in this way can expedite the analysis and reduce the time to resolution. a. Download and install the ISA tool from the ISA website. See b. Open ISA. 22 IBM Security Identity Manager: Cisco Unified Communications Manager Adapter User Guide

35 v v c. Click Collection and Send Data. d. Click the Service Requests tab. e. Click Open a New Service Request. Online through the IBM Support Portal: You can open, update, and view all of your service requests from the Service Request portlet on the Service Request page. By telephone for critical, system down, or severity 1 issues: For the telephone number to call in your region, see the Directory of worldwide contacts web page. Results If the problem that you submit is for a software defect or for missing or inaccurate documentation, IBM Support creates an Authorized Program Analysis Report (APAR). The APAR describes the problem in detail. Whenever possible, IBM Support provides a workaround that you can implement until the APAR is resolved and a fix is delivered. IBM publishes resolved APARs on the IBM Support website daily, so that other users who experience the same problem can benefit from the same resolution. Appendix D. Support information 23

36 24 IBM Security Identity Manager: Cisco Unified Communications Manager Adapter User Guide

37 Appendix E. Accessibility features for IBM Security Identity Manager Accessibility features help users who have a disability, such as restricted mobility or limited vision, to use information technology products successfully. Accessibility features The following list includes the major accessibility features in IBM Security Identity Manager. v Support for the Freedom Scientific JAWS screen reader application v Keyboard-only operation v Interfaces that are commonly used by screen readers v Keys that are discernible by touch but do not activate just by touching them v Industry-standard devices for ports and connectors v The attachment of alternative input and output devices The IBM Security Identity Manager library, and its related publications, are accessible. Keyboard navigation This product uses standard Microsoft Windows navigation keys. Related accessibility information The following keyboard navigation and accessibility features are available in the form designer: v v v v You can use the tab keys and arrow keys to move between the user interface controls. You can use the Home, End, Page Up, and Page Down keys for more navigation. You can launch any applet, such as the form designer applet, in a separate window to enable the Alt+Tab keystroke to toggle between that applet and the web interface, and also to use more screen workspace. To launch the window, click Launch as a separate window. You can change the appearance of applets such as the form designer by using themes, which provide high contrast color schemes that help users with vision impairments to differentiate between controls. IBM and accessibility See the IBM Human Ability and Accessibility Center For more information about the commitment that IBM has to accessibility. Copyright IBM Corp

38 26 IBM Security Identity Manager: Cisco Unified Communications Manager Adapter User Guide

39 Notices This information was developed for products and services offered in the U.S.A. IBM may not offer the products, services, or features discussed in this document in other countries. Consult your local IBM representative for information on the products and services currently available in your area. Any reference to an IBM product, program, or service is not intended to state or imply that only that IBM product, program, or service may be used. Any functionally equivalent product, program, or service that does not infringe any IBM intellectual property right may be used instead. However, it is the user's responsibility to evaluate and verify the operation of any non-ibm product, program, or service. IBM may have patents or pending patent applications covering subject matter described in this document. The furnishing of this document does not give you any license to these patents. You can send license inquiries, in writing, to: IBM Director of Licensing IBM Corporation North Castle Drive Armonk, NY U.S.A. For license inquiries regarding double-byte (DBCS) information, contact the IBM Intellectual Property Department in your country or send inquiries, in writing, to: Intellectual Property Licensing Legal and Intellectual Property Law IBM Japan, Ltd , Nihonbashi-Hakozakicho, Chuo-ku Tokyo , Japan The following paragraph does not apply to the United Kingdom or any other country where such provisions are inconsistent with local law : INTERNATIONAL BUSINESS MACHINES CORPORATION PROVIDES THIS PUBLICATION "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Some states do not allow disclaimer of express or implied warranties in certain transactions, therefore, this statement might not apply to you. This information could include technical inaccuracies or typographical errors. Changes are periodically made to the information herein; these changes will be incorporated in new editions of the publication. IBM may make improvements and/or changes in the product(s) and/or the program(s) described in this publication at any time without notice. Any references in this information to non-ibm Web sites are provided for convenience only and do not in any manner serve as an endorsement of those Web sites. The materials at those Web sites are not part of the materials for this IBM product and use of those Web sites is at your own risk. Copyright IBM Corp

40 IBM may use or distribute any of the information you supply in any way it believes appropriate without incurring any obligation to you. Licensees of this program who wish to have information about it for the purpose of enabling: (i) the exchange of information between independently created programs and other programs (including this one) and (ii) the mutual use of the information which has been exchanged, should contact: IBM Corporation 2Z4A/ Burnet Road Austin, TX U.S.A. Such information may be available, subject to appropriate terms and conditions, including in some cases payment of a fee. The licensed program described in this document and all licensed material available for it are provided by IBM under terms of the IBM Customer Agreement, IBM International Program License Agreement or any equivalent agreement between us. Any performance data contained herein was determined in a controlled environment. Therefore, the results obtained in other operating environments may vary significantly. Some measurements may have been made on development-level systems and there is no guarantee that these measurements will be the same on generally available systems. Furthermore, some measurement may have been estimated through extrapolation. Actual results may vary. Users of this document should verify the applicable data for their specific environment. Information concerning non-ibm products was obtained from the suppliers of those products, their published announcements or other publicly available sources. IBM has not tested those products and cannot confirm the accuracy of performance, compatibility or any other claims related to non-ibm products. Questions on the capabilities of non-ibm products should be addressed to the suppliers of those products. All statements regarding IBM's future direction or intent are subject to change or withdrawal without notice, and represent goals and objectives only. This information contains examples of data and reports used in daily business operations. To illustrate them as completely as possible, the examples include the names of individuals, companies, brands, and products. All of these names are fictitious and any similarity to the names and addresses used by an actual business enterprise is entirely coincidental. COPYRIGHT LICENSE: This information contains sample application programs in source language, which illustrate programming techniques on various operating platforms. You may copy, modify, and distribute these sample programs in any form without payment to IBM, for the purposes of developing, using, marketing or distributing application programs conforming to the application programming interface for the operating platform for which the sample programs are written. These examples have not been thoroughly tested under all conditions. IBM, therefore, cannot guarantee or imply reliability, serviceability, or function of these programs. You may copy, modify, and distribute these sample programs in any form without payment to 28 IBM Security Identity Manager: Cisco Unified Communications Manager Adapter User Guide