VyOS Documentation
VyOS Documentation
Welcome to the VyOS documentation - VyOS is a Linux-based network operating system designed for building routers, firewalls, and VPN gateways.
About VyOS
VyOS is a full-featured open-source network OS that provides:
- Routing: Static, OSPF, BGP, RIP
- VPN: IPsec, WireGuard, OpenVPN, L2TP/IPsec
- Firewall: Stateful firewall with security zones
- NAT: Source/Destination NAT, Port Forwarding
- High availability: VRRP, VRRP sync groups
- QoS: Traffic shaping and prioritization
- Containers: Podman for running applications
- API: REST API for automation
Documentation sections
First steps
- Quick start - Configure a NAT gateway in 10 minutes
- Installation and image management - Installing on various platforms
- Command-line interface - Operational mode and configuration
- Configuration overview - The hierarchical management system
Administrator guide
- VyOS automation - REST API, Ansible, Python
- Operational mode - Show commands and monitoring
- Troubleshooting - Troubleshooting and diagnostics
- Configuration blueprints - Ready-made solutions
VPN
- WireGuard - Modern high-performance VPN
- IPsec - Enterprise-grade site-to-site VPN
- OpenVPN - SSL VPN with TLS
- L2TP/IPsec - VPN for Windows/macOS clients
Security
- Firewall - nftables firewall
- NAT - Source/Destination NAT and Port Forwarding
- PKI - Certificate and CA management
Routing protocols
- Static routing - Static routes and default gateway
- OSPF - Open Shortest Path First
- BGP - Border Gateway Protocol for autonomous systems
Services
- DHCP Server - DHCPv4 server for autoconfiguration
- DHCPv6 Server - DHCPv6 for IPv6 networks
- DNS Forwarding - DNS forwarding and caching
- SSH - SSH server and access configuration
- NTP - Time synchronization
- HTTPS API - REST API for automation
- SNMP - Monitoring via SNMP
- DDNS - Dynamic DNS client
- LLDP - Link Layer Discovery Protocol
- TFTP - TFTP server
- Web Proxy - Squid proxy server
Interfaces
- Ethernet - Physical Ethernet interfaces
- VLAN - 802.1Q VLAN interfaces
- Bridge - L2 bridge with STP
- Bond - Link aggregation (LACP)
- Tunnel - GRE, IPIP tunnels
- VTI - Virtual Tunnel Interface for IPsec
- Loopback - Loopback interfaces
- Dummy - Dummy interfaces
System configuration
- User management - Users, SSH keys, RADIUS
- Syslog - Logging and remote syslog
- Time zone - Timezone and NTP
- IP parameters - System IP settings
- Task scheduler - Cron-like scheduler
Additional capabilities
- Containers - Podman containers
- High Availability - VRRP and fault tolerance
- Load Balancing - WAN link balancing
- Policy Routing - Policy-based routing
- QoS - Quality of Service and Traffic Shaping
- VRF - Virtual Routing and Forwarding
Useful resources
Frequently asked questions
What is VyOS?
VyOS is an open-source, Linux-based network operating system for building routers, firewalls, and VPN gateways.
Which routing protocols does VyOS support?
Static, OSPF, BGP, and RIP.
Which VPNs does VyOS support?
IPsec, WireGuard, OpenVPN, and L2TP/IPsec.
How is VyOS configured?
Through a single network-appliance-style command-line interface, with configuration commit and rollback.
Reviewed by OpenNix LLC · Last updated on