This section covers information you need to understand before running the Directory Preparation Tool, and contains the following topics:
Directory Server Considerations for the Directory Preparation Tool
Information You Need to Gather Before you Run the Directory Preparation Tool
The Directory Preparation Tool proceeds through three steps, as follows:
Collects your choices for utility options.
For a list of the specific information this step requests, see Information You Need to Gather Before you Run the Directory Preparation Tool.
Generates a shell script and LDIF file from your options choices that will be used to modify the LDAP directory.
If you are not using a Sun product for your directory server, or have customized your Directory Server, stop the process here without running the shell script. For further information, see Directory Server Considerations for the Directory Preparation Tool that follows.
Runs the shell script created from your options choices. Your directory is modified accordingly.
At the end of each step, the utility asks you if you want to continue. No changes are made to the LDAP directory until the third step.
The following is a list of the considerations for your LDAP directory:
A directory server must be installed, configured and running before you run the Directory Preparation Tool.
You must run the Directory Preparation Tool on the same machine as your directory server.
You must run the Directory Preparation Tool on every machine on which a directory server resides.
If you add an additional machine that has Directory Server installed on it (such as a replica), at a future date, run the Directory Preparation Tool against it, too.
If you have customized your LDAP directory, the following considerations may apply:
If you have indexed some attributes, you may have to reindex those attributes after the Directory Preparation Tool runs.
If you have added other .ldif files (schema definitions), they should not be affected, so no action should be necessary. However, back up your custom schema definition files before running the Directory Preparation Tool.
For all customizations, including the first two just listed, stop the Directory Preparation Tool after it generates the script and before it actually updates the LDAP directory. Then inspect the script to evaluate how its proposed actions will affect your LDAP directory. Take whatever actions you think necessary to protect your customizations before running the script against your directory.
During the first step of the Directory Preparation Tool, it requests information about your Directory Server. Prepare for this by gathering the information shown in the following table. (To help you keep track of this information, use Directory Server Installation Worksheet.)
Information Item Needed |
Default Value |
---|---|
Directory Server root path name |
/var/opt/mps/serverroot |
Which instance of Directory Server to use? (If more than one.) |
N/A |
Directory Manager Distinguished Name (DN) |
"cn=DirectoryManager" |
Directory Manager's Password |
N/A |
Directory Server being used for user/group data? (yes), or configuration data only? (no) |
yes |
User and group root suffix (if yes to previous question) |
“o=usergroup” |
Schema version? (pick one of the following) 1 Schema 1 1.5 Schema 2 Compatibility Mode 2 Schema 2 Native Mode [For more information on how to choose a schema, see About the Directory Preparation Tool Schema Choices. If you have one version of the schema installed and want to upgrade to a higher level, refer to the Sun Java System Communications Services 6 2005Q4 Schema Migration Guidebefore running this utility. ] |
1 |
Root suffix (if using Schema 1 or Schema 2 Compatibility Mode) [If you choose Schema 1 or 1.5, you will need a DC tree. If the DC tree does not yet exist, the Directory Preparation Tool creates only the root suffix node, its does not create the rest of the DC tree. You must create the rest of your DC tree yourself.] |
o=internet |
Update schema? [If this Directory Server is being used for user/group data, you must have a config directory containing the schema files.] |
yes |
Add Directory Server indexes? [If you answer yes, the Directory Preparation Tool does the indexing for Messaging Server and Calendar Server, even if you are not using both of them.] |
yes |
Communications Suite servers support the following schema choices:
Sun LDAP Schema 2 native mode
Corresponds to Directory Preparation Tool schema version choice 2. This is the default for a fresh installation.
Corresponds to the Directory Preparation Tool schema version choice 1.
Sun LDAP Schema 2 compatibility mode
Corresponds to Directory Preparation Tool schema version choice 1.5.
If you are still trying to decide which schema to use, for further explanation, see Understanding Schema Choices in Sun Java Communications Suite 5 Deployment Planning Guide, and the Sun Java System Communications Services 6 2005Q4 Schema Migration Guide.
If you are using Schema 2, Access Manager must be installed and configured.
Do not use the Access Manager console to administer users. Use Delegated Administrator for administering Messaging and Calendar users.
Attribute indexes improve the performance of search algorithms. The tool offers to index attributes. If you choose to do so, it will add indexes for the all the Communications Suite products. Therefore, once you have run the indexing for one product, you do not need to reindex for other products. If you try to index the same attributes again, nothing happens. The tool calls db2index for each attribute being indexed, but only if the index does not already exist.
The following table lists all the attributes the Directory Preparation Tool indexes, grouped by suffix category. It also lists the type of indexes created for each attribute. For more information about Directory Server indexing, see http://docs.sun.com/coll/1316.1.
Suffix |
Attributes Indexed |
Type of Indexes Added |
---|---|---|
User/Group |
|
pres, eq, approx, sub |
mailAlternateAddress |
pres, eq, approx, sub |
|
mailEquivalentAddress |
pres, eq, approx, sub |
|
member |
eq |
|
cosspecifier |
pres |
|
User/Group (for Access Manager – Schema 2) |
inetDomainBaseDN |
pres, eq |
sunPreferredDomain |
pres, eq |
|
associatedDomain |
pres, eq |
|
o |
pres, eq |
|
sunOrganizationAlias |
pres, eq |
|
DC Tree (for Schema 1) |
inetDomainBaseDN |
pres, eq |
inetCanonicalDomainName |
pres, eq |
|
Personal Address Book (PAB) |
memberOfManagedGroup |
pres, eq |
memberOfPAB |
pres, eq |
|
memberOfPABGroup |
pres,eq |
|
un |
eq |
|
icsCalendar |
pres, eq, approx, sub |
|
icsCalenarOwned |
pres, eq, approx, sub |
|
New PAB |
displayname |
pres, eq, sub |
MemberOfPiBook |
eq |
|
MemberofPiGroup |
eq |
Should you decide to add further indexes on your own, instructions for adding indexes can be found in the Directory Server documentation.