Actions20
- Configuration Actions
- System Actions
- Image Actions
- Generate Actions
- Config File Actions
Overview
The node allows interaction with a VyOS router via its HTTP API, specifically enabling batch configuration changes. The "Set Multiple" operation under the "Configuration" resource lets users send multiple configuration commands in one request to modify the router's settings efficiently. This is useful for automating network device configurations, applying bulk updates, or scripting complex setups.
Practical examples include:
- Setting multiple interface IP addresses and routes in one go.
- Applying firewall rules or NAT configurations simultaneously.
- Automating repetitive configuration tasks during deployment or maintenance.
Properties
| Name | Meaning |
|---|---|
| Commands | A collection of multiple configuration commands to execute in batch. Each command requires specifying a configuration path as a space-separated string (e.g., interfaces ethernet eth0 address 192.168.1.1/24). |
| Additional Fields | Optional settings: • Format Output: Whether to format the API response output for better readability (true/false). • Include Metadata: Whether to include additional API response metadata such as success or error fields (true/false). |
Output
The node outputs JSON data representing the result of executing the batch configuration commands on the VyOS router. The structure typically includes the response from the API indicating success or failure of each command. If enabled, metadata about the API response (such as status or error messages) can also be included.
If binary data were involved (not indicated here), it would represent files or images related to the router configuration, but this node focuses on JSON responses.
Dependencies
- Requires an active connection to a VyOS router accessible via HTTP API.
- Needs an API authentication token or credential configured in n8n to authorize requests.
- The node expects the base URL and SSL validation preferences to be set through credentials.
- No other external dependencies are indicated.
Troubleshooting
- Common Issues:
- Incorrect configuration paths or syntax in commands may cause API errors.
- Network connectivity issues to the VyOS router will prevent execution.
- Missing or invalid API credentials will result in authentication failures.
- Error Messages:
- Authentication errors indicate invalid or missing API tokens; verify credentials.
- Command execution errors usually return details about which command failed and why; check command syntax and router compatibility.
- SSL certificate errors can occur if the router uses self-signed certificates and SSL validation is not disabled.