Programming Guides › Programming Guide for Perl › CLI Policy Management Methods › Session Methods › DeleteAgent Method—Deletes Agent

DeleteAgent Method—Deletes Agent

The DeleteAgent method deletes an agent.

Syntax

The DeleteAgent method has the following format:

Netegrity::PolicyMgtSession‑>DeleteAgent(agent)

Parameters

The DeleteAgent method accepts the following parameter:

agent (PolicyMgtAgent object)

Specifies the agent object to delete.

Return Value

The DeleteAgent method returns one of the following values:

• value = 0

  Specifies that the method is successful or that the agent is not found.

• value = -1

  Specifies that the method is unsuccessful.