AgentCommandStatusDto

AgentCommandStatusDto
AgentCommandStatusDto

Latest state of one command type for one agent.

JSON Example
{
    "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
}
integer As int64 As int64
agentPk
Required  

Identifier of the Agent the command was issued to

type
Required  

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 deleted
  • ActionConfigSyncForce: No behaviour is documented for this value. The server only forwards it to the agent
  • ActionRebuildCache: No behaviour is documented for this value. The server only forwards it to the agent
  • ActionCollectDiagnostics: No behaviour is documented for this value. The server only forwards it to the agent
  • ActionAgentDisable: 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 changes
  • ActionGetFileCatalog: No behaviour is documented for this value. The server only forwards it to the agent; the protocol definition comments it as the full catalog
  • ActionGetUpdatedFileCatalog: No behaviour is documented for this value. The server only forwards it to the agent; the protocol definition comments it as the incremental changes
Enumeration: ActionConfigSync, ActionConfigSyncForce, ActionRebuildCache, ActionCollectDiagnostics, ActionAgentDisable, ActionAgentEnable, ActionSetHeartbeatInterval, ActionGetFileCatalog, ActionGetUpdatedFileCatalog
status
Required  

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 SENT
  • SENT: The agent acknowledged the command; the result is awaited and becomes SUCCEEDED or FAILED, or TIMED_OUT after the result timeout
  • SUCCEEDED: The agent reported result status code 0
  • FAILED: The agent reported a result status code other than 0
  • DISPATCH_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 reason
  • TIMED_OUT: No result arrived from the agent within the result timeout after the command was SENT
Enumeration: PENDING, SENT, SUCCEEDED, FAILED, DISPATCH_FAILED, TIMED_OUT
integer As int64 As int64
commandId
Required  

Console-generated batch id echoed by the agent in its result

integer As int32 As int32
numericValue
Optional

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

string
stringValue
Optional

Text argument of at most 1024 characters given when the command was issued; null when none was given

string
requestedBy
Required  

Username of the administrator who issued the command; null when no signed-in user was available

string As date-time As date-time
requestedAt
Required  

Time the Console accepted the command request

string As date-time As date-time
sentAt
Optional

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

string As date-time As date-time
completedAt
Optional

Time the command reached SUCCEEDED, FAILED, DISPATCH_FAILED or TIMED_OUT; null while it is PENDING or SENT

integer As int32 As int32
resultStatusCode
Optional

Agent-reported status code; 0 means success

string
resultMessage
Optional

Agent-reported response text, or the dispatch error

integer As int64 As int64
executionTimeMs
Optional

Execution time in milliseconds reported by the agent with its result; null until a result is recorded