List CML labs. By default only labs owned by the authenticated user; set show_all=True for every lab on the controller (needs admin rights).

Get full topology detail for a lab: its nodes, links, and their state.

Create a new, empty lab. Use add_node/add_link or build_topology to populate it.

Permanently delete a lab and everything in it. This cannot be undone.

Start (boot) every node in a lab.

Stop every node in a lab.

Wipe every node's disks back to initial state. Startup (day-0) configuration set via set_node_config is preserved; runtime/learned state is discarded. The lab must be stopped first.

List platform/node types available on this controller (e.g. iosv, iosvl2, csr1000v, nxosv, asav, alpine, unmanaged_switch, external_connector). Use the returned 'id' as node_definition when adding nodes. Availability depends on which reference platform images have been imported into CML.

Add a node to an existing lab.

node_definition: a platform id from list_node_definitions(), e.g. 'iosv', 'iosvl2', 'alpine', 'unmanaged_switch'. configuration: day-0 startup config text (e.g. a full IOS config), applied on first boot.

Remove a node, and any links/interfaces attached to it, from a lab.

Start (boot) a single node.

Stop a single node.

Get the stored day-0 startup configuration text for a node.

Set a node's day-0 startup configuration text. Takes effect the next time the node is (wiped and) started. To capture a running node's current config instead, use extract_node_config.

Pull the current running configuration off a booted, converged node and return it. Requires the node to be started.

Get console output captured for a node (console_id 0 is the main console on most platforms). Optionally limit to the last lines lines.

Connect two nodes with a link. If iface_a/iface_b (interface labels, e.g. 'GigabitEthernet0/1') are omitted, the next free interface on each node is used, creating one if needed.

Remove a link between two nodes.

Create a whole lab - nodes, links, and configs - in one call. Use this when you already have a topology design in mind (e.g. from list_example_topologies, or one you designed yourself from the user's description) rather than calling create_lab/add_node/add_link repeatedly.

nodes: [{id, label, node_definition, x?, y?, image_definition?, configuration?, cpus?, ram?}, ...] id is a caller-chosen local key used only to wire up links below; it is not sent to CML. links: [{node_a, node_b, iface_a?, iface_b?}, ...] node_a/node_b reference the local ids from nodes. iface_a/iface_b are optional interface labels (e.g. 'GigabitEthernet0/0'); if omitted the next free interface on each node is used. start: if True, start the lab immediately after building it.

Returns the new lab's id plus a map from each local node id to its real CML node id, so you can immediately call add_node/add_link/set_node_config etc. against the result.

List built-in example network architectures (e.g. OSPF/BGP routing labs, a three-tier campus, a leaf-spine data center fabric, a zone-based firewall with a DMZ) that can be deployed directly with deploy_example_topology, or fetched with get_example_topology and customized before calling build_topology.

Get the full node/link spec for a named example topology (from list_example_topologies), so it can be inspected or edited before building - e.g. to change addressing, swap node_definitions for platform-specific images, or add nodes - then passed to build_topology.

Build one of the built-in example topologies (see list_example_topologies) as a new lab, unmodified. For customization, use get_example_topology + build_topology instead.