After you deploy the connector, you must configure it to meet your requirements. This chapter discusses the following connector configuration procedures:
Note:
These sections provide both conceptual and procedural information about configuring the connector. It is recommended that you read the conceptual information before you perform the procedures.
Section 3.2, "Scheduled Task for Lookup Field Synchronization"
Section 3.5, "Guidelines on Performing Provisioning Operations"
First-time reconciliation involves synchronizing lookup definitions in Oracle Identity Manager with the lookup fields of the target system, and performing full reconciliation. In full reconciliation, all existing user records from the target system are brought into Oracle Identity Manager.
The following is the sequence of steps involved in reconciling all existing user records:
Note:
In Oracle Identity Manager release 11.1.1, a scheduled job is an instance of a scheduled task. In this guide, the term scheduled task used in the context of Oracle Identity Manager release 9.1.0.x is the same as the term scheduled job in the context of Oracle Identity Manager release 11.1.1.
See Oracle Fusion Middleware System Administrator's Guide for Oracle Identity Manager for more information about scheduled tasks and scheduled jobs.
Perform lookup field synchronization by running the scheduled tasks provided for this operation.
See Section 3.2, "Scheduled Task for Lookup Field Synchronization" for information about the attributes of the scheduled tasks for lookup field synchronization.
See Section 3.4, "Configuring Scheduled Tasks" for information about running scheduled tasks.
Perform user reconciliation by running the scheduled task for user reconciliation.
See Section 3.3.4, "Reconciliation Scheduled Tasks" for information about the attributes of this scheduled task.
See Section 3.4, "Configuring Scheduled Tasks" for information about running scheduled tasks.
The Passwd Mirror File/User Mirror File and Shadow Mirror File parameters of the SSH IT resource contain the name and full path of the password mirror and shadow mirror files, respectively. Before you perform first-time reconciliation, the passwd mirror and shadow mirror files are empty (do not contain any user records).
After first-time reconciliation, the user records in the passwd and passwd mirror files are the same. Similarly, the user records in the shadow and shadow mirror files are the same.
From the next reconciliation run onward, only target system user records that are added or modified after the last reconciliation run are considered for incremental reconciliation. This is done by examining differences between the /etc/passwd, /etc/shadow files and their corresponding mirror files."
Note:
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.
See Also:
Section 2.4.3, "Configuring the IT Resource" for information about the parameters of the IT resource
The TelnetSSHGroupLookupReconTask scheduled task is used for lookup fields reconciliation.
Table 3-1 describes the attributes of this scheduled task. See Section 3.4, "Configuring Scheduled Tasks" for information about configuring scheduled tasks.
Note:
Attribute values are predefined in the connector XML file that you import. Specify values only for those attributes that you want to change.
Values (either default or user-defined) must be assigned to all the attributes. If even a single attribute value were left empty, then reconciliation would not be performed.
Table 3-1 Attributes of the Scheduled Tasks for Lookup Field Synchronization
| Attribute | Description |
|---|---|
|
Server |
Enter the name of the target system IT resource. Sample value: |
|
Lookup Field Name |
Enter the name of the lookup field (on the process form) to be used in lookup reconciliation. Default value: |
|
Exclusion List |
Enter a comma-delimited list of the names of groups on the target system that you do not want to reconcile. Sample value: |
As mentioned earlier in this guide, reconciliation involves duplicating in Oracle Identity Manager the creation of and modifications to user accounts on the target system. This section discusses the following topics related to configuring reconciliation:
Full reconciliation involves reconciling all existing user records from the target system into Oracle Identity Manager. After you deploy the connector, you must first perform full reconciliation. In addition, you can switch from incremental reconciliation to full reconciliation whenever you want to ensure that all target system records are reconciled in Oracle Identity Manager.
To perform a full reconciliation run:
Run the following commands on the target system before you run the scheduled tasks:
> etc/passwd1 > etc/shadow1
Specify All as the value of the NumberOfBatches attribute of the user reconciliation scheduled task.
At the end of the reconciliation run, the user records in the passwrd mirror and shadow mirror files are the same as in the passwrd and shadow files, respectively. From the next reconciliation run onward, only records created or modified after the last reconciliation run are considered for reconciliation. This is incremental reconciliation.
By default, all target system records that are added or modified after the last reconciliation run are reconciled during the current reconciliation run. You can customize this process by specifying the subset of added or modified target system records that must be reconciled. You do this by creating a reconciliation filter.
For this connector, you create a filter by specifying a value for the UserNameFilter scheduled task attribute, which will be used in the query SELECT criteria to retrieve the records to be reconciled. For example, if you specify the value JDoe for this attribute, then all target system user records with the user name JDoe are reconciled.
During a reconciliation run, all changes in the target system records are reconciled into Oracle Identity Manager. Depending on the number of records to be reconciled, this process may require a large amount of time. In addition, if the connection breaks during reconciliation, then the process would take longer to complete.
You can configure batched reconciliation to avoid these problems.
To configure batched reconciliation, you must specify values for the following user reconciliation scheduled task attributes:
BatchSize: Use this attribute to specify the number of records that must be included in each batch. The default value is 1000.
NumberOfBatches: Use this attribute to specify the total number of batches that must be reconciled. The default value is All.
If you specify a value other than All, then some of the newly added or modified user records may not get reconciled during the current reconciliation run. The following example illustrates this:
Suppose you specify the following values while configuring the scheduled tasks:
BatchSize: 20
NumberOfBatches: 10
Suppose that 314 user records were created or modified after the last reconciliation run. Of these 314 records, only 200 records would be reconciled during the current reconciliation run. The remaining 114 records would be reconciled during the next reconciliation run.
You specify values for the BatchSize and NumberOfBatches attributes by following the instructions described in Section 3.4, "Configuring Scheduled Tasks."
When you run the Connector Installer or import the connector XML file, the following reconciliation scheduled tasks are automatically created in Oracle Identity Manager:
SSH User Trusted Source Reconciliation Task
This scheduled task is used to reconcile user data in the trusted source (identity management) mode of the connector.
SSH User Target Resource Reconciliation Task
This scheduled task is used to reconcile user data in the target resource (account management) mode of the connector.
Table 3-2 describes the attributes of both scheduled tasks. See Section 3.4, "Configuring Scheduled Tasks" for information about configuring scheduled tasks.
Table 3-2 Attributes of the User Reconciliation Scheduled Tasks
| Attribute | Description |
|---|---|
|
Server |
If the parameter IsRoRecon is set to If the parameter IsRoRecon is set to Yes, then enter the name of the Server type under the IT Resource type definition for the RO which you want to reconcile user records. |
|
IsTrusted |
A value of A value of The default value of this attribute in the SSH User Target Resource Reconciliation Task scheduled task is The default value of this attribute in the SSH User Trusted Source Reconciliation Task scheduled task is Note: It is recommended that you do not change the value of this attribute. |
|
Target System Recon - Resource Object name |
Enter the name of the resource object against which target resource reconciliation runs must be performed. Default value: |
|
Trusted Source Recon - Resource Object name |
Enter the name of the resource object against which trusted source reconciliation runs must be performed. Default value: Note: Enter |
|
BatchSize |
Enter the number of records that must be included in each batch fetched from the target system. If you do not want to implement batched reconciliation, then specify Default value: See Also: Section 3.3.3, "Batched Reconciliation" |
|
NoOfBatches |
This attribute specifies the number of batches to be reconciled. Enter Enter an integer value if you want to reconcile only a fixed number of batches. Default value: Sample value: The number of records in each batch is specified by the BatchSize attribute. See Also: Section 3.3.3, "Batched Reconciliation" |
|
UserNameFilter |
This is a filter attribute. Use this attribute to specify the user name (User Login) for which you want to reconcile user records. If you do not want to use this filter attribute, then specify Default value: See Also: Section 3.3.2, "Limited Reconciliation" |
|
TransformLookupName |
Enter This attribute is valid only when the UseTransformMapping attribute is set to Note: You must not change the value of this attribute. See Section 4.4, "Transforming Data Reconciled Into Oracle Identity Manager" for detailed information about using the TransformLookupName attribute. |
|
UseTransformMapping |
Enter The default value is See Section 4.4, "Transforming Data Reconciled Into Oracle Identity Manager" for detailed information about using the UseTransformMapping attribute. |
|
IsRoRecon |
A value of A value of The default value of this attribute in the SSH User Target Resource Reconciliation Task scheduled task is |
You can apply this procedure to configure the scheduled tasks for lookup field synchronization and reconciliation.
Table 3-3 lists the scheduled tasks that form part of the connector.
Table 3-3 Scheduled Tasks for Lookup Field Synchronization and Reconciliation
| Scheduled Task | Description |
|---|---|
|
TelnetSSHGroupLookupReconTask |
This scheduled task is used to synchronize the values of group lookup fields between Oracle Identity Manager and the target system. See Section 3.2, "Scheduled Task for Lookup Field Synchronization" for information about this scheduled task. |
|
SSH User Trusted Source Reconciliation Task |
This scheduled task is used for reconciling user data when the target system is configured as a trusted source. See Section 3.3.4, "Reconciliation Scheduled Tasks" for information about this scheduled task. |
|
SSH User Target Resource Reconciliation Task |
This scheduled task is used for reconciling user data when the target system is configured as a target resource. See Section 3.3.4, "Reconciliation Scheduled Tasks" for information about this scheduled task. |
Depending on the Oracle Identity Manager release that you are using, perform the procedure described in the following sections:
To configure a scheduled task:
Log in to the Administrative and User Console.
Perform one of the following:
If you are using Oracle Identity Manager release 9.1.0.x, expand Resource Management, and then click Manage Scheduled Task.
If you are using Oracle Identity Manager release 11.1.1, then on the Welcome to Oracle Identity Manager Self Service page, click Advanced in the upper-right corner of the page.
Search for and open the scheduled task as follows:
If you are using Oracle Identity Manager release 9.1.0.x, then:
On the Scheduled Task Management page, enter the name of the scheduled task as the search criteria and then click Search.
In the search results table, click the edit icon in the Edit column for the scheduled task.
On the Scheduled Task Details page where the details of the scheduled task that you selected is displayed, click Edit.
If you are using Oracle Identity Manager release 11.1.1, then:
On the Welcome to Oracle Identity Manager Advanced Administration page, in the System Management region, click Search Scheduled Jobs.
On the left pane, in the Search field, enter the name of the scheduled job as the search criterion. Alternatively, you can click Advanced Search and specify the search criterion.
In the search results table on the left pane, click the scheduled job in the Job Name column.
Modify the details of the scheduled task. To do so:
If you are using Oracle Identity Manager release 9.1.0.x, then on the Edit Scheduled Task Details page, modify the following parameters, and then click Continue:
Status: Specify whether you want to leave the task in the enabled state. In the enabled state, the task is ready for use.
Max Retries: Enter an integer value in this 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. The default value is 1.
Next Start: Use the date editor to specify the date when you want the task to run. After you select a date value in the date editor, you can modify the time value that is automatically displayed in the Next Start field.
Frequency: Specify the frequency at which you want the task to run.
If you are using Oracle Identity Manager release 11.1.1, then on the Job Details tab, you can modify the following parameters:
Retries: Enter an integer value in this field. This number represents the number of times the scheduler tries to start the job before assigning the Stopped status to the job.
Schedule Type: Depending on the frequency at which you want the job to run, select the appropriate schedule type.
Note:
See Oracle Fusion Middleware System Administrator's Guide for Oracle Identity Manager for detailed information about schedule types.
In addition to modifying the job details, you can enable or disable a job.
Specify values for the attributes of the scheduled task. To do so:
Note:
Attribute values are predefined in the connector XML file that you import. Specify values only for those attributes that you want to change.
Attributes of the scheduled task are discussed in Section 3.3.4, "Reconciliation Scheduled Tasks."
If you are using Oracle Identity Manager release 9.1.0.x, then on the Attributes page, select the attribute from the Attribute list, specify a value in the field provided, and then click Update.
If you are using Oracle Identity Manager release 11.1.1, then on the Job Details tab, in the Parameters region, specify values for the attributes of the scheduled task.
After specifying the attributes, perform one of the following:
If you are using Oracle Identity Manager release 9.1.0.x, then click Save Changes to save the changes.
Note:
The Stop Execution option is not available in the Administrative and User Console. If you want to stop a task, then click Stop Execution on the Task Scheduler form of the Design Console.
If you are using Oracle Identity Manager release 11.1.1, then click Apply to save the changes.
Note:
The Stop Execution option is available in the Administrative and User Console. You can use the Scheduler Status page to either start, stop, or reinitialize the scheduler.
Apply the following guidelines while performing provisioning operations:
When you perform the Disable User provisioning operation, the connector disables a user account by prefixing the value in the password field of the shadow file with two exclamation points (!!). When you perform the Enable User provisioning operation, the connector enables a user account by removing the two exclamation points (!!) that were prefixed to the value in the password field. After the user account is enabled, to log in to the target system, the user can use the password that was last used before the user account was disabled.
Therefore, to ensure that the user uses a new password after the account is enabled, you must perform the Set Password provisioning operation before you perform the Enable User provisioning operation.
The Set Password provisioning operation resets the password of a target system user account.
If the Set Password provisioning operation is performed on a user account that has been disabled, then the account is automatically reenabled. This is because information on whether a user account is disabled is stored in the password field of the shadow file. Therefore, when you perform the Set Password provisioning operation, the value in the password field is reset, which causes information on whether or not a user account is disabled to be lost.
While performing a Create User provisioning operation, before populating the Skeleton directory field, data must be populated in the Home Directory field and the Create Home Directory check box must also be selected.
The value in the User Login field must not contain a colon (:) or a newline (\n) character.
The value of the GECOS field must not contain a ' (single apostrophe) or . (period) character.
The group names that you specify in the Secondary Group Names field must be separated by commas, with no intervening whitespace between them.
The value in the Home Directory field must not contain spaces.
The maximum permitted date value for account expiry is 31-Dec-2099.
When you specify the secondary group name for the first time and then run the Update Secondary Group Names provisioning operation, the primary group name is assigned the same value as the secondary group name. However, after the value of the primary group name is changed, you cannot set the secondary group name to the same value.
On AIX 5.2, while performing an Update User Login provisioning operation, the GECOS field value must not contain spaces.
On HP-UX, while performing a Create User provisioning operation, the Inactive Days field must be populated only when the UNIX server is configured in trusted mode.
On Solaris, the value of the Secondary Group Names field in the User Defined process form must always be different from the value of the Primary Group Name field.
On Solaris, while performing a Create User provisioning operation, the value in the Secondary Group Names field must be different from the value in the Primary Group Name field.
Provisioning a resource for an OIM User involves using Oracle Identity Manager to create a target system account for the user.
When you install the connector on Oracle Identity Manager release 11.1.1, the direct provisioning feature is automatically enabled. This means that the process form is enabled when you install the connector.
If you have configured the connector for request-based provisioning, then the process form is suppressed and the object form is displayed. In other words, direct provisioning is disabled when you configure the connector for request-based provisioning. If you want to revert to direct provisioning, then perform the steps described in Section 3.7, "Switching Between Request-Based Provisioning and Direct Provisioning on Oracle Identity Manager Release 11.1.1."
The following are types of provisioning operations:
See Also:
Oracle Identity Manager Connector Concepts for information about the types of provisioning
This section discusses the following topics:
To provision a resource by using the direct provisioning approach:
Log in to the Administrative and User Console.
If you want to first create an OIM User and then provision a target system account, then:
If you are using Oracle Identity Manager release 9.1.0.x, then:
From the Users menu, select Create.
On the Create User page, enter values for the OIM User fields and then click Create User.
If you are using Oracle Identity Manager release 11.1.1, then:
On the Welcome to Identity Administration page, in the Users region, click Create User.
On the Create User page, enter values for the OIM User fields, and then click Save.
If you want to provision a target system account to an existing OIM User, then:
If you are using Oracle Identity Manager release 9.1.0.x, then:
From the Users menu, select Manage.
Search for the OIM User and select the link for the user from the list of users displayed in the search results.
If you are using Oracle Identity Manager release 11.1.1, then:
On the Welcome to Identity Administration page, search for the OIM User by selecting Users from the list on the left pane.
From the list of users displayed in the search results, select the OIM User. The user details page is displayed on the right pane.
Depending on the Oracle Identity Manager release you are using, perform one of the following steps:
If you are using Oracle Identity Manager release 9.1.0.x, then:
On the User Detail page, select Resource Profile from the list at the top of the page.
On the Resource Profile page, click Provision New Resource.
If you are using Oracle Identity Manager release 11.1.1, then:
On the user details page, click the Resources tab.
From the Action menu, select Add Resource. Alternatively, you can click the add resource icon with the plus (+) sign. The Provision Resource to User page is displayed in a new window.
On the Step 1: Select a Resource page, select SSH User from the list and then click Continue.
On the Step 2: Verify Resource Selection page, click Continue.
On the Step 5: Provide Process Data for SSH User Details page, enter the details of the account that you want to create on the target system and then click Continue.
On the Step 6: Verify Process Data page, verify the data that you have provided and then click Continue.
The "Provisioning has been initiated" message is displayed. Perform one of the following steps:
If you are using Oracle Identity Manager release 9.1.0.x, click Back to User Resource Profile. The Resource Profile page shows that the resource has been provisioned to the user.
If you are using Oracle Identity Manager release 11.1.1, then:
Close the window displaying the "Provisioning has been initiated" message.
On the Resources tab, click Refresh to view the newly provisioned resource.
Note:
The information provided in this section is applicable only if you are using Oracle Identity Manager release 11.1.1.
A request-based provisioning operation involves both end users and approvers. Typically, these approvers are in the management chain of the requesters. The following sections discuss the steps to be performed by end users and approvers during a request-based provisioning operation:
Note:
The procedures described in these sections are built on an example in which the end user raises or creates a request for provisioning a target system account. This request is then approved by the approver.
Section 3.6.2.1, "End User's Role in Request-Based Provisioning"
Section 3.6.2.2, "Approver's Role in Request-Based Provisioning"
The following steps are performed by the end user in a request-based provisioning operation:
See Also:
Oracle Fusion Middleware User's Guide for Oracle Identity Manager for detailed information about these steps
Log in to the Administrative and User Console.
On the Welcome page, click Advanced in the upper-right corner of the page.
On the Welcome to Identity Administration page, click the Administration tab, and then click the Requests tab.
From the Actions menu on the left pane, select Create Request.
The Select Request Template page is displayed.
From the Request Template list, select Provision Resource and click Next.
On the Select Users page, specify a search criterion in the fields to search for the user that you want to provision the resource, and then click Search. A list of users that match the search criterion you specify is displayed in the Available Users list.
From the Available Users list, select the user to whom you want to provision the account..
If you want to create a provisioning request for more than one user, then from the Available Users list, select users to whom you want to provision the account.
Click Move or Move All to include your selection in the Selected Users list, and then click Next.
On the Select Resources page, click the arrow button next to the Resource Name field to display the list of all available resources.
From the Available Resources list, select SSH User, move it to the Selected Resources list, and then click Next.
On the Resource Details page, enter details of the account that must be created on the target system, and then click Next.
On the Justification page, you can specify values for the following fields, and then click Finish.
Effective Date
Justification
On the resulting page, a message confirming that your request has been sent successfully is displayed along with the Request ID.
If you click the request ID, then the Request Details page is displayed.
To view details of the approval, on the Request Details page, click the Request History tab.
The following are steps performed by the approver in a request-based provisioning operation:
The following are steps that the approver can perform:
Log in to the Administrative and User Console.
On the Welcome page, click Self-Service in the upper-right corner of the page.
On the Welcome to Identity Manager Self Service page, click the Tasks tab.
On the Approvals tab, in the first section, you can specify a search criterion for request task that is assigned to you.
From the search results table, select the row containing the request you want to approve, and then click Approve Task.
A message confirming that the task was approved is displayed.
Note:
It is assumed that you have performed the procedure described in Section 2.5.5, "Configuring Oracle Identity Manager for Request-Based Provisioning."
On Oracle Identity Manager release 11.1.1, if you want to switch from request-based provisioning to direct provisioning, then:
Log in to the Design Console.
Disable the Auto Save Form feature as follows:
Expand Process Management, and then double-click Process Definition.
Search for and open the SSH User process definition.
Deselect the Auto Save Form check box.
Click the Save icon.
If the Self Request Allowed feature is enabled, then:
Expand Resource Management, and then double-click Resource Objects.
Search for and open the SSH User resource object.
Deselect the Self Request Allowed check box.
Click the Save icon.
On Oracle Identity Manager release 11.1.1, if you want to switch from direct provisioning back to request-based provisioning, then:
Log in to the Design Console.
Enable the Auto Save Form feature as follows:
Expand Process Management, and then double-click Process Definition.
Search for and open the SSH User process definition.
Select the Auto Save Form check box.
Click the Save icon.
If you want to enable end users to raise requests for themselves, then:
Expand Resource Management, and then double-click Resource Objects.
Search for and open the SSH User resource object.
Select the Self Request Allowed check box.
Click the Save icon.