Programming Guides › Programming Guide for C › Agent API › Data Types and Structures › Sm_AgentApi_Init_t

Sm_AgentApi_Init_t

This structure defines agent initialization, including its server information, and also specifies the failover threshold.

Syntax

This structure had the following format:

typedef struct Sm_AgentApi_Init_s
{
   long nVersion;
   char lpszHostName[SM_AGENTAPI_SIZE_NAME];
   char lpszSharedSecret[SM_AGENTAPI_SIZE_NAME];
   long nFailover;
   long nNumServers;
   Sm_AgentApi_Server_t* pServers;
} Sm_AgentApi_Init_t;

Parameters

This structure had the following parameters:

• nVersion

  The version of the Agent API. Set to SM_AGENTAPI_VERSION.

• lpszHostName

  The agent name. This name must match the agent name provided to the Policy Server. The agent name is not case sensitive.

• lpszSharedSecret

  Each agent has a shared secret registered with the Policy Server. Enter that secret here. This is a case sensitive field.

• nFailover

  Setting this to 0 enables the agent to access the specified Policy Servers in a round-robin configuration. Setting this to 1 disables the round-robin configuration, in which case the agent will operate in the failover mode.

• nNumServers

  The number of Policy Servers defined in the next parameter.

• pServers

  An array of nNumServers structures of type Sm_AgentApi_Server_t. This structure defines each identically configured Policy Server with which the agent will communicate. The servers must share a common policy store. Depending on the specified Agent API version the array contains either clustered or non-clustered servers.

Remarks

This structure is populated by calling Sm_AgentApi_GetConfig().