From fc77e32a848b9f601170adee5659549842a1ba20 Mon Sep 17 00:00:00 2001 From: Christopher Goes Date: Mon, 31 Aug 2026 19:43:12 -0600 Subject: [PATCH] docs(vms): document per-interface packet capture stop and interface names Documents the phenix vm capture start/stop CLI support for specifying a VM network interface by name (as declared in the experiment topology) instead of only by index, and for stopping a single interface's capture without affecting other captures running on the same VM. This behavior is introduced by sandialabs/sceptre-phenix#395, which is itself blocked on sandia-minimega/minimega#1632. --- docs/vms.md | 14 ++++++++++++-- 1 file changed, 12 insertions(+), 2 deletions(-) diff --git a/docs/vms.md b/docs/vms.md index 01357b7..3eae0e3 100644 --- a/docs/vms.md +++ b/docs/vms.md @@ -232,10 +232,12 @@ However, when you stop packet capture, it will stop captures on all network taps ### From the Command Line Binary -To start a packet capture, run the following command. +To start a packet capture, run the following command, specifying the target +network interface by its name (as declared in the experiment topology, e.g. +`IF0`) or its zero-based index. ```shell -phenix vm capture start +phenix vm capture start ``` To stop all packet captures on a running VM, use the following command. @@ -244,6 +246,14 @@ To stop all packet captures on a running VM, use the following command. phenix vm capture stop ``` +To stop the packet capture running on a single interface, without affecting +any other captures running on the same VM, provide the interface name or +index. + +```shell +phenix vm capture stop +``` + ## Kill a VM ### From the Web-UI