Actions20
- Configuration Actions
- System Actions
- Image Actions
- Generate Actions
- Config File Actions
Overview
This node enables interaction with VyOS routers via their HTTP API, specifically focusing on managing configuration files when using the "Config File" resource and the "Load Configuration" operation. It allows users to load a configuration file into the router, optionally creating a backup of the current configuration before loading, forcing the load without validation, and committing changes automatically after loading.
Common scenarios include:
- Restoring router settings from a saved configuration file.
- Automating configuration updates in network infrastructure.
- Safely testing new configurations by backing up existing ones first.
Practical example:
- A network administrator wants to deploy a new configuration to multiple VyOS routers. They use this node to load the configuration file remotely, ensuring backups are created and changes committed automatically.
Properties
| Name | Meaning |
|---|---|
| File Path | Absolute path to the configuration file to load. |
| Create Backup | Whether to create a backup of the current configuration before loading the new one. |
| Backup Path | Path where the backup file will be saved if backup is enabled. |
| Force Load | Whether to force loading the configuration without performing validation checks. |
| Commit After Load | Whether to automatically commit the configuration after loading it. |
| Format Output | Whether to format the output for better readability. |
Output
The node outputs JSON data representing the result of the load operation. This typically includes status information about the success or failure of loading the configuration, any error messages, and possibly details about the backup or commit actions performed.
If binary data were involved (e.g., configuration files themselves), it would be summarized here, but this node primarily deals with JSON responses from the VyOS API.
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.
- The configuration file must be accessible at the specified absolute path on the system where n8n runs.
Troubleshooting
- File Not Found: If the specified configuration file path is incorrect or inaccessible, the node will fail to load the configuration. Verify the file path and permissions.
- Backup Failure: If backup creation is enabled but the backup path is invalid or not writable, the operation may fail. Ensure the backup directory exists and is writable.
- Validation Errors: When not forcing load, invalid configurations will cause the load to fail. Use the "Force Load" option cautiously to bypass validation.
- Authentication Issues: Incorrect or missing API credentials will prevent communication with the VyOS router. Confirm that the API key and host details are correct.
- Commit Failures: If automatic commit is enabled but fails, the configuration might be loaded but not applied. Check router logs and ensure proper permissions.