Sun Java System Access Manager Policy Agent 2.2 Guide for IBM Lotus Domino 7.0

Previous: Chapter 2 About Policy Agent 2.2 for IBM Lotus Domino 7.0
Next: Chapter 4 Relationship Between the Agent Profile and Web Agents in Policy Agent 2.2

Chapter 3 Installing the IBM Lotus Domino 7.0 Agent

After you install the agent, continue with the post-installation tasks in Chapter 5, Post-Installation Configuration: Policy Agent 2.2 for IBM Lotus Domino 7.0.

Installing the IBM Lotus Domino 7.0 Agent on UNIX and Linux Systems

The following tasks apply to Solaris, Linux, and AIX systems:

Preparing to Install the IBM Lotus Domino 7.0 Agent on UNIX and Linux Systems

To Prepare to Install the IBM Lotus Domino 7.0 Agent on UNIX and Linux Systems

Ensure that the IBM Lotus Domino 7.0 agent is supported on the desired platform, as listed in Supported Platforms and Compatibility for the IBM Lotus Domino 7.0 Agent.

Install IBM Lotus Domino 7.0 server, if it is not already installed.

Refer to the IBM Lotus Domino 7.0 documentation for details about how to install and configure this server for your platform.

Ensure that IBM Lotus Domino 7.0 has the latest patches available.

Set your JAVA_HOME environment variable to a JDK version 1.5 or later.

You must have JDK 1.5 or later to run the installation program graphical user interface (GUI).

If you do not set the JAVA_HOME variable, the program will prompt you for the path to your JDK:

Please enter JAVAHOME path to pick up java:

Installing the IBM Lotus Domino 7.0 Agent Using the GUI on UNIX and Linux Systems

To Install the IBM Lotus Domino 7.0 Agent on UNIX and Linux Systems

You must have superuser (root) permissions to run the web agent installation program.

If necessary, download the IBM Lotus Domino 7.0 agent distribution file from the following site:

Sun Downloads: http://www.sun.com/download/index.jsp

Unpack the distribution file in the directory of your choice. For example:

# gunzip -dc distribution-file.tar.gz| tar -xvof -

In the same directory, issue the following command:

# ./setup

The Welcome page appears.

In the Welcome page, click Next.

Read the License Agreement. Click Yes to agree to the license terms.

In the Select Installation Directory panel, specify the directory where you would like to install the web agent.

Install the web agent in this directory: Enter the full path to the directory where you want to install the web agent. The default installation directory is /opt.

The directory you choose in which to install the web agent is referred to as the Policy Agent base directory, or PolicyAgent-base.

Click Next and provide the following information about the IBM Lotus Domino 7.0 instance the agent will protect:

Host Name: Enter the fully qualified domain name (FQDN) of the machine where the IBM Lotus Domino 7.0 instance is installed.

For example, if the host is host1, the subdomain is eng, and the domain is example.com, then the Host Name in this case is host1.eng.example.com.

Lotus Domino Data directory: Specify the IBM Lotus Domino 7.0 instance that this agent will protect. The following is the default Lotus Domino Data directory:
```
/local/notesdata
```
Web Server Port: Enter the port number for the IBM Lotus Domino 7.0 instance that will be protected by the web agent.

Web Server Protocol: If the IBM Lotus Domino 7.0 instance has been configured for SSL, choose HTTPS; otherwise choose HTTP.

Agent Deployment URI: Enter a Universal Resource Identifier (URI) that will be used to access Agent for IBM Lotus Domino 7.0. The default value is /amagent.

Note –
The web agent uses the value of the com.sun.am.policy.agents.config.agenturi.prefix property in the web agent AMAgent.properties configuration file to support some essential functions such as notification.

Agent URI prefix is a configurable subset of Agent Deployment URI. It is important to set a valid URL for this property. Its value should be http://host.domain:port/agent-deployment-uri where host, domain and port are FQDN and port number of the IBM Lotus Domino 7.0 instance where the agent is installed and agent-deployment-uri is the URI where the IBM Lotus Domino 7.0 instance will look for web-agent related HTML pages. Its default value is amagent.

The following is an example of an Agent Deployment URI:
```
http://host1.example.com:80/amagent
```

When you have entered all the information correctly, click Next.

Enter information about the Access Manager host.

The web agent will connect to this server.

Primary Server Host: Enter the FQDN of the primary Access Manager host.

For example, if the host is host3, the subdomain is eng, and the domain is example.com, then the Host Name in this case is host3.eng.example.com.

Primary Server Port: Enter the port number for the primary Access Manager host.

Primary Server Protocol: If the primary Access Manager host is SSL-enabled, select HTTPS. Otherwise select HTTP.

Primary Server Deployment URI: Enter the location that was specified when Access Manager was installed. The default URI for Access Manager is /amserver.

If you are using the Lotus Domino 7.0 agent with Sun OpenSSO Enterprise or Sun OpenSSO Express, the URI should be /opensso rather than /amserver. For more information, see Using a Version 2.2 Policy Agent with OpenSSO Enterprise.

Primary Console Deployment URI: Enter the location that was specified when Access Manager Console was installed. The default URI for Access Manager is /amconsole.

Failover Server Host: Enter the FQDN of the secondary Access Manager host if the primary Access Manager host becomes unavailable. If no failover server host exists, then leave this field blank.

Failover Server Port: Enter the port number of the secondary Access Manager host. If no failover server host exists, then leave this field blank.

Failover Server Protocol: If the failover Access Manager host is SSL-enabled, select HTTPS. Otherwise select HTTP. If no failover server host exists, then leave this field blank.

Failover Server Deployment URI: Enter the location that was specified when Access Manager was installed. The default URI for Access Manager is /amserver. If no failover server host exists, then leave this field blank.

If you are using the Lotus Domino 7.0 agent with Sun OpenSSO Enterprise or Sun OpenSSO Express, the URI should be /opensso rather than /amserver. For more information, see Using a Version 2.2 Policy Agent with OpenSSO Enterprise.

Failover Console Deployment URI: Enter the location that was specified when Access Manager Console was installed. The default URI for Access Manager is /amconsole. If no failover server host exists, then leave this field blank.

Agent Access Manager Shared Secret: Enter the password for the Access Manager internal LDAP authentication user. This user is also referred to as amldapuser.

For more information about the shared secret and its relationship with the Access Manager agent profile, see Chapter 4, Relationship Between the Agent Profile and Web Agents in Policy Agent 2.2.

Re-enter Shared Secret: Re-enter the password for the Access Manager internal LDAP authentication user (amldapuser).

CDSSO Enabled: Do not check this box. Cross domain single sign-on is not supported on Agent for IBM Lotus Domino 7.0. For more information see Information Specific to the IBM Lotus Domino 7.0 Agent.

After entering all the information, click Next.

Review the installation summary to ensure that the information you have entered is correct.

If you want to make changes, click Back. If all the information is correct, click Next.

In the Ready to Install panel, click Install Now.

When the installation is complete, you can click Details to view details about the installation, or click Exit to end the installation program.

Restart the IBM Lotus Domino 7.0 instance on which you just installed the agent.

Next Steps

Continue with the post-configuration tasks, as described in Chapter 5, Post-Installation Configuration: Policy Agent 2.2 for IBM Lotus Domino 7.0.

Installing the IBM Lotus Domino 7.0 Agent Using the Command-Line Interface (CLI) on UNIX and Linux Systems

To Install the IBM Lotus Domino 7.0 Agent Using the Command-Line Interface (CLI) on UNIX and Linux Systems

If necessary, download the IBM Lotus Domino 7.0 agent distribution file from the following site:

Sun Downloads: http://www.sun.com/download/index.jsp

Unpack the agent distribution file in the directory of your choice. For example:

# gunzip -dc distribution-file.tar.gz| tar -xvof -

In the directory in which you unpacked the agent distribution file, issue the following command:

# ./setup -nodisplay

When prompted, provide the following information:

Have you read, and do you accept, all of the terms of the preceding Software License Agreement? Enter yes.

Install the web agent in this directory: Enter the full path to the directory in which you want to install the web agent.

The directory you choose in which to install the web agent is referred to as the Policy Agent base directory, or PolicyAgent-base.

Provide the following information about the IBM Lotus Domino 7.0 instance this agent will protect:
- Host Name
- Lotus Domino Data directory
- Web Server Port
- Web Server Protocol
- Agent Deployment URI
  
  For a description of the information to enter for these prompts, see Installing the IBM Lotus Domino 7.0 Agent Using the GUI on UNIX and Linux Systems.

Provide the following information about the Access Manager host:
- Primary Server Host
- Primary Server Port
- Primary Server Protocol
- Primary Server Deployment URI
- Primary Console Deployment URI
- Failover Server Host
- Failover Server Port
- Failover Server Protocol
- Failover Server Deployment URI
- Failover Console Deployment URI
- Agent-Access Manager Shared Secret
- Re-enter Shared Secret
- CDSSO Enabled
  
  For a description of the information to enter for these prompts, see Installing the IBM Lotus Domino 7.0 Agent Using the GUI on UNIX and Linux Systems.
  
  The following text is displayed:
  Ready to Install 1. Install Now 2. Start Over 3. Exit Installation

When prompted, What would you like to do?, enter 1 to start the installation.

The following text is displayed:

Product                                             Result      More Information
1.  Sun Java(tm) System Access Manager Policy Agent Installed   Available
2.  Done

To see log information, enter 1. To exit the installation program, enter 2.

Restart the IBM Lotus Domino 7.0 instance on which you just installed the agent.

Next Steps

After you have installed the IBM Lotus Domino 7.0 agent, perform the applicable post-configuration tasks, as described in Chapter 5, Post-Installation Configuration: Policy Agent 2.2 for IBM Lotus Domino 7.0.

Installing the IBM Lotus Domino 7.0 Agent on Windows Systems

Preparing to Install the IBM Lotus Domino 7.0 Agent on Windows Systems

Follow the specific steps outlined in this section before you install the web agent to reduce the chance of complications occurring during and after the installation.

To Prepare to Install the IBM Lotus Domino 7.0 Agent on Windows Systems

Ensure that Policy Agent 2.2 for IBM Lotus Domino 7.0 is supported on the desired platform as listed in Supported Platforms and Compatibility for the IBM Lotus Domino 7.0 Agent.

Install IBM Lotus Domino 7.0 server, if it is not already installed.

Refer to the IBM Lotus Domino 7.0 documentation for details on how best to install and configure this server for your platform.

Ensure that IBM Lotus Domino 7.0 has the latest patches available.

Set your JAVA_HOME environment variable to a JDK version 1.5 or later.

You must have JDK 1.5 or later to run the graphical user interface (GUI) for the installation program.

If you not set the JAVA_HOME variable, the program will prompt you for the path to your JDK:

Please enter JAVAHOME path to pick up java:

Ensure that required libraries are available on the IBM Lotus Domino 7.0 instance.

Depending on the Windows system you are using, the following libraries, msvcp70.dll and msvcr70.dll, might not be available. If these libraries are not available to the IBM Lotus Domino 7.0 instance , make them available as follows:
1. Obtain these Windows libraries: msvcp70.dll and msvcr70.dll.
  
  These libraries come with certain Windows applications. You can also obtain them by contacting Sun technical support.
2. Place the libraries in the system32 subdirectory.
  
  The following path is an example of a conceivable path to this directory:
```
c:\WINDOWS\system32
```

Installing the IBM Lotus Domino 7.0 Agent on Windows Systems

On Windows systems, the web agent installation program has only the graphical user interface (GUI). You must have administrator privileges to run the installation program.

To Install the IBM Lotus Domino 7.0 Agent on Windows Systems

If necessary, download the IBM Lotus Domino 7.0 agent distribution file from the following site:

Sun Downloads: http://www.sun.com/download/index.jsp

If necessary, unzip the agent distribution file. For example:
unzip distribution-file.zip
Note –
On Microsoft Windows 2003, the zip file is not automatically unzipped. Therefore, after you download the file, be sure to extract the zip file to a directory first and then execute setup.exe. To extract the zip file, right click on the zip file in the File Manager and select Extract.

Run the installation program by double-clicking setup.exe.

The Welcome page appears.

In the Welcome page, click Next.

Read the License Agreement. Click Yes to accept the license agreement.

Select the directory where you want to install the agent.

The directory you choose in which to install the web agent is referred to as the Policy Agent base directory, or PolicyAgent-base.

Enter the applicable information about the IBM Lotus Domino 7.0 instance where this agent will be installed in the dialog box.

The dialog box provides fields for entering the required information. You are prompted for information in the following order:

Host Name: Enter the fully qualified domain name (FQDN) of the system where the IBM Lotus Domino 7.0 instance is installed.

For example, if the host is host1, the subdomain is eng, and the domain is example.com, then the Host Name in this case is host1.eng.example.com.

Lotus Domino Data directory: Specify the IBM Lotus Domino 7.0 instance that this agent will protect. The following is the default Lotus Domino Data directory:
```
c:\Program Files\Lotus\Domino
```
The significance of this directory is that it contains the notes.ini file. The “Lotus Domino Data” wording is not a reference to any file or directory with “data” in the name.

Web Server Port: Enter the port number for the IBM Lotus Domino 7.0 instance that will be protected by the agent.

Web Server Protocol: If your IBM Lotus Domino 7.0 instance has been configured for SSL, then select HTTPS; otherwise select HTTP.

Agent Deployment URI: Enter a Universal Resource Identifier (URI) that will be used to access Agent for IBM Lotus Domino 7.0. The default value is /amagent.

Note –
The web agent uses the value of the com.sun.am.policy.agents.config.agenturi.prefix property in the web agent AMAgent.properties configuration file to support some essential functions such as notification. Agent URI prefix is a configurable subset of Agent Deployment URI. It is important to set a valid URL for this property. Its value should be http://host.domain:port/agent-deployment-uri where host, domain and port are FQDN and port number of the IBM Lotus Domino 7.0 instance where the agent is installed and agent-deployment-uri is the URI where the IBM Lotus Domino 7.0 instance will look for web-agent related HTML pages. Its default value is amagent.

The following is an example of an Agent Deployment URI:
```
http://host1.example.com:80/amagent
```

When you have entered all the information, click Next.

Provide the following information about the Access Manager host:

The deployment container will connect to this server.

Primary Server Host: Enter the FQDN of the primary Access Manager host.

For example, if the host is host3, the subdomain is eng, and the domain is example.com, then the Host Name in this case is host3.eng.example.com.

Primary Server Port: Enter the port number for the primary Access Manager host.

Primary Server Protocol: If the primary Access Manager host is SSL-enabled, select HTTPS. Otherwise select HTTP.

Primary Server Deployment URI: Enter the location that was specified when Access Manager was installed. The default URI for Access Manager is /amserver.

If you are using the Lotus Domino 7.0 agent with Sun OpenSSO Enterprise or Sun OpenSSO Express, the URI should be /opensso rather than /amserver. For more information, see Using a Version 2.2 Policy Agent with OpenSSO Enterprise.

Primary Console Deployment URI: Enter the location that was specified when Access Manager console was installed. The default URI for Access Manager is /amconsole.

Failover Server Host: Enter the FQDN of the secondary Access Manager host if the primary Access Manager host becomes unavailable. If no failover server host exists, then leave this field blank.

Failover Server Port: Enter the port number of the secondary Access Manager host. If no failover server host exists, then leave this field blank.

Failover Server Protocol: If the failover Access Manager host is SSL-enabled, select HTTPS. Otherwise select HTTP. If no failover server host exists, then leave this field blank.

Failover Server Deployment URI: Enter the location that was specified when Access Manager was installed. The default URI for Access Manager is /amserver. If no failover server host exists, then leave this field blank.

If you are using the Lotus Domino 7.0 agent with Sun OpenSSO Enterprise or Sun OpenSSO Express, the URI should be /opensso rather than /amserver. For more information, see Using a Version 2.2 Policy Agent with OpenSSO Enterprise.

Failover Console Deployment URI: Enter the location that was specified when Access Manager Console was installed. The default URI for Access Manager is /amconsole. If no failover server host exists, then leave this field blank.

Agent Access Manager Shared Secret: Enter the password for the Access Manager internal LDAP authentication user. This user is also referred to as amldapuser.

For more information about the shared secret and its relationship with the Access Manager agent profile, see Chapter 4, Relationship Between the Agent Profile and Web Agents in Policy Agent 2.2.

Re-enter Shared Secret: Re-enter the password for the Access Manager internal LDAP authentication user (amldapuser).

CDSSO Enabled: Do not check this box. Cross domain single sign-on is not supported on Agent for IBM Lotus Domino 7.0. For more information see Information Specific to the IBM Lotus Domino 7.0 Agent.

After entering all the information, click Next.

Review the installation summary to ensure that the information you have entered is correct.

If you want to make changes, click Back. If all the information is correct, click Next.

In the Ready to Install page, click Install Now.

When the installation is complete, you can click Details to view details about the installation, or click Close to end the installation program.

Restart the IBM Lotus Domino 7.0 instance on which you just installed the agent.

Restarting your computer is necessary for the agent to work properly. The installation modifies the system path by appending to it the location of the agent libraries. This change takes effect only after your computer is restarted.