Actions20
- Configuration Actions
- System Actions
- Image Actions
- Generate Actions
- Config File Actions
Overview
This node interacts with a VyOS router via its HTTP API, specifically focusing on managing the router's configuration. The "Check Path Exists" operation under the "Configuration" resource allows users to verify whether a specific configuration path exists within the VyOS configuration hierarchy.
Common scenarios for this node include:
- Validating if certain network interface settings or firewall rules are present before applying changes.
- Automating configuration audits by checking the existence of critical configuration paths.
- Conditional workflows that proceed only if specific configuration elements exist.
For example, a user might check if the path interfaces ethernet eth0 address exists to confirm that an IP address is configured on the eth0 interface before attempting to modify it.
Properties
| Name | Meaning |
|---|---|
| Configuration Path | The space-separated path in the VyOS configuration to check for existence. For example: interfaces ethernet eth0 address. Leave empty to refer to 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 existence check for the specified configuration path.
- If the path exists, the output will typically contain the relevant configuration data at that path.
- If the path does not exist, the output will indicate absence accordingly.
- When "Format Output" is enabled, the JSON is formatted for easier reading.
- If "Include Metadata" is enabled, additional fields indicating success status or error details from the API response are included.
The node does not output binary data.
Dependencies
- Requires access to a VyOS router with its HTTP API enabled.
- Requires an API authentication token or credentials configured in n8n to authenticate requests to the VyOS API.
- The node expects the base URL and SSL validation preferences to be set via these credentials.
Troubleshooting
Common Issues:
- Incorrect or incomplete configuration path strings may lead to false negatives (path reported as non-existent).
- Network connectivity issues or incorrect API credentials can cause request failures.
- SSL certificate validation errors if the VyOS device uses self-signed certificates and SSL validation is not disabled.
Error Messages:
- Authentication errors: Verify API credentials and permissions.
- Timeout or connection refused: Check network connectivity and API endpoint availability.
- Invalid path errors: Ensure the configuration path is correctly formatted and exists in the VyOS configuration schema.