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 containerlab configuration file to run Docker containers or Vagrantfile configuration file for libvirt/KVM environment
- 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, GRE tunnels, WireGuard tunnels, 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.10. It should be pretty stable, but if you encounter bugs, please report them as GitHub issues and use release 26.09.
Common netlab CLI Commands
This section introduces common netlab commands. You'll find more details and the complete list of supported commands in the netlab command reference.
Starting and Stopping the Lab
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
Managing Device Configurations
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 create
: Creates device configurations (in node_files directory), virtualization-related configurations, and network automation inventory. You can also use this command to inspect transformed data and create graphs or reports.
Working with Lab Devices
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 status : Displays lab- and device status. More details
Troubleshooting
netlab capture : Perform packet capture on VM- and container interfaces
netlab tc : Disable, enable, display, or modify link impairment parameters
Reports and Graphs
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
1 maintainer
Metadata
1 maintainer
Release files for networklab 26.10
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| networklab-26.10.tar.gz | 826.7 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| networklab-26.10-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 2.1 MB
Release files / networklab-26.10.tar.gz
| Download URL | networklab-26.10.tar.gz |
|---|---|
| Size | 826.7 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
22b5436b0662f3f5148690c1503764f616db7e1381f092c7346489b1b54964e8
|
|
BLAKE2b-256 checksum How to use checksums |
b205ace86750619a5930413dbcef53ee46c894f6173fcc1d383159fdd8ec6c73
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Release files / networklab-26.10-py3-none-any.whl
| Download URL | networklab-26.10-py3-none-any.whl |
|---|---|
| Size | 1.3 MB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
29688f0b634680c8c22eef0b739ee5b3e89fb1dde0e37f5291d89b1ee1c8693e
|
|
BLAKE2b-256 checksum How to use checksums |
60701eba36a98cbf8ac1e36a290c88419d01e953ddabafa291c41027aae0d7c1
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
