Actions22
- Agent Actions
- Alert Actions
- Client Actions
- Software Actions
Overview
This node integrates with the Tactical RMM API to run a specified script on a particular agent. It is useful for automating remote management tasks such as running maintenance scripts, deploying updates, or executing custom commands on managed endpoints. For example, an IT administrator can trigger a security scan script on a selected agent or run a cleanup script with specific arguments remotely.
Properties
| Name | Meaning |
|---|---|
| Agent ID | The unique identifier of the agent (device) on which the script will be executed. |
| Script ID | The unique identifier of the script that should be run on the agent. |
| Arguments | Optional space-separated string of arguments to pass to the script during execution. |
| Timeout (Seconds) | Maximum time in seconds to wait for the script to complete execution (1 to 3600 seconds). |
Output
The node outputs JSON data representing the result of the script execution on the agent. This typically includes status information, output logs, or any returned data from the script run. The exact structure depends on the Tactical RMM API response but generally contains success/failure indicators and any relevant output messages.
No binary data output is indicated by the source code.
Dependencies
- Requires an active connection to the Tactical RMM API.
- Needs an API authentication token configured in n8n credentials to authorize requests.
- The node relies on the Tactical RMM API endpoint to execute scripts on agents.
Troubleshooting
Common issues:
- Invalid or missing Agent ID or Script ID will cause the API call to fail.
- Passing improperly formatted arguments may lead to script execution errors.
- Timeout values outside the allowed range (1-3600 seconds) might be rejected.
- Network connectivity problems or invalid API credentials will prevent successful execution.
Error messages:
- Authentication errors indicate invalid or missing API credentials; verify and update them.
- "Agent not found" or "Script not found" errors suggest incorrect IDs; double-check the provided identifiers.
- Timeout exceeded errors mean the script took longer than allowed; consider increasing the timeout or optimizing the script.
Links and References
- Tactical RMM official documentation: https://tacticalrmm.io/docs/
- Tactical RMM API reference (for script execution): https://tacticalrmm.io/docs/api/agents/#run-script