Sun OpenSSO Enterprise 8.0 Installation and Configuration Guide

Running the amsfo Script to Start and Stop the Session Failover Components

The amsfo script (or on Windows systems) reads variables in the amsfo.conf configuration file and then performs these functions:

To run the script on Windows systems, Active Perl version 5.8 or later is required.

To run amsfo, use the following syntax:

amsfo start | stop

The amsfo command then automatically finds the amsfo.conf file.

The following table describes the variables in the amsfo.conf file. Some variables are set when you run the setup (or script. Before you run the amsfo script, set other variables as required for your deployment.

Table 8–1 amsfo.conf Configuration File Parameters




Specifies the following directory: sfo-zip-root/dirname


  • sfo-zip-root is where you unzipped the file.

  • dirname is the name you specified when you ran the setup script to install the session failover scripts and related files.


Specifies (true or false) whether the script should automatically restart the Oracle Berkeley DB client (amsessiondb).

The default is true (restart the amsessiondb client).


Specifies the Message Queue broker list participating in the cluster. The format is:  

host1:port,host2:port, ... hostn:port

For example:,,

You can deploy the Message Queue brokers on the same servers that are running OpenSSO Enterprise instances. However, for improved performance, consider installing the brokers on different servers. 


Specifies the directory where the session database files will be created.  

Default: /tmp/amsession/sessiondb


Specifies (true or false) whether the script should delete and then create a new database each time the Oracle Berkeley DB client (amsessiondb) is restarted.

Default: true


Specifies the location of the log directory.  

Default: /tmp/amsession/logs


Specifies (true or false) whether the Message Queue broker should be started with the amsessiondb process on the same server:

true - The Message Queue broker will run on the same server as the amsessiondb process.

false - The Message Queue broker and the amsessiondb process will run on different servers.

Default: true


Specifies the name of the Message Queue broker instance to start.  

For example: mqbroker


Specifies the port for the local Message Queue broker instance.  

Default: 7777 


Specifies the Java VM arguments. Set to a maximum of 1024m, based on the system resources.

Default: "-Xms256m -Xmx512m"


Specifies the user name used to connect to the Message Queue broker. 

Default: guest


Location of the password file that contains the encrypted password of the user name (default is guest) used to connect to the Message Queue broker. To generate the encrypted password, use the amsfopassword script, as described in Encrypting the Message Queue Broker Password Using the amsfopassword Script (Required).

Default: sfo-zip-root/dirname/.password


amsessiondb script arguments.

The amsessiondb script is called by the amsfo (or script. To determine the list of arguments, run: amsession db -h

ProcedureTo Run the amsfo Script

Before You Begin

Stop each of the OpenSSO Enterprise instances in the session failover deployment.

  1. Set the variables in the amsfo.conf file, as required for your deployment.

    For a description of all variables, see Table 8–1.

  2. Run the amsfo script on Solaris or Linux systems or the script on Windows systems.

    For example, to start the session failover components on a Solaris system:

    # cd /sfo-zip-root/sfo/bin
    # ./amsfo start

    The amsfo command then automatically finds the amsfo.conf file and displays status information as it runs.

  3. To check the results, see the /var/tmp/amsfo.log file.