AgentCommandStatusDto
Latest state of one command type for one agent.
{
"agentPk": 0,
"type": "string",
"status": "string",
"commandId": 0,
"numericValue": 0,
"stringValue": "string",
"requestedBy": "string",
"requestedAt": "string",
"sentAt": "string",
"completedAt": "string",
"resultStatusCode": 0,
"resultMessage": "string",
"executionTimeMs": 0
}
Identifier of the Agent the command was issued to
Command types an administrator can issue from the console.
ActionConfigSync: Tells the agent to pull its Group's configuration now instead of at its next heartbeat; the Console sends it itself when a Group is published, its protection, enforcement mode or heartbeat interval changes, agents are moved, or the Group is deletedActionConfigSyncForce: No behaviour is documented for this value. The server only forwards it to the agentActionRebuildCache: No behaviour is documented for this value. The server only forwards it to the agentActionCollectDiagnostics: No behaviour is documented for this value. The server only forwards it to the agentActionAgentDisable: Sent by the Console to every active agent of a Group when its Agent Protection flag is set (agentDisabledStatus true)ActionAgentEnable: Sent by the Console to every active agent of a Group when its Agent Protection flag is cleared (agentDisabledStatus false)ActionSetHeartbeatInterval: numericValue is the new heartbeat interval in seconds and must be a positive number (400 INVALID_NUMERIC_VALUE otherwise); the Console also sends it when a Group's heartbeat interval changesActionGetFileCatalog: No behaviour is documented for this value. The server only forwards it to the agent; the protocol definition comments it as the full catalogActionGetUpdatedFileCatalog: No behaviour is documented for this value. The server only forwards it to the agent; the protocol definition comments it as the incremental changes
Latest state of a command for one agent.
PENDING: Recorded by the Console and not yet delivered; becomes SENT or DISPATCH_FAILED, and a command still PENDING after the result timeout (default 300 seconds) becomes DISPATCH_FAILED; a new command of the same type is refused while it is PENDING or SENTSENT: The agent acknowledged the command; the result is awaited and becomes SUCCEEDED or FAILED, or TIMED_OUT after the result timeoutSUCCEEDED: The agent reported result status code 0FAILED: The agent reported a result status code other than 0DISPATCH_FAILED: The Console could not deliver the command, or the agent dispatched no command, or the command stayed PENDING past the result timeout; resultMessage holds the reasonTIMED_OUT: No result arrived from the agent within the result timeout after the command was SENT
Console-generated batch id echoed by the agent in its result
Numeric argument given when the command was issued; ActionSetHeartbeatInterval requires it as a positive number of seconds; sent to the agent as 0 when absent; null when none was given
Text argument of at most 1024 characters given when the command was issued; null when none was given
Username of the administrator who issued the command; null when no signed-in user was available
Time the Console accepted the command request
Time the agent acknowledged the command; null while the command is PENDING and when it ended as DISPATCH_FAILED; also null on a SUCCEEDED or FAILED command when the agent answered before the acknowledgement was recorded
Time the command reached SUCCEEDED, FAILED, DISPATCH_FAILED or TIMED_OUT; null while it is PENDING or SENT
Agent-reported status code; 0 means success
Agent-reported response text, or the dispatch error
Execution time in milliseconds reported by the agent with its result; null until a result is recorded