Programming Guides › Programming Guide for Perl › CLI Agent API Methods › Agent Administration Methods › Connect Method—Establishes Connection between Agent API and Policy Server

Connect Method—Establishes Connection between Agent API and Policy Server

The Connect method establishes a connection between the Agent API and the Policy Server.

Syntax

The Connect method has the following format:

Netegrity::AgentAPI‑>Connect([bootFile])

Parameters

The Connect method accepts the following parameter:

bootFile (string)

(Optional) Specifies the name of the configuration file to be used for connecting to a v5.x agent.

Note: You can use an existing file such as SmHost.conf or create a new file. For more information, see the method AgentAPI‑>CreateBootstrapFile.

Return Value

The Connect method returns one of the following values:

• SM_AGENTAPI_YES (value = 1)

  Specifies that the connection was successful.

• SM_AGENTAPI_FAILURE (value = -1)

  Specifies that the Agent API could not reach the Policy Server.

• SM_AGENTAPI_TIMEOUT (value = -2)

  Specifies that the method timed out.

• SM_AGENTAPI_NOCONNECTION (value = -3)

  Specifies that initialization failed.