Skip Headers
Oracle® Fusion Middleware Installation Guide for Oracle Directory Server Enterprise Edition
11g Release 1 (11.1.1.7.0)

Part Number E28973-01
Go to Documentation Home
Home
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
PDF · Mobi · ePub

2 Installing Directory Server Enterprise Edition

This chapter includes the following topics:

2.1 Installing Directory Server Enterprise Edition

To install ODSEE, complete the steps described in each of the following sections:

  1. Complete Pre-Installation Tasks

  2. Download and Unzip the ODSEE Zip Distribution File

  3. Set Up the Administration (DSCC) Host

  4. Set Up a DSCC Agent on the Directory Server or Directory Proxy Server Host

  5. Save Useful Information for Your Records

2.1.1 Complete Pre-Installation Tasks

Review the following notes to determine if you have additional pre-installation tasks to complete:

2.1.2 Download and Unzip the ODSEE Zip Distribution File

After you download the zip distribution file, the zip file is in your download target directory. The zip file contains the Directory Server Enterprise Edition software, idsktune, the Identity Synchronization for Windows software, and the relevant legal files.

You can install the zip distribution as a non-root user.

  1. Download the Directory Server Enterprise Edition zip distribution binaries.

    For the latest information on download filenames and locations, see Getting the Software in the Release Notes for Oracle Directory Server Enterprise Edition.

  2. Unzip the zip distribution file.

    In this example, download-dir is the download target directory, and install-dir is the installation target directory.

    # cd /download-dir
    # unzip -q ODSEE11_1_1_7_0_xxx.zip
    # cd ODSEE_ZIP_Distribution
    # unzip -q sun-dsee7.zip -d install-dir
    # cd install-dir/dsee7
    

    The install-dir directory is where all the software elements are placed. A minimum of 1 GByte of space is required in this directory.

    The install-dir/dsee7 directory contains all of the Directory Server Enterprise Edition components, with the exception of the idsktune utility. The idsktune utility is located in /download-dir/ODSEE_ZIP_Distribution. For the remainder of this guide, /install-dir/dsee7 is referred to as the install-path.

2.1.3 Set Up the Administration (DSCC) Host

The Directory Service Control Center (DSCC) is a web-based interface to manage Directory Server and Directory Proxy Server instances. Set up the DSCC on the computer system that you choose as the administration host.

  1. Initialize the DSCC registry.

    $ install-path/bin/dsccsetup ads-create
    Choose password for Directory Service Manager:directory-service-pwd
    Confirm password for Directory Service Manager:directory-service-pwd
    
    Creating DSCC registry...
    DSCC Registry has been created successfully
    

    The value that you provide for directory-service-pwd, will be needed to authenticate the DSCC login page and is also used as a DSCC registry password.

    DSCC uses its own local instance of Directory Server to store information about your directory service configuration. The instance is referred to as the DSCC Registry.

  2. Create the WAR file for DSCC.

    $ install-path/bin/dsccsetup war-file-create
    
    Created dscc-war-file-path
    

    Make a note of the dscc-war-file-path, which is the path of the DSCC war file.

  3. Note the port and the path assigned to DSCC registry.

    # install-path/bin/dsccsetup status
    ...
    Path of DSCC registry is dscc-registry-path
    Port of DSCC registry is dscc-registry-port
    ...
    

    The dscc-registry-port is the port assigned to the DSCC registry by dsccsetup ads-create. The default port that is assigned to the DSCC registry is 3998.

  4. To create server instances on the same host on which DSCC is deployed, add the DSCC agent to the DSCC registry.

    1. Create a DSCC agent.

      $ install-path/bin/dsccagent create
      Enter DSCC agent password: ***
      Confirm the password: ***
      Agent instance install-path/var/dcc/agent has been created successfully
      Run the following command to register the agent in the registry: install-path/bin/dsccreg add-agent install-path/var/dcc/agent
      
    2. Add the new DSCC agent to the DSCC registry.

      Use the command displayed at the completion of the previous step. For example:

      $ install-path/bin/dsccreg add-agent install-path/var/dcc/agent
      
    3. Start the DSCC agent.

      $ install-path/bin/dsccagent start
      The agent install-path/var/dcc/agent has been started
      
  5. Configure all Directory Server instances you want to monitor through SNMP. For detailed information, see "Chapter 14, Directory Server Monitoring" in the Administrator's Guide for Oracle Directory Server Enterprise Edition."

    Run the following command to obtain the DS port number for an instance you want to monitor through SNMP:

    # install-path/bin/dsccagent info
    Instance Path         :   install-dir/dsee7/var/dcc/agent
    Owner                 :   root
    JMX port              :   3997
    SNMP port             :   3996
    DS port               :   3995
    State                 :   Stopped
    PID                   :   -
    DSCC hostname         :   host2
    DSCC non-secure port  :   3998
    DSCC secure port      :   3999
    SNMP v3               :   Disabled
    Instance version      :   A-A00 
    

    Run the following command using the DS port number obtained in the previous step to set the port number argument:

    # install-path/bin/dsconf set-plugin-prop dssnmp argument:on argument:3995
    
  6. Deploy the DSCC WAR file on a supported application server.

    See Appendix A, "To Deploy the DSCC WAR File With Oracle iPlanet Web Server" for important information about supported application servers and minimum system and software requirements. Complete the steps in any of the following sections that apply to your application server or servers:

  7. Verify that the DSCC setup is working properly.

    Type the following command to check the location and other statistics of your WAR file and DSCC registry:

    $ install-path/bin/dsccsetup status
    

2.1.4 Set Up a DSCC Agent on the Directory Server or Directory Proxy Server Host

Create a DSCC agent and add it to the DSCC registry. You must do this for each Directory Server host or Directory Proxy Server host in your topology.

  1. Create a DSCC agent.

    # install-path/bin/dsccagent create
    Enter DSCC agent password: ***
    Confirm the password: ***
    Agent instance install-path/var/dcc/agent has been created successfully
    Run the following command to register the agent in the registry: install-path/bin/dsccreg add-agent install-path/var/dcc/agent
    
  2. Add the new DSCC agent to the DSCC registry.

    # install-path/bin/dsccreg add-agent -h dscc-host -p dscc-registry-port install-path/var/dcc/agent
    
  3. Start the DSCC agent.

    # install-path/bin/dsccagent start
    The agent install-path/var/dcc/agent has been started
    
  4. Create an SNMP agent, and configure Directory Server instances to use the SNMP agent. For detailed information, see "Chapter 14, Directory Server Monitoring" in the Administrator's Guide for Oracle Directory Server Enterprise Edition."

    1. Create the SNMP agent.

      # install-path/bin/dsccagent enable-snmp 
      
    2. Configure all Directory Server instances you want to monitor through SNMP.

      Run the following command to obtain the DS port number for an instance you want to monitor through SNMP:

      # install-path/bin/dsccagent info
      Instance Path         :   install-dir/dsee7/var/dcc/agent
      Owner                 :   root
      JMX port              :   3997
      SNMP port             :   3996
      DS port               :   3995
      State                 :   Stopped
      PID                   :   -
      DSCC hostname         :   host2
      DSCC non-secure port  :   3998
      DSCC secure port      :   3999
      SNMP v3               :   Disabled
      Instance version      :   A-A00 
      

      Run the following command using the DS port number obtained in the previous step to set the port number argument:

      # install-patch/bin/set-plugin-prop dssnmp argument:on argument:3995
      

2.1.5 Save Useful Information for Your Records

You must make a note of the following information that is gathered during the pre-configuration operation.

Information Description Comments

install-path

Path under which Directory Server Enterprise Edition 11g Release 1 (11.1.1.7.0) is installed.

 

directory-service-pwd

Password assigned to the Directory Service Manager.

 

dscc-war-file-path

Path of the DSCC WAR file that is to be deployed in your application server.

install-path/var/dscc7.war

dscc-registry-path

Path of the DSCC Registry

install-path/var/dcc/ads

dscc-registry-port

Port of the DSCC Registry

3998 or random. The DSCC Registry port can be retrieved by typing the following command:

install-path/bin/dsccsetup status

dscc-agent-port

Port of the DSCC Agent

3997 or random. The DSCC agent port can be retrieved by typing the following command:

install-path/bin/dsccagent info

2.2 Checking Your Directory Server Enterprise Edition Installation

When you have successfully installed and pre-configured the Directory Server Enterprise Edition software, you can check your installation by creating server instances and working with them.

This section covers the following topics:

2.2.1 Creating Server Instances From Command Line

The following set of commands create a sample server instance, populates it with example data and registers it with DSCC. These commands should execute without any error if software is correctly installed and configured.

2.2.1.1 To Create a Directory Server Instance From the Command Line

Non-root users can create server instances.

Refer to the following procedure to create a Directory Server instance using the command line:

  1. Create a new Directory Server instance.

    In the following example, default port numbers are specified. But you can specify other port numbers to suit your needs.

    $ dsadm create -p 1389 -P 1636 /local/dsInst
    
    Choose the Directory Manager password:xxxxxxxx
    Confirm the Directory Manager password:xxxxxxxx
    Use 'dsadm start /local/dsInst' to start the instance
    

    The dsInst instance is created under the existing directory, /local/ and xxxxxxxx is assigned as the Directory Manager password.

  2. Start the instance.

    $ dsadm start /local/dsInst
    Server started: pid=2845
    
  3. Prepare an example suffix.

    1. Create an empty suffix.

      $ dsconf create-suffix -p 1389 -e dc=example,dc=com
      Enter "cn=Directory Manager" password:xxxxxxxx
      

      A suffix with root dc=example,dc=com is created.

    2. Populate the suffix with LDIF data.

      $ dsconf import -p 1389 -e\
      install-path/resources/ldif/Example.ldif dc=example,dc=com
      
      Enter "cn=Directory Manager" password:
      
      New data will override existing data of the suffix "dc=example,dc=com".
      Initialization will have to be performed on replicated suffixes.
      
      ...
      ...
      ## Closing files...
      ## Import complete.  Processed 160 entries in 4 seconds. (40.00 entries/sec)
      
      Task completed (slapd exit code: 0).
      

      The suffix is populated with sample data from Example.ldif.

    3. Search for data in the new instance.

      $ ldapsearch -p 1389 -b dc=example,dc=com "(uid=ajensen)" mail
      
      version: 1
      dn: uid=ajensen, ou=People, dc=example,dc=com
      mail: ajensen@example.com
      
  4. Manage your server instance using DSCC.

    The following steps assume the following:

    • DSCC is installed on dscc-host.

    • A DSCC agent is created on the local host and registered in the DSCC registry.

    1. Register the server instance with DSCC:

      $ dsccreg add-server /local/dsInst/host2
       
      Enter DSCC administrator's password: directory-service-pwd
      /local/dsInst2/host2 is an instance of DS
       
      Agent No    Hostname Port Owner    iPath
      --------    -------- ---- -------- --------------------------------
      0           host2    1636 ajensen  install-path/var/dcc/agent
       
      The registration will use DSCC agent on port: 1389
      Enter password of "cn=Directory Manager" for /local/dsInst/host1: xxxxxxxx
      This operation will restart /local/dsInst/host1.
      Do you want to continue ? (y/n) y
      Starting /local/dsInst/host1
      Connecting to /local/dsInst/host1 (using ldap://127.0.0.1:1389)
      Enabling DSCC access to /local/dsInst/host1
      Restarting /local/dsInst/host1
      Registering /local/dsInst/host1 in DSCC on dscc-host.
      
    2. List the servers and agents that are currently registered into DSCC.

      Description of listservers.png follows
      Description of the illustration listservers.png

  5. If you need to use the installation for production and want to clean the system, type the following commands:

    # dsccreg remove-server -h dscc-host -p dscc-registry-port /local/dsInst
    # dsadm delete /local/dsInst
    

Next Steps

You can add more suffixes, configure replication with other server instances, tune the instance, and generally proceed with other configuration operations.

See Part I, Directory Server Administration, in Administrator's Guide for Oracle Directory Server Enterprise Edition for instructions on configuring Directory Server with command-line administration tools.

For information about creating Directory Proxy Server instances using the command line, see Chapter 17, Directory Proxy Server Instances, in Administrator's Guide for Oracle Directory Server Enterprise Edition.

2.2.2 Creating Server Instances Using Directory Service Control Center

Before You Begin: The DSCC must already be deployed on a supported application server. See Appendix A, "Deploying the DSCC WAR File."

2.2.2.1 To Create Server Instances with Directory Service Control Center

Non-root users can create server instances.

Refer to the following procedure to create server instances using DSCC.

  1. Access DSCC by using http://dscc-host:port/dscc7.

    Use http://dscc-host:port/dscc7 or https://dscc-host:port/dscc7 to access DSCC, where dscc-port is determined by your application server configuration.

  2. Log in to DSCC as Directory Service Manager.

    Directory Service Manager's entry is stored in the DSCC registry. Directory Service Manager also has administrator access to the server instances registered with DSCC.

    1. Type the following values:

      *  Directory Server Manager: admin
          * Password: directory-service-pwd
      
    2. Click the Log In button.

  3. Under the Directory Servers tab, click New Server.

    The Directory Service Control Center New Directory Server wizard displays.

    Description of dscc.png follows
    Description of the illustration dscc.png

  4. Follow the instructions in the Directory Service Control Center New Directory Server wizard to create the server instance.

    Description of new-ds-wizard.png follows
    Description of the illustration new-ds-wizard.png

    While creating the new server instances, you need to provide the following information. In this example, the LDAP Port 1389 and LDAPS Port 1636 are default values. You can specify other values to suit your needs.

    * Host: server-host   # Host where DSCC agent has been configured
        * LDAP Port: 1389
        * LDAPS Port: 1636
        * Instance Path: /local/dsInst
        * Directory Manager Password: xxxxxxxx
        * Confirm Password: xxxxxxxx
        * DSCC Agent Port: dscc-agent-port
    

    Note:

    The instance path does not support non-ASCII characters.

  5. Complete the create server instance process by following the instructions provided in the graphical user interface.

  6. You can choose to delete the server instance by clicking Delete in the More Server Actions drop-down menu.

See Also

Similarly, you can create Directory Proxy Server instances using the Proxy Server tab.

For further configuration and administration of Directory Server and Directory Proxy Server instances, refer to Administrator's Guide for Oracle Directory Server Enterprise Edition.

See the online help for Directory Service Control Center for hints on configuring Directory Server and Directory Proxy Server through the graphical user interface.

2.3 Setting Environment Variables

This section lists environment variables that you can set to facilitate creating server instances and using Directory Server Resource Kit and software development kits.

Environment Variable Description Reference

DIR_PROXY_HOST

Hostname of Directory Proxy Server, used when the --hostname option is not specified.

dpconf command

DIR_PROXY_PORT

Port number of Directory Proxy Server, used when the --port and --secure-port options are not specified.

dpconf command

DIRSERV_HOST

Hostname of Directory Server, used when the --hostname option is not specified.

dsconf command

DIRSERV_PORT

Port number of Directory Server, used when the --port and --secure-port options are not specified.

dsconf command

DSCC_HOST

Hostname of the DSCC registry, used when the --hostname option is not specified.

dsccreg, dsccmon commands

DSCC_PORT

Port number of the DSCC registry, used when the --port and --secure-port options are not specified.

dsccreg, dsccmon commands

LDAP_ADMIN_PWF

Path to the file that contains a password, used when the --pwd-file option is not specified.

When server instances are registered with Directory Service Control Center, setting this variable to a file containing the Directory Service Manager password allows to manage all the server instances even if they have different Directory Manager passwords.

dpconf, dsconf, dsccreg, dsccmon commands

LDAP_ADMIN_USER

Directory administrator DN, used when the --user-dn option is not specified.

When server instances are registered with Directory Service Control Center, you may set this variable to cn=admin,cn=Administrators,cn=dscc or any other administrator DN create using DSCC.

dpconf, dsconf, dsccreg, dsccmon commands

MANPATH

install-path/resources/man/:\
$ install-path/resources/man

Online manual pages to browse with the man command

MANSECT

Add any of the following sections that are not listed in your MANSECT environment variable.

1:1m:4:5dsconf:5dpconf:5dssd:5dsat:5dsoc:5

Alternatively, specify the sections to search explicitly when using the man command.

The man command uses the MANSECT environment variable to identify the sections to search by default.

PATH

install-path/bin

Directory Server Enterprise Edition commands

Zip distribution: install-path/dsrk/bin

Directory Server Resource Kit and LDAP client commands