Sun logo      Previous      Contents      Index      Next     

Sun ONE Identity Server 6.1 Administration Guide

Chapter 10
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

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 (Web Server Instances only)". This command is only applicable for Web Server instances.

startall

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

IdentityServer_base/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 the instance 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.

Note

stop and start may not function correctly with the new container- independent deployments. Use stop and start on the container if you experience this behavior.

restart

restart is a command that restarts Identity Server

amserver cannot stop or start Directory Server. You may need to restart it manually. It can only restart a Web Server instance. For other web containers, this command only restarts the authentication helpers.

Using amserver for Multi-Server Installer Administration (Web Server Instances only)

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 IdentityServer_base/SUNWam/bin.

To install multiple instances:

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

    2. 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:

      2.   IdentityServer_base/SUNWam/servers/https-instance_name

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

      3.   IdentityServer_base/SUNWam/servers/web-apps-instance_name

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

      4.   amserver.instance_name

    4. A copy of the Identity Server configuration file is created in IdentityServer_base/SUNWam/lib/AMConfig-instance_name.properties.
    5. The file /etc/rc3.d, holds the instance specific version of the initialization files:

      6.   S55amserver.instance_name

        K55amserver.instance_name

Note

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

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

    2. ./amserver startall

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

    IdentityServer_base/SUNWam/bin/amserver.instance_name start

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

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

    3. ./amserver stopall

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

    IdentityServer_base/SUNWam/bin/amserver.instance_name stop

  3. Invoke the Delete Command option by entering:

    4. ./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.

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

    5. Edit IdentityServer_base/SUNWam/lib/AMConfig-instan ce_name.properties

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

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

    6. ammultiserverinstall [ server-instance-name ] [ port ]

    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.

  6. amserver will automatically add server instances to the Platform Server List.
  7. Configure Identity Server to run in SSL mode. Instructions for this found in Appendix B, "Configuring Identity Server in SSL Mode" of this manual.
  8. Enter the following command to start all of the Identity Server instances:

    9. ./amserver startall

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

    ./amserver-instance start

TO BE ADDED FOR 6.2!!!!!!!!!

Multiple Instances of Identity Server Do Not Contain Map Additions

If you have customized authentication screens and are also using amserver to create new Identity Server instances, MAP does not update Identity Server’s services.war (We Archive file), so the newly created instance does not contain MAP additions.

Workaround

Update the services.war file. By default, it is in the following location:

IdentityServer_base/SUNWam/services.war

To update the services.war file, enter the following command:

jar -uvf services.war IdentityServer_base/SUNWam/services.war

The uvf option will replace the old file with the new modified one. For example:

cd /opt/SUNWam

jar -uvf services.war index.html

rm index.html

The following files can be modified:

Web Container Redeployment

To redeploy the .war file to the Application Server web container, enter the following commands:

asadmin deploy -u $IAS7_ADMIN -w $IAS7_ADMINPASSWD -H $SERVER_HOST -p $IAS7_ADMINPORT --type web $SECURE_FLAG --contextroot

$SERVER_DEPLOY_URI --name amserver --instance $IAS7INSTANCE ${BASEDIR}/${PRODUCT_DIR}/services.war

To redeploy the .war file to the BEA WebLogic web container, enter the following commands:

java weblogic.deploy -url $SERVER_URL -component ${SERVER_DEPLOY_URI}:${WL61 _SERVER} deploy $WL61_ADMINPASSWD

${SERVER_DEPLOY_URI}

${BASEDIR}/${PRODUCT_DIR} /services.war

To redeploy the .war file to the BEA WebLogic web container, see the deployment documentation at the following location:

http://www-3.ibm.com/software/webservers/studio/doc/v40/studioguide/en/html/sdsscenario1.html



Previous      Contents      Index      Next     

Copyright 2003 Sun Microsystems, Inc. All rights reserved.