VyOS icon

VyOS

Interact with VyOS router via HTTP API

Overview

This node interacts with a VyOS router via its HTTP API, specifically allowing system-level operations such as rebooting the device. The "System - Reboot" operation enables users to schedule a reboot of the VyOS system either immediately or after a specified delay (1, 5, or 10 minutes). This is useful for applying configuration changes that require a restart or recovering from certain system states.

Practical examples:

  • Scheduling a reboot right after a critical update.
  • Delaying a reboot by a few minutes to allow ongoing processes to complete.
  • Automating system maintenance tasks that include controlled reboots.

Properties

Name Meaning
Reboot Delay When to reboot the system. Options: "Now", "1 Minute", "5 Minutes", "10 Minutes".
Additional Fields Collection of optional settings:
  Confirmation Required Whether to require confirmation before executing destructive operations like reboot or poweroff. Boolean true/false.
  Format Output Whether to format the output for better readability. Boolean true/false.

Output

The node outputs JSON data representing the result of the reboot command execution on the VyOS system. If the "Format Output" option is enabled, this JSON will be formatted for easier reading. The output typically includes status information about the reboot request.

No binary data output is indicated in the source code.

Dependencies

  • Requires an API key credential to authenticate with the VyOS HTTP API.
  • Needs the VyOS host URL and optionally SSL validation settings configured in the credentials.
  • The node sends requests with content type application/x-www-form-urlencoded.

Troubleshooting

  • Common issues:
    • Authentication failures due to incorrect or missing API credentials.
    • Network connectivity problems preventing access to the VyOS API endpoint.
    • Insufficient permissions on the VyOS system to perform reboot operations.
  • Error messages:
    • Errors related to invalid credentials should prompt checking the API key and host configuration.
    • Timeout or connection errors suggest verifying network access and firewall rules.
    • Confirmation required error if the "Confirmation Required" flag is set but no confirmation is provided.

Links and References

Discussion