Actions20
- Configuration Actions
- System Actions
- Image Actions
- Generate Actions
- Config File Actions
Overview
This node enables interaction with a VyOS router via its HTTP API, specifically focusing on system-related operations. The "Show Information" operation under the "System" resource allows users to query and retrieve various system details from the VyOS device. This can include information such as system version, network interfaces, routing protocols summaries, and other system status data.
Practical scenarios where this node is beneficial include:
- Monitoring the current state of a VyOS router within an automated workflow.
- Retrieving system diagnostics or configuration summaries for auditing or troubleshooting.
- Integrating VyOS system information into broader network management or reporting tools.
For example, a user might configure the node to show the "system version" to verify firmware levels across multiple devices or request "interfaces" to get a snapshot of active network interfaces.
Properties
| Name | Meaning |
|---|---|
| Show Path | A space-separated string specifying what system information to display. Examples: "system version", "interfaces", "protocols bgp summary". |
| Additional Fields | A collection of optional settings: |
| - Confirmation Required | (Only for destructive operations like reboot or poweroff) Whether to require confirmation before executing the operation. |
| - Format Output | Whether to format the output for better readability (boolean). |
Output
The node outputs JSON data containing the requested system information from the VyOS router. The structure of the JSON depends on the specific "Show Path" queried but generally includes detailed system status or configuration data relevant to the path.
If the node supports binary data output (not explicitly shown in the provided code), it would typically represent files or images related to system snapshots or configurations, but this is not indicated here.
Dependencies
- Requires an API key credential to authenticate with the VyOS router's HTTP API.
- Needs the base URL of the VyOS device and optionally a setting to ignore SSL certificate issues.
- The node expects the VyOS HTTP API to be accessible and properly configured on the target device.
Troubleshooting
Common Issues:
- Connection failures due to incorrect host URL or network issues.
- Authentication errors if the API key or credentials are invalid or missing.
- Incorrect "Show Path" strings may result in empty or error responses from the API.
- SSL validation errors if the device uses self-signed certificates and the option to ignore SSL issues is not enabled.
Error Messages:
- Authentication errors typically indicate invalid credentials; verify API key correctness.
- Network timeouts suggest connectivity problems; check network routes and firewall rules.
- API response errors may occur if the "Show Path" is malformed; ensure correct syntax and supported paths.