VyOS icon

VyOS

Interact with VyOS router via HTTP API

Actions20

Overview

This node interacts with a VyOS router via its HTTP API, specifically allowing management of the router's configuration. The "Delete Configuration" operation enables users to remove specific parts of the VyOS configuration by specifying a path within the configuration hierarchy. This is useful for automating network device management tasks such as cleaning up obsolete settings or resetting certain configuration sections.

Practical examples include:

  • Deleting an IP address setting from a specific interface.
  • Removing a routing policy or firewall rule.
  • Clearing custom configurations that are no longer needed.

Properties

Name Meaning
Configuration Path Space-separated path elements specifying which part of the configuration to delete, e.g., interfaces ethernet eth0 address. Leave empty to target the full configuration.
Additional Fields 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 delete operation on the VyOS configuration. This typically includes confirmation of the deletion or details about the affected configuration. If enabled, the output can also include metadata about the API response, such as success status or error messages.

No binary data output is involved in this operation.

Dependencies

  • Requires access to a VyOS router with its HTTP API enabled.
  • Needs an API authentication token or credential configured in n8n to authenticate requests.
  • The node expects the base URL and SSL validation preferences to be set via credentials.

Troubleshooting

  • Common issues:

    • Incorrect or incomplete configuration path may lead to no changes or errors.
    • Network connectivity problems or incorrect API credentials will cause authentication failures.
    • Attempting to delete a non-existent configuration path might return an error or no effect.

  • Error messages:

    • Authentication errors indicate invalid or missing API credentials; verify and update credentials accordingly.
    • Path-related errors suggest the specified configuration path does not exist; double-check the path syntax and elements.
    • SSL certificate errors can occur if the router uses self-signed certificates and SSL validation is not disabled; adjust SSL settings in credentials.

Links and References

Discussion