Knowledge Base

Everything, documented.

Install, build your first lab, migrate from EVE-NG, and drive netplex. by API. Search, or browse by topic.

/

All guides

Automation & API

CI/CD: test a lab from GitHub Actions or GitLab CI CLI quickstart: manage labs from the terminal Control netplex. from Claude with MCP The Python SDK REST API quickstart: create and drive a lab from curl Terraform provider and Ansible collection Real-time lab events over WebSocket

Canvas & topology

Add devices from the palette Zoom, fit, minimap and view options The command palette (⌘K)Give a node a custom icon Export the topology as PNG or PDF Working with large topologies The link appearance popover Wire a link to a specific interface See traffic flow on your links The minimap: your position at a glance The node appearance popover Pin your favourite devices The right-click menu Select many nodes and undo mistakes Select multiple nodes at once Style individual nodes and links Undo and redo on the canvas Zoom and fit the whole topology to view

Canvas & topology editing

Pick a specific image version when several match Delete a link Drag and reposition nodes Fullscreen the canvas Presentation Mode: laser pointer and live annotations

Configs & code

Back up your labs to git Diff a device's running config against its startup config Roll back a node to its saved startup config Lab-as-code: your topology as text Save a device configuration

Configs, git & backups

Export every device config in one zip Diff and restore a lab from its backup history Startup profiles: swap every node's config in one click

Consoles

Command snippets: one-click macros in every console Copy and paste in shell consoles Download a console session as a log file The Connector: native terminals and local device access Open a console on a node Console splits and broadcast typing Pop a console out into its own browser tab Find text in a console's scrollback

Dashboard & monitoring

The Dashboard Read the event log Reading the host resource cards The Notification Centre Per-lab and per-node resource usage

Getting started

Connect two nodes Create your first lab What a brand-new account sees first The in-canvas guided tour The one-click Demo lab The in-app Help guide Find your way around netplex.Your first ping

Images & the pipeline

Select and delete several images at once Classify an unrecognised image to a vendor Delete an image you no longer need Set the hardware defaults a device gets on the canvas Import images into the Library How to import a Cisco ASAv firewall image How to import a Cisco IOS image (Dynamips)How to import a Cisco IOL / IOU image Import an image from a URL How to import a Juniper vSRX (and vMX) image How to import a Nokia SR OS (VSR) image How to import a QEMU / qcow2 VM image (vIOS, ASAv, vSRX)How to run VyOS in netplex MicroVMs: Firecracker-backed nodes from the marketplace Pre-pull tool images for offline use Programming environment nodes: a language sandbox with Monaco built in How to pull a Docker image into netplex Pull an LXC system-container image Run your own code as a node - no Docker build What netplex. can run: the runtimes Drop files straight into the server uploads folder Supported Dynamips and Cisco IOL images

Import & migrate

Export a lab to EVE-NG or GNS3 format

Labs

Select and delete several labs at once Delete a lab Export and import labs (.npx)Autosave: nothing to save, nothing to lose Search, filter and group your labs Organise labs into groups Rename and duplicate a lab

Migrating from EVE-NG

Import from EVE-NG, GNS3 or ContainerLab Import a ContainerLab topology How to migrate an EVE-NG lab to netplex How to migrate a GNS3 project to netplex

Multi-host & VXLAN fabric

The VXLAN fabric: run one lab across several hosts

Networking & connectivity

Cloud gateway: Host Veth mode Test reachability between nodes Directional QoS: impair only one side of a link Inject a fault: pull a link down Add a link while the lab is running (hot-attach)How links work (and why netplex injects no traffic)The Hub: an L2 device with no MAC learning Give a lab internet access (Cloud gateway)IPv6 in labs Why a switch loop refuses to start Shape a link: delay, loss and bandwidth (QoS)Connect devices with an unmanaged switch

Nodes & devices

Give a node another interface Set a node’s CPU, RAM and disk Set a custom MAC address on a VM node Dynamips idle-PC tuning: stop a router pinning a CPU core Export a single node's config to a file The node Inspector The node Interfaces tab A node's live CPU and memory A node's live logs Node logs and live metrics Snapshots and save-as-image Rename a network interface Run a Cisco IOL switch (fast Cisco labs)Run a real Cisco IOS router Start and stop nodes

Nodes & runtimes

Docker nodes: the fastest, lightest runtime LXC nodes: full-system Linux containers Namespace nodes: instant, image-free network endpoints QEMU/KVM nodes: real vendor firmware The device catalogue: every platform netplex. knows

Settings & appearance

Changing the accent colour Update your email and password Per-role styling, link looks, labels and capture defaults Packet capture defaults Console mode, diagnostics and licensing info Choosing Web vs. Desktop console mode Create an API token Dashboard appearance: style the platform shell General preferences: language, accent, text size Browse and change the global settings How appearance inheritance works Track your bug reports (My Reports)Style devices by role, not by vendor Privacy, diagnostics and icon licensing The one-time diagnostics banner Terminal font and size Themes and terminal colours

Shapes & annotations

Draw a line or arrow Draw a circle or ellipse Draw shapes and labels on the canvas Insert an image or logo on the canvas Layer shapes: bring to front, send to back Style shapes: colours, borders and opacity

System administration

The System page: health, logs and updates

Traffic & analysis tools

Capture history: find and download past captures Test multicast with the generator and receiver Scan your lab with the Network Scanner Capture packets on a link Generate traffic with the built-in generator

Troubleshooting

The UI looks stale after an update Fix-it guides: repair the host by hand Get support and send diagnostics Image upload rejected: unsupported file format A node has no internet access Diagnosing a node that won't start What happens when your connection drops