Skip Headers
Oracle® Identity Manager Connector Guide for UNIX Telnet
Release 9.0.3

Part Number B32375-01
Go to Documentation Home
Home
Go to Book List
Book List
Go to Table of Contents
Contents
Go to Index
Index
Go to Feedback page
Contact Us

Go to previous page
Previous
Go to next page
Next
View PDF

2 Deploying the Connector

Deploying the connector involves the following steps:

If you want to configure the connector for multiple installations of UNIX Telnet, then perform the following procedure:

Step 1: Verifying Deployment Requirements

The following table lists the deployment requirements for the connector.

Item Requirement
Oracle Identity Manager Oracle Identity Manager release 8.5.3 or later
Target systems The target system can be any one of the following:
  • Solaris 8, Solaris 9, or Solaris 10

  • HP-UX 11.11 (trusted/nontrusted)

  • Linux (Red Hat Advanced Server 2.1, Red Hat Enterprise Linux 3.x, or Red Hat Linux 4.x)

  • AIX 4.3 or AIX 5.2

External code JSCAPE Telnet/SSH Libraries (SSH factory)
Other systems Operating system patches (HP-UX)
Target system user account root

You provide the credentials of this user account while performing the procedure in the "Defining IT Resources" section.

Character encoding (en_US) supported by the target system The target system must support en_US character encoding standards such as UTF-8 and iso8859.

Use the following command to check the en_US character encoding standards that the target system supports:

locale -a

Note: If the target system does not support any of the en_US character encoding standards, then you must install the en_US language pack.


The supported shell types for various operating systems are given in the following table.

Solaris HP-UX Linux AIX
sh csh ksh csh
csh ksh bash ksh
- sh sh sh
- - csh -

Step 2: Configuring the Target System

This section provides instructions to configure the target system on the following platforms:

Configuration Steps for Solaris and Linux

Perform the following steps for Solaris and Linux environments:

  1. Ensure that the /etc/passwd and /etc/shadow files are available on the UNIX server.

  2. Ensure that a passwd mirror file is created on the target server by using a command similar to the following:

    cp /etc/passwd /etc/passwd1
    
    

    The same file name with the path must be inserted in the Passwd Mirror File/User Mirror File (AIX) attribute of the reconciliation scheduled task.

  3. Ensure that a shadow mirror file is created on the target server by using a command similar to the following:

    cp /etc/shadow /etc/shadow1 
    
    

    The name and path of this file must be specified for the Shadow Mirror File attribute of the reconciliation scheduled task.

Configuration Steps for AIX

Perform the following steps for AIX environments:

  1. Ensure that the /etc/passwd and /etc/security/user files are available on the server.

  2. Ensure that a user mirror file is created on the server by using a command similar to the following:

    lsuser -c -a id pgrp gecos home shell expires maxage ALL |
    tr '#' ' ' > /mainUserFile1
    
    

    The name and path of this file must be specified for the Passwd Mirror File/User Mirror File (AIX) attribute of the scheduled task for reconciliation.

Configuration Steps for HP-UX

Perform the following steps for HP-UX environments:

  1. Log in as root and then run the following command:

    /usr/bin/sam
    
    
  2. Select Auditing and Security and System Security Policies. A message is displayed asking if you want to switch to the trusted mode.

  3. Click OK.

    If the following message is displayed, then skip the next step:

    System changed successfully to trusted system
    
    
  4. Ensure that the /etc/passwd and /etc/shadow directories are available on the target server.

    If the shadow file does not exist, then follow the installation instructions at

    http://docs.hp.com/en/5991-0909/index.html

    All the patches are available in the HP patch database, which you can download from

    http://www5.itrc.hp.com/

Step 3: Copying the Connector Files

The connector files to be copied and the directories to which you must copy them are given in the following table.

Note:

The directory paths given in the first column of this table correspond to the location of the connector files in the following directory on the installation media:
Operating Systems\UNIX\UNIX Telnet

Refer to the "Files and Directories That Comprise the Connector" section for more information about these files.

File in the Installation Media Directory Destination Directory
ext\sshfactory.jar
OIM_home/xellerate/ThirdParty
lib\xliTelnet.jar
OIM_home/xellerate/JavaTasks
lib\xliTelnet.jar
OIM_home/xellerate/ScheduleTask
Files in the resources directory
OIM_home/xellerate/connectorResources
Files in the tests directory
OIM_home/xellerate/XLIntegrations/Telnet/tests
Files in the xml directory
OIM_home/xellerate/XLIntegrations/Telnet/xml

Note:

While installing Oracle Identity Manager in a clustered environment, you copy the contents of the installation directory to each node of the cluster. Similarly, you must copy the connectorResources directory and the JAR files to the corresponding directories on each node of the cluster.

Step 4: Configuring the Oracle Identity Manager Server

Configuring the Oracle Identity Manager server involves the following procedures:

Note:

In a clustered environment, you must perform this step on each node of the cluster.

Changing to the Required Input Locale

Changing to the required input locale (language and country setting) involves installing the required fonts and setting the required input locale.

To set the required input locale:

Note:

Depending on the operating system used, you may need to perform this procedure differently.
  1. Open Control Panel.

  2. Double-click Regional Options.

  3. On the Input Locales tab of the Regional Options dialog box, add the input locale that you want to use and then switch to the input locale.

Clearing Content Related to Connector Resource Bundles from the Server Cache

Whenever you add a new resource bundle in the OIM_home\xellerate\connectorResources directory or make a change in an existing resource bundle, you must clear content related to connector resource bundles from the server cache.

To clear content related to connector resource bundles from the server cache:

  1. In a command window, change to the OIM_home\xellerate\bin directory.

  2. Enter one of the following commands:

    Note:

    You must perform Step 1 before you perform this step. If you run the command as follows, then an exception is thrown:
    OIM_home\xellerate\bin\batch_file_name
    
    • On Microsoft Windows:

      PurgeCache.bat ConnectorResourceBundle
      
      
    • On UNIX:

      PurgeCache.sh ConnectorResourceBundle
      
      

    In this command, ConnectorResourceBundle is one of the content categories that you can remove from the server cache. Refer to the following file for information about the other content categories:

    OIM_home\xellerate\config\xlConfig.xml
    

Note:

You can ignore the exception that is thrown when you perform Step 2.

Enabling Logging

When you enable logging, Oracle Identity Manager automatically stores in a log file information about events that occur during the course of provisioning and reconciliation operations. To specify the type of event for which you want logging to take place, you can set the log level to one of the following:

  • ALL

    This level enables logging for all events.

  • DEBUG

    This level enables logging of information about fine-grained events that are useful for debugging.

  • INFO

    This level enables logging of informational messages that highlight the progress of the application at coarse-grained level.

  • WARN

    This level enables logging of information about potentially harmful situations.

  • ERROR

    This level enables logging of information about error events that may still allow the application to continue running.

  • FATAL

    This level enables logging of information about very severe error events that could cause the application to stop functioning.

  • OFF

    This level disables logging for all events.

The file in which you set the log level depends on the application server that you use:

  • For JBoss Application Server

    In the JBoss_home\server\default\conf\log4j.xml file, add the following lines of XML code:

    <category name = "Adapter.TELNETSSH">
       <priority value = "log_level"/>
    </category>
    
    

    In the second XML code line, replace log_level with the log level that you want to set. For example:

    <category name = "Adapter.TELNETSSH">
       <priority value = "WARN"/>
    </category>
    
    

    After you enable logging, log information is written to the following file:

    JBoss_home\server\default\log\server.log
    
    
  • For IBM WebSphere

    Add the following line in the OIM_home\xellerate\config\log.properties file:

    log4j.logger.Adapter.TELNETSSH=log_level
    
    

    In this line, replace log_level with the log level that you want to set. For example:

    log4j.logger.Adapter.TELNETSSH=INFO
    
    

    After you enable logging, log information is written to the following file:

    WebSphere_home\AppServer\logs\server_name\startServer.log
    
    
  • For BEA WebLogic

    Add the following line in the OIM_home\xellerate\config\log.properties file:

    log4j.logger.Adapter.TELNETSSH=log_level
    
    

    In this line, replace log_level with the log level that you want to set. For example:

    log4j.logger.Adapter.TELNETSSH=INFO
    
    

    After you enable logging, log information is written to the following file:

    WebLogic_home\user_projects\domains\domain_name\server_name\server_name.log
    
    
  • For OC4J

    Add the following line in the OIM_home\xellerate\config\log.properties file:

    log4j.logger.Adapter.TELNETSSH=log_level
    
    

    In this line, replace log_level with the log level that you want to set. For example:

    log4j.logger.Adapter.TELNETSSH=INFO
    
    

    After you enable logging, log information is written to the following file:

    OC4J_home\opmn\logs\default_group~home~default_group~1.log
    

Step 5: Importing the Connector XML Files

To import the connector XML files into Oracle Identity Manager:

Note:

If you do not import the connector files in the specified order, then the connector may not work.
  1. Open the Oracle Identity Manager Administrative and User Console.

  2. Click the Deployment Management link on the left navigation bar.

  3. Click the Import link under Deployment Management. A dialog box for locating files is displayed.

  4. Locate and open the XLITelnet_DM.xml file, which is in the OIM_home/xellerate/XLIntegrations/Telnet/xml directory. Details of this XML file are shown on the File Preview page.

  5. Click Add File. The Substitutions page is displayed.

  6. Click Next. The Confirmation page is displayed.

  7. Click Next. The Provide IT Resource Instance Data page for the Telnet server- Solaris IT resource is displayed.

  8. Specify values for the parameters of the Telnet server- Solaris IT resource. Refer to the table in the "Defining IT Resources" section for information about the values to be specified.

  9. Click Next. The Provide IT Resource Instance Data page for a new instance of the TELNET Server IT resource type is displayed.

  10. Click Skip to specify that you do not want to define another IT resource. The Confirmation page is displayed.

    See Also:

    If you want to define another IT resource, then refer to Oracle Identity Manager Tools Reference Guide for instructions.
  11. Click View Selections.

    The contents of the XML file are displayed in the Deployment Manager – Import window. Remove these nodes by right-clicking each node and then selecting Remove.

  12. Click Import. The connector file is imported into Oracle Identity Manager.

  13. Perform the same procedure to import the XLITelnetSchedulerTask_DM.xml file, which is in the OIM_home/xellerate/XLIntegrations/Telnet/xml directory.

  14. If you plan to use the connector in trusted source reconciliation mode, then perform the same procedure to import the XLITelnet_Trusted_DM.xml file. This file is in the OIM_home/xellerate/XLIntegrations/Telnet/xml directory.

    Caution:

    Only one connector can be configured for trusted source reconciliation. If you import the XLITelnet_Trusted_DM.xml file while you have another trusted source configured, then both connector reconciliations would stop working.

After you import the connector XML files, proceed to the "Step 6: Configuring Reconciliation" section.

Defining IT Resources

You must specify values for the Telnet server- Solaris IT resource parameters listed in the following table.

Parameter Description
Admin UserId User ID of the administrator

root

Admin Password Password of the administrator

dead_line

Server IP Address Server IP address
Port The port at which the Telnet service is running on the server

Default value: 23

Server OS Specify one of the following:
  • AIX

  • HP-UX

  • SOLARIS

  • LINUX

Shell Prompt # or $
Login Prompt Login prompt that is displayed when you log in to the server

login:

Password Prompt Password prompt that is displayed when you log in to the server

Password:

Whether Trusted System (HP-UX) YES (for trusted HP-UX System) or NO (for nontrusted HP-UX system)
Target Locale Target locale

You can specify any one of the following values:

  • en_US for English

  • ja_JP for Japanese

  • fr_FR for French

Note: You must not make any change (uppercase or lowercase) in the value that you specify.

Supported Character Encoding (en_US) - Target Encoding format for the en_US target locale

The default value is UTF-8.

Note: You can check which en_US encoding formats the target system supports by using the following command:

locale -a


After you specify values for these IT resource parameters, proceed to Step 9 of the procedure to import connector XML files.

Step 6: Configuring Reconciliation

This section describes the following steps involved in configuring the Oracle Identity Manager server:

Adding Prerequisites for Reconciliation

This section discusses the following topics:

Configuring System Properties

To configure system properties:

  1. Open the Oracle Identity Manager Design Console.

  2. Navigate to the System Configuration page.

  3. Check if there is an entry for "Default date format." If this entry is not there, then perform Step 4.

  4. Add a new entry in the Server category:

    • Name: Default date format

    • Keyword: XL.DefaultDateFormat

    • Value: yyyy/MM/dd hh:mm:ss z

  5. Click Save.

Configuring Trusted Source Reconciliation Oracle Identity Manager Entities

Note:

Perform this step of the procedure only if you want to configure trusted source reconciliation. Only one connector can be configured for trusted source reconciliation. If you configure trusted source reconciliation for this connector while you have another trusted source configured, then both connector reconciliations would stop working.

Refer to Oracle Identity Manager Connector Framework Guide for conceptual information about reconciliation configurations.

This procedure involves the following steps:

  1. Open the Oracle Identity Manager Design Console.

  2. In the Resource Object form:

    1. Search for the Xellerate User.

    2. On the Object Reconciliation tab, add the required reconciliation fields. Add all the reconciliation fields that will be needed to provide input for mandatory fields in the Xellerate User form, for example, fields such as User Login and First Name. Only one mandatory field, Password, can be left unmapped. All the mandatory fields of the User Defined process form must be mapped.

  3. In the Process Definition form:

    1. Search for the Xellerate User.

    2. On the Reconciliation Field Mappings tab, add the required reconciliation field mappings. All the mandatory fields of the User Defined process form should be mapped.

  4. In the Reconciliation Rules form:

    1. Create a new rule for the Xellerate User resource object, with a rule element.

    2. Select the Active check box.

Defining Scheduled Tasks

To create the reconciliation scheduled task:

  1. Open the Oracle Identity Manager Design Console.

  2. Expand the Xellerate Administration folder.

  3. Select Task Scheduler.

  4. Click Find. The details of the predefined scheduled tasks are displayed.

  5. Enter a number in the Max Retries field. This number represents the number of times Oracle Identity Manager must attempt to complete the task before assigning the ERROR status to the task.

  6. Ensure that the Disabled and Stop Execution check boxes are not selected.

  7. In the Start region, double-click the Start Time field. From the date-time editor that is displayed, select the date and time at which you want the task to run.

  8. In the Interval region, set the following schedule parameters:

    • To set the task to run on a recurring basis, select the Daily, Weekly, Recurring Intervals, Monthly, or Yearly option.

      If you select the Recurring Intervals option, then you must also specify the time interval at which you want the task to run on a recurring basis.

    • To set the task to run only once, select the Once option.

  9. Provide values for the user-configurable attributes of the scheduled task. Refer to the "Specifying Values for the Scheduled Task Attributes" section for information about the values to be specified.

    See Also:

    Oracle Identity Manager Design Console Guide for information about adding and removing task attributes
  10. Click Save. The scheduled task is created. The INACTIVE status is displayed in the Status field, because the task is not currently running. The task is run at the date and time that you set in Step 7.

After you create the scheduled task, proceed to the "Enabling Reconciliation in Oracle Identity Manager Release 9.0.1" section.

Specifying Values for the Scheduled Task Attributes

You must specify values for the following attributes of the reconciliation scheduled task.

Note:

Attribute values are predefined in the connector XML file that you import. Specify values only for those attributes that you want to change.
Attribute Description Sample Value
Server Name of the IT Resource Telnet server- Solaris
Passwd Mirror File/User Mirror File Name of the password mirror file/user mirror file /etc/passwd1
Shadow Mirror File Name of the shadow mirror file

Note:

This attribute is not required on AIX.

The value of this attribute must not be null or blank, even for an HP-UX trusted system. However, the reconciliation process on an HP-UX trusted system ignores this attribute.

/etc/shadow1
Target System Recon - Resource Object name Name of the target system resource object Telnet User
Trusted Source Recon - Resource Object name Name of the trusted source resource object Default value: Xellerate User

Specify false (in lowercase) if you do not want to configure trusted source reconciliation

Date Format Format in which date values sent from the target system are to be saved during reconciliation

The value that you specify must be the same as the value specified in the "Configuring System Properties" section.

yyyy/MM/dd hh:mm:ss z

After you specify values for these task attributes, proceed to Step 10 of the procedure to create scheduled tasks.

Enabling Reconciliation in Oracle Identity Manager Release 9.0.1

If you are using Oracle Identity Manager release 9.0.1, then you must perform the following procedure to enable reconciliation:

See Also:

Oracle Identity Manager Design Console Guide
  1. Open the Process Definition form for the Telnet User. This form is in the Process Management folder.

  2. Click the Reconciliation Field Mappings tab.

  3. For each field that is of the IT resource type:

    1. Double-click the field to open the Edit Reconciliation Field Mapping window for that field.

    2. Deselect Key Field for Reconciliation Matching.

Step 7: Compiling Adapters

The following adapters are imported into Oracle Identity Manager when you import the connector XML file:

You must compile these adapters before you can use them to provision accounts on the target system.

To compile adapters by using the Adapter Manager form:

  1. Open the Adapter Manager form.

  2. To compile all the adapters that you import into the current database, select Compile All.

    To compile multiple (but not all) adapters, select the adapters you want to compile. Then, select Compile Selected.

    Note:

    Click Compile Previously Failed to recompile only those adapters that were not compiled successfully. Such adapters do not have an OK compilation status.
  3. Click Start. Oracle Identity Manager compiles the selected adapters.

  4. If Oracle Identity Manager is installed in a clustered environment, then copy the compiled adapters from the OIM_home\xellerate\Adapter directory to the same directory on each of the other nodes of the cluster. If required, overwrite the adapter files on the other nodes.

To view detailed information about an adapter:

  1. Highlight the adapter in the Adapter Manager form.

  2. Double-click the row header of the adapter, or right-click the adapter.

  3. Select Launch Adapter from the shortcut menu that is displayed. Details of the adapter are displayed.

Note:

To compile one adapter at a time, use the Adapter Factory form. Refer to Oracle Identity Manager Tools Reference Guide for information about using the Adapter Factory and Adapter Manager forms.

Configuring the Connector for Multiple Installations of the Target System

Note:

Perform this procedure only if you want to configure the connector for multiple installations of UNIX Telnet. Refer to Oracle Identity Manager Design Console Guide for detailed instructions on performing each step of this procedure.

To configure the connector for multiple installations of the target system:

  1. Create and configure one IT resource for each target system installation.

    The IT Resources form is in the Resource Management folder. An IT resource is created when you import the connector XML file. You can use this IT resource as the template for creating the remaining IT resources, of the same resource type.

  2. Configure reconciliation for each target system installation. Refer to the "Step 6: Configuring Reconciliation"section for instructions. Note that you only need to modify the attributes that are used to specify the IT resource and to specify whether or not the target system installation is to be set up as a trusted source.

    You can designate either a single or multiple installations of UNIX Telnet as the trusted source.

  3. If required, modify the fields to be reconciled for the Xellerate User resource object.

When you use the Administrative and User Console to perform provisioning, you can specify the IT resource corresponding to the UNIX Telnet installation to which you want to provision the user.