NEnetxms
Objects

Execute command on agent

Changed on
post/v1/objects/{object-id}/execute-agent-command

Request

  • Base URL
    http://127.0.0.1:8000
  • URL
    http://127.0.0.1:8000/v1/objects/{object-id}/execute-agent-command
  • Auth
    HTTP bearer

Path parameters

object-idinteger required

Request body

commandstring required

Command line to execute. Supports macro expansion; the command name is the first token, remaining tokens are passed as arguments.

alarmIdinteger

Optional alarm ID used as context for macro expansion. Requires read access to the alarm.

inputFieldsobject

Optional map of input field values used for macro expansion.

Response

Command executed successfully

Changes