Web Agent Guides › Web Agent Configuration Guide › Web Agents › Web Agent Configurations › Parameters Requiring a Server Restart when Changed › WebAgent.conf file for Framework Agents

WebAgent.conf file for Framework Agents

Along with the AgentConfigObject, HostConfigFile, and EnableWebAgent parameters, the following parameters are also added to the WebAgent.conf file of Framework Agents:

Important! You should not modify any sections of the file that refer to other SiteMinder products besides the Web Agent. You may, however, change the values of the Web Agent parameters in the file.

LocalConfigFile

Specifies the location of the LocalConfig.conf file, where most of Agent configuration settings reside.

ServerPath

Identifies the web server directory (of Apache 2.0 and Oracle iPlanet web servers) to the Agent.

LoadPlugin

Specifies which plug-ins are loaded for IIS 6.0 and Apache 2.0 Agents. The plug-ins support different types of Agent functions. The following plug-ins are available:

HttpPlugin

Specifies whether the Web Agent operates as an HTTP agent.

Default: Enabled

SAMLAffiliatePlugin

Allows communication between the Web Agent and a SAML Affiliate Agent (if you have purchased Federation Security Services).

Default: Disabled

Affiliate10Plugin

Allows communication between the Web Agent and a 4.x Affiliate Agent.

Default: Disabled.

Limits: The SAML affiliate agent does not use this plug-in.

To enable the other LoadPlugin entries, remove the pound symbol (#) from the beginning of the line.

More Information

Manage Web Agents with Multiple Web Server Instances

LocalConfig.conf File Locations (Framework Agents)

When you install a Framework Web Agent, the SiteMinder installation program creates a LocalConfig.conf file in the following directory:

Windows

web _agent_home\config

UNIX

web _agent_home/config

Important! This file contains all of the default settings. Do not modify this file. We recommend creating a backup copy of this file for future reference or for recovery purposes.

When you configure the Web Agent, the configuration wizard copies the LocalConfig.conf file to the following directory:

IIS web server

web_agent_home\bin\IIS

Oracle iPlanet web server

Oracle_iPlanet_home/https-hostname/config

Apache web server

Apache_home/conf

The Web Agent retrieves its configuration settings from this copy of the LocalConfig.conf file.

Parameters Found Only in Local Configuration Files

For central Agent configurations, most of the parameters in the local configuration file are also in an Agent Configuration Object. The following parameters are used in the local configuration file only and are not found in Agent Configuration Objects:

AgentConfigObject

Defines the name of an Agent Configuration Object (stored on a policy server) in a local agent configuration file. This parameter is not used in Agent Configuration Objects.

Default: no default

EnableWebAgent

Activates a Web Agent and allows it to communicate with the Policy server. Set this parameter to yes only after you have finished changing all of the configuration parameters.

Default: No

HostConfigFile

Specifies the path to the SMHost.conf file (in an IIS 6.0 or Apache agent) that is created after a trusted host computer has been successfully registered with a Policy server. All Web Agents on a computer share the SMHost.conf file.

Default: No default

How to Edit an Agent Configuration File

The agent configuration file controls the settings of a locally configured Web Agent. To change those settings, use the following process:

1. Create a backup copy of WebAgent.conf (for a traditional agent) or the LocalConfig.conf file (for a Framework agent).
2. Open the original copy of the agent configuration file with a text editor.
3. Enable or disable parameters by doing any of the following tasks:
   • Removing the pound sign (#) from the beginning of the line to enable a parameter.
   • Adding the pound sign (#) to the beginning of the line to disable a parameter.
4. Change the values of parameters using the following guidelines:
   • Do not add spaces between the parameter names, the equal sign (=), and the parameter values.
   • Surround the parameter values with quotation marks.
   • The WebAgent.conf and LocalConfig.conf files are not case-sensitive. You do not have to match the case shown in the sample file that is installed with the agent.
   • Many values are shown in the file as descriptive variables, such as <Agent Name>,<IP Address>. Replace the angle brackets and text with the values you want.
   • In cases where the value is Empty, a blank is valid as the default. A default value applies only if there is no pound sign (#) preceding the parameter.
5. Set EnableWebAgent to yes only when you are done. Then save and close the file.

   All local configuration changes are effective. If you make more changes after an Agent has been enabled, restart your web server to apply those changes.