VyOS User Guide¶
VyOS is an open source network operating system based on Debian GNU/Linux.
VyOS provides a free routing platform that competes directly with other commercially available solutions from well known network providers. Because VyOS is run on standard amd64, i586 and ARM systems, it is able to be used as a router and firewall platform for cloud deployments.
We use multiple live versions of our manual hosted thankfully by https://readthedocs.org. We will provide one version of the manual for every VyOS major version starting with VyOS 1.2 which will receive Long-term support (LTS).
The manual version is selected/specified by it’s Git branch name. You can switch between versions of the documentation by selecting the appropriate branch on the bottom left corner.
VyOS CLI syntax may change between major (and sometimes minor) versions. Please always refer to the documentation matching your current, running installation. If a change in the CLI is required, VyOS will ship a so called migration script which will take care of adjusting the synatax. No action needs to be taken by you.
- Command-Line Interface
- Quick Start Guide
- Configuration Overview
- Network Interfaces
- QoS and Traffic Policy
- High availability
- WAN load balancing
- System Image Management
- Command scripting
- Release notes
- Configuration Examples
- VyOS DMVPN Hub
- Zone-Policy example
- VyOS BGP ipv6 unnumbered with extended nexthop
- VyOS OSPF unnumbered with ecmp
- Route-Based Site-to-Site VPN to Azure (BGP over IKEv2/IPsec)
- Route-Based Redundant Site-to-Site VPN to Azure (BGP over IKEv2/IPsec)
- VyOS Tunnelbroker.net IPv6
- VyOS High Availability Walkthrough
- Command tree
- Running on VMWare ESXi
- Running on Bare Metal
- Migrate from Vyatta Core
Copyright (C) 2018-2019 VyOS maintainers and contributors
Permission is granted to make and distribute verbatim copies of this manual provided the copyright notice and this permission notice are preserved on all copies.
Permission is granted to copy and distribute modified versions of this manual under the conditions for verbatim copying, provided that the entire resulting derived work is distributed under the terms of a permission notice identical to this one.
Permission is granted to copy and distribute translations of this manual into another language, under the above conditions for modified versions, except that this permission notice may be stated in a translation approved by the VyOS maintainers.