Sun Java System Access Manager 7.1 Performance Tuning and Troubleshooting Guide

Installation Environment Tuning Parameters

The following table describes the Access Manager installation environment tuning parameters.


Note –

The OSTYPE, OSPLATFORM, and HWPLATFORM parameters are used to construct other parameters, so you should not need to change their values.


Table 2–3 Installation Environment Tuning Parameters

Parameter 

Description 

HOSTNAME

Specifies the host name of the system where Access Manager is deployed. 

If the host name for your environment cannot be obtained using the hostname command, comment the following line:

HOSTNAME=/bin/hostname | /bin/cut -f1 -d"."

Then, add a line setting the correct host name. For example: 

HOSTNAME=myhost

DOMAINNAME

Specifies the domain name of the system where Access Manager is deployed.

If the domain name for your environment cannot be obtained using the domainname command, comment the following line:

DOMAINAME=’/bin/domainname’

Then, add a line setting the correct domain name. For example: 

DOMAINNAME=example.com

IS_INSTALL_DIR

Specifies the Access Manager installation directory. 

Default: blank. The tuning scripts determine the default Access Manager installation directory dynamically by the pkginfo or rpm command. If the pkginfo or rpm command fails, values are /opt/SUNWam on Solaris systems or opt/sun/identity on Linux systems.

For an Access Manager WAR file deployment, the value should be blank. The IS_INSTALL_DIR and IS_CONFIG_DIR parameters are then replaced by WAR file deployment setup script.

AMTUNE_BIN_DIR

Specifies the location of the tuning scripts. Set this variable only if the tuning scripts are not installed in the default location. Otherwise, leave it blank. 

Default: AccessManager-base/bin/amtune

WEB_CONTAINER

Specifies the name of the Web container on which Access Manager is deployed:

  • WS7 — Web Server 7.0

  • WS61 — Web Server 6.1

  • AS8 — Application Server 8

  • AS7 — Application Server 7

Default: WS7

Any other value returns a validation error. 

CONTAINER_BASE_DIR

Specifies the base directory for the Web container that is running Access Manager. If you installed the Web container in a non-default location, change this value before running amtune.

Default values: 

  • Web Server 7.0: /opt/SUNWwbsvr7

  • Web Server 6.1: /opt/SUNWwbsvr

  • Application Server 7: /var/opt/SUNWappserver7

  • Application Server 8 on Solaris systems /var/opt/SUNWappserver

  • Application Server 8 on Linux systems /var/opt/sun/appserver

WEB_CONTAINER_INSTANCE_NAME

Specifies the instance name of the Access Manager web container.

Typically, this value is the host name where Access Manager is deployed. If you have multiple instances for the Web container, this value might be different from the host name, and you must set it to the correct instance name. 

Defaults: 

  • Web Server 6.1 or Web Server 7.0: hostname (${HOSTNAME})

  • Application Server 7: domains/server1

  • Application Server 8: domains/domain1

IS_INSTANCE_NAME

Specifies the Access Manager instance names. IS_INSTANCE_NAME is used to determine the properties file names for the Access Manager installation.

Default: none 

You can deploy multiple instances of Access Manager on the same machine, but generally, there is one set of properties files for each Access Manager instance, and the instance name is appended to the file names. 

If there is only one instance of Access Manager on a machine, the instance name is not appended to the file name. 

For example, there might be a single instance of Access Manager running under the default instance of Web Server. 

If Access Manager is installed on a machine named server.example.com, typically the first instance of Web Server is https-server.example.com. The properties files for the first Access Manager instance will not have the instance name appended (for example, AMConfig.properties).

Multiple Access Manager Instances

Multiple instances will have different names. For example, if there are three instances of Web Server, the Web Server instances might be:

  • server.example.com-instance1

  • server.example.com-instance2

  • server.example.com-instance3

If three instances of Access Manager are deployed (one per web container instance), the primary properties file names for Access Manager (typically, AMConfig.properties) might be named as:

  • AMConfig-instance1.properties

  • AMConfig-instance2.properties

  • AMConfig-instance3.properties

IS_INSTANCE_NAME

(continued) 

You can specify IS_INSTANCE_NAME=instance1. The amtune script resolves the properties file names in the following order:

  1. AMConfig-IS_INSTANCE_NAME

  2. AMConfig-WEB_CONTAINER_INSTANCE_NAME

  3. AMConfig.properties

    The script uses the first available properties file in the list.

    The amadmin utility should also point to the correct server name. Java option:

    -Dserver.name=IS_INSTANCE_NAME

    amtune automatically tries to associate the instance names with the Access Manager properties files using this parameter. Currently, only these files are based on this instance name:

    • AMConfig.properties

    • serverconfig.xml

CONTAINER_INSTANCE_DIR

Specifies the base directory for the Access Manager web container instance. If you have installed the web container in a non-default location, change this value before running amtune.

Default values are: 

Web Server 6.1 or Web Server 7.0: 

$CONTAINER_BASE_DIR/https-${WEB_CONTAINER_INSTANCE_NAME}

Application Server 7 or Application Server 8: 

$CONTAINER_BASE_DIR/${WEB_CONTAINER_INSTANCE_NAME}