VyOS User Guide

Introduction

• About
  • Copyright Notice
• History
• Installation
  • Requirements
  • Getting the software
  • Software verification
  • Install
• CLI
• Quick Start
  • Configure DHCP Server and DNS
  • NAT and Firewall
  • Basic QoS
  • Security Hardening

Basics

• Configuration Overview
  • Terminology
  • Navigating
  • Managing
  • Access from config mode
  • Archive
  • Restore Default
• Network Interfaces
  • Addresses
  • Dummy
  • Ethernet
  • L2TPv3
  • PPPoE
  • Wireless (Wi-Fi)
  • Bridge
  • Bond
  • Tunnel
  • VLAN (802.1q)
  • QinQ (802.1ad)
  • VXLAN
  • GENEVE
• System Configuration
  • Config Management
  • Event Handler
  • Flow Accounting
  • Host Information
  • Login
  • NTP
  • System Proxy
  • Serial console
  • Syslog
  • Task scheduler
  • Time Zone
• Image Management
  • Update VyOS

Advanced

• Services
  • Conntrack
  • DHCP / DHCPv6
  • DNS Forwarding
  • Dynamic DNS
  • LLDP
  • mDNS Repeater
  • IPoE server
  • PPPoE server
  • SSTP server
  • UDP Broadcast Relay
  • SNMP
  • SSH
  • TFTP
  • Webproxy
• Firewall
  • Zone-based Firewall Policy
  • Groups
  • Rule-Sets
  • Applying a Rule-Set to an Interface
  • Applying a Rule-Set to a Zone
  • How VyOS replies when being pinged
  • Example Partial Config
• Routing
  • ARP
  • BGP
  • OSPF
  • PBR
  • RIP
  • Static Routes
  • TCP-MSS Clamping
  • Routing-policy
  • IGMP Proxy
• NAT
  • Source NAT
  • Destination NAT
  • 1-to-1 NAT
  • 1-to-1 NAT example
  • NPTv6
  • NAT before VPN
• QoS and Traffic Policy
  • Configuration nodes
  • Traffic policies in VyOS
  • Ingress shaping
  • Classful policies and traffic matching
• High availability
  • Basic setup
  • IPv6 support
  • Disabling a VRRP group
  • Setting VRRP group priority
  • Sync groups
  • Preemption
  • Unicast VRRP
  • Scripting
• VPN
  • OpenVPN
  • L2TP
  • Site-to-Site
  • GRE/IPsec
  • DMVPN
  • PPTP-Server
  • WireGuard VPN Interface
• Clustering
  • General cluster configuration
  • Cluster group configuration
  • Review cluster status
  • Example
• WAN load balancing
  • Balancing Rules
  • Health checks
  • Source NAT rules
  • Sticky Connections
  • Failover
  • Script execution
  • Handling and monitoring
• Command scripting
  • Run configuration commands
  • Run operational commands
  • Other script language
  • Executing Configuration Scripts
  • Postconfig on boot
• Troubleshooting
  • Basic Connectivity Verification
  • Monitoring
  • Clear Command
  • Basic System Information

Appendix

• Release notes
  • 1.2 (Crux)
  • Earlier releases
• 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
  • ESXi 5.5 or later
• Running on Bare Metal
  • Intel Atom C3000
  • PC Engines APU4
  • Qotom Q355G4
  • Partaker i5
  • Acrosser AND-J190N1
• Migrate from Vyatta Core
  • Vyatta release compatiblity
  • Upgrade procedure

Contributing

• Building VyOS
  • Build Docker Container
  • Build ISO
  • Upstream packages
• Issues/Feature requests
  • Bug Report/Issue
  • Feature Request
• Development
  • Submit a Patch
  • Coding Guidelines
  • Python
  • XML (used for CLI definitions)
  • Continous Integration
• Documentation
  • Forking Workflow
  • Style Guide