Directory Server Tuning Scripts

The amtune-prepareDSTuner scripts generates the amtune-directory script, which you can then use to tune Directory Server. This chapter describes:

• Directory Server Indexes

• Running the Directory Server Tuning Script in REVIEW Mode

• Applying the Tuning Changes to Directory Server

Directory Server Indexes

The Directory Server tuning script creates the following indexes if they do not already exist:

• Index for attributes that are used to search for a user to be authenticated

• Indexes for the default Access Manager attributes: nsroledn, memberof, iplanet-am-static-group-dn, iplanet-am-modifiable-by, iplanet-am-user-federation-info-key, sunxmlkeyvalue, o, ou, sunPreferredDomain, associatedDomain, and sunOrganizationAlias

  These attributes are indexed during installation by using the index.ldif file in /etc/opt/SUNWam/config/ldif directory on Solaris systems and /etc/opt/sun/identity/config/ldif directory on Linux systems. If for some reason, any of these attributes are not indexed, the Directory Server tuning script creates them.

  For more information about indexes, see Appendix A, Directory Server Considerations, in Sun Java System Access Manager 7.1 Postinstallation Guide.

Running the Directory Server Tuning Script in REVIEW Mode

The amtune script and amtune-prepareDSTuner scripts do not actually tune Directory Server. However, you must run one of these scripts to generate the amtune-directory script, which you can then use to tune Directory Server.

1. Log in as or become superuser (root).

2. Make sure that the following parameter is set in the amtune-env file:

   AMTUNE_TUNE_DS=true

3. Run the amtune script or amtune-prepareDSTuner script. The script generates the following tar file:

   current-directory/amtune-directory.tar

4. Copy the amtune-directory.tar file to a temporary location on the server that is running Directory Server.

5. Untar the amtune-directory.tar file in the temporary location.

6. In the amtune-directory script, make sure REVIEW mode is set:

   AMTUNE_MODE="REVIEW"

7. Set these parameters, if you prefer a value other than the default (amtune):

   • DEBUG_FILE_PREFIX is a prefix that will be included with the timestamp to specify the filename of the log file where the script writes the recommended tuning changes.

   • DB_BACKUP_DIR_PREFIX is a prefix that will be included with the timestamp to specify the name of the Directory Server backup directory.

8. Run the amtune-directory script in REVIEW mode. For example:

   # ./amtune-directory dirmanager_password

   The dirmanager_password is the Directory Manager password.

9. Review the recommended tuning settings for Directory Server in the debug log file.

   The script creates the log file in the same directory with the tuning scripts.

Applying the Tuning Changes to Directory Server

If you are working with a production Directory Server or a Directory Server that has not been backed up (both the data and the configuration), it is recommended that you do not run the amtune-directory script in CHANGE mode to apply to the tuning changes. Review the tuning recommendations from REVIEW mode and apply the changes manually, if they meet your deployment needs.

Before making the tuning changes, the amtune-directory script stops and backs up Directory Server.

If you are working with a pilot or prototype Directory Server and you are sure you want to apply the tuning changes, follow these steps:

1. Back up both your Directory Server data and configuration.

2. Set the following parameter in the amtune-directory script:

   AMTUNE_MODE="CHANGE"

3. Run the amtune-directory script in CHANGE mode. For example:

   # ./amtune-directory dirmanager_password

   The dirmanager_password is the Directory Manager password.

4. Check the amtune log file for the results of the run.

   The script creates the log file in the same directory with the tuning scripts.