Changes in Release 26.11

New Functionality

Ansible-free operations:

  • Netmiko is the default configuration deployment method for Arista EOS, Cisco ASAv, Cisco IOS/IOS XE, Cisco IOS XR, Cisco Nexus OS, Extreme EXOS, Extreme VOSS, FRR virtual machines, and IP Infusion OcNOS. netlab falls back to Ansible playbooks when netmiko is not installed.

  • The netlab config command uses the device configuration mode (for example, netmiko) instead of always running an Ansible playbook

  • netlab collect uses netmiko to collect configurations from Arista EOS, Cisco ASAv, Cisco IOS, Cisco IOS XR, Cisco Nexus OS, Extreme EXOS, and Extreme VOSS devices, and runs an Ansible playbook only when needed

  • netlab config –reload uses netmiko to replace device configurations on Arista EOS, Cisco IOS/IOS XE, Cisco IOS XR, Cisco Nexus OS, and FRR virtual machines. Other devices get their saved configurations deployed like custom configurations (for example, with cp_sh on FRR containers).

  • netlab connect uses netmiko to execute single commands, and netmiko can use SSH private key files (for example, on Vagrant boxes)

  • The device readiness checks use netmiko to check the SSH server and netlab connect (instead of Ansible task lists) to check interface readiness

Other new functionality:

Minor improvements

  • netlab waits for vrnetlab containers to become healthy by default

  • The netlab install upgrade command upgrades the netlab Python package in the same Python environment and directory it was installed into

  • The netlab install containerlab script defines the Docker repository in the deb822 format and limits the Docker repository key to that repository

  • Commands executed on lab devices (for example, readiness checks) can have a timeout

  • The netmiko parameters are defined as device features, and the netmiko configuration error patterns capture the whole error message

  • RIPv2/RIPng timers are configured on Nokia SR OS, VyOS, and IP Infusion OcNOS. netlab displays a warning when you set RIP timers on a device that cannot configure them.

  • netlab checks the Ansible version only when running Ansible playbooks and displays the “unsupported Ansible version” warning only when a playbook fails

  • FRR containers use the containerlab frr kind. netlab generates the list of FRR daemons from the node modules and the frr.daemons node attribute, which can be set to True to enable all FRR daemons. FRR log messages are also sent to the container stdout.

New Device Features

Cisco ASAv:

  • Loopback interface

  • Static routes

  • IBGP

  • OSPFv3

  • BGP and OSPF route import (redistribution)

IP Infusion OcNOS:

  • OSPFv2, OSPFv3, IS-IS, and BGP

  • BFD, static routes, VLANs, VRFs, and STP

  • OSPF and IS-IS BFD configured on individual interfaces

  • VRF OSPF instances support the same features as the global OSPF process

  • MTU on VLAN interfaces

  • Routing policies and the bgp.policy plugin

  • RIPv2 and RIPng

  • Route redistribution into OSPF and IS-IS

  • IS-IS in VRFs

  • VRF-aware OSPF area configuration

Extreme VOSS:

  • Initial configuration, VLANs, and static routes

  • SPBm with AutoSense

Nokia SR OS and VyOS:

  • RIPv2/RIPng timers

ArubaOS-CX and Extreme EXOS:

  • Transparent management IP address in containerlab (vrnetlab) containers

Fixes in Configuration Templates

Arista EOS:

  • Use numeric version comparison when checking whether a cEOS release supports MPLS data plane (#4027)

Cisco IOS, IOS XE, and VyOS:

  • Create route maps only for the IPv4 and IPv6 address families (not for VPNv4/VPNv6) (#4012)

Extreme EXOS:

  • Disable EDP, use the mgmt.ifname variable, and use # instead of ! as the comment character

Cisco Nexus OS:

  • vrnetlab Nexus OS containers boot as a layer-2 switch. netlab shuts down all interfaces before configuring them, and enables an interface only after it is fully configured.

  • The netmiko error pattern recognizes configuration error messages without the leading % sign

Cisco IOS XR:

  • netlab waits before starting the netmiko configuration process to avoid “another config session is active” errors

Breaking Changes

  • The minimum supported containerlab version is 0.83.0

  • Ubuntu 22.04 and Python 3.10 are deprecated and will not be supported in an upcoming release. netlab up and netlab version display a warning when running on Python 3.10. Please upgrade to Python 3.11 or later (for example, Ubuntu 24.04 or later).

  • FRR containers use the containerlab frr kind instead of the linux kind. netlab no longer maps the generated daemons file into /etc/frr/daemons; containerlab generates it from the daemons node attribute.

  • Ansible core 2.21 dropped the paramiko_ssh connection plugin. netlab uses the ssh Ansible connection (instead of paramiko) for all SSH-based devices (#4087). Password-based SSH logins need sshpass on the netlab host (installed by the Ubuntu and libvirt installation scripts).

  • The Nokia SR OS and SR-SIM configuration deployment, configuration collection, and readiness checks use the official nokia.openconfig Ansible Galaxy collection instead of the archived nokia.grpc collection. Rerun netlab install grpc to install it (see Nokia SR OS).

  • Older vrnetlab containers might fail to become healthy when running with the containerlab version 0.83.0. If you experience this, rebuild those containers using the latest vrnetlab code.

  • netlab uses netmiko to configure most Arista and Cisco devices (see above). If you used netlab install ansible to install Ansible, you already have netmiko installed. Otherwise, install it with netlab install netmiko (netlab uses Ansible playbooks to configure those devices when netmiko is missing), or set the netlab_config_mode device group variable (or node parameter) to an empty value to keep using Ansible playbooks.

  • The netmiko_* device group variables were replaced with netmiko.* device features. Move any customized netmiko_* group variables (for example, netmiko_device_type) into the device features.

  • netlab waits for vrnetlab containers to become healthy. Set the defaults.providers.clab.healthy_timeout parameter to zero to disable that check.

  • FRR and Linux virtual machines use the netmiko configuration mode (instead of sh/cp_sh) to deploy configuration scripts. netlab replaces the sh/cp_sh configuration mode with netmiko (and displays a warning) on libvirt nodes; change the netlab_config_mode node parameters or user defaults (for example, set by netlab install netmiko) to netmiko, or rerun netlab install netmiko.

Bug Fixes

  • Netmiko-based configuration reload works on Cisco IOS devices with a generic boot-time hostname (#4083, #4084)

  • Deploy custom configurations into FRR containers with the cp_sh configuration mode (#4071)

  • netlab config –reload deploys the reload-time initial configuration with the netlab initial code (#4073)

  • Handle non-string netmiko results in netlab connect (#4072)

  • strings.eval_format accepts multiline text (#4082)

  • routing.neighbors returns all BGP session types (including local-AS IBGP and confederation EBGP sessions) by default (#4055). This fixes the BGP session attributes and BGP graphs for those sessions.

  • A single function decides whether a configuration file is a shell script (#4046)

  • netlab checks the topology version and normalizes nodes before loading the plugins (#4041)

  • Return clean stdout from the netlab connect functions (#4039)

  • Check for sshpass in netlab connect (#4034)

  • Use semantic version comparison when checking the version of Ansible collections (#4032)

  • Add CAP_DAC_READ_SEARCH capability to the edgeshark container (#4030)

  • Deduplicate list elements in append_to_list with flatten (#4014)

  • Use MULTILINE regular expressions to detect configure replace errors

  • Use a different SSH readiness command with netmiko (#4006)

  • Provider initialization no longer crashes when there is no default device

  • Captured command output is thread-safe, so parallel readiness checks do not see each other’s output (#3990)

  • Updated the netlab collect section headers to match other multi-step commands (#3981)

  • netlab collect collects configurations only from nodes that support configuration collection (#3980), including OcNOS

  • Consistent handling of the –limit/node CLI parameter (#3979)

  • Created a package from the netlab collect CLI module (#3978)

  • Validation tests executed with docker exec see both stdout and stderr (#3977)

  • FRR bgp_prefix validation works with best=False (#3968)

  • Corrected the error message reported when a device does not support VRFs (#3967)

  • Use correct names for MPLS kernel modules (#3963)

Documentation Fixes

  • New developer documentation: device readiness checks (#3994), netmiko configuration deployment (#3961), and device hooks (#4024)

  • More detailed Netmiko-or-Ansible installation instructions (#4068, #4070)

  • Pointers to the netlab-ui web interface (#4090)

  • The RIPv2/RIPng documentation uses feature tables (#4053)

  • Feature tables use the table-wrap CSS (#4009)

  • The VRF documentation uses feature tables (#3976)

  • Feature tables are built faster because the device data is merged only once (#3975)