After you run the Java Enterprise System installer, the Access Manager sample configuration script input file (amsamplesilent) is available in the AccessManager-base/SUNWam/bin directory on Solaris systems or the AccessManager-base/identity/bin directory on Linux systems.
To set configuration variables, first copy and rename the amsamplesilent file. Then set the variables in the copy for the operation you want to perform. For an example of this file, see Example Configuration Script Input File.
This sample silent mode input file contains the following configuration variables:
This section describes the values for the required DEPLOY_LEVEL variable. This variable determines the operation you want the amconfig script to perform.
Table 1–1 Access Manager DEPLOY_LEVEL Variable
Operation |
DEPLOY_LEVEL Variable Value and Description |
---|---|
Install |
1 = Full Access Manager installation for a new instance (default) 2 = Install Access Manager console only 3 = Install Access Manager SDK only 4 = Install SDK only and configure the container 5 = Install Federation Management module only 6 = Install server only 7=Install Access Manager and configure the container for deploying with Portal Server. Caution DEPLOY_MODE=7 is intended only for deploying Access Manager with Portal Server. For some deployments, you might want to install the console only and server only on a single host server using different web containers. First, run the Java ES installer to install all Access Manager subcomponents using the Configure Later option. Then, run the amconfig script to configure both the console and server instances. |
Uninstall (unconfigure) |
11 = Full uninstall 12 = Uninstall console only 13 = Uninstall SDK only 14 = Uninstall SDK only and unconfigure the container 15 = Uninstall Federation Management module 16 = Uninstall server only Uninstall Access Manager and unconfigure the container when deployed with Portal Server. Caution DEPLOY_MODE=7 is intended only when Access Manager is deployed with Portal Server. |
Re-install (also referred to as re-deploy or re-configure) |
21 = Redeploy all (console, password, services, and common) web applications. 26 = Undeploy all (console, password, services, and common) web applications. |
This section describes the Access Manager configuration variables.
Table 1–2 Access Manager Configuration Variables
Variable |
Description |
---|---|
AM_REALM |
Indicates the Access Manager mode:
Default: enabled Caution – Access Manager Realm Mode is enabled by default. If you are deploying Access Manager with Portal Server, Messaging Server, Calendar Server, Delegated Administrator, or Instant Messaging, you must select Legacy Mode (AM_REALM=disabled) before you run the amconfig script. |
BASEDIR |
Base installation directory for Access Manager packages. Default: PLATFORM_DEFAULT For Solaris systems, PLATFORM_DEFAULT is /opt For Linux systems, PLATFORM_DEFAULT is /opt/sun |
SERVER_HOST |
Fully qualified host name of the system where Access Manager is running (or will be installed). For a remote SDK installation, set this variable to the host where Access Manager is (or will be) installed and not the remote client host. This variable should match the counterpart variable in the web container configuration. For example, for Application Server 8, this variable should match AS81_HOST. |
SERVER_PORT |
Access Manager port number. Default: 58080 For a remote SDK installation, set this variable to the port on the host where Access Manager is (or will be) installed and not the remote client host. This variable should match the counterpart variable in the web container configuration. For example, for Application Server 8, this variable should match AS81_PORT. |
SERVER_PROTOCOL |
Server protocol: http or https. Default: http For a remote SDK installation, set this variable to the protocol on the host where Access Manager is (or will be) installed and not the remote client host. This variable should match the counterpart variable in the web container configuration. For example, for Application Server 8, this variable should match AS81_PROTOCOL. |
CONSOLE_HOST |
Fully qualified host name of the server where the console is installed. Default: Value provided for the Access Manager host |
CONSOLE_PORT |
Port of the web container where the console is installed and listens for connections. Default: Value provided for the Access Manager port |
CONSOLE_PROTOCOL |
Protocol of the web container where the console is installed. Default: Server protocol |
CONSOLE_REMOTE |
Set to true if the console is remote from the Access Manager services. Otherwise, set to false. Default: false |
DS_HOST |
Fully qualified host name of Directory Server. |
DS_PORT |
Directory Server port. Default: 389. |
DS_DIRMGRDN |
Directory manager DN: the user who has unrestricted access to Directory Server. Default: "cn=Directory Manager" |
DS_DIRMGRPASSWD |
Password for the directory manager See the note about special characters in the description of Access Manager Configuration Variables. |
ROOT_SUFFIX |
Initial or root suffix of the directory. You must make sure that this value exists in the Directory Server you are using. See the note about special characters in the description of Access Manager Configuration Variables. |
ADMINPASSWD |
Password for the administrator (amadmin). Must be different from the password for amldapuser. Note: If the password contains special characters such as a slash (/) or backslash (\\), the special character must be enclosed by single quotes (”). For example: ADMINPASSWD=’\\\\\\\\\\####///’ However, the password cannot have a single quote as one of the actual password characters. |
AMLDAPUSERPASSWD |
Password for amldapuser. Must be different from the password for amadmin. See the note about special characters in the description of Access Manager Configuration Variables. |
CONSOLE_DEPLOY_URI |
URI prefix for accessing the HTML pages, classes and JAR files associated with the Access Manager Administration Console subcomponent. Default: /amconsole |
SERVER_DEPLOY_URI |
URI prefix for accessing the HTML pages, classes, and JAR files associated with the Identity Management and Policy Services Core subcomponent. Default: /amserver |
PASSWORD_DEPLOY_URI |
URI that determines the mapping that the web container running Access Manager will use between a string you specify and a corresponding deployed application. Default: /ampassword |
COMMON_DEPLOY_URI |
URI prefix for accessing the common domain services on the web container. Default: /amcommon |
COOKIE_DOMAIN |
Names of the trusted DNS domains that Access Manager returns to a browser when it grants a session ID to a user. At least one value should be present. In general, the format is the server’s domain name preceded with a period. Example: .example.com |
JAVA_HOME |
Path to the JDK installation directory. Default: /usr/jdk/entsys-j2se. This variable provides the JDK used by the command line interface’s (such as amadmin) executables. The version must be 1.4.2 or later. |
AM_ENC_PWD |
Password encryption key: String that Access Manager uses to encrypt user passwords. Default: none. When the value is set to none, amconfig will generate a password encryption key for the user, so a password encryption will exist for the installation that is either specified by the user or created through amconfig . Important: If you are deploying multiple instances of Access Manager or the remote SDK, all instances must use the same password encryption key. When you deploy an additional instance, copy the value from the am.encryption.pwd property in the AMConfig.properties file for the first instance. |
PLATFORM_LOCALE |
Locale of the platform. Default: en_US (US English) |
NEW_OWNER |
New owner for the Access Manager files after installation. Default: root |
NEW_GROUP |
New group for the Access Manager files after installation. Default: other For a Linux installation, set NEW_GROUP to root. |
PAM_SERVICE_NAME |
Name of the PAM service from the PAM configuration or stack that comes with the operating system and is used for the Unix authentication module (normally other for Solaris or password for Linux). Default: other. |
XML_ENCODING |
XML encoding. Default: ISO-8859-1 |
NEW_INSTANCE |
Specifies whether the configuration script should deploy Access Manager to a new user-created web container instance:
|
SSL_PASSWORD |
Is not used in this release. |
To specify the web container for Access Manager, set the WEB_CONTAINER variable in the silent mode input file. For the versions of the web containers supported by Access Manager 7 2005Q4, see the Sun Java System Access Manager 7 2005Q4 Release Notes.
Table 1–3 Access Manager WEB_CONTAINER Variable
Value |
Web Container |
---|---|
WS6 (default) | |
AS8 | |
WL8 | |
WAS5 |
This section describes the configuration variables for Web Server 6.1 2005Q4 SP5 in the silent mode input file.
Table 1–4 Web Server 6.1 Configuration Variables
Variable |
Description |
---|---|
WS61_INSTANCE |
Name of the Web Server instance on which Access Manager will be deployed or un-deployed. Default: https-web-server-instance-name where web-server-instance-name is the Access Manager host (Access Manager Configuration Variables variable) |
WS61_HOME |
Web Server base installation directory. Default: /opt/SUNWwbsvr |
WS61_PROTOCOL |
Protocol used by the Web Server instance set by the Sun Java System Web Server 6.1 SP5 variable where Access Manager will be deployed: http or https. Default: Access Manager protocol (Access Manager Configuration Variables variable) |
WS61_HOST |
Fully qualified host name for the Web Server instance ( Sun Java System Web Server 6.1 SP5 variable). Default: Access Manager host instance (Access Manager Configuration Variables variable) |
WS61_PORT |
Port on which Web Server listens for connections. Default: Access Manager port number (Access Manager Configuration Variables variable) |
WS61_ADMINPORT |
Port on which the Web Server Administration Server listens for connections. Default: 8888 |
WS61_ADMIN |
User ID of the Web Server administrator. Default: "admin" |
This section describes the configuration variables for Application Server 8.1 in the silent mode input file.
Table 1–5 Application Server 8.1 Configuration Variables
Variable |
Description |
---|---|
AS81_HOME |
Path to the directory where Application Server 8.1 is installed. Default: /opt/SUNWappserver/appserver |
AS81_PROTOCOL |
Protocol used by the Application Server instance: http or https. Default: Access Manager protocol (Access Manager Configuration Variables variable) |
AS81_HOST |
Fully qualified domain name (FQDN) on which the Application Server instance listens for connections. Default: Access Manager host (Access Manager Configuration Variables variable) |
AS81_PORT |
Port on which Application Server instance listens for connections. Default: Access Manager port number (Access Manager Configuration Variables variable) |
AS81_ADMINPORT |
Port on which the Application Server administration server listens for connections. Default: 4849 |
AS81_ADMIN |
Name of the user who administers the Application Server administration server for the domain into which Application Server is being displayed. Default: admin |
AS81_ADMINPASSWD |
Password for the Application Server administrator for the domain into which Application Server is being displayed. See the note about special characters in the description of Access Manager Configuration Variables. |
AS81_INSTANCE |
Name of the Application Server instance that will run Access Manager. Default: server |
AS81_DOMAIN |
Path to the Application Server directory for the domain to which you want to deploy this Access Manager instance. Default: domain1 |
AS81_INSTANCE_DIR |
Path to the directory where Application Server stores files for the instance. Default: /var/opt/SUNWappserver/domains/domain1 |
AS81_DOCS_DIR |
Directory where Application Server stores content documents. Default: /var/opt/SUNWappserver/domains/domain1/docroot |
AS81_ADMIN_IS_SECURE |
Specifies whether the Application Server administration instance is using SSL:
|
This section describes the configuration variables for BEA WebLogic Server 8.1 in the silent mode input file.
Table 1–6 BEA WebLogic Server 8.1 Configuration Variables
Variable |
Description |
---|---|
WL8_HOME |
WebLogic home directory. Default: /usr/local/bea |
WL8_PROJECT_DIR |
WebLogic project directory. Default: user_projects |
WL8_DOMAIN |
WebLogic domain name. Default: mydomain |
WL8_SERVER |
WebLogic server name. Default: myserver |
WL8_INSTANCE |
WebLogic instance name. Default: /usr/local/bea/weblogic81 ($WL8_HOME/weblogic81) |
WL8_PROTOCOL |
WebLogic protocol. Default: http |
WL8_HOST |
WebLogic host name. Default: Host name of the server |
WL8_PORT |
WebLogic port. Default: 7001 |
WL8_SSLPORT |
WebLogic SSL port. Default: 7002 |
WL8_ADMIN |
WebLogic administrator. Default: "weblogic" |
WL8_PASSWORD |
WebLogic administrator password. See the note about special characters in the description of Access Manager Configuration Variables. |
WL8_JDK_HOME |
WebLogic JDK home directory. Default: BEA WebLogic Server 8.1 /jdk142_04 |
WL8_CONFIG_LOCATION |
Should be set to the parent directory of the location of the WebLogic start script. |
This section describes the configuration variables for IBM WebSphere Server 5.1 in the silent mode input file.
Table 1–7 IBM WebSphere 5.1 Configuration Variables
Variable |
Description |
---|---|
WAS51_HOME |
WebSphere home directory. Default: /opt/WebSphere/AppServer |
WAS51_JDK_HOME |
WebSphere JDK home directory. Default: /opt/WebSphere/AppServer/java |
WAS51_CELL |
WebSphere cell. Default: hostname value |
WAS51_NODE |
WebSphere node name. Default: host name of the server where WebSphere is installed. Default: hostname value |
WAS51_INSTANCE |
WebSphere instance name. Default: server1 |
WAS51_PROTOCOL |
WebSphere protocol. Default: http |
WAS51_HOST |
WebSphere host name. Default: Hostname of the server |
WAS51_PORT |
WebSphere port. Default: 9080 |
WAS51_SSLPORT |
WebSphere SSL port. Default: 9081 |
WAS51_ADMIN |
WebSphere administrator. Default: "admin" |
WAS51_ADMINPORT |
WebSphere administrator port. Default: 9090 |
For the versions of Directory Server supported by Access Manager 7 2005Q4, see the Sun Java System Access Manager 7 2005Q4 Release Notes. This section describes the Directory Server configuration variables in the silent mode input file.
Table 1–8 Directory Server Configuration Variables
Variable |
Description |
---|---|
DIRECTORY_MODE |
Directory Server modes: 1 = Use for a new installation of a Directory Information Tree (DIT). 2 = Use for an existing DIT. The naming attributes and object classes are the same, so the configuration scripts load the installExisting.ldif and umsExisting.ldif files. The configuration scripts also update the LDIF and properties files with the actual values entered during configuration (for example, BASE_DIR, SERVER_HOST, and ROOT_SUFFIX). This update is also referred to as “tag swapping,” because the configuration scripts replace the placeholder tags in the files with the actual configuration values. 3 = Use for an existing DIT when you want to do a manual load. The naming attributes and object classes are different, so the configuration scripts do not load the installExisting.ldif and umsExisting.ldif files. The scripts perform tag swapping (described for mode 2). You should inspect and modify (if needed) the LDIF files and then manually load the LDIF files and services. 4 = Use for an existing multi-server installation. The configuration scripts do not load the LDIF files and services, because the operation is against an existing Access Manager installation. The scripts perform tag swapping only (described for mode 2) and adds a server entry in the platform list. 5 = Use for an existing upgrade. The scripts perform tag swapping only (described for mode 2). Default: 1 |
USER_NAMING_ATTR |
User naming attribute: Unique identifier for the user or resource within its relative name space. Default: uid |
ORG_NAMING_ATTR |
Naming attribute of the user’s company or organization. Default: o |
ORG_OBJECT_CLASS |
Organization object class. Default: sunismanagedorganization |
USER_OBJECT_CLASS |
User object class. Default: inetorgperson |
DEFAULT_ORGANIZATION |
Default organization name. Default: none |