Policy Server Guides › Policy Server Configuration Guide › Agents and Agent Groups › Agent Configuration Object Overview

Agent Configuration Object Overview

An agent configuration object holds the parameters that define the agent configuration. The configuration object is the Policy Server counterpart to the LocalConfig.conf agent configuration file.

When you configure an agent, you are prompted for the name of the agent configuration object. The configuration object is associated with the agent that you are configuring.

More information:

Required Agent Configuration Object Parameters

Copy an Agent Configuration Object

You can create a new Agent configuration object by copying an existing Agent configuration object. Sample Agent configuration objects are provided for supported Web Agents. After the new Agent configuration object is created, you can modify its list of parameters and their values.

Note: For more information about parameters and default settings, see the Web Agent Configuration Guide.

To copy an Agent Configuration Object

1. Click Infrastructure, Agent.
2. Click Agent Configuration Objects.

   The Agent Configuration Objects page appears.

3. Click Create Agent Configuration.

   The Create Agent Configuration page appears.

4. Select the Create a copy of an object of type Agent Configuration option, and do one of the following:
   • Select one of the default Agent Configuration Objects from the list.
   • Click Search and select one from the list of Agent Configuration Objects that is displayed.
5. Click OK.

   The Create Agent Configuration: page appears.

6. Enter a new name and description and click Submit.

   You are prompted to specify a parameter or continue entering a comment.

7. Enter a comment and click Yes.

   The Agent Configuration Object based on the default Agent Configuration Object is created.

Create an Agent Configuration Object

The Policy Server installer creates several Agent Configuration Objects for several supported web servers that contain default settings. These sample objects have names, such as IISDefaultSettings or iPlanetDefaultSettings. You can duplicate these default objects and use them as templates for your Agent configuration.

Note: We recommend creating a new Agent Configuration Object by copying an existing object and modifying its list of parameters and their values. If you create a new Agent Configuration object without copying an existing one, enter all of your parameters and their values manually.

Follow these steps:

1. Click Infrastructure, Agent.
2. Click Agent Configuration Objects.

   The Agent Configuration Objects page appears.

3. Click Create Agent Configuration.

   Verify that the Create a new object of type Agent Configuration option is selected.

4. Click OK.

   The Create Agent Configuration page appears.

   Note: Click Help for descriptions of settings and controls, including their respective requirements and limits.

5. Type the name and a description of the Agent.
6. Click Add.

   The Create Parameter page appears.

7. Type the ame and value of the parameter.
8. (Optional) Do one of the following:
   • To encrypt the value of the parameter, select the Encrypted option.
   • To add multiple values for a parameter, do the following:
     1. Select the Multi-value option.
     2. Type a value for the parameter.
     3. Click Add.
     4. Repeat Steps b and c until you have added all the values you want.
     5. (Optional) To change the sequence of multiple values, click the up and down arrows. Multiple values are separated by the square symbol () when displayed on the Parameters page. To delete a value, click the minus sign.

     Note: You cannot enter multiple values for encrypted parameters. A single encrypted value is displayed as a string of symbols.

9. Click OK.

   The parameter is added to the list.

   Note: Parameters are listed in alphabetical order by name. To edit a parameter on the list, click the right arrow. To delete a parameter from the list, click the minus sign. To add more parameters to the Agent configuration object, repeat Steps 4 through 7.

10. Click Submit.

    The Agent Configuration Object is created.

Required Agent Configuration Object Parameters

Agent configuration objects require settings for the following parameters:

• All Agents require DefaultAgentName
• IIS Agents require DefaultUserName and DefaultPassword
• (Domino Agents only) DominoDefaultUser
• (Domino Agents only) DominoSuperUser

Note: More information about these parameters exists in the Web Agent Installation Guide.

Specify the IIS Proxy User

IIS Web Agents require the following settings in the agent configuration object:

DefaultUserName

Specifies the username of the IIS Proxy user.

DefaultPassword

Specifies the password of the IIS Proxy user.

Note: Leave these parameters blank if you are using the NTLM authentication scheme or the Windows User Security Context feature.

These parameters identify an existing NT user account that has sufficient privileges to access resources on an IIS web server that the product protects. Users requesting access could lack the necessary server access privileges. The agent requires this NT user account. An administrator assigns this NT account which acts as a proxy‑user account for the product.

Specify the Domino Users

Configuring an agent on a Domino server requires that you edit the following settings to match your system:

DominoDefaultUser

Specifies the name by which the Domino Web Agent identifies that user to the Domino server. This situation occurs when the user is not in the Domino Directory and they have been authenticated by the product against another user directory. This value can be encrypted.

DominoSuperUser

Ensures that all users successfully logged in to the product are logged in to Domino as the Domino SuperUser. This value can be encrypted.

Specify the Agent Name

All agents require that you specify a value for the DefaultAgentName.

DefaultAgentName

Identifies the Agent identity that the Web Agent uses for IP addresses that do not have an Agent identity that is assigned to it.

Default: the default Agent name is the name of the installed Web Agent.

Modify Agent Configuration Parameters

You can edit the names and values of the parameters in an Agent configuration object. Parameter names must be unique. Parameter values can be plain, encrypted, or multi‑valued. To make an inactive parameter active, remove the pound sign (#).

Follow these steps:

1. Click Infrastructure, Agent.
2. Click Agent Configuration Objects.
3. Specify search criteria, and click Search.
4. Click the name of the Agent Configuration object that you want to modify.
5. Click Modify.
6. Click the right arrow to the left of the parameter name.
7. Edit the value of the parameter.

   Note: To delete a value, click the minus sign. To change the sequence of multiple values, click the up and down arrows. To specify multiple values for one parameter, click Add. The square symbol () separates multiple parameters.

8. (Optional) Select the Encrypted option.

   Note: When Encrypted is selected, the option of specifying multiple values for one parameter is disabled. A single encrypted value is displayed as a string of symbols on the Parameters page.

9. Click OK.

   Note: Parameters are listed in alphabetical order by name. To edit a parameter on the list, click the right arrow. To delete a parameter from the list, click the minus sign. To edit multiple parameters for the Agent configuration object, repeat steps 5 through 8.

10. Click Submit.