Sm_AgentApi_DoManagement()
Requests agent commands from the Policy Server. Agent commands indicate work to be performed by agents.
sm1252sp1
Requests agent commands from the Policy Server. Agent commands indicate work to be performed by agents.
Syntax
int SM_EXTERN Sm_AgentApi_DoManagement (const void* pHandle,Sm_AgentApi_ManagementContext_t* pManagementContext,long* pNumAttributes,Sm_AgentApi_Attribute_t** ppAttributes);
Parameter | I/O | Description |
pHandle
| I | Agent API session handle returned in parameter ppHandle of Sm_AgentApi_Init(). |
pMananagement Context
| I | A management definition structure. The agent uses this structure to define a management command. |
pNumAttributes
| I | The number of attributes in ppAttributes . |
ppAttributes
| O | A pointer to an array of requested attribute definition structures. One or more of the following attributes may be returned: SM_AGENTAPI_AFFILIATE_KEY_UPDATE SM_AGENTAPI_AGENT_KEY_UPDATE_NEXT SM_AGENTAPI_AGENT_KEY_UPDATE_LAST SM_AGENTAPI_AGENT_KEY_UPDATE_CURRENT SM_AGENTAPI_AGENT_KEY_UPDATE_PERSISTENT SM_AGENTAPI_CACHE_FLUSH_ALL SM_AGENTAPI_CACHE_FLUSH_ALL_USERS SM_AGENTAPI_CACHE_FLUSH_THIS_USER SM_AGENTAPI_CACHE_FLUSH_ALL_REALMS SM_AGENTAPI_CACHE_FLUSH_THIS_REALM SM_AGENTAPI_CONFIG_UPDATE |
Return Values
- SM_AGENTAPI_YES. The operation succeeded.
- SM_AGENTAPI_NOCONNECTION. The initialization was not done.
- SM_AGENTAPI_FAILURE. The server could not be reached.
- SM_AGENTAPI_TIMEOUT. The function timed out.
Example
See the function SmAgentExample::Sm_DoManagement() in the example application smagentexample.cpp.