networklab 26.3

CLI-based Virtual Networking Lab Abstraction Layer

Overview

netlab is bringing infrastructure-as-code concepts to networking labs. You'll describe your high-level network topology and routing design in a YAML file, and the tools in this repository will

• Create Vagrantfile configuration file for libvirt/KVM environment
• Create containerlab configuration file to run Docker containers
• Create Ansible inventory and configuration file
• Create IPv4 and IPv6 addressing plan and OSPFv2, OSPFv3, EIGRP, IS-IS, RIPv2, RIPng, and BGP routing design
• Configure IPv4, IPv6, DHCP, DHCPv6, VLANs, VRFs, VXLAN, LLDP, BFD, OSPFv2, OSPFv3, EIGRP, IS-IS, BGP, RIPv2, RIPng, VRRP, LACP, LAG, MLAG, link bonding, STP, anycast gateways, static routes, route maps, prefix lists, AS-path prefix lists, route redistribution, default route origination, MPLS, BGP-LU, L3VPN (VPNv4 + VPNv6), 6PE, EVPN, SR-MPLS, or SRv6 on your lab devices.
• Create graphs and reports of your lab topology and BGP, IS-IS, and OSPF routing
• Configure and manage (virtual) link impairment
• Provide local- or remote traffic capture capabilities

Instead of wasting time creating a lab topology in a GUI and configuring tedious details, you'll start with a preconfigured lab that meets your high-level specifications (aka intent).

Interested? Read the documentation (also available on GitHub Pages) and installation guidelines.

Releases

The latest release is release 26.03. It should be pretty stable, but if you encounter bugs, please report them as GitHub issues and use release 26.02.

An Overview of CLI Commands

netlab up : Uses netlab create to create configuration files, starts the virtual lab, and uses netlab initial to deploy device configurations, including IP addressing, LLDP, OSPF, BGP, IS-IS, EIGRP, VRRP, VLANs, VRFs, MPLS, SR-MPLS, VXLAN, EVPN, and SRv6. More details

netlab down : Destroys the virtual lab. More details

netlab restart : Restart and/or reconfigure the virtual lab. More details

netlab config : Applies additional Jinja2 configuration templates to network devices.

netlab collect : Using Ansible fact gathering or other device-specific Ansible modules, collects device configurations and saves them in the specified directory (default: config).

netlab connect : Use SSH or docker exec to connect to a lab device using device names, management network IP addresses (ansible_host), SSH port, and username/passwords specified in lab topology or netlab device defaults.

netlab exec : Use SSH or docker exec to execute a command on one or more network devices using device names, management network IP addresses (ansible_host), SSH port, and username/passwords specified in lab topology or netlab device defaults.

netlab capture : Perform packet capture on VM- and container interfaces

netlab tc : Disable, enable, display, or modify link impairment parameters

netlab report : Creates a report from the transformed lab topology data. More details

netlab graph : Creates a lab topology graph description in Graphviz or D2 format. More details

netlab show : Display system settings in tabular, text, or YAML format. More details

netlab defaults : Display and manage system defaults. More details

netlab usage : Display and manage usage statistics. More details