Sun Java Enterprise System Upgrade Guide for Microsoft Windows |
Chapter 10
Directory Preparation ToolThis chapter describes how to upgrade Directory Preparation Tool from previous Java ES versions to Java ES Release 4.
The chapter provides a general overview of upgrade issues and procedures for the different upgrade paths supported by Java ES Release 4. The chapter covers the following:
Overview of Directory Preparation Tool UpgradesThis section describes the following general aspects of Directory Preparation Tool that impact upgrading to Java ES Release 4:
About Java ES Release 4 Directory Preparation Tool
Java ES Release 4 versions of Directory Preparation Tool represents a number of minor fixes needed to prepare Directory Server for use by Release 4 communications components (Messaging Server, Calendar Server, Communications Express, and Delegated Administrator).
For details, see the appropriate release notes.
Directory Preparation Tool Upgrade Roadmap
Table 10-1 shows the supported Directory Preparation Tool upgrade paths to Java ES Release 4.
Directory Preparation Tool Data
The following table shows the type of data that could be impacted by an upgrade of Directory Preparation Tool software.
Compatibility Issues
Release 4 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 Java ES components other than Directory Server. Directory Preparation Tool is used to configure Directory Server for use with Java ES communications components.
Upgrading Directory Preparation Tool from Java ES Release 3This section includes information about upgrading Directory Preparation Tool from Java ES Release 3 to Java ES Release 4. The section covers the following topics:
Introduction
When upgrading Java ES Release 3 Directory Preparation Tool to Release 4, consider the following aspects of the upgrade process:
- General Upgrade Approach. The upgrade is performed by applying patches to the Release 3 version. Directory Preparation Tool is then used to modify Directory Server as required to support Release 4 Messaging Server, Calendar Server, Communications Express, and Delegated Administrator components.
- Upgrade Dependencies. Directory Preparation Tool has no dependencies on Java ES shared components and is compatible with Release 3 Directory Server. Upgrade of Directory Server is therefore optional with respect to upgrade of Directory Preparation Tool to Release 4.
- Backward Compatibility. Release 4 Directory Preparation Tool is backwardly compatible with the Release 3 version.
- Upgrade Rollback. Rollback of the Release 4 upgrade to Release 3 is achieved by removing the patches applied during the upgrade. The Release 3 Directory Preparation Tool can then be run against Directory Server to back out changes made by the Release 4 version.
Directory Preparation Tool Upgrade
This section describes how to perform an upgrade of Directory Preparation Tool from Java ES Release 3 to Java ES Release 4. 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, for how to run the tool.
Upgrade Directory Preparation Tool Dependencies
It is generally recommended that all Java ES components on a computer system (and in a computing environment) be upgraded to Java ES Release 4. However, the upgrade of Directory Preparation Tool to Release 4 does not depend upon any other Java ES component.
Back Up Directory Data
The Directory Preparation Tool upgrade from Release 3 to Release 4 does not in itself modify Directory Server data. However, as a safety measure, it is a good idea to back up Directory Server before upgrading the Directory Preparation Tool and running it against Directory Server.
Obtain Required Configuration Information and Passwords
Directory Preparation Tool upgrade requires you to know the superuser password. Otherwise, the tool remembers parameter values used in the previous run and supplies them as defaults when run the next time.
Upgrading Directory Preparation Tool
This section discusses considerations that impact the upgrade procedure for Directory Preparation Tool followed by a description of the procedure itself.
Upgrade Considerations
The upgrade of Directory Preparation Tool software to Java ES Release 4 takes into account the following considerations:
- Release 3 Directory Preparation Tool was installed with Directory Server and resides on any computer hosting Directory Server.
- The upgrade of Directory Preparation Tool must be performed on the computer hosting every Directory Server instance being used by Messaging Server, Calendar Server, Communications Express, or Delegated Administrator components.
- The Release 4 upgrade patches are shown in Table 1-3
Upgrade Procedure
The procedure documented below applies to the Directory Preparation Tool installed on the computer where Directory Server resides.
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:
%TEMP%\dssetup_yyyymmddhhmmss
Post-Upgrade Tasks
There are no post-upgrade tasks beyond the steps described in Upgrade Procedure.
Rolling Back the Upgrade
This section describes considerations that impact the upgrade rollback procedure for Directory Preparation Tool followed by the procedure itself.
Rollback Considerations
The procedure for rolling back the upgrade to Release 4 of Directory Preparation Tool reverses the procedure for upgrading to Release 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