Sun Java System Messaging Server 6 2005Q4 Administration Guide

To Prepare Directory Server for Messaging Server Configuration

This section provides instructions on how to run the Directory Server Setup script (comm_dssetup.pl) that configures your LDAP Directory Server to work with your Messaging Server, Calendar Server, or User Management Utility configurations. The comm_dssetup.pl script prepares the Directory Server by setting up new schema, index, and configuration data in your Directory Server. It must be run for new installations of Messaging Server and Communications Express. It is also a good idea to run the latest comm_dssetup.pl if you are upgrading any of the component products that depend on Directory Server.

The following topics are explained:

Location of comm_dssetup.pl

In earlier versions of Java Enterprise System, this utility was bundled with Messaging Server and Calendar Server and did not have to be separately installed. However, starting with Java Enterprise System 2005Q1, the script is now a separately installable shared component.

To install comm_dssetup.pl, choose one of the following methods:

As installed, comm_dssetup.pl is found in the following directory:

Solaris: /opt/SUNWcomds/sbin

Linux: /opt/sun/comms/dssetup/sbin

comm_dssetup.pl Requirements

Before you run the comm_dssetup.pl script, be sure to read the following requirements:

Running the comm_dssetup.pl Script

You can either run comm_dssetup.pl in interactive or silent mode as described in the following sections:

Use the Installation Worksheets in Table E–3 to record your answers.

ProcedureTo Run comm_dssetup.pl in Interactive Mode

The following questions will be asked if you specify comm_dssetup.pl without any arguments:

Steps
  1. Introduction


    # perl comm_dssetup.pl
    
    Welcome to the Directory Server preparation tool for Java Enterprise 
    Communications Server.(Version X.X Revision X.X)
    This tool prepares your directory server for Sun Java System Messaging 
    Server install.
    
    The logfile is /var/tmp/dssetup_YYYYMMDDHHSS
    
    Do you want to continue [y]:

    Press Enter to continue. Type No to exit.

  2. Installation Root of Directory Server


    Please enter the full path to the directory where the Java 
    Enterprise Directory Server was installed.
    
    Directory server root [/var/opt/mps/serverroot]

    Indicate the location of the installation root of the Directory Server on the Directory Server machine. Note that the Directory server root location is different on Linux.

  3. Directory Server Instance


    Please select a directory server instance from the following list:
    
    [1]   slapd-varrius
    
    Which instance do you want [1]:

    If multiple instances of Directory Server reside on the machine, choose the one that will be configured with Messaging Server.

  4. Directory Manager Distinguished Name (DN)


    Please enter the directory manager DN [cn=Directory Manager]:
    
    Password:

    The Directory Manager DN (cn=Directory Manager) is the administrator who is responsible for the user and group data in the Organization Tree. Be sure that the Directory Manager DN you specify in this script is the same DN that you set up in your Directory Server installation as well as your Messaging Server installation.

  5. User and Group Directory Server


    Will this directory server be used for users/groups [Yes]:

    If you type Yes, more questions will be asked regarding the user/group tree.

    If you type No, it is assumed that this directory instance is only used to store configuration data; you will skip to the question about updating schema files. After you finish running this script against the configuration directory instance, you need to run this script against the directory instance that stores user and group data before moving on in the installation process.

  6. User and Group Base Suffix


    Please enter the Users/Groups base suffix [o=usergroup]:

    The User and Group base suffix is the top entry in the Organization Tree which holds the namespace for user and group entries. Be sure that the User and Group base suffix you select is the same as what you specified during your Directory Server installation and in your Messaging Server installation.


    Note –

    If you installed Access Manager, be sure the suffix specified in Access Manager installation is the same as what you specify for this question. If you do not use the same suffix, Messaging Server will not recognize your Access Manager installation.


    For more information on the Organization Tree, see LDAP Directory Information Tree Requirements in Sun Java System Communications Services 6 2005Q4 Deployment Planning Guide and Chapter 12, “Provisioning and Schema Concepts for Messaging Server 6.0” in the Sun Java Enterprise System 2003Q4 Installation Guide.

  7. Schema Type


    There are 3 possible schema types:
      1   - schema 1 for systems with iMS 5.x data
      1.5 - schema 2 compatibility for systems with iMS 5.x data
            that has been converted with commdirmig
      2   - schema 2 native for systems using Access Manager
    
    Please enter the Schema Type (1, 1.5, 2) [1]:

    Choose Option 1 if you are planning to use Sun LDAP Schema 1.

    Choose Option 1.5 if you plan to use Sun LDAP Schema 2, Compatibility Mode. For more information, see the Sun Java System Communications Services 6 2005Q4 Schema Migration Guide.

    Choose Option 2 if you plan to use Sun LDAP Schema 2, Native Mode.

    comm_dssetup.pl will no longer terminate if Access Manager is not installed. Instead it will warn you that Access Manager is not installed and offer to install schema 2 for you. The warning screen looks like this:


    Please enter the Schema Type (1, 1.5, 2) [1]: 2
    
    Access Manager has not been configured for this new user/group suffix
    
    You can opt to continue, but you will not be able to use features
    that depend on Access Manager
    
    Are you sure you want this schema type? [n]:

    For more information on your schema options, see Chapter 8, Understanding Schema and Provisioning Options, in Sun Java System Communications Services 6 2005Q4 Deployment Planning Guide.

  8. Domain Component (DC) Tree Base Suffix


    Please enter the DC Tree base suffix [o=internet]:

    Note –

    In Step 7, if you choose Option 1 or 1.5, you will be asked to provide your DC Tree Base Suffix. If you choose Option 2 - Sun LDAP Schema 2 - Native Mode, you will not be asked this question.


    The DC Tree mirrors the local DNS structure and is used by the system as an index to the Organization Tree that contain the user and group data entries. The DC Tree base suffix is the name of the top entry on the DC tree. You can either choose the default o=internet or another name.

    For more information on the DC Tree or the Organization Tree, see LDAP Directory Information Tree Requirements in Sun Java System Communications Services 6 2005Q4 Deployment Planning Guide and Chapter 12, “Provisioning and Schema Concepts for Messaging Server 6.0” in the Sun Java Enterprise System 2003Q4 Installation Guide.

  9. Updating Schema Files


    Do you want to update the schema files [yes]:

    If you answer Yes, new elements will be added to your schema. It is recommended that you update the Directory with the new schema files each time you install newer versions of Messaging Server.

  10. Configuring New Indexes


    Do you want to configure new indexes [yes]:

    If you answer Yes to the question of whether or not this directory server be used for users/groups (Step 5), you will be asked if you want to configure new indexes, which are used to create caches to improve efficiency of directory searches. It is recommended that you answer Yes to this question. However, there are several conditions under which you wouldn’t want to create the indexes:

    • If this is for a master user/group Directory Server that is only used to serve replicas, that is, there are no direct queries done against the user/group Directory Server.

    • If you have a production user/group Directory Server with lots of entries in which you don’t want a lot of downtime while the indexes are created.

  11. Summary of Settings


    Here is a summary of the settings that you chose:
      Server Root                        : /var/opt/mps/serverroot/
      Server Instance                    : slapd-varrius
      Users/Groups Directory             : Yes
      Update Schema                      : yes
      Schema Type                        : 1
      DC Root                            : o=internet
      User/Group Root                    : o=usergroup
      Add New Indexes                    : yes
      Directory Manager DN               : cn=Directory Manager
    
    Now ready to generate a shell script and ldif file to modify 
    the Directory.
    No changes to the Directory Server will be made this time.
    
    Do you want to continue [y]:

    A summary of your settings will be displayed before your directory configuration is updated. No changes will be made at this time.


    Note –

    In Step 7, if you choose Option 2: Sun LDAP Schema 2 - Native Mode, the DC Root in the Summary of Settings will be the same value that you entered for the User/Group Root.


    If you want to change any of your settings, enter No and run the script again.

    If you enter Yes to continue, the comm_dssetup.pl script will create an LDIF file and a shell script that will be used to update the indexes and schema in your directory server:


    /var/tmp/dssetup_YYYYMMDDHHMMSS.sh
    /var/tmp/dssetup_YYYYMMDDHHMMSS.ldif
    

    where YYYYMMDDHHMMSS indicates the time and date stamps when the files were created.


    Note –

    You can either choose to run the script now or later. If you choose to run the script now, type Yes when asked if you want to continue. If you want to run the script later, you can invoke the script by using /var/tmp/dssetup_YYYYMMDDHHMMSS.sh.


ProcedureTo Run comm_dssetup.pl in Silent Mode

Step

    To enable the silent mode, specify all the arguments at one time on a single line:


    # perl comm_dssetup.pl -i yes|no -R yes|no -c \
    Directory_Svr_Root -d Directory_instance \
     -r DC_tree -u User_Group_suffix -s yes|no \
    -D "DirectoryManagerDN" \
      -w password -b yes|no -t 1|1.5|2 \
    -m yes|path-to-schema-files]
    

    For example:


    # perl comm_dssetup.pl -i yes -c /var/opt/mps/serverroot -d slapd-budgie 
    -r o=internet -u o=usergroup -s yes -D "cn=Directory Manager"  
    -w password -b yes -t 1 -m yes
    

    The options for this command are:

    Option 

    Description 

    -i yes|no

    Answers the following question: “Do you want to configure new indexes?” Specify yes to configure new indexes. Specify no if you don’t want to configure new indexes.

    -R yes|no

    Execute reindexing if new indexes found and -m yes is given 

    -c Directory_Svr_Root

    Directory Server Root path name. For example: /var/opt/mps/serverroot

    -d Directory_instance

    Directory Server instance subdirectory. For example: slapd-budgie

    -r DC_tree

    DC tree suffix. For example: o=internet

    -u User_Group_suffix

    User/Group suffix. Example: o=usergroup

    -s yes|no

    Answers the following question: “Do you want to update the schema?” Specify yes to update the schema files. Specify no if you don’t want to update the schema files.

    -D DirectoryManagerDN

    Directory Manager DN. For example, "cn=Directory Manager"

    -w password

    Directory Manager password 

    -b yes|no

    Answers the following question: “Will this directory server be used for users and groups?” Specify yes if the directory server will be used for configuration and user/groups. Specify no if this directory will be only used for configuration data.

    -t 1|1.5|2

    Determines the schema version that you want to use for your Messaging Server: 

    • Choose 1 for Sun LDAP Schema 1.

    • Choose 1.5 for Sun LDAP Schema 2 (Compatibility Mode). See the Sun Java System Communications Services Schema Migration Guide for more information.

    • Choose 2 for Sun LDAP Schema 2 (Native Mode).

    -m yes|no

    Answers the following question: “Do you want to modify the directory server?” Specify yes to modify the directory. Specify no if you don’t want to modify the directory.

    -S path-to-schema-files

    Specifies the directory path to schema files. For example: ./schema.

    Once you set all the options for the comm_dssetup.pl script, you will see the following summary screen before the script runs:


    Here is a summary of the settings that you chose:
      Server Root                        : /var/opt/mps/serverroot/
      Server Instance                    : slapd-budgie
      Users/Groups Directory             : Yes
      Update Schema                      : yes
      Schema Type                        : 1
      DC Root                            : o=internet
      User/Group Root                    : o=usergroup
      Add New Indexes                    : yes
      Schema Directory                   : ./schema
      Directory Manager DN               : "cn=Directory Manager"

    Each option is further described in To Run comm_dssetup.pl in Interactive Mode.