VyOS User Guide

Introduction

• About
• History
• Installation
  • Requirements
  • Download
  • Installation
• CLI
• Quick Start
  • Configuration Mode
  • Commit and Save
  • Interface Configuration
  • SSH Management
  • Configure DHCP/DNS Servers
  • NAT
  • Firewall
  • Hardening

Basic Configuration

• Configuration Overview
  • Terminology
  • Seeing and navigating the configuration
  • Editing the configuration
  • Access opmode from config mode
  • Managing configurations
• Basic Network Interfaces
  • Ethernet
  • Loopback
  • PPPoE
• Basic System Tweaks
  • User Management
  • Host Information
  • Default Gateway/Route
  • Time Zone
• Image Management
  • Update VyOS

Advanced Configuration

• Advanced Network Interfaces
  • Bond / Link Aggregation
  • Bridge
  • Dummy
  • GENEVE
  • L2TPv3
  • MACsec
  • Pseudo Ethernet/MACVLAN
  • QinQ (802.1ad)
  • Tunnel
  • VLAN (802.1q)
  • VXLAN
  • Wireless LAN (WiFi)
  • WirelessModem (WWAN)
• Advanced System Tweaks
  • Event Handler
  • Flow Accounting
  • NTP
  • Options
  • System Proxy
  • Serial Console
  • Syslog
  • Task Scheduler
• Services
  • Conntrack
  • Console Server
  • DHCP / DHCPv6
  • DNS Forwarding
  • Dynamic DNS
  • LLDP
  • mDNS Repeater
  • IPoE Server
  • PPPoE Server
  • UDP Broadcast Relay
  • Router Advertisements
  • SNMP
  • SSH
  • TFTP Server
  • Webproxy
• Firewall
  • Overview
  • Global settings
  • Groups
  • Rule-Sets
  • Applying a Rule-Set to an Interface
  • Zone-based Firewall Policy
  • Operation-mode Firewall
  • Example Partial Config
• Routing
  • ARP
  • BGP
  • RPKI
  • OSPF
  • PBR
  • RIP
  • Static
  • BFD
  • TCP-MSS Clamping
  • Routing-policy
  • Multicast
• VRF
  • Configuration
  • Operation
• NAT
  • Overview
  • Configuration Examples
• NPTv6
  • VyOS Support
• QoS
  • How to make it work
  • Units
  • Classes
  • Creating a traffic policy
  • Applying a traffic policy
  • The case of ingress shaping
• High availability
  • Basic setup
  • IPv6 support
  • Disabling a VRRP group
  • Setting VRRP group priority
  • Sync groups
  • Preemption
  • Unicast VRRP
  • Scripting
• VPN
  • DMVPN
  • GRE/IPsec
  • L2TP
  • OpenVPN
  • PPTP-Server
  • Site-to-Site
  • SSTP
  • WireGuard
• WAN load balancing
  • Balancing Rules
  • Health checks
  • Source NAT rules
  • Sticky Connections
  • Failover
  • Script execution
  • Handling and monitoring
• Command List

System Operation

• Troubleshooting
  • Basic Connectivity Verification
  • Monitoring
  • Clear Command
  • IPv6 topology discovery
  • Basic System Information
• Commands List

Appendix

• Release Notes
  • 1.2 (Crux)
  • Earlier releases
• Configuration Blueprints
  • DMVPN Hub
  • DHCP Relay through GRE-Bridge
  • Zone-Policy example
  • BGP IPv6 unnumbered with extended nexthop
  • 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)
  • Tunnelbroker.net (IPv6)
  • High Availability Walkthrough
• Running on VMware ESXi
  • ESXi 5.5 or later
• Running on Bare Metal
  • Supermicro A2SDi (Atom C3000)
  • PC Engines APU4
  • Qotom Q355G4
  • Partaker i5
  • Acrosser AND-J190N1
• Running on Clouds
  • Amazon AWS
  • Azure
  • Google Cloud Platform
  • Oracle
• Running in Virtual Environments
  • Libvirt Qemu/KVM
  • Proxmox
• Migrate from Vyatta Core
  • Vyatta release compatibility
  • Upgrade procedure
• Command Scripting
  • Run configuration commands
  • Run operational commands
  • Other script language
  • Executing Configuration Scripts
  • Postconfig on boot
• HTTP-API
  • Enabling HTTP-API
  • Configuration mode requests
  • Configuration management requests
  • Image management requests
  • Operational mode requests
• VyOS on GNS3
  • Requirements
  • VM setup
  • VyOS installation
  • VyOS VM configuration

Contributing

• Build VyOS
  • Prerequisites
  • Build ISO
  • Packages
• Upstream packages
  • vyos-netplug
  • keepalived
  • strongswan
  • ppp
  • mdns-repeater
  • udp-broadcast-relay
  • Linux kernel
  • Linux Firmware
  • Intel NIC drivers
  • Accel-PPP
  • hvinfo
• Issues/Feature requests
  • Bug Report/Issue
  • Feature Request
• Development
  • Submit a Patch
  • Coding Guidelines
  • Python
  • XML (used for CLI definitions)
  • Continuous Integration
• Debugging
  • System Startup
  • Live System
  • Priorities
• Documentation
  • Forking Workflow
  • Style Guide

Copyright Notice

Copyright (C) 2018-2020 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.