Actions20
- Configuration Actions
- System Actions
- Image Actions
- Generate Actions
- Config File Actions
Overview
This node allows interaction with a VyOS router via its HTTP API, specifically enabling system-level operations such as powering off the device. The "Power Off" operation lets users schedule when the VyOS system should shut down, either immediately or after a specified delay. This is useful for automated maintenance, controlled shutdowns before updates, or remote management scenarios where physical access to the device is limited.
Practical examples:
- Scheduling an immediate power off after completing configuration changes.
- Delaying power off by 5 or 10 minutes to allow running processes to finish gracefully.
- Requiring confirmation before executing the power off to prevent accidental shutdowns.
Properties
| Name | Meaning |
|---|---|
| Power Off Delay | When to power off the system. Options: "Now", "1 Minute", "5 Minutes", "10 Minutes". |
| Confirmation Required | Whether to require confirmation before executing destructive operations like power off. |
| Format Output | Whether to format the output for better readability (true/false). |
Output
The node outputs JSON data representing the result of the power off command execution on the VyOS system. If formatting is enabled, the output will be structured for easier reading. The output typically includes status information confirming whether the power off command was accepted and any relevant messages from the VyOS API.
No binary data output is involved in this operation.
Dependencies
- Requires an API key credential to authenticate with the VyOS router's HTTP API.
- The node expects the base URL and SSL validation preferences to be configured via credentials.
- Network connectivity to the VyOS device must be available.
Troubleshooting
- Common issues:
- Authentication failures due to incorrect or missing API credentials.
- Network errors if the VyOS device is unreachable or the base URL is misconfigured.
- Permission errors if the authenticated user lacks rights to perform system power operations.
- Error messages:
- "Authentication failed": Verify API credentials and permissions.
- "Connection refused" or "Timeout": Check network connectivity and device availability.
- "Operation not permitted": Ensure the user has sufficient privileges on the VyOS system.
- To resolve, confirm credentials, network settings, and user permissions.
Links and References
- VyOS Official Documentation
- VyOS API Reference (for details on system commands)
- n8n documentation on Creating Custom Nodes