n8n-nodes-vyos
This is an n8n community node for VyOS router management via HTTP API. It provides comprehensive configuration, system management, and operational capabilities for VyOS network appliances.
Features
- Configuration Management: Full VyOS configuration control via HTTP API
- System Operations: System information, reboot, shutdown, and maintenance
- Image Management: System image operations and upgrades
- Config Generation: Generate configuration snippets and templates
- Config File Operations: Backup, restore, and manage configuration files
- Real-time Operations: Execute commands and retrieve system status
- AI Integration: Marked as
usableAsTool: true for AI agent compatibility
Installation
npm install n8n-nodes-vyos
Configuration
- Go to Credentials in n8n
- Select VyOS API credential type
- Configure your VyOS connection:
- Host: Your VyOS router URL (e.g., https://192.168.1.1)
- Username: VyOS API username
- Password: VyOS API password
- Ignore SSL Issues: Enable if using self-signed certificates
Usage
- Add the VyOS node to your workflow
- Select your VyOS API credential
- Choose the resource and operation you want to perform
- Configure the parameters as needed
Resources and Operations
Configuration
- Set Configuration: Configure VyOS settings and parameters
- Get Configuration: Retrieve current configuration values
- Delete Configuration: Remove configuration elements
- Commit Configuration: Apply pending configuration changes
- Save Configuration: Save current configuration to startup
- Load Configuration: Load configuration from file
- Compare Configuration: Compare configurations
- Discard Configuration: Discard pending changes
System
- Get System Info: Retrieve system information and status
- Reboot System: Restart the VyOS system
- Shutdown System: Shutdown the VyOS system
- Get System Status: Check system health and resources
- Execute Command: Run operational commands
- Get Interfaces: List and manage network interfaces
- Get Routes: Display routing table information
Image
- List Images: Show available system images
- Add Image: Install new system images
- Delete Image: Remove system images
- Set Default Image: Configure default boot image
- Show Image Info: Get image details and versions
Generate
- Generate Keys: Create SSH, certificates, and encryption keys
- Generate Config: Create configuration templates
- Generate Certificates: Generate SSL/TLS certificates
- Generate Passwords: Create secure passwords
- Generate Documentation: Export configuration documentation
Config File
- Load Config File: Load configuration from file
- Save Config File: Save configuration to file
- List Config Files: Show available configuration files
- Delete Config File: Remove configuration files
- Compare Config Files: Compare configuration versions
- Backup Config: Create configuration backups
Use Cases
- Network Automation: Automate VyOS configuration and management
- Infrastructure as Code: Manage router configurations programmatically
- Monitoring and Alerting: Monitor VyOS system health and status
- Configuration Management: Version control and backup configurations
- Deployment Automation: Automate VyOS deployments and updates
- Compliance Checking: Verify configuration compliance
- Troubleshooting: Automated diagnostics and issue resolution
- Backup and Recovery: Automated configuration backup procedures
VyOS Compatibility
This node is compatible with VyOS 1.3+ and 1.4+ versions that support the HTTP API. Features include:
- Full HTTP API support
- Configuration session management
- Real-time command execution
- System image management
- Configuration file operations
- SSL/TLS support with certificate validation options
API Authentication
The node uses VyOS HTTP API with basic authentication. Ensure your VyOS system has:
- HTTP API enabled (
set service https api)
- Valid user credentials with appropriate permissions
- Network connectivity from n8n to VyOS management interface
Security Considerations
- Use HTTPS when possible for secure communication
- Implement proper firewall rules for API access
- Use strong passwords for VyOS API accounts
- Consider certificate validation for production environments
- Monitor API access logs for security compliance
License
MIT
Support
This is a community-maintained node. For issues and questions, please use the GitHub issues.
