2 Deploying the Connector

Deploying the connector involves the following steps:

Verifying Deployment Requirements
Configuring the Target System
Depending on the release of Oracle Identity Manager that you use, perform the procedures described in one of the following sections:
- Installing the Connector on Oracle Identity Manager Release 9.1.0 or Later
- Installing the Connector on Oracle Identity Manager Release 8.5.3.1 Through 9.0.3.x
Configuring the Oracle Identity Manager Server

2.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.1 or later
Target systems	The target system can be any one of the following: HP-UX 11.11, 11.20 IBM AIX 5L Version 5.2, 5.3 Oracle Enterprise Linux 5.2 Red Hat Enterprise Linux AS 2.1, 3, 4.x, Red Hat Enterprise Linux ES 3, 4.x Solaris 8, 9, 10
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 configuring the IT resource. The procedure is described later in this guide. If you do not provide the credentials of this user account, then the "Insufficient rights or privileges" message is displayed when Oracle Identity Manager tries to communicate with the target system.
Character encoding supported by the target system	The target system must support the default C (POSIX) locale. Use the following command to check the locale that the target system supports: `locale –a`

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`	-

2.2 Configuring the Target System

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

Configuration Steps for Solaris and Linux
Configuration Steps for AIX
Configuration Steps for HP-UX

2.2.1 Configuration Steps for Solaris and Linux

Perform the following steps for Solaris and Linux environments:

Ensure that the /etc/passwd and /etc/shadow files are available on the UNIX server.
Create a passwd mirror file on the target server by using a command similar to the following:
```
cp /etc/passwd /etc/passwd1
```
You can specify any destination directory and file name when you run the command. While configuring the IT resource, you specify the name and path of this file as the value of the Passwd Mirror File/User Mirror File parameter of the IT resource for Solaris and Linux.

Note:
The administrator account whose credentials you provide as part of the IT resource definition must have read and write permissions on this file.
Create a shadow mirror file on the target server by using a command similar to the following:
```
cp /etc/shadow /etc/shadow1 
```
You can specify any destination directory and file name when you run the command. While configuring the IT resource, you specify the name and path of this file as the value of the Shadow Mirror File parameter of the IT resource.

Note:
The administrator account whose credentials you provide as part of the IT resource definition must have read and write permissions on this file.

2.2.2 Configuration Steps for AIX

Perform the following steps for AIX environments:

Ensure that the /etc/passwd and /etc/security/user files are available on the server.
Create a user mirror file on the server by using a command similar to the following:
```
> /etc/mainUserFile1
```
You can specify any directory and file name when you run the command. While configuring the IT resource, you specify the name and path of this file as the value of the Passwd Mirror File/User Mirror File (AIX) parameter of the IT resource for AIX.
Note:
- The administrator account whose credentials you provide as part of the IT resource definition must have read and write permissions on this file.
- For AIX, first-time reconciliation involves reconciliation of all the users present in the target system. This functionality is different from that of other target systems. On other target systems, records of all existing users are fetched from the target system only if you have created the passwd mirror file and the shadow mirror file as empty files.

2.2.3 Configuration Steps for HP-UX

Perform the following steps for HP-UX environments:

If you want to switch to HP-UX Trusted mode, then:
1. Log in as root and then run one of the following commands:
```
/usr/bin/sam
```
```
/usr/sbin/sam
```
2. Select Auditing and Security and then select System Security Policies. A message is displayed asking if you want to switch to the trusted mode.
3. Click Yes. The following message is displayed:
```
System changed successfully to trusted system
```
Ensure that the /etc/passwd and /etc/shadow directories are available on the target server.
Create a passwd mirror file on the target server by using a command similar to the following:
```
cp /etc/passwd /etc/passwd1
```
You can specify any destination directory and file name when you run the command. While configuring the IT resource, you specify the name and path of this file as the value of the Passwd Mirror File/User Mirror File parameters of the IT resource for HP-UX.

Note:
The administrator account whose credentials you provide as part of the IT resource definition must have read and write permissions on this file.
Create a shadow mirror file on the target server by using a command similar to the following:
```
cp /etc/shadow /etc/shadow1
```
You can specify any destination directory and file name when you run the command. While configuring the IT resource, you specify the name and path of this file as the value of the Shadow Mirror File parameter of the IT resource.

Note:
The administrator account whose credentials you provide as part of the IT resource definition must have read and write permissions on this file.

2.3 Installing the Connector on Oracle Identity Manager Release 9.1.0 or Later

Note:

In this guide, the term Connector Installer has been used to refer to the Connector Installer feature of the Oracle Identity Manager Administrative and User Console.

Installing the connector on Oracle Identity Manager release 9.1.0 or later involves the following procedures:

Running the Connector Installer
Configuring the IT Resource

2.3.1 Running the Connector Installer

To run the Connector Installer:

Copy the contents of the connector installation media into the following directory:
```
OIM_HOME/xellerate/ConnectorDefaultDirectory
```
Log in to the Administrative and User Console by using the user account described in the "Creating the User Account for Installing Connectors" section of Oracle Identity Manager Administrative and User Console.
Click Deployment Management, and then click Install Connector.
From the Connector List list, select UNIX Telnet RELEASE_NUMBER This list displays the names and release numbers of connectors whose installation files you copy into the default connector installation directory:
```
OIM_HOME/xellerate/ConnectorDefaultDirectory 
```
If you have copied the installation files into a different directory, then:
1. In the Alternative Directory field, enter the full path and name of that directory.
2. To repopulate the list of connectors in the Connector List list, click Refresh.
3. From the Connector List list, select UNIX Telnet RELEASE_NUMBER.
Click Load.
To start the installation process, click Continue.

The following tasks are performed in sequence:
1. Configuration of connector libraries
2. Import of the connector Target Resource user configuration XML file (by using the Deployment Manager). If you want to import the target system as a trusted source for reconciliation, then see "Configuring the Target System As a Trusted Source".
3. Compilation of adapters
On successful completion of a task, a check mark is displayed for the task. If a task fails, then an X mark and a message stating the reason for failure are displayed. Depending on the reason for the failure, make the required correction and then perform one of the following steps:
- Retry the installation by clicking Retry.
- Cancel the installation and begin again from Step 0.
If all three tasks of the connector installation process are successful, then a message indicating successful installation is displayed. In addition, a list of the steps that you must perform after the installation is displayed. These steps are as follows:
1. Ensuring that the prerequisites for using the connector are addressed
  
  Note:
  At this stage, run the PurgeCache utility to load the server cache with content from the connector resource bundle in order to view the list of prerequisites. Refer to "Clearing Content Related to Connector Resource Bundles from the Server Cache" for information about running the PurgeCache utility.
  There are no prerequisites for some predefined connectors.
2. Configuring the IT resource for the connector
  
  Record the name of the IT resource displayed on this page. The procedure to configure the IT resource is described later in this guide.
3. Configuring the scheduled tasks that are created when you installed the connector
  
  Record the names of the scheduled tasks displayed on this page. The procedure to configure these scheduled tasks is described later in this guide.

When you run the Connector Installer, it copies the connector files and external code files to destination directories on the Oracle Identity Manager host computer. These files are listed in Table 1-1.

Installing the Connector in an Oracle Identity Manager Cluster

While installing Oracle Identity Manager in a clustered environment, you must copy all the JAR files and the contents of the connectorResources directory into the corresponding directories on each node of the cluster. See "Files and Directories on the Installation Media" for information about the files that you must copy and their destination locations on the Oracle Identity Manager server.

2.3.2 Configuring the IT Resource

Note:

Perform this procedure if you are installing the connector on Oracle Identity Manager release 9.1.0 or later.

You must specify values for the parameters of the Telnet IT resource as follows:

Log in to the Administrative and User Console.
Expand Resource Management.
Click Manage IT Resource.
In the IT Resource Name field on the Manage IT Resource page, enter Telnet and then click Search.
Click the edit icon for the IT resource.
From the list at the top of the page, select Details and Parameters.

Specify values for the parameters of the IT resource. The following table describes each parameter:

Parameter	Description and Sample Value
`Admin UserId`	User ID of the administrator `root` or `jdoe` Here, `jdoe` can be the SUDO user ID, for the SUDO Admin mode.
`Admin Password/Private file Pwd`	Password of the administrator Note: For the SUDO Admin mode, the private key is not supported. Specify a password for this mode as the value of the parameter. If a private key is used, then enter the private key passphrase as the value of the parameter.
`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 $
`Whether Trusted System (HP-UX)`	`YES` (for trusted HP-UX System) or `NO` (for non-trusted HP-UX system)
`Sudo Or RBAC`	Enter one of the following values: `None`: Specifies the root user. `Sudo`: Specifies the sudo user.
`Max Retries`	Number of times that the UNIX Telnet connector should retry connecting to the target server if the connection fails Default value: `2`
`Delay`	Delay (in milliseconds) before the connector attempts to retry connecting to the target system, in case the connection fails Default value: `10000`
`Timeout`	Value of the timeout (in milliseconds) for the connection to the target server Default value: `20000`
`Passwd Mirror File/User Mirror File`	Name of the password mirror file/user mirror file. The user must have read and write permissions on this file. The sample value for this parameter is: `/etc/passwd1` This parameter is used for user reconciliation. The administrator account whose credentials you provide as part of the IT resource definition must have read and write permissions on this file.
`Shadow Mirror File`	Name of the shadow mirror file. The user must have read and write permissions on this file. This parameter 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. The sample value for this parameter is: `/etc/shadow1` This parameter is used for user reconciliation.
`Target Date Format`	This parameter is used to specify the date format of the target UNIX computer. The default value for this parameter is: `MMddhhmmyy` This parameter is used for user reconciliation.
`Protocol`	Default value: `Telnet` Do not change this default value.

To save the values, click Save.

2.4 Installing the Connector on Oracle Identity Manager Release 8.5.3.1 Through 9.0.3.x

Installing the connector on any Oracle Identity Manager release between releases 8.5.3.1 and 9.0.3.x involves the following procedures:

Copying the Connector Files
Importing the Connector XML Files

2.4.1 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.

File in the Installation Media Directory	Destination Directory
Files in the `config` directory	OIM_HOME/xellerate/XLIntegrations/Telnet/config
ext/sshfactory.jar	OIM_HOME/xellerate/ThirdParty
lib/xliTelnet.jar	OIM_HOME/xellerate/JavaTasks OIM_HOME/xellerate/ScheduleTask
Files in the `resources` directory	OIM_HOME/xellerate/connectorResources
Files in the `test` directory	OIM_HOME/xellerate/XLIntegrations/Telnet
Files in the `xml` directory	OIM_HOME/xellerate/XLIntegrations/Telnet/xml

2.4.2 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.

Open the Oracle Identity Manager Administrative and User Console.
Click the Deployment Management link on the left navigation bar.
Click the Import link under Deployment Management. A dialog box for opening files is displayed.
Locate and open the TelnetNonTrustedUser.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.
Click Add File. The Substitutions page is displayed.
Click Next. The Confirmation page is displayed.
Click Next. The Provide IT Resource Instance Data page for the Telnet IT resource is displayed.

Specify values for the parameters of the Telnet IT resource. Refer to the following table for information about the values to be specified:

Parameter	Description and Sample Value
`Admin UserId`	User ID of the administrator `root` or `jdoe` Here, `jdoe` can be the SUDO user ID, for the SUDO Admin mode.
`Admin Password/Private file Pwd`	Password of the administrator Note: For the SUDO Admin mode, the private key is not supported. Specify a password for this mode as the value of the parameter. If a private key is used, then enter the private key passphrase as the value of the parameter.
`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 $
`Whether Trusted System (HP-UX)`	`YES` (for trusted HP-UX System) or `NO` (for non-trusted HP-UX system)
`Sudo Or RBAC`	Enter one of the following values: `None`: Specifies the root user. `Sudo`: Specifies the sudo user.
`Max Retries`	Number of times that the UNIX Telnet connector should retry connecting to the target server if the connection fails Default value: `2`
`Delay`	Delay (in milliseconds) before the connector attempts to retry connecting to the target system, in case the connection fails Default value: `10000`
`Timeout`	Value of the timeout (in milliseconds) for the connection to the target server Default value: `20000`
`Passwd Mirror File/User Mirror File`	Name of the password mirror file/user mirror file. The user must have read and write permissions on this file. The sample value for this parameter is: `/etc/passwd1` This parameter is used for user reconciliation. The administrator account whose credentials you provide as part of the IT resource definition must have read and write permissions on this file.
`Shadow Mirror File`	Name of the shadow mirror file. The user must have read and write permissions on this file. 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. The sample value for this parameter is: `/etc/shadow1` This parameter is used for user reconciliation.
`Target Date Format`	This parameter is used to specify the date format of the target UNIX computer. The default value for this parameter is: `MMddhhmmyy` This parameter is used for user reconciliation.
`Protocol`	Default value: `Telnet` Do not change this default value.

Click Next. The Provide IT Resource Instance Data page for a new instance of the TELNET Server IT resource type is displayed.
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 Administrative and User Console Guide for instructions.
Click View Selections.

The contents of the XML file are displayed on the Import page. You may see a cross-shaped icon along with some nodes. These nodes represent Oracle Identity Manager entities that are redundant. Before you import the connector XML file, you must remove these entities by right-clicking each node and then selecting Remove.
Click Import. The connector file is imported into Oracle Identity Manager.

2.5 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
Clearing Content Related to Connector Resource Bundles from the Server Cache
Enabling Logging

2.5.1 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.

You may require the assistance of the system administrator to change to the required input locale.

2.5.2 Clearing Content Related to Connector Resource Bundles from the Server Cache

While performing the instructions described in the "Copying the Connector Files" section, you copy files from the resources directory on the installation media into the OIM_HOME/xellerate/connectorResources directory. Whenever you add a new resource bundle in the 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:

In a command window, change to the OIM_HOME/xellerate/bin directory.
Note:
You must perform Step 1 before you perform Step 2. An exception is thrown if you run the command described in Step 2 as follows:
```
OIM_HOME\xellerate\bin\batch_file_name
```
Enter one of the following commands:
- On Microsoft Windows:
```
PurgeCache.bat ConnectorResourceBundle
```
- On UNIX:
```
PurgeCache.sh ConnectorResourceBundle
```
Note:
You can ignore the exception that is thrown when you perform Step 2.

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
```

2.5.3 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 messages that highlight the progress of the application at a 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 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:

BEA WebLogic Server

To enable logging:
1. Add the following line in the OIM_HOME/xellerate/config/log.properties file:
```
log4j.logger.OIMCP.TELNETSSH=log_level
```
2. In this line, replace log_level with the log level that you want to set.
  
  For example:
```
log4j.logger.OIMCP.TELNETSSH=INFO
```
After you enable logging, log information is displayed on the server console.
IBM WebSphere Application Server

To enable logging:
1. Add the following line in the OIM_HOME/xellerate/config/log.properties file:
```
log4j.logger.OIMCP.TELNETSSH=log_level
```
2. In this line, replace log_level with the log level that you want to set.
  
  For example:
```
log4j.logger.OIMCP.TELNETSSH=INFO
```
After you enable logging, log information is written to the following file:
```
WEBSPHERE_HOME/AppServer/logs/SERVER_NAME/SystemOut.log
```
JBoss Application Server

To enable logging:
1. In the JBOSS_HOME/server/default/conf/log4j.xml file, add the following lines if they are not already present in the file:
```
<category name="OIMCP.TELNETSSH">
   <priority value="log_level"/>
</category>
```
2. In the second XML code line, replace log_level with the log level that you want to set. For example:
```
<category name="OIMCP.TELNETSSH">
   <priority value="INFO"/>
</category>
```
After you enable logging, log information is written to the following file:
```
JBOSS_HOME/server/default/log/server.log
```
Oracle Application Server

To enable logging:
1. Add the following line in the OIM_HOME/xellerate/config/log.properties file:
```
log4j.logger.OIMCP.TELNETSSH=log_level
```
2. In this line, replace log_level with the log level that you want to set.
  
  For example:
```
log4j.logger.OIMCP.TELNETSSH=INFO
```
After you enable logging, log information is written to the following file:
```
ORACLE_HOME/opmn/logs/default_group~home~default_group~1.log
```