Skip Headers
Oracle® Fusion Middleware Installation Guide for Oracle Unified Directory
11g Release 2 (11.1.2)

Part Number E23737-05
Go to Documentation Home
Home
Go to Table of Contents
Contents
Go to Feedback page
Contact Us

Go to previous page
Previous
Go to next page
Next
PDF · Mobi · ePub

5 Setting Up the Replication Gateway

The replication gateway enables replication between Oracle Directory Server Enterprise Edition and Oracle Unified Directory. Its main purpose is to facilitate migration from an Oracle Directory Server Enterprise Edition deployment.

You can set up the replication gateway in two ways:

Note:

The command-line setup is complex and is recommended for scripting purposes only. It is preferable to set up the replication gateway by using the GUI.

This chapter covers the following topics:

5.1 Before You Set Up the Gateway

Before you set up a replication gateway instance, the following must be in place:

5.2 Setting Up the Replication Gateway by Using the GUI

The following procedure walks you through setting up a replication gateway server instance by using the graphical user interface.

  1. When you have installed the software, change to the OUD_ORACLE_HOME subdirectory.

    (UNIX, Linux)  $ cd OUD-base-location/OUD_ORACLE_HOME
    (Windows)      C:\> cd OUD-base-location\OUD_ORACLE_HOME
    
  2. Ensure that your JAVA_HOME environment variable is set to a supported JVM installation (at least Java 1.6).

  3. Run the oud-replication-gateway-setup command to configure the replication gateway installation.

    (UNIX, Linux)  $ oud-replication-gateway-setup
    (Windows)      C:\> oud-replication-gateway-setup.bat
    

    The utility launches the graphical installer and creates the replication gateway instance in OUD-base-location/instance-dir.

    The default instance directory name is asinst_1, with subsequent instances on the same server named asinst_2, asinst_3, and so on. To specify a different instance name, set the INSTANCE_NAME environment variable before you run the setup, for example:

    $ export INSTANCE_NAME=my-oud-instance
    
  4. On the Welcome screen, click Next.

    A confirmation message is displayed, requesting you to confirm that you have configured the Oracle Unified Directory directory servers to coexist with Oracle Directory Server Enterprise Edition servers in a replicated topology. If you have done this, click Yes. If you have not, click No, exit the installer, and run the ds2oud command to perform the required configuration before you install the replication gateway. For more information, see "Replicating Between Oracle Directory Server Enterprise Edition and Oracle Unified Directory" in the Administration Guide for Oracle Unified Directory.

    The Replication Gateway Administration screen is displayed.

  5. Enter the following information:

    Click Next.

    The ODSEE Server Settings screen is displayed.

  6. Enter the following information:

    • Host Name: Enter the ODSEE directory server's host name or IP address.

      The default is the local host name.

    • Port: Enter the LDAP port for the ODSEE directory server.

    • Bind DN: Enter the Bind DN that will be used to access the Oracle Directory Server Enterprise Edition server, or keep the default, cn=Directory Manager.

    • Password: Enter the bind password.

    • If the Oracle Unified Directory servers are read-only servers, uncheck the first check box. Otherwise, leave it checked.

    • To secure the traffic between the gateway and the Oracle Directory Server Enterprise Edition server:

      1. Check the Use SSL between ODSEE and Replication Gateway checkbox.

      2. Ensure that the Port specified in step b is the secure port of the Oracle Directory Server Enterprise Edition server.

      3. Check the Use Client Authentication checkbox and click Change to configure the certificate.

    Click Next.

    The Review Replication Setting screen is displayed.

  7. Review the ODSEE replication setup and click Next.

    The Port for ODSEE Replication screen is displayed.

  8. Enter the port on the replication gateway instance that will be used for Oracle Directory Server Enterprise Edition replication updates.

  9. Click Next.

    The Oracle Unified Directory Server Settings screen is displayed.

  10. Enter the following information:

    • Host Name: Enter the directory server's host name or IP address.

      The default is the local host name.

    • Administration Connector Port: Enter the port that is used for administration traffic.

      The default administration port is 4444. For more information, see Managing Administration Traffic to the Server in Oracle Fusion Middleware Administrator's Guide for Oracle Unified Directory.

    • Global Administrator User ID: Enter the name of the global administrator that has been defined to manage replication on the Oracle Unified Directory instance.

      If no global administrator has been defined, enter the root user bind DN.

    • Enter the password of the Global Administrator.

    Click Next.

  11. Accept the certificates.

  12. If the Oracle Unified Directory server was not previously configured for replication, perform the following steps:

    • Enter the replication port number for this directory server.

    • Provide a UID and password for the new global administrator.

  13. Review the replication settings and click Next.

    The Replicated Base DNs screen is displayed.

  14. Select the suffixes that will be replicated between the Oracle Directory Server Enterprise Edition servers and the Oracle Unified Directory servers.

  15. On the Review screen, verify the final topology and click Finish to complete the installation.

    The Show Summary menu item in the drop down list displays a textual summary of the resulting topology.

    The Show Topology menu item displays a graphical summary of the topology, and can be useful for obtaining a physical idea of the resulting topology.

    The Show Equivalent Command Line menu item displays all of the commands that are executed in configuring the replication gateway. This item also provides information about the next steps that are required to start replication between the two servers. For more information, see Replicating Between Oracle Directory Server Enterprise Edition and Oracle Unified Directory in Oracle Fusion Middleware Administrator's Guide for Oracle Unified Directory.

  16. Click Finish to complete the setup.

5.3 Setting Up the Replication Gateway By Using the CLI

To set up the replication gateway on the command line, type the following command:

$ oud-replication-gateway-setup --cli

In interactive command-line mode, you are prompted to provide the required configuration details, for example:

$ oud-replication-gateway-setup --cli
OUD Instance location successfully created - /local/OUD_BASE/Oracle_OUD1/../asinst_4
The migration utility ds2oud must be run to configure the OUD servers before
setting up the replication gateway.
If you have executed ds2oud type 'yes' to continue, type 'no' otherwise. (yes
/ no) [yes]: yes
 
Oracle Unified Directory 11.1.2.1.0
Please wait while the replication gateway setup program initializes ..... Done.
 
====================================================================
Replication gateway administration settings
====================================================================
 
You must provide the fully-qualified name of the host where the replication
gateway will be installed.  The ODSEE server and Oracle Unified Directory
servers in the replication topology must be able to access this host name
[server1]:
 
What would you like to use as the initial root user DN for the replication
gateway? [cn=Directory Manager]:

To facilitate scripting, you can also set up the replication gateway in non-interactive mode, by using the --no-prompt option. The following example shows a typical replication gateway setup in non-interactive mode:

$ oud-replication-gateway-setup --cli --hostname localhost \
  --adminConnectorPort 4444 --replicationPortForLegacy 2389 \
  --rootUserDN "cn=Directory Manager" --rootUserPasswordFile pwd-file \
  --baseDN dc=example,dc=com --hostNameLegacy ODSEE-host \
  --portLegacy 1389 --doNotUpdateTrustStoreWithLegacyCertsArg \
  --bindDNLegacy "cn=Directory Manager" --bindPasswordLegacyFile pwd-file \
  --hostNameNg OUD-host --portNg 4444 --adminUID admin \
  --adminPasswordFile pwd-file --trustAll --no-prompt --noPropertiesFile

For detailed information about all of the command-line options, see "oud-replication-gateway-setup" in the Oracle Fusion Middleware Administrator's Guide for Oracle Unified Directory.

5.4 Verifying the Replication Gateway Setup

To verify that the replication gateway has been set up and is working correctly, add an entry on the Oracle Unified Directory server. Verify that the newly added entry has been successfully replicated to the Oracle Directory Server Enterprise Edition server.

The following example adds a user entry on the Oracle Unified Directory server:

$ ldapmodify -a -h oud-host -p 1389 -D "cn=directory manager" -j pwd-file 
dn: uid=bjensen,ou=People,dc=example,dc=com 
objectclass: top 
objectclass: person 
objectclass: organizationalPerson 
objectclass: inetorgPerson 
uid: bjensen 
givenName: Barbara 
sn: Jensen 
cn: Babs Jensen 
telephoneNumber: (408) 555-3922 
facsimileTelephoneNumber: (408) 555-4000 
mail: bjensen@example.com 
userPassword: secret 
 
Processing ADD request for uid=bjensen,ou=People,dc=example,dc=com
ADD operation successful for DN uid=bjensen,ou=People,dc=example,dc=com

The following example searches for that user entry on the Oracle Directory Server Enterprise Edition server:

$ ldapsearch -h odsee-host -p 1389 -D "cn=directory manager" -j pwd-file -b "ou=people,dc=example,dc=com" ("uid=bjensen")

version: 1
dn: uid=bjensen, ou=People, dc=example,dc=com
cn: Barbara Jensen
cn: Babs Jensen
sn: Jensen
givenName: Barbara
objectClass: top
objectClass: person
objectClass: organizationalPerson
objectClass: inetOrgPerson
ou: Product Development
ou: People
l: Cupertino
uid: bjensen
mail: bjensen@example.com
telephoneNumber: +1 408 555 1862
facsimileTelephoneNumber: +1 408 555 1992
roomNumber: 0209
userPassword: {SSHA}rDLnCHlFRhyAcBM7GZpby0MrwfxzTlIEdG7WYA==