Installation and Upgrade Guides › Web Agent Installation Guide for Domino › Install and Configure an Agent for Domino on Windows › How to Install and Configure an Agent for Domino on Windows

How to Install and Configure an Agent for Domino on Windows

Installing and configuring the CA SiteMinder® Agent for Domino involves several separate procedures. To install and configure the Agent for Domino, use the following process:

1. Gather the information for the installation program.
2. Run the wizard based installation program.
3. Gather the information that the configuration that the program requires.
4. Add the Domino Agent DLL file.
5. Run the configuration program.
6. (Optional) Install and configure the Agent for Domino on additional Domino servers silently.
7. (Optional) Perform any of the following procedures:
   • Configure the CGI Directory and CGI URL path settings.
   • Configure alias settings to enable HTML forms authentication.

Gather the Information for the Installation Program

Gather the following information about your web server before running the installation program for the agent:

Installation Directory

Specifies the location of the agent binary files on your web server. The web_agent_home variable is set to this location.

Limit: The product requires the name "webagent" for the bottom directory in the path

Run the Installation Program on Windows

The installation program for the agent installs the agent on one computer at a time using the Windows operating environment. This installation program can be run in wizard or console modes. The wizard and console-based installation programs also create a .properties file for subsequent installations and configurations using the unattended or silent method with the same settings.

For example, suppose the Agents in your environment use the same web server version, installation directory, Agent Configuration Object and Policy Servers. Use the installation wizard or console-based installation program for your first installation. Afterwards, you could create your own script to run the installation program with the .properties file the wizard or console-based installation program created.

Follow these steps:

1. Copy the Web Agent installation executable file to a temporary directory on your web server.
2. Do one of the following steps:
   • For wizard-based installations, right-click the installation executable file, and then select Run as Administrator.
   • For console-based installations, open a command line window and run the executable as shown in the following example:

     executable_file_name.exe -i console
     

3. Use the information that you gathered previously to complete the installation.

More information:

Web Agent Install Worksheet for the Windows Operating Environment

Gather the Information that the Configuration Program Requires on Windows

Gather the following information before running the configuration program for the agent on your Domino server:

Register Host

Indicates whether you want to register a trusted host. This registration creates a trusted host object in the Policy Server and an SmHost.conf file on the web server. The agent uses this information to make an initial connection to Policy Servers when it starts. Register each agent instance as a trusted host only once.

Default:Yes

Limits: Yes, No

Admin User Name

Specifies the name of a CA SiteMinder® user with Administrative privileges that is already defined in the Policy Server. This user account requires privileges to register trusted hosts.

Admin Password

Specifies a password for the Admin User Name that is already defined in the Policy Server.

Confirm Admin Password

Repeats the password entered in the Admin Password field. This value verifies the password for the Admin User Name already defined in the Policy Server.

Trusted Host Object Name

Specifies a unique name for the trusted host you are registering. This trusted host object is stored on the Policy Server.

Host Configuration Object

Specifies the name of a Host Configuration Object that is already defined in the CA SiteMinder® Policy Server. After the agent initially connects to a Policy Server (using the SmHost.conf file settings), subsequent connections use the settings from the Host Configuration Object.

Policy Server IP Address

Specifies the Internet Protocol address of the Policy Servers to which the agent attempts to connect upon startup. If your Policy Server is behind a firewall, specify a port number also.

If a hardware load balancer is configured to expose Policy Servers in your environment through a single Virtual IP Address (VIP), enter the VIP.

Example: (IPV4) 192.168.1.105

Example: (IPV4 with the port number) 192.168.1.105:44443

Example: (IPV6) 2001:DB8::/32

Example: (IPV6) [2001:DB8::/32]:44443

FIPS Mode Setting

Specifies one of the following algorithms:

FIPS Compatibility/AES Compatibility

Uses algorithms existing in previous versions of CA SiteMinder® to encrypt sensitive data and is compatible with previous versions of CA SiteMinder®. If your organization does not require the use of FIPS-compliant algorithms, use this option.

FIPS Migration/AES Migration

Allows a transition from FIPS-compatibility mode to FIPS-only mode. In FIPS-migration mode, the environment continues to use existing CA SiteMinder® encryption algorithms as you reencrypt existing sensitive data using FIPS-compliant algorithms.

FIPS Only/AES Only

Uses only FIPS-compliant algorithms to encrypt sensitive data in the CA SiteMinder® environment. This setting does not interoperate with, nor is backwards-compatible with, previous versions of CA SiteMinder®.

Default: FIPS Compatibility/AES Compatibility

Note: FIPS is a US government computer security standard that accredits cryptographic modules which meet the Advanced Encryption Standard (AES).

Important! Use a compatible FIPS/AES mode (or a combination of compatible modes) for both the CA SiteMinder® agent and the CA SiteMinder® Policy Server.

Name

Specifies the name of the SmHost.conf file which contains the settings the Web Agent uses to make initial connections to a Policy Server.

Default: SmHost.conf

Location

Specifies the directory where the SmHost.conf file is stored.

Default: web_agent_home\config

Enable Shared Secret Rollover

Select this check box to change the shared secret that the Policy Server uses to encrypt communications to the Web Agents.

iNotes File

Specifies the location of the iNotes file for a Web Agent running on a Domino web server.

Select Servers

Indicates the web server instances that the configuration program finds on the computer. Select the check boxes of the instances you want to configure. Clear the check boxes of those instances from which you want to remove CA SiteMinder® protection.

Agent Configuration Object Name

Specifies the name of an agent configuration object (ACO) already defined on the Policy Server.

Default: AgentObj

Advanced Authentication Scheme Dialog

Specifies the advanced authentication scheme for the web server instances you selected previously.

Add the Domino Web Agent DLL (Windows)

To make the Domino Web Agent operate properly, add the DOMINOWebAgent.dll file to the filter DLLs. The Web Agent DLL must be the first DLL in the list.

Follow these steps:

1. Open Lotus Notes.
2. Select File, Database, Open.
3. In the Server field, select the Domino Server where you installed the Web Agent.
4. In the Database scroll box, select the address book of the server.

   Verify that names.nsf appears in the Filename field.

5. Click Open.
6. In the left pane, expand the Server folder and double-click the All Server Documents icon.
7. Select your server and click Edit Server.
8. Select the Internet Protocols tab.
9. In the DSAPI section of the window, find the DSAPI filter file names field and enter the full path to the Domino Web Agent DLL. Verify that the Domino Web Agent DLL appears first in the list. The default location of this DLL file is shown in the following example:

   web_agent_home\bin\DOMINOWebAgent.dll

   web_agent_home

   Indicates the directory where the CA SiteMinder® agent is installed on your web server.

   Default (Windows 32-bit installations only): C:\Program Files\CA\webagent

   Default (Windows 64-bit installations only): C:\Program Files\CA\webagent\win64

   Default (Windows 32-bit applications operating on 64-bit systems [Wow64]): C:\Program Files (x86)\webagent\win32

10. Click Save and Close.
11. Restart the web server. In some situations, a reboot could possibly be necessary.

Run the Web Agent Configuration Program on Windows

After gathering the information for your agent configuration, run the agent configuration program. This program creates an agent runtime instance for the web servers running on your computer.

This configuration program is wizard or console based, depending on the option you select. Running the configuration program in the wizard or console modes once creates a properties file. Use the properties file to run unattended configurations on other computers with same operating environment in the future.

Follow these steps:

1. Open the following directory on your web server:

   web_agent_home\install_config_info

   web_agent_home

   Indicates the directory where the CA SiteMinder® agent is installed on your web server.

   Default (Windows 32-bit installations only): C:\Program Files\CA\webagent

   Default (Windows 64-bit installations only): C:\Program Files\CA\webagent\win64

   Default (Windows 32-bit applications operating on 64-bit systems [Wow64]): C:\Program Files (x86)\webagent\win32

2. Use one of the following configuration methods:
   • For a GUI-based configuration, go to Step 3.
   • For a console-based configuration, go to Step 5.
3. Right-click the following executable, and then select Run as Administrator:

   ca-wa-config.exe
   

4. Go to Step 8.
5. Open a Command Prompt window with Administrator privileges.
6. Navigate to the executable file listed previously, and then run it with the following switch:

   -i console
   

7. Go to Step 8.
8. Follow the prompts shown in the configuration program. Provide the requested values from your agent configuration worksheet.

   The agent runtime instance is created for your web servers.