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 Web Agent configuration. The configuration object is the Policy Server counterpart to Web Agent configuration file.

When you configure a Web Agent, you are prompted for the name of the Agent Configuration Object. The configuration object is associated with the Web Agent that you are configuring.

For more information about the initial configuration of a Web Agent and the required Web Agent parameters, see the Web Agent Installation Guide.

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 the Web Agents that CA SiteMinder® supports. 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.

To create an Agent Configuration Object

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

When you configure an Agent Configuration Object, the following parameters must be configured:

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

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

Specify the IIS Proxy User

Configuring an IIS Web Agent requires that you configure the following settings in the Agent Configuration Object:

Note: If you plan to use the NTLM authentication scheme, or enable the Windows User Security Context feature, do not specify values for these IIS parameters.

DefaultUserName

Specifies the username of the IIS Proxy user.

DefaultPassword

Specifies the password of the IIS Proxy user.

The DefaultUserName and DefaultPassword identify an existing NT user account that has sufficient privileges to access resources on an IIS Web server protected by CA SiteMinder®. When users want to access resources on an IIS Web server protected by CA SiteMinder®, they may not have the necessary server access privileges. The Web Agent must use this NT user account, which is assigned by an NT administrator, to act as a proxy user account for users granted access by CA SiteMinder®.

Specify the Domino Users

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

DominoDefaultUser

If the user is not in the Domino Directory, and they have been authenticated by CA SiteMinder® against another user directory, this is the name by which the Domino Web Agent identifies that user to the Domino server. This value can be encrypted.

DominoSuperUser

Ensures that all users successfully logged into CA SiteMinder® will be logged into Domino as the Domino SuperUser. This value can be encrypted.

Specify the Agent Name

All Web Agents require that you specify a value for the DefaultAgentName.

DefaultAgentName

Identifies the Agent identity that the Web Agent uses when it detects an IP address on its Web server that does not have an Agent identity 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-value. To make an inactive parameter active, remove the pound sign (#).

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

To modify an Agent configuration object

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

   The Agent Configuration Objects page appears.

3. Specify search criteria, and click Search.

   A list of Agent configuration objects that match the search criteria appears.

4. Click the name of the Agent Configuration object that you want to modify.

   The View Agent Configuration page appears.

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

5. Click Modify.

   The settings and controls become active.

6. Click the right arrow to the left of the parameter's name.

   The Edit Parameter page appears.

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. Multiple values are separated by the square symbol () when displayed on the Parameters page.

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.

   The value of the parameter is updated.

   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.

    The Agent configuration object is modified.