ModulesAgent Orchestrator
Operations & reference
Every Agent Orchestrator operation with its required role, plus the flow nodes this module provides.
Operations & permissions
Every action is gated by a minimum role. Viewers can read device information, status metrics, and module details. Editors additionally create and update device records, modify module configuration, execute module commands, and trigger agent updates.
| Operation | What it does | Min role |
|---|---|---|
| Get device information | Retrieve the device record including technical details and current status | Viewer |
| Get device status | Retrieve the current device status including real-time CPU, memory, and disk metrics | Viewer |
| Get system stats | Read current system resource usage | Viewer |
| List historical device status | Query historical device status records filtered by a time range | Viewer |
| Stream with device | Send and receive messages over the bidirectional agent–cloud stream | Viewer |
| List modules | Retrieve all modules on the device with their configurations and current statuses | Viewer |
| Get module | Fetch detailed information and current status of a specific module | Viewer |
| Get module status | Retrieve the active/inactive status of all modules | Viewer |
| Create device record | Create a new device record in the agent | Editor |
| Update device details | Update the device name, description, and other editable fields | Editor |
| Update module configuration | Modify the configuration of a specific module to meet system requirements | Editor |
| Execute module command | Run a module-specific command programmatically | Editor |
| Get build information | Return the agent's version, variant, and commit metadata, and whether it runs in container mode | Editor |
| Check latest version | Fetch the latest published agent version from the CDN and compare it to the running version | Editor |
| Trigger self-update | Launch an in-place reinstall of the agent binary via a detached systemd unit | Editor |
| Trigger container update | Signal a container update by writing a trigger file; picked up by the host systemd path unit (container mode only) | Editor |
Self-update and container update both return before the update process completes — the agent restarts independently after the response is sent. Trigger container update is only operational when the agent runs in container mode.
Flow nodes
Agent Orchestrator ships a set of general-purpose connectivity nodes you can use in any Automation Manager flow.
Output
| Node | Purpose |
|---|---|
HTTPPush | Send JSON events to an HTTP endpoint with batching and retry |
NATSPush | Publish JSON events to a NATS subject |
Resource
| Node | Purpose |
|---|---|
HttpClient | HTTP client to fetch data from an HTTP endpoint |
HttpReceiver | HTTP client to receive data from an HTTP server |
HttpSender | HTTP client to send data to an HTTP server |
MqttReceiver | MQTT endpoint node for receiving data from an MQTT broker |
MqttSender | MQTT sender node for transmitting data to an MQTT broker |
WebhookEndpoint | Webhook endpoint to receive data from external sources |
Messaging
| Node | Purpose |
|---|---|
NatssReceiver | NATS Streaming receiver node for receiving data from a NATS Streaming server |
NatssSender | NATS Streaming sender node for transmitting data to a NATS Streaming server |
Utility
| Node | Purpose |
|---|---|
StaticText | Emit a predefined static text value |