SendAgentCommandRequest

SendAgentCommandRequest
SendAgentCommandRequest

Request to send one command to an agent.

JSON Example
{
    "type": "string",
    "numericValue": 0,
    "stringValue": "string"
}
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
integer As int32 As int32
numericValue
Optional

ActionSetHeartbeatInterval: seconds (must be positive). ActionGetFileCatalog: maximum catalog size in bytes.

string
stringValue
Optional
Constraints: maxLength: 1024

String argument, when the command takes one