VyOS icon

VyOS

Interact with VyOS router via HTTP API

Actions20

Overview

The node interacts with a VyOS router via its HTTP API, specifically allowing management of system images. The "Add Image" operation downloads and installs a VyOS image from a specified URL. This is useful for automating the deployment or upgrade of VyOS router images in network environments.

Typical use cases include:

  • Automatically downloading and installing new VyOS ISO images from a direct URL.
  • Verifying the integrity of downloaded images by checksum validation.
  • Setting a newly added image as the default boot image to streamline upgrades.

For example, a user can provide a direct URL to a VyOS ISO file, have the node download it, verify its checksum, and optionally set it as the default boot image, all within an automated workflow.

Properties

Name Meaning
Image URL URL of the VyOS image to download and install. Must be a direct link to a VyOS ISO file.
Verify Checksum Whether to verify the image checksum after download (true/false).
Set as Default Whether to set the newly added image as the default boot image (true/false).
Format Output Whether to format the output for better readability (true/false).

Output

The node outputs JSON data representing the result of the image addition process. This typically includes status information about the download, checksum verification, installation success, and whether the image was set as default.

If the "Format Output" option is enabled, the output will be structured for easier reading and interpretation.

No binary data output is indicated for this operation.

Dependencies

  • Requires an active connection to a VyOS router's HTTP API.
  • Needs an API authentication token or key configured in n8n credentials to authorize requests.
  • The VyOS router must be accessible at the provided host URL.
  • The image URL must point directly to a downloadable VyOS ISO image file.

Troubleshooting

  • Common issues:

    • Invalid or inaccessible image URL: Ensure the URL is correct and publicly reachable or accessible from the VyOS device.
    • Checksum verification failure: If enabled, the checksum might not match if the image is corrupted or incomplete.
    • API connection errors: Verify that the VyOS API credentials are correct and the router is reachable.
    • Permission denied errors when setting the image as default: Confirm the API user has sufficient privileges.

  • Error messages:

    • "Failed to download image": Check network connectivity and URL validity.
    • "Checksum verification failed": Re-download the image or disable checksum verification if appropriate.
    • "Authentication error": Recheck API credentials and permissions.
    • "Setting default image failed": Verify user permissions and router state.

Links and References

Discussion