sybase ada pter installa tion and - ibmpublic.dhe.ibm.com/software/security/products/isim/...in a...

IBM Security Privileged Identity Manager

Sybase Adapter Installation andConfiguration Guide

IBM

ii IBM Security Privileged Identity Manager: Sybase Adapter Installation and Configuration Guide

Contents

Figures . . . . . . . . . . . . . . . v

Tables . . . . . . . . . . . . . . . vii

Chapter 1. Overview . . . . . . . . . 1Features of the adapter . . . . . . . . . . . 1Architecture of the adapter . . . . . . . . . 1Supported configurations . . . . . . . . . . 2

Chapter 2. Planning. . . . . . . . . . 5Roadmap for IBM Tivoli Directory Integrator basedadapters, for IBM Security Privileged IdentityManager . . . . . . . . . . . . . . . . 5Prerequisites . . . . . . . . . . . . . . 6Software downloads . . . . . . . . . . . . 8Installation worksheet . . . . . . . . . . . 8

Chapter 3. Installing . . . . . . . . . 11Installing the dispatcher . . . . . . . . . . 11Installing the adapter binaries or connector . . . . 11Restarting the adapter service . . . . . . . . 12Importing the adapter profile . . . . . . . . 12Creating an adapter service/target. . . . . . . 13Service/Target form details . . . . . . . . . 14Verifying that the adapter is working correctly . . 15

Chapter 4. Upgrading . . . . . . . . 17Upgrading the dispatcher. . . . . . . . . . 17Upgrading the adapter profile . . . . . . . . 17

Chapter 5. Configuring . . . . . . . . 19Customizing the adapter profile . . . . . . . 19Editing adapter profiles on the UNIX or Linuxoperating system . . . . . . . . . . . . 20Password management for account restoration . . 20

Chapter 6. Troubleshooting . . . . . . 23Techniques for troubleshooting problems . . . . 23Error messages and problem solving . . . . . . 25

Chapter 7. Uninstalling . . . . . . . . 27Uninstalling the adapter . . . . . . . . . . 27Deleting the adapter profile . . . . . . . . . 27

Chapter 8. Reference . . . . . . . . 29Adapter attributes and object classes . . . . . . 29Adapter attributes by operations . . . . . . . 30

System Login Add . . . . . . . . . . . 30System Login Change . . . . . . . . . . 30System Login Delete . . . . . . . . . . 30System Login Suspend . . . . . . . . . 31System Login Restore . . . . . . . . . . 31Test . . . . . . . . . . . . . . . . 31Reconciliation . . . . . . . . . . . . 31

Special attributes . . . . . . . . . . . . 32

Index . . . . . . . . . . . . . . . 33

iii

iv IBM Security Privileged Identity Manager: Sybase Adapter Installation and Configuration Guide

Figures

1. The architecture of the Sybase Adapter . . . . 22. Example of a single server configuration . . . 2

3. Example of a multiple server configuration 3

v

vi IBM Security Privileged Identity Manager: Sybase Adapter Installation and Configuration Guide

Tables

1. Prerequisites to install the adapter . . . . . 72. Required information to install the adapter 93. Required roles and their descriptions . . . . 144. Warning and error messages . . . . . . . 255. Attributes, object identifiers, descriptions, and

corresponding column/table name on theSybase Adapter . . . . . . . . . . . 29

6. Add request attributes for Oracle . . . . . 307. Change request attributes for Oracle . . . . 308. Delete request attributes for Oracle. . . . . 319. Suspend request attributes for Oracle . . . . 31

10. Restore request attributes for Oracle . . . . 3111. Test attributes . . . . . . . . . . . . 3112. Reconciliation function attributes . . . . . 31

vii

viii IBM Security Privileged Identity Manager: Sybase Adapter Installation and Configuration Guide

Chapter 1. Overview

An adapter is an interface between a managed resource and the IBM® SecurityIdentity server. The Sybase Adapter enables communication between the IBMSecurity Identity server and the Sybase Adaptive Server Enterprise (ASE).

Adapters can be installed on the managed resource. The IBM Security Identityserver manages access to the resource by using the security system. Adaptersfunction as trusted virtual administrators on the target operating system. Theadapter creates, suspends, restores user accounts, and other functions thatadministrators run manually. The adapter runs as a service, independently ofwhether you are logged on to the IBM Security Identity server.

Features of the adapterThe adapter automates several administrative and management tasks.v Reconciling user accounts and other support datav Adding user accountsv Modifying user account attributesv Modifying user account passwordsv Suspending, restoring, and deleting user accounts

Architecture of the adapterSeveral components are involved in running and using the adapter. Install all thesecomponents so that the adapter can function correctly.v Dispatcherv Tivoli® Directory Integrator connectorv IBM Security Identity Adapter profile

You need to install the Dispatcher and the adapter profile; however, the TivoliDirectory Integrator connector might already be installed with the base TivoliDirectory Integrator product.

Figure 1 on page 2 describes the components that work together to complete theuser account management tasks in a Tivoli Directory Integrator environment.

1

Supported configurationsThe adapter supports both single and multiple server configurations. In a singleserver configuration, the adapter is installed on only one server. In a multipleserver configuration, the adapter is installed on several different servers.

The fundamental components in each environment are:v The IBM Security Identity serverv The IBM Tivoli Directory Integrator serverv The managed resourcev The adapter

The adapter must be installed directly on the server that runs the Tivoli DirectoryIntegrator server.

Single server configuration

In a single server configuration, the IBM Security Identity server, the TivoliDirectory Integrator server, and the Sybase Adapter are installed on one server toestablish communication with the managed resource.

The managed resource is installed on a different server as described in Figure 2.

RMI callsIBM SecurityIdentityServer

DispatcherService(an instanceof the IBMTivoliDirectoryIntegrator)

Adapterresource

Figure 1. The architecture of the Sybase Adapter

IBM SecurityIdentity Server

Tivoli DirectoryIntegrator Server

Adapter

Managedresource

Figure 2. Example of a single server configuration

2 IBM Security Privileged Identity Manager: Sybase Adapter Installation and Configuration Guide

Multiple server configuration

In a multiple server configuration, the IBM Security Identity server, the TivoliDirectory Integrator server, and the Sybase Adaptive Server Enterprise are installedon different servers.

The Tivoli Directory Integrator server and the Sybase Adapter are installed on thesame server as described in Figure 3.

IBM SecurityIdentity Managerserver

Security DirectoryIntegrator server Managed

resource

Adapter

Figure 3. Example of a multiple server configuration

Chapter 1. Overview 3

Chapter 2. Planning

Installing and configuring the adapter involves several steps that you mustcomplete in a specific sequence. Follow the roadmap for the main tasks.

Roadmap for IBM Tivoli Directory Integrator based adapters, for IBMSecurity Privileged Identity Manager

Follow this section when using the guide to install, configure, troubleshoot, oruninstall the adapter.

Pre-installation

Complete these tasks.1. Verify that your environment meets the software and hardware requirements

for the adapter. See Prerequisites.2. Obtain the installation software. See Software downloads.3. Obtain the necessary information for the installation and configuration. See

Installation worksheet.

Installation

Complete these tasks.1. Install the dispatcher.2. Install the adapter binaries or connector.3. Install 3rd party client libraries.4. Set up the adapter environment.5. Restart the adapter service.6. Import the adapter profile.7. Create an adapter service/target.8. Install the adapter language package.9. Verify that the adapter is working correctly.

Upgrade

To upgrade the adapter, do a complete re-installation of the adapter. Follow theInstallation roadmap.

Configuration

Complete these tasks.1. Configure secure communication between the IBM Security Identity server and

the adapter.a. Configure 1-way authentication.b. Configure 2-way authentication.

2. Configure secure communication between the adapter and the managed target.a. Configure 1-way authentication.b. Configure 2-way authentication.

5

3. Configure the adapter.4. Modify the adapter profiles.5. Customize the adapter.

Troubleshooting

See the following topics.v Techniques for troubleshooting problemsv Configure debuggingv Logsv Error messages and problem solving

Uninstallation

Complete these tasks.1. Stop the adapter service.2. Remove the adapter binaries or connector.3. Remove 3rd party client libraries.4. Delete the adapter service/target.5. Delete the adapter profile.

Reference

See the following topics.v Adapter attributes and object classesv Adapter attributes by operationsv Special attributes

PrerequisitesVerify that your environment meets the software and hardware requirements forthe adapter.

Table 1 on page 7 identifies the software and operating system prerequisites for theadapter installation.

Ensure that you install the adapter on the same workstation as the IBM TivoliDirectory Integrator server.


Table 1. Prerequisites to install the adapter

Prerequisite Description

Directory Integrator v IBM Tivoli Directory Integrator Version 7.1.1+ 7.1.1-TIV-TDI-FP0004 +7.2.0-ISS-SDI-LA0008

v IBM Security Directory Integrator Version 7.2

Note:

v Earlier versions of IBM Tivoli DirectoryIntegrator that are still supported mightfunction properly. However, to resolve anycommunication errors, you must upgradeyour Directory Integrator release to theversions that the adapter officially supports.

v The adapter supports IBM Security DirectoryIntegrator 7.2, which is available only tocustomers who have the correct entitlement.Contact your IBM representative to find outwhether you have the entitlement todownload IBM Security Directory Integrator7.2.

IBM Security Identity server The following servers are supported:

v IBM Security Identity Manager server Version6.0

v IBM Security Identity Manager server Version7.0

v IBM Security Privileged Identity ManagerVersion 2.0

v IBM Security Identity Governance andIntelligence server Version 5.2.2

Sybase Adaptive Server Enterprise A system that runs the Sybase Adapter with oneof following versions:

v Sybase Adaptive Server Enterprise v15.7

v Sybase (SAP) Adapter Server Enterprise v16.0

Sybase JDBC Driver jconn4.jar

Network Connectivity Install the adapter on a workstation that cancommunicate with the IBM Security PrivilegedIdentity Manager service through the TCP/IPnetwork.

System Administrator Authority To complete the adapter installation procedure,you must have system administrator authority.

Tivoli Directory Integrator adapterssolution directory

A Tivoli Directory Integrator adapters solutiondirectory is a Tivoli Directory Integrator workdirectory for IBM Security Identity Manageradapters. See the Dispatcher Installation andConfiguration Guide.

Chapter 2. Planning 7

Table 1. Prerequisites to install the adapter (continued)

Prerequisite Description

Sybase Account You must provide a Sybase account andpassword for every Sybase instance that theadapter manages.

The Sybase account must have the followingSybase privileges and roles:

v SA_ROLE

v SSO_ROLE

v OPER_ROLE

Install the Sybase Adapter and the appropriate Sybase JDBC drivers on the sameworkstation as the Tivoli Directory Integrator.

For information about the prerequisites and supported operating systems for TivoliDirectory Integrator, see the IBM Tivoli Directory Integrator 7.0: Administrator Guide.

Software downloadsDownload the software through your account at the IBM Passport Advantage®

website.

Go to IBM Passport Advantage.

See the corresponding IBM Security Identity server Download Document forinstructions.

Note:

You can also obtain additional adapter information from IBM Support.

Installation worksheetThe installation worksheet lists the information that is required to install andconfigure the adapter. Complete this worksheet before you start the installationprocedure for ease of reference. Make a copy of the worksheet for each adapterinstance you install.


http://www.ibm.com/software/howtobuy/passportadvantage/pao_customers.htm

Table 2. Required information to install the adapter

Required information Description Value

IBM Tivoli DirectoryIntegrator HomeDirectory

The ITDI_HOME directory containsthe jars/connectors subdirectory thatcontains adapter jars. For example,the jars/connectors subdirectorycontains the jar for the UNIXadapter.

If Tivoli DirectoryIntegrator is automaticallyinstalled with your IBMSecurity Privileged IdentityManager product, thedefault directory path forTivoli Directory Integratoris as follows:

Windows:

v for version 7.0:

drive\ProgramFiles\IBM\TDI\V7.0

v for version 7.1

drive\ProgramFiles\IBM\TDI\V7.1

UNIX:

v for version 7.0:

/opt/IBM/TDI/V7.0

v for version 7.1:

/opt/IBM/TDI/V7.1

Adapters solutiondirectory

When you install the dispatcher, theadapter prompts you to specify a filepath for the adapters solutiondirectory. For more informationabout the solution directory, see theDispatcher Installation andConfiguration Guide.

The default solutiondirectory is located at:

Windows:

v for version 7.0:

drive\ProgramFiles\IBM\TDI\V7.0\isimsoln

v for version 7.1:

drive\ProgramFiles\IBM\TDI\V7.1\isimsoln

UNIX:

v for version 7.0:

/opt/IBM/TDI/V7.0/isimsoln

v for version 7.1:

/opt/IBM/TDI/V7.1/isimsoln

Chapter 2. Planning 9

Chapter 3. Installing

Installing the adapter mainly involves importing the adapter profile and creatingan adapter service. Depending on the adapter, several other tasks can be involvedto completely install it.

All IBM Tivoli Directory Integrator based adapters require the Dispatcher for theadapters to function correctly. If the Dispatcher is installed from a previousinstallation, do not reinstall it unless the Dispatcher is upgraded. See DispatcherInstallation Verification.

Depending on your adapter, the Tivoli Directory Integrator connector mightalready be installed as part of the Tivoli Directory Integrator product and nofurther action is required. If the connector is not pre-installed, install it after theDispatcher.

Installing the dispatcherIf this is the first Tivoli Directory Integrator-based adapter installation, you mustinstall the RMI Dispatcher before you install the adapter. Install the RMIDispatcher on the same Tivoli Directory Integrator server where you want to installthe adapter.

If you already installed the RMI Dispatcher for another adapter, you do not needto reinstall it.

If you have not yet installed the RMI Dispatcher in the Tivoli Directory Integratorenvironment, download the Dispatcher installer from the IBM Passport Advantagewebsite. For more information about the installation, see the Dispatcher Installationand Configuration Guide.

Installing the adapter binaries or connectorThe connector might or might not be available with the base Tivoli DirectoryIntegrator or Security Directory Integrator product. The connector is required toestablish communication between the adapter and the Dispatcher.

Before you beginv The Dispatcher must be installed.

About this task

The adapter uses the IBM Tivoli Directory Integrator JDBC connector. Thisconnector is already available with the base Tivoli Directory Integrator product. Assuch, you just need to install the Dispatcher. See the IBM Security DispatcherInstallation and Configuration Guide..

11

http://www.ibm.com/software/howtobuy/passportadvantage/pao_customers.htm

Restarting the adapter serviceVarious installation and configuration tasks might require the adapter to berestarted to apply the changes. For example, you must restart the adapter if thereare changes in the adapter profile, connector, or assembly lines. To restart theadapter, restart the Dispatcher.

The adapter does not exist as an independent service or a process. The adapter isadded to the Dispatcher instance, which runs all the adapters that are installed onthe same Security Directory Integrator instance.

See the topic about starting, stopping, and restarting the Dispatcher service in theDispatcher Installation and Configuration Guide.

Importing the adapter profileAn adapter profile defines the types of resources that the IBM Security Identityserver can manage. It is packaged with the IBM Security Identity Adapter. Use theadapter profile to create an adapter service on IBM Security Identity server andestablish communication with the adapter.

Before you beginv The IBM Security Privileged Identity Manager is installed and running.v You have root or administrator authority on the IBM Security Privileged Identity

Manager.v The file to be imported must be a Java archive (JAR) file. The

<Adapter>Profile.jar file includes all the files that are required to define theadapter schema, account form, service/target form, and profile properties. Ifnecessary, you can extract the files from the JAR file, modify the files, andrepackage the JAR file with the updated files.The JAR file for IBM SecurityPrivileged Identity Manager is located in the top level folder of the installationpackage.

About this task

Service definition files are also called adapter profile files.

If the adapter profile is not installed correctly, the adapter cannot functioncorrectly. You cannot create a service with the adapter profile or open an accounton the service. You must import the adapter profile again.

Procedure1. Log on to the IBM Security Privileged Identity Manager by using an account

that has the authority to perform administrative tasks.2. From the navigation tree, select Configure System > Manage Service Types.

The Manage Service Types page is displayed.3. On the Manage Service Types page, click Import. The Import Service Type page

is displayed.4. On the Import Service Type page, complete these steps:

a. In the Service Definition File field, type the directory location of the<Adapter>Profile.jar file, or click Browse to locate the file. For example, ifyou are installing the IBM Security Identity Adapter for a Windows serverthat runs Active Directory, locate and import the ADProfileJAR file.

b. Click OK to import the file.


Results

A message indicates that you successfully submitted a request to import a servicetype.

What to do nextv The import occurs asynchronously, which means it might take some time for the

service type to load into the IBM Security Identity server from the propertiesfiles and to be available in other pages. On the Manage Service Types page, clickRefresh to see the new service type. If the service type status is Failed, checkthe log files to determine why the import failed.

v If you receive a schema-related error, see the trace.log file for informationabout it. The trace.log file location is specified by the handler.file.fileDirproperty that is defined in the enRoleLogging.properties file. TheenRoleLogging.properties file is in the IBM Security Identity serverHOME\datadirectory. .

Creating an adapter service/targetAfter you import the adapter profile on the IBM Security Identity server, create aservice/target so that IBM Security Identity server can communicate with themanaged resource.

Before you begin

Complete “Importing the adapter profile” on page 12.

About this task

You must create an administrative user account for the adapter on the managedresource. You can provide the account information such as administrator name andpassword when you create the adapter service. Ensure that the account hassufficient privileges to administer the users. For information about creating anadministrative account, see the documentation for the managed resource.

To create or change a service, you must use the service form to provideinformation for the service. Service forms might vary depending on the adapter.The service name and description that you provide for each service are displayedon the console. Therefore, it is important to provide values that make sense to yourusers and administrators.

Procedure1. From the navigation tree, click Manage Services.2. On the Services table, click Create. The Create a Service wizard is displayed.3. On the Select the Type of Service page, click Search to locate a business unit.

The Business Unit page is displayed.4. On the Business Unit page, complete these steps:

a. Type information about the business unit in the Search information field.b. Select a business type from the Search by list, and then click Search. A list

of business units that matches the search criteria is displayed.If the table contains multiple pages, you can do the following tasks:v Click the arrow to go to the next page.v Type the number of the page that you want to view and click Go.

Chapter 3. Installing 13

c. In the Business Units table, select business unit in which you want to createthe service, and then click OK. The Select the Type of Service page isdisplayed, and the business unit that you specified is displayed in theBusiness unit field.

5. On the Select the Type of Service page, select a service type, and then clickNext.

6. On the Service Information page, specify the appropriate values for the serviceinstance. The content of the Service Information page depends on the type ofservice that you are creating.

7. Click Finish.

Results

A message is displayed, indicating that you successfully created the serviceinstance for a specific service type.

Service/Target form detailsComplete the service/target form fields.

The accounts must be able to remotely connect to the Sybase Adaptive ServerEnterprise server and must have sufficient roles to administer Sybase users.

Table 3. Required roles and their descriptions

Role Description

SA_ROLE System administrator role

SSO_ROLE System security officer role

OPER_ROLE Operator role

Note: If the following fields on the service form are changed for an existingservice, the IBM Security Identity Adapter service on the Tivoli DirectoryIntegrator server must be restarted.v Service Name

v Sybase Admin Password

v AL File System Path

v Max Connection Count

On the Sybase Connection tab:

Service nameSpecify a name that defines the adapter service on the IBMSecurity Identity server.

Note: Do not use forward (/) or backward slashes (\) in theservice name.

Description Specify a description that identifies the service for yourenvironment. This field is optional.

Tivoli Directory Integrator location

Specify the URL for the IBM Tivoli Directory Integrator instance.The valid syntax for the URL is rmi://ip-address:port/


ITDIDispatcher, where ip-address is the IBM Tivoli DirectoryIntegrator host and port is the port number for the RMI Dispatcher.

The default URL for the default SDI1 instance isrmi://localhost:1099/ITDIDispatcher.

Sybase Server HostSpecify the host workstation on which the Sybase server isrunning. This field is required.

Sybase Server PortSpecify the TCP port on which the Sybase server is running. Forexample, 5000. This field is required.

Sybase Admin IDSpecify the name of the user who has access to the Sybase resourceand who can perform administrative operations. This field isrequired.

Sybase Admin PasswordSpecify the password for the user. This field is required.

OwnerSpecify a user as a service owner. This field is optional.

Service PrerequisiteSpecify a service that is prerequisite to this service.

On the Dispatcher Attributes tab:

Disable AL CachingSelect the check box to disable the assembly line caching in thedispatcher for the service. The assembly lines for the add, modify,delete, and test operations are not cached.

AL File System PathSpecify the file path from where the dispatcher loads the assemblylines. If you do not specify a file path, the dispatcher loads theassembly lines received from IBM Security Identity server.

For example, you can specify the following file path to load theassembly lines from the profiles directory of the Windowsoperating system: c:\Files\IBM\TDI\V7.0\profiles or you canspecify the following file path to load the assembly lines from theprofiles directory of the UNIX and Linux operating system: system:/opt/IBM/TDI/V7.0/profiles.

Max Connection CountSpecify the maximum number of assembly lines that the dispatchercan run simultaneously for the service. For example, enter 10 whenyou want the dispatcher to run a maximum of 10 assembly linessimultaneously for the service. If you enter 0 in the MaxConnection Count field, the dispatcher does not limit the numberof assembly lines that are run simultaneously for the service.

Verifying that the adapter is working correctlyAfter you install and configure the adapter, verify that the installation andconfiguration are correct.

Chapter 3. Installing 15

Procedure1. Test the connection for the service that you created on the IBM Security Identity

server.2. Run a full reconciliation from the IBM Security Identity server.3. Run all supported operations such as add, modify, and delete on one user

account.4. Verify the ibmdi.log file after each operation to ensure that no errors are

reported.5. Verify the trace.log file to ensure that no errors are reported when you run an

adapter operation.


Chapter 4. Upgrading

Upgrading an IBM Tivoli Directory Integrator-based adapter involves tasks such asupgrading the dispatcher, the connector, and the adapter profile. Depending on theadapter, some of these tasks might not be applicable. Other tasks might also berequired to complete the upgrade.

To verify the required version of these adapter components, see the adapter releasenotes. For the installation steps, see Chapter 3, “Installing,” on page 11.

Upgrading the dispatcherBefore you upgrade the dispatcher, verify the version of the dispatcher.v If the dispatcher version mentioned in the release notes is later than the existing

version on your workstation, install the dispatcher.v If the dispatcher version mentioned in the release notes is the same or earlier

than the existing version, do not install the dispatcher.

Note: Stop the dispatcher service before the upgrading the dispatcher and start itagain after the upgrade is complete.

Upgrading the adapter profileRead the adapter Release Notes for any specific instructions before you import anew adapter profile.

Note: Restart the Dispatcher service after importing the profile. Restarting theDispatcher clears the assembly lines cache and ensures that the dispatcher runs theassembly lines from the updated adapter profile.

17

Chapter 5. Configuring

After you install the adapter, configure it to function correctly. Configuration isbased on your requirements or preference.

See the IBM Security Dispatcher Installation and Configuration Guide for additionalconfiguration options such as:v JVM propertiesv Dispatcher filteringv Dispatcher propertiesv Dispatcher port numberv Logging configurationsv Secure Sockets Layer (SSL) communication

Customizing the adapter profileTo customize the adapter profile, you must modify the Sybase Adapter JAR file.You can customize the adapter profile to change the account form or the serviceform.

About this task

You can also use the Form Designer or the CustomLabels.properties file to changethe labels on the forms. Each adapter has a CustomLabels.properties file for thatadapter.

The JAR file is included in the Sybase Adapter compressed file that youdownloaded from the IBM website. The JAR file and the files that are contained inthe JAR file vary depending on your operating system.

Note: You cannot modify the schema for this adapter. You cannot add or deleteattributes from the schema.

The adapter JAR file includes the following files:v CustomLabels.properties

v erSybaseAccount.xml

v erSybaseService.xml

v schema.dsml

v service.def

v SybaseAdapter.xml

Procedure1. Edit the JAR file.

a. Log on to the workstation where the Sybase Adapter is installed.b. On the Start menu, click Programs → Accessories → Command Prompt.c. Copy the JAR file into a temporary directory.

19

d. Extract the contents of the JAR file into the temporary directory by runningthe following command. The following example applies to the SybaseAdapter profile. Type the name of the JAR file for your operating system.cd c:\tempjar -xvf SybaseAdapterProfile.jar

The jar command extracts the files into the directory.e. Edit the file that you want to change.

2. Import the file into the IBM Security Identity server for the changes to takeeffect..a. Create a JAR file by using the files in the \temp directory. Run the following

commands:cd c:\tempjar -cvf SybaseAdapterProfile.jar SybaseAdapterProfile

b. Import the JAR file into the IBM Security Privileged Identity Managerapplication server.

c. Stop and start the IBM Security Identity serverd. Restart the adapter service.

Editing adapter profiles on the UNIX or Linux operating systemThe adapter profile .jar file might contain ASCII files that are created by using theMS-DOS ASCII format.

About this task

If you edit an MS-DOS ASCII file on the UNIX operating system, you might see acharacter ^M at the end of each line. These characters indicate new lines of text inMS-DOS. The characters can interfere with the running of the file on UNIX orLinux systems. You can use tools, such as dos2unix, to remove the ^M characters.You can also use text editors, such as the vi editor, to remove the charactersmanually.

Example

You can use the vi editor to remove the ^M characters. From the vi commandmode, run the following command and press Enter::%s/^M//g

When you use this command, enter ^M or Ctrl-M by pressing ^v^M or Ctrl V CtrlM sequentially. The ^v instructs the vi editor to use the next keystroke instead ofissuing it as a command.

Password management for account restorationHow each restore action interacts with its corresponding managed resourcedepends on the managed resource or on the business processes that youimplement.

Certain resources reject a password when a request is made to restore an account.In this case, you can configure IBM Security Privileged Identity Manager to foregothe new password requirement. You can configure the Sybase Adapter to require a


new password when the account is restored. This feature is useful if yourcompany's business processes require you to reset the password when an accountis restored.

In the service.def file, you can define whether a password is required as a newprotocol option. When you import the adapter profile, if an option is not specified,the adapter profile importer determines the correct restoration password behaviorfrom the schema.dsml file. The adapter profile components enable remote servicesto know whether to discard a password that is entered by the user where multipleaccounts on disparate resources are being restored. In this situation, where onlysome of the accounts that are being restored might require a password. Remoteservices discard the password from the restore action for those managed resourcesthat do not require them.

Edit the service.def file to add the new protocol options, for example:<Property Name = "com.ibm.itim.remoteservices.ResourceProperties.

PASSWORD_NOT_REQUIRED_ON_RESTORE"<value>true</value></property><Property Name = "com.ibm.itim.remoteservices.ResourceProperties.

PASSWORD_NOT_ALLOWED_ON_RESTORE"<value>false</value></property>

By adding the two options in the preceding example, you can ensure that you arenot prompted for a password when an account is restored.

Chapter 5. Configuring 21

Chapter 6. Troubleshooting

Troubleshooting is a systematic approach to solving a problem. The goal oftroubleshooting is to determine why something does not work as expected andhow to resolve the problem. This topic provides information and techniques foridentifying and resolving problems that are related to the adapter, includingtroubleshooting errors that might occur during the adapter installation.

Techniques for troubleshooting problemsCertain common techniques can help with the task of troubleshooting. The firststep in the troubleshooting process is to describe the problem completely.

Problem descriptions help you and the IBM technical-support representative findthe 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 you start to describe a problem, the most obvious question is “What is theproblem?” This question might seem straightforward; however, you can break itdown into several more-focused questions that create a more descriptive picture ofthe 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 themost important steps in resolving a problem. Many layers of technology can existbetween the reporting and failing components. Networks, disks, and drivers areonly 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 isolatethe problem layer:v Is the problem specific to one operating system, or is it common across multiple

operating systems?v Is the current environment and configuration supported?v Do all users have the problem?v (For multi-site installations.) Do all sites have the problem?

23

If one layer reports the problem, the problem does not necessarily originate in thatlayer. Part of identifying where a problem originates is understanding theenvironment in which it exists. Take some time to completely describe the problemenvironment, including the operating system and version, all correspondingsoftware and versions, and hardware information. Confirm that you are runningwithin an environment that is a supported configuration. Many problems can betraced back to incompatible levels of software that are not intended to run togetheror are not fully tested together.

When does the problem occur?

Develop a detailed timeline of events that lead up to a failure, especially for thosecases that are one-time occurrences. You can most easily develop a timeline byworking 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 andinformation. Typically, you use the first suspicious event that you find in adiagnostic 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 whichto investigate the problem.

Under which conditions does the problem occur?

Knowing which systems and applications are running at the time that a problemoccurs is an important part of troubleshooting. These questions about yourenvironment can help you to identify the root cause of the problem:v Does the problem always occur when the same task is being done?v Is a certain sequence of events required 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 inwhich the problem occurs and correlate any dependencies. Remember that justbecause multiple problems might occur around the same time, the problems arenot necessarily related.

Can the problem be reproduced?

From a troubleshooting standpoint, the ideal problem is one that can bereproduced. Typically, when a problem can be reproduced you have a larger set oftools or procedures at your disposal to help you investigate. Problems that you canreproduce are often easier to debug and solve.

However, problems that you can reproduce can have a disadvantage: If theproblem is of significant business impact, you do not want it to recur. If possible,re-create the problem in a test or development environment, which typically offersyou more flexibility and control during your investigation.v Can the problem be re-created on a test system?


v Do multiple users or applications have 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 messages and problem solvingA warning or error message might be displayed in the user interface to provideinformation about the adapter or when an error occurs.

A warning or error might be displayed in the user interface to provide informationthat you need to know about the adapter or about an error. Table 4 containswarnings or errors which might be displayed in the user interface if the SybaseAdapter is installed on your system.

Table 4. Warning and error messages

Message code Warning or error message Remedial action

CTGIMT001E The following error occurred. Error:Either the Sybase service name isincorrect or the service is not up.

Ensure that the Sybase service name given on theservice form is running.

CTGIMT001E The following error occurred. Error:Either the Sybase host or port isincorrect.

Verify that the host workstation name or the port forthe Sybase service is correctly specified.

CTGIMT002E The login credential is missing orincorrect.

Verify that you provided correct login credential onservice form.

CTGIMT001E The following error occurred. Error:No suitable JDBC driver found.

Ensure that the correct version of the JDBC driver iscopied onto the workstation where the adapter isinstalled. Ensure that the path for the driver isincluded in the system CLASSPATH variable.

CTGIMT600E An error occurred while establishingcommunication with the IBM TivoliDirectory Integrator server.

IBM Security Privileged Identity Manager cannotestablish a connection with IBM Tivoli DirectoryIntegrator. To fix this problem, ensure that:

v IBM Tivoli Directory Integrator is running.

v The URL specified on the service form for the IBMTivoli Directory Integrator is correct.

CTGIMT004E The adapter does not have permissionto add an account: Account_Name.

The administrator user that is provided on the IBMTivoli Directory Integrator service form does not havethe required privileges to add a user account. Ensurethat an administrator user with the requiredprivileges is specified on service form. Theseprivileges are the minimum that are required for theadministrator user:

v SA_ROLE

v SSO_ROLE

v OPER_ROLE

CTGIMT003E The account already exists. Use different name for the user to be added.

CTGIMT015E An error occurred while deleting theAccount_Name account because theaccount does not exist.

The user you trying to delete does not exist. Ensurethat you are deleting only an existing account.

Chapter 6. Troubleshooting 25

Chapter 7. Uninstalling

To remove an adapter from the IBM Security Identity server for any reason, youmust remove all the components that were added during installation. Uninstallingan IBM Tivoli Directory Integrator based adapter mainly involves removing theconnector file, and the adapter profile from the IBM Security Identity server.Depending on the adapter, some of these tasks might not be applicable, or therecan be other tasks.

Uninstalling the adapterTo remove an adapter from the IBM Security Identity server for any reason, youmust remove all the components that were added during installation. Uninstallingthe adapter involves running the uninstaller and removing the adapter profile fromthe IBM Security Identity server.

About this task

The Sybase Adapter installation installs the Dispatcher only on the Tivoli DirectoryIntegrator server. Therefore, you only need to uninstall from the Dispatcher. Thereis no uninstall for the Sybase Adapter.

The JAR file needed to uninstall the Dispatcher was created in theITDI_HOME\DispatcherUninstall directory when the Dispatcher was installed.

Note: The Dispatcher is required for all Tivoli Directory Integrator-based adapters.If you uninstall the Dispatcher, none of the other installed adapters function.

To remove the Sybase Adapter, complete these steps:

Procedure1. Stop the adapter service.2. Run the DispatcherUninstall.jar file. To run the JAR file, double click on the

executable file or enter the following command at the command prompt:TDI_HOME/jvm/jre/bin/java –jar DispatcherUninstall.jar

Deleting the adapter profileRemove the adapter service/target type from the IBM Security Identity server.Before you delete the adapter profile, ensure that no objects exist on the IBMSecurity Identity server that reference the adapter profile.

Objects on the IBM Security Identity server that can reference the adapter profile:v Adapter service instancesv Policies referencing an adapter instance or the profilev Accounts

Note: The Dispatcher component must be installed on your system for adapters tofunction correctly in a Tivoli Directory Integrator environment. When you deletethe adapter profile, do not uninstall the Dispatcher.

27

For specific information about how to delete the adapter profile, see the IBMSecurity Privileged Identity Manager product documentation.


Chapter 8. Reference

Reference information is organized to help you locate particular facts quickly, suchas adapter attributes, registry settings, and environment variables.

Adapter attributes and object classesAdapter attributes and object classes are required for customization, creatingprovisioning rules, and understanding what service/target attributes are supportedby the adapter. The IBM Security Identity server communicates with the adapterby using attributes, which are included in transmission packets that are sent over anetwork.This topic is not applicable for this adapter.

Table 5 is a listing of the attributes that are used by the Sybase Adapter. The tablegives a brief description and the data type for the attribute.

Table 5. Attributes, object identifiers, descriptions, and corresponding column/table name on the Sybase Adapter

Attribute nameDirectory serverattribute Description Data type

Database Access erSybAccess Specifies the database and alias access for the user.

For database access:

databasename:user:group:username

Note:

v The databasename must be a valid database onthe managed resource.

v The user is a keyword.

v The group is a valid group that exists on thedatabase database name.

v The username is the name for the user in thedatabase database name.

For alias access:

databasename:alias:databaseuser_name

Note:

v The databasename must be a valid database onthe managed resource.

v The alias is a keyword.

v The databaseuser_name must exist inmaster.dbo.syslogins and in the sysusers table ofthe database databasename.

String

Default Database erSybDefaultDatabase Specifies the default database for the user. If thisvalue is not supplied, then the default database istempdb with public group permissions.

String

Default Language erSybDefaultLanguage Specifies the default language for the user. If thisvalue is not supplied, then the form default isEnglish, us_english.

String

29

Table 5. Attributes, object identifiers, descriptions, and corresponding column/table name on the SybaseAdapter (continued)

Attribute nameDirectory serverattribute Description Data type

Password erPassword Specifies the password for the Sybase Adapter.Only one Password attribute is passed to the IBMSecurity Identity server

String

Roles Assigned erSybRole Specifies the name of the Sybase Adapter role thatis assigned to the user. Multiple Role attributes canbe passed to the IBM Security Identity server.

String

Sybase Adapter ServerRole

erSybServerName Specifies the name of the Sybase Adapter Server. String

Sybase AdapterAdmin ID

erSybAdminId Specifies the Sybase Adapter account that wascreated for the Sybase Adapter.

String

Sybase AdapterAdmin Password

erSybPwd1 Specifies the password for the user account that isspecified as the Sybase Adapter Admin ID.

String

User’s Full Name erSybFullName Specifies the full name of the user. String

User Name erUid Specifies the Sybase Adapter login ID. String

User Status erAccountStatus Specifies whether the user account is suspended. String

UserAccountDisabled AccountStatus Specifies whether the user account is enabled. String

Adapter attributes by operationsAdapter attributes by operations refer to adapter actions by their functionaltransaction group. They are required for customization, creating provisioning rules,and understanding what service/target attributes are supported by the adapter.

System Login AddA System Login Add is a request to create a user account with the specifiedattributes.

Table 6. Add request attributes for Oracle

Required attribute Optional attribute

erUidAll other supported attributes

System Login ChangeA System Login Change is a request to change one or more attributes for thespecified users.

Table 7. Change request attributes for Oracle


erUidAll other supported attributes

System Login DeleteA System Login Delete is a request to remove the specified user from the Oracledatabase.


Table 8. Delete request attributes for Oracle


erUid None

System Login SuspendA System Login Suspend is a request to disable a user account. The user is notremoved, and the attributes of the user are not modified.

Table 9. Suspend request attributes for Oracle


erUid

erAccountStatus

None

System Login RestoreA System Login Restore is a request to activate a user account that was previouslysuspended. After an account is restored, the user can access the system by usingthe same attributes as the ones before the Suspend function was called.

Table 10. Restore request attributes for Oracle


erUid

erAccountStatus

None

TestThe following table identifies attributes that are needed to test the connection.

Table 11. Test attributes


None None

ReconciliationThe Reconciliation request synchronizes user account information between IBMSecurity Privileged Identity Manager and the adapter.

Table 12. Reconciliation function attributes


erServicePwd1

erSybServerName

erSybAdminId

None

Chapter 8. Reference 31

Special attributesCertain attributes have special syntax and meaning that customers needs to beaware off. This information will be used to help the customer in how to supply theattribute value.This topic is not applicable for this adapter.


Index

Aaccounts

password requirements 20restoration 20

adapterarchitecture

directory integrator connector 1dispatcher 1profile 1

attributesdescriptions 29

customizationsteps 19

features 1installation 11

tasks 11troubleshooting errors 23verifying 16warnings 23worksheet 9

overview 1post-installation steps 19profile

customization 19upgrading 17

supported configurations 2trusted virtual administrator 1uninstalling 27upgrading 17user account

management tasks 1adapter attributes

add 30adapter installation 11adapters

removing profiles 27attributes

change 30delete 31descriptions 29restore 31suspend 31testing connection 31

Ccreating

services 13

Ddirectory integrator

connector 1uninstalling the adapter 27

dispatcheradapter architecture 1installation 11upgrading 17

download, software 8

Eerror messages 25

Iinstallation

adapter 11software 11

planning roadmaps 5post-installation steps 19troubleshooting errors 23uninstall 27verification

adapter 16warnings 23worksheet 9

Mmessages

error 25warning 25

MS-DOS ASCII characters 20

Ooperating system prerequisites 6overview 1

Ppost-installation steps 19profile

editing on UNIX or Linux 20

RReconciliation, request 31removing

adapter profiles 27request

Reconciliation 31System Login Add 30System Login Change 30System Login Delete 31System Login Restore 31System Login Suspend 31

roadmapsplanning 5

Sservice

restart 12start 12stop 12

service, creating 13

softwaredownload 8requirements 6website 8

supported configurationsadapter 2overview 2

System Login Add, request 30System Login Change, request 30System Login Delete, request 31System Login Restore, request 31System Login Suspend, request 31

Ttroubleshooting

error messages 25identifying problems 23techniques for 23warning messages 25

troubleshooting and supporttroubleshooting techniques 23

Uuninstallation 27updating

adapter profile 19upgrades

adapter 17adapter profiles 17dispatcher 17

user accountmanagement tasks 1

Vverification

dispatcher installation 11installation 16operating system prerequisites 6operating system requirements 6software

prerequisites 6requirements 6

vi command 20

Wwarning messages 25

33

IBM®

Printed in USA

sybase ada pter installa tion and - ibmpublic.dhe.ibm.com/software/security/products/isim/...in a...

Documents