CreateAgent Method—Creates SiteMinder Agent

The CreateAgent method creates and configures a SiteMinder agent.

Syntax

The CreateAgent method has the following format:

Netegrity::PolicyMgtSession‑>CreateAgent(agentName, agentType[, agentDesc][, agentIP][, agentSecret][, realmHintAttrID])

Parameters

The CreateAgent method accepts the following parameters:

agentName (string)

Specifies the name of the agent.

agentType (PolicyMgtAgentType object)

Specifies the type of agent.

agentDesc (string)

(Optional) Specifies the description of the agent.

agentIP (string)

(Optional) Specifies the agent's IP address.

Note: This parameter is required for RADIUS agents.

agentSecret (string)

(Optional) Specifies the shared secret.

Note: To create a v4.x agent, specify the shared secret. To create a v5.x agent, omit this parameter.

realmHintAttrID (int)

(Optional) Specifies the realm hint attribute ID.

Note: This parameter only applies to RADIUS agents.

Return Value

The CreateAgent method returns one of the following values:

PolicyMgtAgent (object)
undef if the call is unsuccessful or the SiteMinder agent name already exists