Overview
This node monitors the status of a specified OPNSense gateway and triggers a workflow when the gateway's status changes. It periodically polls the OPNSense API to fetch the current status of the selected gateway. If a change in status is detected, it can optionally delay triggering the workflow by a user-defined number of minutes.
Common scenarios:
- Monitoring network gateways for availability or connectivity issues.
- Automating alerts or remediation workflows when a gateway goes down or comes back up.
- Integrating OPNSense gateway status into broader network monitoring dashboards or incident management systems.
Practical example:
You could use this node to watch your primary internet gateway and trigger a notification workflow if the gateway goes offline, allowing your team to respond quickly to outages.
Properties
| Name | Meaning |
|---|---|
| Gateway Name or ID | Select the gateway to monitor from a dynamically loaded list or specify an ID via expression. |
| Trigger Delay (Minutes) | Number of minutes to wait after detecting a status change before triggering the workflow (0–60). |
Output
The node outputs JSON data with the following structure when a status change triggers the workflow:
{
"gateway": "string", // The name or ID of the monitored gateway
"status": "string", // The current status of the gateway ("up" or "down")
"changedAt": "ISO8601 timestamp or null" // The date and time when the status last changed
}
No binary data output is produced by this node.
Dependencies
- Requires access to an OPNSense instance with API enabled.
- Needs an API key credential with username and password (API key and secret) for authentication.
- The node makes HTTPS requests to the OPNSense API endpoint
/api/routes/gateway/status. - No additional environment variables are required beyond the configured API credentials.
Troubleshooting
- Gateway not found error: If the specified gateway name or ID does not exist in the OPNSense API response, the node throws an error indicating the gateway was not found. Verify the gateway name/ID is correct and available in OPNSense.
- Timeout errors: Network timeouts result in the node treating the gateway status as "down". Check network connectivity and API server responsiveness.
- Authentication failures: Ensure the API credentials are valid and have sufficient permissions to query gateway status.
- Trigger delay misconfiguration: Setting a very high trigger delay may cause delayed reactions to status changes; set appropriately based on your monitoring needs.