Chapter 9   The amserver Command Line Tool


This chapter provides information on the amserver command line tool. This chapter contains the following sections:

• The amserver Command Line Executable

• Using amserver for Multi-Server Installer Administration

The amserver Command Line Executable

---

The amserver command line executable is to create, start, stop, and delete additional Identity Server instances on the Solaris platform. amserver on the Windows 2000 platform only allows for starting and stopping Identity Server.

amserver Syntax

The generic syntax for the tools is:

./amserver { create | delete [<instance_name>] | startall | start | stop | stopall | version }

amserver Commands for Solaris

create
create is a command that is used to create a new instance of Identity Server.The amserver script should be run as root. To create instances run amserver script ./amserver create. Detailed steps for creating multiple server instances are described in "Using amserver for Multi-Server Installer Administration".

startall
startall is a command that is used to start all the Identity server instances. To start individual instance run:

Identity_Server_root/SUNWam/bin/amserver.<instance_name> start

stopall
stopall is a command that is used to stop all the Identity Server instances. To stop individual identity server instance run:

/opt/SUNWam/bin/amserver.<instance_name> stop

delete
delete is a command that will delete all the files created by the create option.

amserver Commands for Windows 2000

amserver on the Windows 2000 platform only supports the following commands:

start
start is a command that starts the Identity Server.

stop
stop is a command that stops the Identity Server.

restart
restart is a command that restarts Identity Server

amserver cannot stop or start Directory Server if its not installed with Identity Server packages. You may need to start it manually

Using amserver for Multi-Server Installer Administration

---

You can use the amserver command line utility to install and administer multiple instances of Identity Server. Before installing multiple instances of Identity Server, you must log in as root. The scripts described in the steps below can be found in <Identity_Server_root>/SUNWam/bin.

To install multiple instances:

1. Create a new server instance through amServer by entering ./amserver create.

   For example, if you were to create instances named instance1 which will listen to port 81:, the output of the script output may look like the following:

   ##################################################################### Please enter the name of the server instance: instance1 Please enter the port number: 81 Do you want to create more server instances? y/[n] Installing... please wait.... ##################################################################

   1. A directory is then created for each web server instance. Example:

         <Identity_Server_root>/SUNWam/servers/https-<instance_name>

   2. The Identity Server applications are deployed to the following location:

         <Identity_Server_root>/SUNWam/servers/web-apps-<instance_name>

   3. The <Identity_Server_root>/SUNWam/bin directory holds the instance specific version of amServer. For example:

         amserver.<instance_name>

   4. A copy of the Identity Server configuration file is created in <Identity_Server_root>/SUNWam/lib/AMConfig-<instance_name>.properties.

   5. The file /etc/rc3.d, holds the instance specific version of the initialization files:

         S55amserver.<instance_name>

         K55amserver.<instance_name>

---

Note	Do not use "_" (under score_ or "." (period) in the creation of the instance name

---

2. Start all Identity Server instances, including the original server instance, by entering:

   ./amserver startall

   You can alternatively use the following command to start individual servers:

   <Identity_Server_root>/SUNWam/bin/amserver.<instance_name> start

   You should now be able to invoke the Identity Server login screens for all instances through your browser.

3. Stop all server instances, including the original, by entering:

   ./amserver stopall

   Alternatively, you can use the following command to stop individual servers:

   <Identity_Server_root>/SUNWam/bin/amserver.<instance_name> stop

4. Invoke the Delete Command option by entering:

   ./amserver delete

   All of the files created by the Create command should be removed. If you use the Identity Server Uninstall utility, the files generate by the scripts are not removed.

5. Specify your directories for the debug files by entering:

   Edit <Identity_Server_root>/SUNWam/lib/AMConfig-<instance_name>.properties

   Make sure that you change the com.iplanet.services.debug.directory property to your designated directory.

6. Invoke the ammultiserverinstall utility by using the following syntax:

   ammultiserverinstall [ server-instance-name ] [ port-number ]

   For applications that require the installation of multiple instances of Identity Server, but prefer a non-interactive interface, use the ammultiserverinstall utility. If the ammultiserverinstall fails, it will exit with a value of 1.

7. amserver will automatically add server instances to the Platform Server List.

8. Configure Identity Server to run in SSL mode. Instructions for this found in Appendix A "Configuring Identity Server in SSL Mode" of this manual.

9. Enter the following command to start all of the Identity Server instances:

   ./amserver startall

   Alternatively, you can use the following command to start individual Identity Server instances:

   ./amserver-<instance> start