Actions20
- Configuration Actions
- System Actions
- Image Actions
- Generate Actions
- Config File Actions
Overview
The node interacts with a VyOS router via its HTTP API, specifically allowing users to perform system-level operations such as resetting parts of the system configuration. The "Reset" operation under the "System" resource enables users to reset specific components or paths within the VyOS system configuration by specifying a space-separated path string.
This node is beneficial in scenarios where automated network management and configuration resets are required, such as clearing BGP neighbors, resetting VPN IPsec security associations, or managing DHCP server leases programmatically. For example, a user might reset all BGP neighbors on a router after a topology change or clear expired DHCP leases without manual CLI intervention.
Properties
| Name | Meaning |
|---|---|
| Reset Path | Specifies what part of the system to reset, given as a space-separated path string. Examples include "ip bgp neighbor", "vpn ipsec-sa", or "dhcp-server lease". This property is required. |
| Additional Fields | A collection of optional fields: |
| - Confirmation Required | (Only for reboot or poweroff operations) Whether to require confirmation before executing destructive operations. Not applicable for Reset operation. |
| - Format Output | Whether to format the output for better readability. Defaults to true. |
Output
The node outputs JSON data representing the result of the reset operation performed on the VyOS system. The structure typically includes status information about the reset command execution, any messages returned by the VyOS API, and possibly details about the affected configuration paths.
If the operation supports binary data output (not indicated here), it would represent raw data from the device, but this node primarily deals with JSON responses.
Dependencies
- Requires an API key credential to authenticate with the VyOS router's HTTP API.
- The node expects the base URL and SSL validation preferences to be configured via credentials.
- No additional external services are needed beyond access to the VyOS API endpoint.
Troubleshooting
Common Issues:
- Incorrect or incomplete "Reset Path" strings may cause the API to reject the request or have no effect.
- Network connectivity issues or incorrect API credentials will prevent successful communication with the VyOS router.
- If the output is not formatted as expected, verify the "Format Output" option.
Error Messages:
- Authentication errors indicate invalid or missing API credentials; ensure correct API key/token is provided.
- API errors related to invalid reset paths suggest verifying the exact syntax and available reset commands supported by the VyOS API.
- SSL certificate errors can occur if the router uses self-signed certificates and SSL validation is not disabled in credentials.