For the complete documentation index, see llms.txt. This page is also available as Markdown.

Basic commands

netlab up -- up the lab by automatically running netlab create (topology build) and netlab initial (device configuration and provisioning).

netlab down — down the lab and removes all deployed devices.

netlab restart — restarts the lab by tearing it down and bringing it back up, reloading the topology.yml.

netlab config — applies additional configuration to devices using defined templates.

netlab collect — collects and saves device configuration files (by default to the config/ directory).

netlab connect — connects to the CLI of lab devices using SSH or docker exec, via the management network.

netlab exec — executes commands on lab devices using SSH or docker exec, via the management network.

netlab validate — runs automated validation tests on lab devices.

netlab capture — performs live packet capture on interfaces and streams output to the console.

netlab show — displays lab parameters in json or txt formats.

netlab defaults — views and manages default parameters used when launching labs.

There are additional commands available. For a complete list, including syntax and usage details, refer to the CLI Overview.

You can also run netlab help or append -h to any command to view its built-in help and usage options.

Last updated