Pre-Installation Tasks for the WebSphere Application Server/Portal Server Agent

• Setting Your JAVA_HOME Environment Variable

• Downloading and Unzipping the websphere_v61_agent_3.zip Distribution File

• Creating a Password File

• Creating an Agent Profile

• Creating an Agent Administrator

Setting Your JAVA_HOME Environment Variable

Version 3.0 agents, including the agentadmin program, require JDK 1.5 or later to be available on the server where you plan to install the agent. Before you install the agent, set your JAVA_HOME environment variable to point to the JDK installation directory.

Downloading and Unzipping the websphere_v61_agent_3.zip Distribution File

To Download and Unzip the websphere_v61_agent_3.zip Distribution File

1. Login to the server where you want to install the agent.

2. Create a directory to unzip the websphere_v61_agent_3.zip distribution file.

   This guide uses Agent-HomeDirectory to represent the directory where you unzip the distribution file.

3. Download and unzip the websphere_v61_agent_3.zip distribution file from one of the following sites:

   • Sun Downloads site under Identity Management > Policy Agents: http://www.sun.com/download/index.jsp

   • OpenSSO project site: https://opensso.dev.java.net/public/use/index.html

   The following table shows the files and directories after you unzip the agent distribution file, which are in the following directory:

   Agent-HomeDirectory/j2ee_agents/websphere_v61_agent

   Agent-HomeDirectory is where you unzipped the agent distribution file.

   File or Directory	Description
   README.txt and license.txt	Readme and license files
   /bin	agentadmin and agentadmin.bat programs
   /config	Template, properties, and XML files
   /data	license.log file. Do not edit this file.
   /etc	Agent application (agentapp.war). The agent application is a housekeeping application used by the agent for notifications and other functions such as cross domain single sign-on (CDSSO) support. For more information, see Deploying the Agent Application.
   /installer-logs	Log files written by the agentadmin or agentadmin.bat program: /audit contains local audit trail for the agent instance. /debug contains the debug files for the agent instance when the agent runs in debug mode.
   /lib	Required JAR files
   /locale	Required properties files
   /sampleapp	Policy agent sample application. For information, see Deploying the Java EE Policy Agent Sample Application.

Creating a Password File

A password file is an ASCII text file with only one line specifying the password in clear text. By using a password file, you are not forced to expose a password at the command line during the agent installation. When you install the WebSphere Application Server/Portal Server agent using the agentadmin program, you are prompted to specify paths to following password files:

• An agent profile password file is required for both the agentadmin default and custom installation options.

• An agent administrator password file is required only if you use the custom installation option and have the agentadmin program automatically create the agent profile in OpenSSO Enterprise server during the installation.

To Create a Password File

1. Create an ASCII text file for the agent profile. For example: /tmp/wsas6agentpw

2. If you want the agentadmin program to automatically create the agent profile in OpenSSO Enterprise server during the installation, create another password file for the agent administrator. For example: /tmp/agentadminpw

3. Using a text editor, enter the appropriate password in clear text on the first line in each file.

4. Secure each password file appropriately, depending on the requirements for your deployment.

Creating an Agent Profile

The WebSphere Application Server/Portal Server agent uses an agent profile to communicate with OpenSSO Enterprise server. You can create an agent profile using any of these three methods:

• Create the agent profile during installation when you run the agentadmin program with the --custom-install option. The program prompts you for this information:

  • Agent profile name and path to the agent profile password file

  • Agent administrator name and path to the agent administrator password file

• Use the OpenSSO Enterprise Console

• Use the ssoadm command-line utility with the create-agent subcommand. For more information about the ssoadm command, see the Sun OpenSSO Enterprise 8.0 Administration Reference.

To Create an Agent Profile in the OpenSSO Enterprise Console

1. Login into the OpenSSO Enterprise Administration Console as amAdmin.

2. Click Access Control, realm-name, Agents, and then J2EE.

3. Under Agent, click New.

4. In the Name field, enter the name for the new agent profile. For example: WSASAgentProfile

5. Enter and confirm the Password.

   Important: This password must be the same password that you enter in the agent profile password file that you specify when you run the agentadmin program to install the agent.

6. In the Server URL field, enter the OpenSSO Enterprise server URL.

   For example: http://openssohost.example.com:8080/opensso

7. In the Agent URL field, enter the URL for the agent application (agentapp).

   For example: http://agenthost.example.com:8090/agentapp

   The agent application (agentapp.war) is a housekeeping application used by the agent for notifications and other functions such as cross domain single sign-on (CDSSO) support. For more information, see Deploying the Agent Application.

8. Click Create.

   The console creates the agent profile and displays the J2EE Agent page again with a link to the new agent profile, WSASAgentProfile.

   To do additional configuration for the agent profile, click the agent link to display the Edit agent page. For information about the agent configuration fields, see the Console online Help.

   If you prefer, you can also use the ssoadm command-line utility to edit the agent profile. For more information, see the Sun OpenSSO Enterprise 8.0 Administration Reference.

   ---

   Tip –

   Make a note of the values you specified for the agent profile, including the profile name, password, server URL, and agent URL. You will need these values when you install the agent using the agentadmin program.

   ---

9. If the WebSphere Application Server/Portal Server agent will not retrieve the Role from the Access Manager SDK (AMSDK) Identity Repository Plug-in, perform the following steps:

   1. Click the WebSphere Application Server/Portal Server agent link (for example, WSASAgentProfile) to display the agent profile Edit page.

   2. Click the Application subtab.

   3. Click the Privilege Attributes Processing link.

   4. Under the Privilege Attributes Processing section, remove Role from the Current Values for the Privileged Attribute Type list box.

      You should have only Group left under the Current Values.

   5. Click Save.

Creating an Agent Administrator

An agent administrator can manage agents in OpenSSO Enterprise, including:

• Agent management: Use the agent administrator to manage agents either in the OpenSSO Enterprise Console or by executing the ssoadm utility.

• Agent installation: If you install the agent using the custom installation option (agentadmin --custom-install) and want to have the installation program create the agent profile, specify the agent administrator (and password file) when you are prompted.

To Create an Agent Administrator

1. Login to OpenSSO Enterprise Administration Console.

2. Create a new agents administrator group:

   1. Click Access Control, realm-name, Subjects, and then Group.

   2. Click New.

   3. In ID, enter the name of the group. For example: agentadmingroup

   4. Click OK.

3. Create a new agent administrator user and add the agent administrator user to the agents administrator group:

   1. Click Access Control, realm-name, Subjects, and then User.

   2. Click New and provide the following values:

      • ID: Name of the agent administrator. For example: agentadminuser

        This is the name you will use to login to the OpenSSO Enterprise Console .

      • First Name (optional), Last Name, and Full Name.

        For simplicity, use the same name for each of these values that you specified for ID.

      • Password (and confirmation)

      • User Status: Active

   3. Click OK.

   4. Click the new agent administrator name.

   5. On the Edit User page, click Group.

   6. Add the agents administrator group from Available to Selected.

   7. Click Save.

4. Assign read and write access to the agents administrator group:

   1. Click Access Control, realm-name, Privileges and then on the new agents administrator group link.

   2. Check “Read and write access to all configured Agents”.

   3. Click Save.

Next Steps

Login into the OpenSSO Enterprise Console as the new agent administrator. The only available top-level tab is Access Control. Under realm-name, you will see only the Agents tab and sub tabs.