Using the amtune Tool

• To Install the amtune Tool

• To Tune the Operating System, Web Container, and OpenSSO Enterprise

• To Tune a Remote Sun Directory Server

To Install the amtune Tool

1. In the directory where you want to install the tuning tool, unzip the ssoAdmintools.zip file.

2. In the directory which has the unzipped ssoAdminTools file, run the following command:

   UNIX

   ./setup

   Windows

   setup

3. When prompted, enter the configuration directory.

   Example: /opensso_config/opensso

   Once installation is complete, you can use the command-line interface under the following directory:

   <TOOLS_DIR>/<OPENSSO_INSTANCE_NAME>/bin

   where <TOOLS_DIR> is the directory which has the unzipped ssoAdmintools.zip file, and <OPENSSO_INSTANCE_NAME> is the OpenSSO Enterprise deployment URI.

   The amtune tool is now in the <TOOLS_DIR>/<OPENSSO_URI>/bin/amtune directory.

To Tune the Operating System, Web Container, and OpenSSO Enterprise

1. Log in as or change to superuser.

2. If you have not run the tool in REVIEW mode, ensure that AMTUNE_MODE is set to REVIEW in the following file:

   <TOOLS_DIR>\<OPENSSO_URI>\bin\amtune\amtune-env.properties file

3. Edit other parameters in the amtune-env.properties file, depending upon the components you want to tune.

   See the Appendix for detailed information about the properties.

4. In REVIEW mode, run the amtune tool with a password file.

   See the section Using a Password File in this document.

   Solaris or Linux

   <TOOLS_DIR>/<OPENSSO_URI>/bin/amtune/amtune

   Windows

   <TOOLS_DIR>\<OPENSSO_URI>\bin\amtune\amtune.bat

   Review the tuning recommendations in the terminal or in the <TOOLS_DIR>/OPENSSO_URI/logs/amtune-config.<timestamp>.log file. If necessary, make changes to the amtune-env.properties file based on the tuning recommendations.

5. When you are satisfied with the tuning recommendations from running amtune in REVIEW mode, set AMTUNE_MODE to CHANGE in the amtune-env.properties file.

6. Check the debug log file for the results.

   In CHANGE mode, the amtune tool might need to restart the web container and OpenSSO Enterprise. When the operating system kernel parameters are changed, the amtune tool will recommend a system restart.

To Tune a Remote Sun Directory Server

1. FTP or copy amtune.zip to the remote Sun Directory Server host.

   In the change mode section of amtune-env.properties file, if AMTUNE_TUNE_DS=true, then the amtune.zip file is automatically generated.

2. Unzip amtune.zip.

3. Set values for TOOL_HOME and JAVA_HOME.

   Solaris, Linux, and AIX

   <TOOLS_DIR>/bin/unix/amtune

   Windows

   <TOOLS_DIR>\bin\windows\amtune.bat

4. Edit the amtune-env.properties file to include Directory Server information.

5. Run the amtune tool with a password file for the Sun Directory Server Directory Manager.

   The Directory Server Directory Manager password must be inaccessible to non-owners and only readable by its owner . For example, you can run change the permissions mode of the password file by running the following command:

   chmod 400

   UNIX or Linux

   amtune

   Windows

   amtune.bat

   On Windows, you must also execute amtune.bat with a password file. But amtune.bat does not check its file permission on Windows.

   In CHANGE mode, if AMTUNE_TUNE_DS=true, then the amtune tool will restart the Sun Directory Server instance.

   If AMTUNE_TUNE_OS=true, then the amtune tool will tune the operating system kernel parameters and will recommend a system restart.