Programming Guides › Programming Guide for Perl › CLI Agent API Methods › Agent Administration Methods › New Method—Constructs the Agent API

New Method—Constructs the Agent API

The New method constructs the Agent API object and must be called before the Agent API object can be used.

Syntax

The New method has the following format:

Netegrity::AgentAPI‑>New(agentName[, sharedSecret][, failover])

Parameters

The New method accepts the following parameters:

pagentName (string)

Specifies the name of the agent as it appears in the policy store.

Note: The agent name is not case-sensitive.

psharedSecret (string)

(Optional) Specifies the shared secret as it appears in the policy store.

Note: If you provide a value for the shared secret, a v4.x agent object is created. If you do not provide a value for the shared secret, a v5.x agent object is created. The shared secret is case-sensitive.

failover (int)

(Optional) Specifies whether to enable or disable failover operation:

• value = -1

  Specifies enabling failover operation.

• value = 0

  Specifies disabling failover operation.

Return Value

The New method returns the following value:

• AgentAPI (object)