Skip to main content

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.11. It contains numerous breaking changes and tons of new functionality (see release notes for details); if you encounter bugs, please report them as GitHub issues and use release 26.10.

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

Metadata

Release files for networklab 26.11

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for networklab 26.11
File Size Uploaded Provenance Actions
networklab-26.11.tar.gz 884.0 kB Without provenance Details for networklab-26.11.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for networklab 26.11
File Interpreter ABI Platform Actions
networklab-26.11-py3-none-any.whl Python 3 none any Details for networklab-26.11-py3-none-any.whl

Total release size: 2.2 MB

Release files / networklab-26.11.tar.gz

Download URL networklab-26.11.tar.gz
Size 884.0 kB
Tags Source
SHA-256 checksum
How to use checksums
206563b276251c3d327deb591aeefb0b346ebecaec693fe344ec98092d980879
BLAKE2b-256 checksum
How to use checksums
5e88039238cc02d54de0dbcb911e9f7697902610013d727204ca104a795d88f2
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.16

Release files / networklab-26.11-py3-none-any.whl

Download URL networklab-26.11-py3-none-any.whl
Size 1.4 MB
Tags Python 3
SHA-256 checksum
How to use checksums
e8b181711f289343ca37f65a96dbe7e37587d0d3efa3d39fc45943ebe583a52d
BLAKE2b-256 checksum
How to use checksums
2ef27be31a377c579feeb5035a7357af2bf7e79baa77c55a30e90d6b3028c856
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.16

Security for networklab 26.11

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

26.11 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page