Actions20
- Configuration Actions
- System Actions
- Image Actions
- Generate Actions
- Config File Actions
Overview
This node enables interaction with a VyOS router via its HTTP API, specifically focusing on managing the router's configuration. The "Set Configuration" operation allows users to modify or set specific parts of the VyOS configuration by specifying a path within the configuration hierarchy and providing new values.
Common scenarios where this node is beneficial include automating network device configuration changes, updating interface settings, or applying batch configuration updates without manual CLI intervention. For example, a user can update the IP address of an Ethernet interface or enable/disable services programmatically as part of a larger automation workflow.
Properties
| Name | Meaning |
|---|---|
| Configuration Path | Space-separated path indicating the location in the VyOS configuration to set or modify. Example: interfaces ethernet eth0 address. Leave empty to target the full configuration. |
| Additional Fields | A collection of optional parameters: - Format Output: Whether to format the output for better readability (true/false). - Include Metadata: Whether to include API response metadata such as success or error fields (true/false). |
Output
The node outputs JSON data representing the result of the configuration set operation. This typically includes confirmation of the applied changes or the updated configuration state. If enabled, metadata about the API response (such as success status or error messages) may also be included.
No binary data output is expected from this node.
Dependencies
- Requires access to a VyOS router with its HTTP API enabled.
- An API authentication token or credentials must be configured in n8n to authenticate requests to the VyOS API.
- Network connectivity between n8n and the VyOS device.
- Optional: SSL certificate validation can be skipped based on credential settings.
Troubleshooting
- Connection errors: Ensure the VyOS host address and port are correct and reachable from the n8n instance.
- Authentication failures: Verify that the API credentials are valid and have sufficient permissions to modify the configuration.
- Invalid configuration path: Double-check the space-separated configuration path syntax; incorrect paths will cause the API to reject the request.
- API errors: If the API returns errors, enabling "Include Metadata" can help diagnose issues by providing detailed response information.
- SSL issues: If using HTTPS and encountering SSL errors, consider enabling the option to skip SSL certificate validation if appropriate.