VyOS icon

VyOS

Interact with VyOS router via HTTP API

Actions20

Overview

This node integrates with VyOS routers via their HTTP API, specifically enabling management of system images when the "Image" resource and "List Images" operation are selected. It retrieves a list of available system images from the VyOS router, which can be useful for automation workflows that need to inventory or manage boot images on VyOS devices.

Common scenarios include:

  • Automatically fetching all available system images before performing upgrades or rollbacks.
  • Auditing or reporting on the current images stored on VyOS routers.
  • Feeding image data into further automation steps such as selecting an image to set as default or delete.

Properties

Name Meaning
Additional Fields A collection of optional parameters to customize the operation:
- Verify Checksum (Only for add operation) Whether to verify the image checksum after download.
- Set as Default (Only for add operation) Whether to set the new image as the default boot image.
- Force Delete (Only for delete operation) Whether to force deletion without confirmation.
- Format Output Whether to format the output for better readability (boolean).

For the "List Images" operation, only the "Format Output" field is relevant among these additional fields.

Output

The node outputs JSON data representing the list of system images retrieved from the VyOS router. The structure typically includes details about each image such as its name, version, checksum, and status. If the "Format Output" option is enabled, the output will be formatted for easier reading and downstream processing.

No binary data output is involved in this operation.

Dependencies

  • Requires an active connection to a VyOS router's HTTP API.
  • Needs an API authentication token or credential configured in n8n to authorize requests.
  • The base URL and SSL validation settings are derived from the provided credentials.

Troubleshooting

  • Connection errors: Ensure the VyOS router is reachable at the specified host and port, and that network/firewall rules allow HTTP API access.
  • Authentication failures: Verify that the API key or credentials used have sufficient permissions and are correctly configured in n8n.
  • Unexpected output or empty lists: Confirm that the VyOS device has images available and that the API endpoint is functioning properly.
  • SSL issues: If using self-signed certificates, enable the option to ignore SSL certificate validation in credentials or node settings.

Links and References

Discussion