Sun Java logo     Previous      Contents      Index      Next     

Sun logo
Sun Java Communications Suite 5 Upgrade Guide 

Chapter 3
Directory Preparation Tool

This chapter describes how to upgrade Directory Preparation Tool to Version 6.4.

The chapter provides an overview of upgrade considerations for the different upgrade paths supported by the Communications Suite Upgrade. The chapter covers upgrades on both the Solaris and Linux operating systems:

Overview of Directory Preparation Tool Upgrades

This section describes the following general aspects of Directory Preparation Tool that impact upgrading to Directory Preparation Tool 6.4:

About the Directory Preparation Tool

The Directory Preparation Tool represents a minor upgrade with respect to the previous release, mostly to add additional support for Directory Server.

For details, see the appropriate release notes.

Directory Preparation Tool Upgrade Roadmap

Table 3-1 shows the supported Directory Preparation Tool upgrade paths to Version 6.4. The table applies to both Solaris and Linux operating systems.

Table 3-1  Upgrade Paths to Sun Java System Directory Preparation Tool Version 6.4  

Release

Directory Preparation Tool Version

General Approach

Re-configuration Required

Java Enterprise System 2005Q4

Sun Java System Directory Preparation Tool 6.3 2005Q4

Direct upgrade:
Perform by applying patches.

Prepare Directory Server for
6.4 communications components

Java Enterprise System 2005Q1

Sun Java System Directory Preparation Tool 6.2 2005Q1

Direct upgrade:
Perform by applying patches.

Prepare Directory Server for
6.4 communications components

Java Enterprise System 2004Q2

comm_dssetup.pl script

Version 6.1 Revision 0.2 (bundled with Messaging Server and Calendar Server)

Direct upgrade:
Perform by applying genesis patch followed by an upgrade patch.

Prepare Directory Server for
6.4 communications components

Java Enterprise System 2003Q4

comm_dssetup.pl script

(bundled with Messaging Server and Calendar Server)

Direct upgrade not certified:
But can perform by applying genesis patch followed by an upgrade patch.

Prepare Directory Server for
6.4 communications components

5.2 and earlier

ims_dssetup.pl script

(bundled with Messaging Server)

No direct upgrade.

 

Directory Preparation Tool Data

The following table shows the type of data that could be impacted by an upgrade of Directory Preparation Tool software.

Table 3-2  Directory Preparation Tool Data Usage

Type of Data

Location

Usage

Directory Server schema

Directory Server

Prepare Directory Server for
6.4 communications components: modifies schema, creates new entries and creates indexes

Directory Preparation Tool Upgrade Strategy

Your strategy for upgrading Directory Preparation Tool depends on the many considerations discussed in Chapter 1, "Planning for Upgrades": upgrade path, dependencies components, selective upgrade versus upgrade all, multi-instance deployments, and so forth.

This section is to particularize that general discussion to Directory Preparation Tool by presenting issues that might influence your Directory Preparation Tool upgrade plan.

Compatibility Issues

This release of the Directory Preparation Tool does not introduce any interface changes and is backwardly compatible with earlier versions.

Directory Preparation Tool Dependencies

Directory Preparation Tool has no dependencies on other components other than Directory Server. Directory Preparation Tool is used to configure Directory Server for use with communications components.

Upgrading Directory Preparation Tool from 6.3 (2005Q4)

This section includes information about upgrading Directory Preparation Tool from Version 6.3 (2005Q4). The section covers the following topics:

Introduction

When upgrading the Directory Preparation Tool from 6.3 (2005Q4) to 6.4, consider the following aspects of the upgrade process:

Version 6.3 (2005Q4) Directory Preparation Tool Upgrade

This section describes how to perform an upgrade of Directory Preparation Tool from 6.3 (2005Q4) to Version 6.4 on both Solaris and Linux platforms. Where a topic depends on platform-specific procedures, the topic will indicate the operating system to which it applies. The section covers the following topics:

Pre-Upgrade Tasks

Before you upgrade Directory Preparation Tool you should perform the tasks described below.

Verify Current Version Information

You can verify the version of Directory Preparation Tool last run against Directory Server by checking attribute values of the cn=CommServers,o=comms-config entry written by the tool:

The entry has two attributes that specify the current version:

The tool will write a message to console only if the version of Directory Preparation Tool being run is the same or earlier than the version that was previously run. See the upgrade procedures, Step 5 (Solaris) or Step 5 (Linux), for how to run the tool.

Upgrade Directory Preparation Tool Dependencies

It is generally recommended that all Communications Suite components on a computer system (and in a computing environment) be upgraded to Communications Suite 5. However, the upgrade of Directory Preparation Tool does not depend upon any other Communications Suite component.

Back Up Directory Data

The Directory Preparation Tool upgrade from 6.3 (2005Q4) to 6.4 modifies Directory Server data in only minor ways. However, as a safety measure, it is a good idea to back up Directory Server before upgrading the Directory Preparation Tool and using it to modify Directory Server.

Obtain Required Configuration Information and Passwords

Directory Preparation Tool upgrade requires you to know the superuser password. The tool remembers parameter values used in the previous run and supplies them as defaults when run the next time.

Upgrading 6.3 (2005Q4) Directory Preparation Tool (Solaris)

This section discusses considerations that impact the upgrade procedure for Directory Preparation Tool followed by a description of the procedure itself.

Upgrade Considerations (Solaris)

The upgrade of Directory Preparation Tool software to Version 6.4 takes into account the following considerations:

Upgrade Procedure (Solaris)

The procedure documented below applies to the Directory Preparation Tool installed on the computer where Directory Server resides.

  1. Obtain the required patches, based on Table 3-4.

    2. Patches can be downloaded to /tmp from: http://sunsolve.sun.com/pub-cgi/show.pl?target=patches/patch-access

  2. Log in as root or become superuser.

    3. su -

  3. Apply the appropriate Directory Preparation Tool patches in Table 3-4.

    4. patchadd patch_ID

  4. Confirm that the patch upgrade was successful:

    5. showrev -p | grep patch_ID

    The output should return the versions of patch IDs applied in Step 3.

  5. Run the Directory Preparation Tool against Directory Server.
    1. Confirm that Directory Server is running.
    2. Change directory to the location of the Directory Preparation Tool

      3. cd DirPrepTool-base/sbin

    3. Run the Directory Preparation Tool (comm_dssetup.pl perl script).

      4. perl comm_dssetup.pl

      Provide the parameters requested by the script.

Upgrading 6.3 (2005Q4) Directory Preparation Tool (Linux)

This section discusses considerations that impact the upgrade procedure for Directory Preparation Tool followed by a description of the procedure itself.

Upgrade Considerations (Linux)

The upgrade of Directory Preparation Tool software to Version 6.4 on the Linux platform takes into account the same considerations as on the Solaris platform (see Upgrade Considerations (Solaris)), except that the Linux 6.4 upgrade patches differ from the Solaris patches.

The 6.4 Directory Preparation Tool upgrade patch for Linux OS is shown in the following table:

Table 3-5  Patches1 to Upgrade Directory Preparation Tool on Linux 

Description

Patch ID and RPM names

Directory Preparation Tool (DSSETUP)

118247-13

  • sun-comms-dssetup-6.3-3.xx.i386.rpm

1Patch revision numbers are the minimum required for upgrade to Version 6.4. If newer revisions become available, use the newer ones instead of those shown in the table.

Upgrade Procedure (Linux)

The procedure documented below applies to the Directory Preparation Tool installed image on the computer where Directory Server resides.

Caution

An upgrade from Version 6.3 (2005Q4) to Version 6.4 on Linux cannot be rolled back.

  1. Obtain the required patch using the patch number and RPM name from Table 3-5. Use this information to obtain the version numbers for the RPM.

    2. Patches can be downloaded to /tmp from: http://sunsolve.sun.com/pub-cgi/show.pl?target=patches/patch-access

  2. Log in as root or become superuser.

    3. su -

  3. Apply the RPMs for Directory Preparation Tool in Table 3-5.

    4. rpm -Uvh sun-comms-dssetup-6.3-3.xx.i386.rpm

  4. Confirm that the upgrade was successful:

    5. rpm -q sun-comms-dssetup

    The new version number of the RPM should be returned.

  5. Run the Directory Preparation Tool against Directory Server.
    1. Confirm that Directory Server is running.
    2. Change directory to the location of the Directory Preparation Tool

      3. cd DirPrepTool-base/sbin

    3. Run the Directory Preparation Tool (comm_dssetup.pl perl script).

      4. perl comm_dssetup.pl

      Provide the parameters requested by the script.

Verifying the Upgrade

You can verify successful upgrade of Directory Preparation Tool and extension of directory schema by checking the log file created when running the script. The log file is located at:

/var/tmp/dssetup_yyyymmddhhmmss.log

Post-Upgrade Tasks

There are no post-upgrade tasks beyond the steps described in Upgrade Procedure (Solaris) and Upgrade Procedure (Linux).

Rolling Back the Upgrade (Solaris)

This section describes considerations that impact the upgrade rollback procedure for Directory Preparation Tool followed by the procedure itself.

Rollback Considerations (Solaris)

The procedure for rolling back the upgrade to 6.4 of Directory Preparation Tool reverses the procedure for upgrading to 6.4. However, among the changes made by Directory Preparation Tool are modifications to Directory Server schema. These changes are not backed out by the rollback procedure described below, however the schema changes are backwardly compatible.

Rollback Procedure (Solaris)
  1. Log in as root or become superuser.

    2. su -

  2. Remove the patches in Table 3-4.

    3. patchrm patch_ID

  3. Run the rolled-back Directory Preparation Tool against Directory Server.

    4. Directory Server modifications, except for indexes and schema changes, are restored to their previous states. There is no negative impact to the indexes or schema extensions; the latter are backwardly compatible.

Upgrading Directory Preparation Tool from Version 6.3 (2005Q1)

The procedure for upgrading Version 6.3 (2005Q1) Directory Preparation Tool to 6.4 is the same as that for upgrading 6.3 (2005Q4) Directory Preparation Tool to 6.4.

To upgrade 6.3 (2005Q1) Directory Preparation Tool to 6.4, use the instructions in Upgrading Directory Preparation Tool from 6.3 (2005Q4), except substitute 6.3 (2005Q1) wherever 6.3 (2005Q4) is referenced.

Upgrading Directory Preparation Tool from Version 6.1 (2004Q2)

The procedure for upgrading Version 6.1 (2004Q2) Directory Preparation Tool to 6.4 is similar to that for upgrading 6.3 (2005Q1) Directory Preparation Tool to 6.4, with the following exception:

In Version 6.1 (2004Q2), Directory Preparation Tool was bundled with Messaging Server and Calendar Server and not installed as a separate package. Hence no Directory Preparation Tool installed packages or RPMs reside on the computer hosting Directory Server. For this reason, to upgrade from 6.1 (2004Q2) to 6.4, you have to install Directory Preparation Tool packages:

Upgrades from 6.1 (2004Q2) Directory Preparation Tool to 6.4 is similar to that described in Upgrading Directory Preparation Tool from 6.3 (2005Q4). The pre-upgrade and post-upgrade considerations are the same, except you substitute 6.1 (2004Q2) wherever 6.3 (2005Q1) is referenced. The specific upgrade procedures, however, are described in the following sections.

Version 6.1 (2004Q2) Upgrade Procedure (Solaris)

The procedure documented below applies to the Directory Preparation Tool installed on the computer where Directory Server resides.

  1. Obtain the required genesis patch, based on the following table:

    2. Table 3-6  Genesis Patches1 to Upgrade Directory Preparation Tool on Solaris 

    Description

    SPARC

    Solaris 9,& 10

    X86

    Solaris 9 & 10

    Directory Preparation Tool (DSSETUP)

    118242-03

    118243-03

    1Patch revision numbers are the minimum required for upgrade to Version 6.4. If newer revisions become available, use the newer ones instead of those shown in the table.

    Patches can be downloaded to /tmp from: http://sunsolve.sun.com/pub-cgi/show.pl?target=patches/patch-access

  2. Log in as root or become superuser.

    3. su -

  3. Apply the Directory Preparation Tool genesis patch in Table 3-6.

    4. patchadd patch_ID

  4. Obtain the required upgrade patch, based on Table 3-4.

    5. Patches can be downloaded to /tmp from: http://sunsolve.sun.com/pub-cgi/show.pl?target=patches/patch-access

  5. Apply the appropriate Directory Preparation Tool upgrade patch in Table 3-4.

    6. patchadd patch_ID

  6. Confirm that the patch upgrade was successful:

    7. showrev -p | grep patch_ID

    The output should return the versions of patch IDs applied in Step 5.

  7. Run the Directory Preparation Tool against Directory Server.
    1. Confirm that Directory Server is running.
    2. Change directory to the location of the Directory Preparation Tool

      3. cd DirPrepTool-base/sbin

    3. Run the Directory Preparation Tool (comm_dssetup.pl perl script).

      4. perl comm_dssetup.pl

      Provide the parameters requested by the script.

Version 6.1 (2004Q2) Upgrade Procedure (Linux)

The procedure documented below applies to the Directory Preparation Tool installed on the computer where Directory Server resides.

  1. Log in as root or become superuser.

    2. su -

  2. Obtain the required upgrade patch using the patch number and RPM name from Table 3-5.

    3. Patches can be downloaded to /tmp from: http://sunsolve.sun.com/pub-cgi/show.pl?target=patches/patch-access

  3. Apply the upgrade RPMs for Directory Preparation Tool in Table 3-5.

    4. rpm -Uvh sun-comms-dssetup-6.3-2.5.i386.rpm

  4. Confirm that the upgrade was successful:

    5. rpm -q sun-comms-dssetup

    The new version number of the RPM should be returned.

  5. Run the Directory Preparation Tool against Directory Server.
    1. Confirm that Directory Server is running.
    2. Change directory to the location of the Directory Preparation Tool

      3. cd DirPrepTool-base/sbin

    3. Run the Directory Preparation Tool (comm_dssetup.pl perl script).

      4. perl comm_dssetup.pl

      Provide the parameters requested by the script.



Previous      Contents      Index      Next     

Part No: 819-7561-10.   Copyright 2007 Sun Microsystems, Inc. All rights reserved.