Access Manager amtune-env File Parameters

AMTUNE_MODE

Sets the tuning mode to one of the following: 

• REVIEW– The scripts return tuning recommendations for an Access Manager deployment but do not make any actual changes to the deployment environment.

• CHANGE– The scripts make all of the tuning modifications that you have defined in the amtune-env file, except for Directory Server. For more information, see Chapter 3, Directory Server Tuning.

Default: REVIEW 

AMTUNE_TUNE_OS

Tunes the Solaris OS kernel and TCP/IP settings.

Default: true 

AMTUNE_TUNE_DS

Generates a script to tune the Directory Server that supports Access Manager. 

Default: true 

AMTUNE_TUNE_WEB_CONTAINER

Tunes the Access Manager web container, which can be either Web Server or Application Server. 

Default: true 

AMTUNE_TUNE_IDENTITY

Tunes the installed instance of Access Manager. 

Default: true 

AMTUNE_DEBUG_FILE_PREFIX

Identifies the prefix for the amtune log file. If this parameter is set, all operations performed by the amtune scripts are logged. The location of the log file is determined by the com.iplanet.services.debug.directory parameter in the AMConfig.properties file.

If this parameter is not set, information is not logged, and all output is sent to /dev/null.

Default: amtune

AMTUNE_PCT_MEMORY_TO_USE

Specifies the percent of available memory used by Access Manager. 

Currently, Access Manager can use a maximum of 4 GB, which is the per process address space limit for 32-bit applications. 

Access Manager requires a minimum of 256 MB RAM.

When you set AMTUNE_PCT_MEMORY_TO_USE to 100, the maximum space allocated for Access Manager is the minimum between 4 GB and 100% of available RAM. 

When you set AMTUNE_PCT_MEMORY_TO_USE to 0, Access Manager is configured to use 256 MB RAM 

Default: 75 

The following values are derived from this parameter setting: 

• JVM memory usage - Heap sizes, NewSizes, PermSizes

• Thread pool sizes - Web Server RqThrottle, Authentication LDAP connection pool, SM LDAP connection pool, Notification thread pools

• Access Manager caches - SDK caches and session caches

• Maximum sizes - Maximum number of sessions and maximum number of cache entries

AMConfig.properties File Settings

Notification thread pool settings: 

com.iplanet.am.notification.threadpool.size

com.iplanet.am.notification.threadpool.threshold

SDK cache maximum size setting: 

com.iplanet.am.sdk.cache.maxsize

Session settings: 

com.iplanet.am.session.httpSession.enabled

com.iplanet.am.session.maxSessions

com.iplanet.am.session.invalidsessionmaxtime

com.iplanet.am.session.purgedelay

AMTUNE_PER_THREAD_STACK_SIZE

Sets the available stack space per thread in Java (Web container). The per thread stack size is used to tune various thread-related parameters in Access Manager and the Web container. 

Default: 128 KB 

Caution: Do not change this value unless absolutely necessary.

AMTUNE_DONT_TOUCH_SESSION_PARAMETERS

Specifies whether session time-out tuning using the next three parameters is enabled. To enable, set to false.

Default: true 

AMTUNE_SESSION_MAX_SESSION_TIME_IN_MTS

Sets the maximum session time in minutes.

Default: 60 

However, the default value might be different for your installation. If the session service is registered and customized at the any other level, the tuning will not apply. 

Setting this parameter to very high or very low values affects the number of active user sessions an Access Manager deployment can support, so this parameter is optional for tuning purposes. 

To use this parameter, AM_TUNE_DONT_TOUCH_SESSION_PARAMETERS must be set to false. 

AMTUNE_SESSION_MAX_IDLE_TIME_IN_MTS

Sets the maximum idle time for a session in minutes.

Default: 10 

However, the default value might be different for your installation. If the Session service is registered and customized at the any other level, the tuning will not apply. 

Setting this parameter to very high or very low values affects the number of active user sessions an Access Manager deployment can support, so this parameter is optional for tuning purposes. 

To use this parameter, AM_TUNE_DONT_TOUCH_SESSION_PARAMETERS must be set to false. 

AMTUNE_SESSION_MAX_CACHING_TIME_IN_MTS

Sets the maximum session cache time in minutes.

Default: 2 

However, the default value might be different for your installation. If the Session service is registered and customized at the any other level, the tuning will not apply. 

Setting this parameter to very high or very low values affects the number of active use sessions an Access Manager deployment can support, so this parameter is optional for tuning purposes. 

To use this parameter, AM_TUNE_DONT_TOUCH_SESSION_PARAMETERS must be set to false. 

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_CONFIG_DIR

Specifies the Access Manager configuration directory.

Default: /etc/opt/SUNWam/config

Note: Do not change this parameter.

WEB_CONTAINER

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

• WS61 specifies Web Server 6.1.

• AS8 specifies Application Server 8.

• AS7 specifies Application Server 7.

Default: WS61 

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 6.1 or later: /opt/SUNWwbsvr

• Application Server 7: /var/opt/SUNWappserver7

• Application Server 8: /var/opt/SUNWappserver

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 later: 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 later: 

$CONTAINER_BASE_DIR/https-${WEB_CONTAINER_INSTANCE_NAME}

Application Server 7 or later: 

$CONTAINER_BASE_DIR/${WEB_CONTAINER_INSTANCE_NAME}

ASADMIN

Specifies the Application Server 8 asadmin utility location.

Default values: 

• Solaris systems: /opt/SUNWappserver/appserver/bin/asadmin

• Linux systems: /opt/sun/appserver/bin/asadmin

ASADMIN_USER

Specifies the Application Server 8 administrator user account.

Default: admin

ASADMIN_PASSFILE

Specifies the temporary password file location used by the asadmin utility. The amtune-as8 script creates this file and then deletes it after use.

Default: /tmp/passfile

ASADMIN_HOST

Specifies the Application Server 8 admin host name.

Default: $HOSTNAME

ASADMIN_PORT

Specifies the Application Server 8 admin port.

Default: 4849 

ASADMIN_SECURE

Specifies whether the ASADMIN_PORT is secure: 

• "--secure" specifies the port is secure.

• Blank specifies that the port is not secure.

Default: "--secure"

ASADMIN_TARGET

Specifies whether this Application Server 8 installation is used exclusively for Access Manager and Portal Server.

Default: server, indicating that Application Server 8 installation is exclusively used for Access Manager and Portal Server.

ASADMIN_INTERACTIVE

Specifies whether Application Server 8 administrator operates interactively. 

Default: false 

Caution: Do not change this parameter.

AMTUNE_WEB_CONTAINER_JAVA_POLICY

Specifies whether Application Server 8 evaluates Java security descriptors, as specified in the server.policy file.

Default: false 

Caution: Do not change this parameter. Evaluating Java security descriptors can add a significant performance overhead.