phenix vm¶
Every command on this page also accepts the global flags.
phenix vm¶
Virtual machine management
Options¶
SEE ALSO¶
- phenix - A cli application for phēnix
- phenix vm capture - Modify network packet captures for one or more VMs
- phenix vm cdrom - Insert or eject the optical disc of a VM
- phenix vm commit - Create a backing image from the disk of a running VM
- phenix vm cp - Copy a file into or out of a running VM
- phenix vm exec - Run a command in a running VM
- phenix vm forward - List, add, or remove the port forwards of a VM
- phenix vm info - Table of virtual machine(s)
- phenix vm kill - Kill a running or paused VM
- phenix vm memory-snapshot - Create an ELF memory snapshot of a VM
- phenix vm mount - Mount a VM's filesystem on the headnode
- phenix vm net - Modify network connectivity for a VM
- phenix vm pause - Pause running VM(s) for a specific experiment
- phenix vm qos - View or change the link quality of VM interfaces
- phenix vm redeploy - Redeploy running experiment VM(s)
- phenix vm reset-disk - Resets the disk state for running or powered off VM(s)
- phenix vm restart - Restart running, paused, or powered off VM(s) for a specific experiment
- phenix vm resume - Resume paused VM(s) for a specific experiment
- phenix vm screenshot - Save a screenshot of the screen of a running VM
- phenix vm set - Set configuration value(s) for VM(s)
- phenix vm shutdown - Shutdown a running or paused VM
- phenix vm snapshot - List, create, restore, and delete VM disk and memory snapshots
- phenix vm unmount - Unmount a VM's filesystem from the headnode
phenix vm capture¶
Modify network packet captures for one or more VMs
Synopsis¶
Modify network packet captures for a VM
Used to modify the network packet captures for virtual machines in a running
experiment; see command help for start and stop for additional arguments.
Options¶
SEE ALSO¶
- phenix vm - Virtual machine management
- phenix vm capture list - List the running packet captures of an experiment or a VM
- phenix vm capture start - Start a packet capture for a VM specifying the interface (by name or index) and using given output file as name of capture file
- phenix vm capture start-subnet - Start packet captures for the specified subnet
- phenix vm capture start-vlan - Start packet captures for the specified VLAN
- phenix vm capture stop - Stop packet captures for the specified VM
- phenix vm capture stop-all - Stop all packet captures for the specified experiment
- phenix vm capture stop-subnet - Stop all packet captures for the specified subnet
- phenix vm capture stop-vlan - Stop the packet captures for the specified VLAN
- phenix vm capture stream - Write a running packet capture to stdout as it is captured
phenix vm capture list¶
List the running packet captures of an experiment or a VM
Synopsis¶
List the running packet captures of an experiment or a VM
Prints the VM, the interface index and the file of each running packet
capture. With a VM name, the table shows only the captures of that VM. A
stopped experiment has no captures. -o json and -o yaml print the
captures with the fields of GET /experiments/{name}/captures.
Examples¶
Options¶
SEE ALSO¶
- phenix vm capture - Modify network packet captures for one or more VMs
phenix vm capture start¶
Start a packet capture for a VM specifying the interface (by name or index) and using given output file as name of capture file
Options¶
SEE ALSO¶
- phenix vm capture - Modify network packet captures for one or more VMs
phenix vm capture start-subnet¶
Start packet captures for the specified subnet
Options¶
-f, --filter string Filter to restrict the list of VMs
--format string capture file format, pcapng or pcap (default "pcapng")
-h, --help help for start-subnet
SEE ALSO¶
- phenix vm capture - Modify network packet captures for one or more VMs
phenix vm capture start-vlan¶
Start packet captures for the specified VLAN
Synopsis¶
Start packet captures for the specified VLAN
Starts a packet capture on each interface on the VLAN of the running VMs.
Give the VLAN alias in the case that minimega reports it, for example EXP_1.
Options¶
-f, --filter string Filter to restrict the list of VMs
--format string capture file format, pcapng or pcap (default "pcapng")
-h, --help help for start-vlan
SEE ALSO¶
- phenix vm capture - Modify network packet captures for one or more VMs
phenix vm capture stop¶
Stop packet captures for the specified VM
Synopsis¶
Stop packet captures for the specified VM
If an interface name or index is provided, only the packet capture running
on that interface is stopped, leaving any other running captures for the VM
untouched. Otherwise, all packet captures for the VM are stopped.
Options¶
SEE ALSO¶
- phenix vm capture - Modify network packet captures for one or more VMs
phenix vm capture stop-all¶
Stop all packet captures for the specified experiment
Options¶
SEE ALSO¶
- phenix vm capture - Modify network packet captures for one or more VMs
phenix vm capture stop-subnet¶
Stop all packet captures for the specified subnet
Options¶
--dry-run Show what the command would change, and change nothing
-f, --filter string Filter to restrict the list of VMs
-h, --help help for stop-subnet
SEE ALSO¶
- phenix vm capture - Modify network packet captures for one or more VMs
phenix vm capture stop-vlan¶
Stop the packet captures for the specified VLAN
Synopsis¶
Stop the packet captures for the specified VLAN
Stops the packet capture on each interface on the VLAN of the running VMs.
The captures on other interfaces of the VMs continue.
Options¶
--dry-run Show what the command would change, and change nothing
-f, --filter string Filter to restrict the list of VMs
-h, --help help for stop-vlan
SEE ALSO¶
- phenix vm capture - Modify network packet captures for one or more VMs
phenix vm capture stream¶
Write a running packet capture to stdout as it is captured
Synopsis¶
Write a running packet capture to stdout as it is captured
Writes the capture as a pcap stream: every packet captured so far (or, with
--from-now, none of them), then each packet as it is captured, until the
capture stops or the command is interrupted. Pipe it into Wireshark to
watch it live:
phenix vm capture stream <exp> <vm> <iface> | wireshark -k -i -
Options¶
--from-now Skip the packets captured before the command started
-h, --help help for stream
-O, --output-file string Write the capture to this file instead of stdout
SEE ALSO¶
- phenix vm capture - Modify network packet captures for one or more VMs
phenix vm cdrom¶
Insert or eject the optical disc of a VM
Synopsis¶
Insert or eject the optical disc of a VM
Changes the disc in the first optical drive of a running VM. The experiment
must run.
Options¶
SEE ALSO¶
- phenix vm - Virtual machine management
- phenix vm cdrom eject - Eject the optical disc of a VM
- phenix vm cdrom insert - Insert an optical disc image into a VM
phenix vm cdrom eject¶
Eject the optical disc of a VM
Examples¶
Options¶
SEE ALSO¶
- phenix vm cdrom - Insert or eject the optical disc of a VM
phenix vm cdrom insert¶
Insert an optical disc image into a VM
Synopsis¶
Insert an optical disc image into a VM
Puts the ISO image in the first optical drive of the VM, in place of the
disc it holds. minimega reads the path on the cluster node that runs the
VM.
Examples¶
Options¶
SEE ALSO¶
- phenix vm cdrom - Insert or eject the optical disc of a VM
phenix vm commit¶
Create a backing image from the disk of a running VM
Synopsis¶
Create a backing image from the disk of a running VM
Writes the first disk of the VM as it is now, with the changes in its
snapshot, to a new image that has no backing image. phenix shuts down the
VM while it writes the image, and then starts the VM again. It also starts
the VM again if the operation fails.
The image name must be a bare file name, with no folder. Without an image
name, phenix names the image after the base image of the VM and the time,
for example ubuntu_20261106120000.qc2. phenix writes the image in
<base-dir.phenix>/images on the head node, copies it to the other cluster
nodes, and prints its name. The VM can run on any cluster node.
The experiment and the VM must run, and the VM must have its snapshot flag
set. For a VM with more than one disk, the image holds only the first disk.
The other disks do not change.
Examples¶
Options¶
SEE ALSO¶
- phenix vm - Virtual machine management
phenix vm cp¶
Copy a file into or out of a running VM
Synopsis¶
Copy a file into or out of a running VM
Copy one file between the local host and a running VM through the VM's
miniccc agent, as scp does. Name the VM side as <vm name>:<path>, with an
absolute path in the VM. Exactly one of <src> and <dst> must name the VM.
A path that ends with "/" is a folder, and the file keeps its name.
To copy into the VM, phenix puts a staging copy in the experiment's folder
of the minimega files directory. It sends the copy with "cc send" and then
moves it to the path in the VM. To copy out of the VM, phenix gets the file
with "cc recv". This works only for a VM on the headnode, and for a Unix
path with no glob characters. phenix removes the staging copy and the
received copy when the copy is complete. A file copied out of the VM gets
the permissions 0600. The VM must run the miniccc agent.
Examples¶
phenix vm cp myexp ./setup.sh host-01:/root/setup.sh
phenix vm cp myexp ./setup.sh host-01:/root/
phenix vm cp myexp host-01:/var/log/syslog ./syslog
Options¶
-h, --help help for cp
--timeout duration How long to wait for the VM to complete the copy (default 1m0s)
SEE ALSO¶
- phenix vm - Virtual machine management
phenix vm exec¶
Run a command in a running VM
Synopsis¶
Run a command in a running VM
Run a command in a running VM through its miniccc agent, as the minimega
command "cc exec" does, and print the stdout and stderr of the command.
The command exits with the exit code of the command in the VM when minimega
reports it.
miniccc runs the command without a shell. To use pipes or redirects, run a
shell, such as "sh -c '...'". Put "--" before a command that has flags.
phenix refuses an argument that minimega would change on the host: an
argument with a "$" variable, or a file:, http:, https: or tar: URL. The VM
must run the miniccc agent.
Examples¶
phenix vm exec myexp host-01 hostname
phenix vm exec myexp host-01 --timeout 5m -- ls -la /tmp
phenix vm exec myexp host-01 -- sh -c 'ps aux | grep nginx'
Options¶
-h, --help help for exec
--timeout duration How long to wait for the command to complete (default 1m0s)
SEE ALSO¶
- phenix vm - Virtual machine management
phenix vm forward¶
List, add, or remove the port forwards of a VM
Synopsis¶
List, add, or remove the port forwards of a VM
A port forward is a minimega tunnel from a cluster port to a port that the
VM reaches, which phenix-tunneler serves on the computer of its owner. The
running phenix server holds the forwards, so these commands call it over
its unix socket (--unix-socket). The server takes a request from the socket
as the user global-admin, so a forward that the CLI adds has that owner,
and the CLI removes only the forwards of that owner.
Options¶
SEE ALSO¶
- phenix vm - Virtual machine management
- phenix vm forward add - Add a port forward to a VM
- phenix vm forward list - List the port forwards of a VM
- phenix vm forward remove - Remove a port forward of a VM
phenix vm forward add¶
Add a port forward to a VM
Synopsis¶
Add a port forward to a VM
Opens a minimega tunnel from a cluster port to the destination port on
--host, as the cluster node of the VM reaches it. With vnc, the forward
goes to the VNC console of the VM. --source-port is the port that
phenix-tunneler listens on; it defaults to the destination port. An owner
has at most one forward to each host and port of a VM.
Examples¶
phenix vm forward add my-exp web 22
phenix vm forward add my-exp web 80 --host 10.0.0.5 --source-port 8080
phenix vm forward add my-exp web vnc
Options¶
-h, --help help for add
--host string Destination host, as the cluster node of the VM reaches it (default "127.0.0.1")
--source-port string Port for phenix-tunneler to listen on (default the destination port)
SEE ALSO¶
- phenix vm forward - List, add, or remove the port forwards of a VM
phenix vm forward list¶
List the port forwards of a VM
Synopsis¶
List the port forwards of a VM
Lists the forwards of every owner. -o json and -o yaml print the forwards
with the fields of GET /experiments/{exp}/vms/{name}/forwards.
Examples¶
Options¶
SEE ALSO¶
- phenix vm forward - List, add, or remove the port forwards of a VM
phenix vm forward remove¶
Remove a port forward of a VM
Synopsis¶
Remove a port forward of a VM
Closes the forward of the owner global-admin to the destination port on
--host, and its minimega tunnel.
Examples¶
Options¶
--dry-run Show what the command would change, and change nothing
-h, --help help for remove
--host string Destination host of the forward (default "127.0.0.1")
SEE ALSO¶
- phenix vm forward - List, add, or remove the port forwards of a VM
phenix vm info¶
Table of virtual machine(s)
Synopsis¶
Table of VM(s)
Used to display a table of virtual machine(s) for a specific experiment;
VM name is optional, when included will display only that VM.
Filter the output by repeating --filter with a COLUMN=VALUE expression.
Multiple filters are combined with AND semantics. Column names and values
are case-insensitive. Supported columns are HOST, NAME, RUNNING, DISK,
INTERFACES, UPTIME, MEMORY, VCPUS, OS_TYPE, and TAPS. DISK values may be
full paths, filenames, or filenames without extensions. For example:
phenix vm info my-experiment --filter RUNNING=true
phenix vm info my-experiment --filter RUNNING=true --filter OS_TYPE=linux
phenix vm info my-experiment --filter DISK=jammy
Repeat --host to list only the VMs running on any of the named cluster
hosts, named exactly as minimega reports them. --host combines with the VM
name or --label, and with --filter: a VM must match each of them. For
example:
phenix vm info my-experiment --host compute1 --host compute2
phenix vm info my-experiment --host compute1 --label role-web
-o json and -o yaml print each VM with the fields of the API, as
GET /experiments/{exp}/vms gives them.
Options¶
-f, --filter stringArray Filter output by column value (COLUMN=VALUE); may be repeated
-h, --help help for info
--host stringArray Cluster host to filter VMs by, named exactly as minimega reports it; may be repeated
-l, --label stringArray Label to filter VMs (supports glob patterns); use 'all' to select every VM
-o, --output string Output format (table, json, yaml) (default "table")
-t, --taps Include tap interface names in the table
SEE ALSO¶
- phenix vm - Virtual machine management
phenix vm kill¶
Kill a running or paused VM
Synopsis¶
Kill running or paused VM(s)
Used to kill or delete running or paused virtual machine(s) for a specific
experiment
Options¶
--dry-run Show what the command would change, and change nothing
-h, --help help for kill
-l, --label stringArray Label to filter VMs (supports glob patterns); use 'all' to select every VM
SEE ALSO¶
- phenix vm - Virtual machine management
phenix vm memory-snapshot¶
Create an ELF memory snapshot of a VM
Synopsis¶
Create an ELF memory snapshot of the VM
Used to create an ELF memory snapshot for a running virtual machine
that is compatible with memory forensic toolkits Volatility and Google's Rekall.
Options¶
SEE ALSO¶
- phenix vm - Virtual machine management
phenix vm mount¶
Mount a VM's filesystem on the headnode
Synopsis¶
Mount a VM's filesystem on the headnode
Mount the filesystem of a running virtual machine to a directory on the
headnode. The VM must run the miniccc agent. phenix mounts the filesystem at
<mount-dir>/<experiment name>/<vm name>. The default mount-dir is
<base-dir.phenix>/mounts, which is /phenix/mounts with the default settings.
Use the global --mount-dir flag (or the PHENIX_MOUNT_DIR environment
variable) to change it.
Options¶
SEE ALSO¶
- phenix vm - Virtual machine management
phenix vm net¶
Modify network connectivity for a VM
Synopsis¶
Modify network connectivity for a VM
Used to modify the network connectivity for a virtual machine in a running
experiment; see command help for connect or disconnect for additional
arguments.
Options¶
SEE ALSO¶
- phenix vm - Virtual machine management
- phenix vm net connect - Connect a VM interface to a VLAN
- phenix vm net disconnect - Disconnect a VM interface
phenix vm net connect¶
Connect a VM interface to a VLAN
Options¶
SEE ALSO¶
- phenix vm net - Modify network connectivity for a VM
phenix vm net disconnect¶
Disconnect a VM interface
Options¶
SEE ALSO¶
- phenix vm net - Modify network connectivity for a VM
phenix vm pause¶
Pause running VM(s) for a specific experiment
Options¶
-h, --help help for pause
-l, --label stringArray Label to filter VMs (supports glob patterns); use 'all' to select every VM
SEE ALSO¶
- phenix vm - Virtual machine management
phenix vm qos¶
View or change the link quality of VM interfaces
Synopsis¶
View or change the link quality of VM interfaces
The link quality is the packet loss, the delay or the rate limit that
minimega applies to the traffic that a VM interface receives. A rate cannot
go with a loss or a delay. The experiment must run. An interface is an
index from 0 or an interface name of the topology.
Options¶
SEE ALSO¶
- phenix vm - Virtual machine management
- phenix vm qos clear - Remove the link quality of a VM interface, or of all its interfaces
- phenix vm qos get - Show the link quality of each interface of a VM
- phenix vm qos set - Replace the link quality of a VM interface
phenix vm qos clear¶
Remove the link quality of a VM interface, or of all its interfaces
Synopsis¶
Remove the link quality of a VM interface, or of all its interfaces
With an interface, removes the link quality of that interface. Without one,
removes the link quality of each interface that has one.
Examples¶
Options¶
SEE ALSO¶
- phenix vm qos - View or change the link quality of VM interfaces
phenix vm qos get¶
Show the link quality of each interface of a VM
Examples¶
Options¶
SEE ALSO¶
- phenix vm qos - View or change the link quality of VM interfaces
phenix vm qos set¶
Replace the link quality of a VM interface
Synopsis¶
Replace the link quality of a VM interface
Clears the link quality of the interface, then applies each setting given.
Give a --loss, a --delay or both, or give a --rate alone.
Examples¶
phenix vm qos set my-exp web 0 --loss 0.5 --delay 100ms
phenix vm qos set my-exp web IF0 --rate 10mbit
Options¶
--delay string Delay to add to each packet, in us, ms or s, such as 100ms
-h, --help help for set
--loss string Percent of packets to drop, from 0 up to 100, such as 0.5
--rate string Rate limit, a whole number of kbit, mbit or gbit, such as 10mbit
SEE ALSO¶
- phenix vm qos - View or change the link quality of VM interfaces
phenix vm redeploy¶
Redeploy running experiment VM(s)
Synopsis¶
Redeploy running experiment VM(s)
Used to redeploy running virtual machine(s) for a specific experiment; several redeploy
values can be modified. The CPU and memory values change only when their flags are set.
A new disk replaces only the first disk of the VM. The disk value is
<path>[,<interface>][,<cache>]; a field that the value leaves out keeps the value of
the old first disk.
Options¶
-c, --cpu int Number of VM CPUs (1-16 is valid; 0 keeps the current value)
-d, --disk string New first disk: <path>[,<interface>][,<cache>]
-h, --help help for redeploy
-l, --label stringArray Label to filter VMs (supports glob patterns); use 'all' to select every VM
-m, --mem int Amount of memory in megabytes (a multiple of 512 from 512 to 131072; 0 keeps the current value)
-p, --partition int Partition of the new disk to inject files into (used only with --disk and --replicate-injects) (default 1)
-r, --replicate-injects Recreate disk snapshot and VM injections
SEE ALSO¶
- phenix vm - Virtual machine management
phenix vm reset-disk¶
Resets the disk state for running or powered off VM(s)
Synopsis¶
Resets the disk state to the initial pre-boot disk state for running or powered off VM(s)
Used to reset the disk state for the first disk for running or powered off virtual machine(s) for a specific
experiment. The VM's snapshot flag must be set to true in order to use this command.
Options¶
--dry-run Show what the command would change, and change nothing
-h, --help help for reset-disk
-l, --label stringArray Label to filter VMs (supports glob patterns); use 'all' to select every VM
SEE ALSO¶
- phenix vm - Virtual machine management
phenix vm restart¶
Restart running, paused, or powered off VM(s) for a specific experiment
Options¶
-h, --help help for restart
-l, --label stringArray Label to filter VMs (supports glob patterns); use 'all' to select every VM
SEE ALSO¶
- phenix vm - Virtual machine management
phenix vm resume¶
Resume paused VM(s) for a specific experiment
Options¶
-h, --help help for resume
-l, --label stringArray Label to filter VMs (supports glob patterns); use 'all' to select every VM
SEE ALSO¶
- phenix vm - Virtual machine management
phenix vm screenshot¶
Save a screenshot of the screen of a running VM
Synopsis¶
Save a screenshot of the screen of a running VM
Writes the screen of the VM as a PNG image to the --output-file file, or to
stdout when stdout is not a terminal. With no --output-file and a terminal,
it makes the file <vm name>-<YYYYMMDD-HHMMSS>.png (UTC time) in the current
folder, as the web UI names a saved screenshot, and prints the file name.
It does not replace a file with that name: it adds -1, -2 and so on. With
--size, minimega scales the image so that its longest side is at most that
many pixels. The experiment must run.
Examples¶
phenix vm screenshot my-exp web
phenix vm screenshot my-exp web --output-file web.png
phenix vm screenshot my-exp web --size 800 > web.png
Options¶
-h, --help help for screenshot
-O, --output-file string Write the PNG image to this file ("-" for stdout)
--size int Longest side of the image in pixels, from 1 to 4096 (0 for the full size)
SEE ALSO¶
- phenix vm - Virtual machine management
phenix vm set¶
Set configuration value(s) for VM(s)
Synopsis¶
Set configuration value(s) for VM(s)
Used to set one or more configuration values for virtual machine(s) in an
experiment. Only flags that are explicitly provided will be applied.
While the experiment is running, you can change only the labels
(--label-changes, --append-labels), the annotations (--annotation) and the
VLAN of an interface (--interface). Apps read the new annotations when the
experiment starts again. --interface changes only a VM of a running
experiment.
--annotation replaces all of the annotations of the VM with the given ones.
The values true and false become booleans, and a JSON list or object keeps
its type. Other values, numbers too, stay text.
--interface <index>=<vlan> connects the interface with that index to a VLAN
alias or ID. --interface <index>= disconnects the interface.
--partition 0 turns off disk injection for the VM, so the startup app sends
its scripts through miniccc.
Examples¶
phenix vm set <experiment name> <vm name> --cpu 2 --mem 4096
phenix vm set <experiment name> <vm name> --host compute1
phenix vm set <experiment name> <vm name> --annotation phenix/default-apps=false
phenix vm set <experiment name> <vm name> --interface 0=EXP_1
phenix vm set <experiment name> <vm name> --interface 1=
phenix vm set <experiment name> --label role=server --label-changes tier=web --append-labels
Options¶
--annotation stringArray VM annotation in key=value form (may be repeated; replaces all of the annotations of the VM)
--append-labels Append the provided labels to the VM's existing labels instead of replacing the labels
-c, --cpu int Number of VM CPUs (1-16 is valid)
-d, --disk string VM backing disk image file
--do-not-boot Set the do-not-boot flag for the VM
-h, --help help for set
--host string Cluster host to run the VM on (an empty value lets the scheduler choose the host)
--interface string Connect an interface to a VLAN alias or ID as <index>=<vlan>, or disconnect it as <index>= (running experiments only)
-l, --label stringArray Label to filter VMs (supports glob patterns); use 'all' to select every VM
-L, --label-changes stringArray VM label(s) to add or edit in key=value form (may be repeated)
-m, --mem int Amount of memory in megabytes (a multiple of 512 from 512 to 131072)
-p, --partition int Partition of the first disk to inject files into (0 turns off disk injection)
--snapshot Set the snapshot (non-persistent) flag for the VM
SEE ALSO¶
- phenix vm - Virtual machine management
phenix vm shutdown¶
Shutdown a running or paused VM
Synopsis¶
Shuts down or powers off running or paused VM(s)
Used to shutdown or power off running or paused virtual machine(s) for a specific
experiment. The shutdown is not graceful and is equivalent to pulling the power cord
Options¶
--dry-run Show what the command would change, and change nothing
-h, --help help for shutdown
-l, --label stringArray Label to filter VMs (supports glob patterns); use 'all' to select every VM
SEE ALSO¶
- phenix vm - Virtual machine management
phenix vm snapshot¶
List, create, restore, and delete VM disk and memory snapshots
Synopsis¶
List, create, restore, and delete the snapshots of a VM
A snapshot holds the disk and the memory state of a VM in a running
experiment. Restore a snapshot to return the VM to that state. For an ELF
memory dump, use phenix vm memory-snapshot.
To create or restore a snapshot, the VM must have its snapshot flag set and
exactly one disk. phenix refuses a VM with more than one disk, because a
snapshot holds only the first disk (sandialabs/sceptre-phenix#145).
phenix keeps the snapshot files on the cluster node that runs the VM, in
<base-dir.phenix>/images/<experiment name>/files. The list shows the
snapshots on all nodes. A restore of a VM on a node other than the head
node can fail if minimega on that node runs with the -headnode flag:
minimega then gets the snapshot files from the head node, which does not
have them (sandialabs/sceptre-phenix#153).
Options¶
SEE ALSO¶
- phenix vm - Virtual machine management
- phenix vm snapshot create - Create a snapshot of a running VM
- phenix vm snapshot delete - Delete one of the snapshots of a VM
- phenix vm snapshot list - List the snapshots of a VM
- phenix vm snapshot restore - Restore a VM to one of its snapshots
phenix vm snapshot create¶
Create a snapshot of a running VM
Synopsis¶
Create a snapshot of a running VM
Saves the disk and the memory state of the VM as a snapshot. The snapshot
name must be a bare file name, with no folder. phenix removes an extension
from the name, and names the snapshot <vm name>__<snapshot name>. The
command prints that name.
minimega pauses the VM while it saves the snapshot, and then resumes the VM.
The command waits up to one hour for the save. The experiment and the VM
must run.
Examples¶
Options¶
SEE ALSO¶
- phenix vm snapshot - List, create, restore, and delete VM disk and memory snapshots
phenix vm snapshot delete¶
Delete one of the snapshots of a VM
Synopsis¶
Delete one of the snapshots of a VM
Deletes the memory state and the disk of the snapshot from the experiment's
files directory on every cluster node. Give the snapshot name as phenix vm
snapshot list prints it. The experiment does not have to run. phenix
refuses a snapshot whose disk a running VM uses, as it does after a
restore.
Examples¶
Options¶
SEE ALSO¶
- phenix vm snapshot - List, create, restore, and delete VM disk and memory snapshots
phenix vm snapshot list¶
List the snapshots of a VM
Synopsis¶
List the snapshots of a VM
Prints the name of each snapshot of the VM, one name on each line, in sort
order. Give one of these names to phenix vm snapshot restore. The
experiment does not have to run. -o json and -o yaml print the names as a
list.
Options¶
SEE ALSO¶
- phenix vm snapshot - List, create, restore, and delete VM disk and memory snapshots
phenix vm snapshot restore¶
Restore a VM to one of its snapshots
Synopsis¶
Restore a VM to one of its snapshots
Relaunches the VM from the disk and the memory state of the snapshot. The
VM keeps its UUID. The VM loses all changes made after the snapshot. Give
the snapshot name as phenix vm snapshot list prints it. The experiment must
run.
Examples¶
Options¶
SEE ALSO¶
- phenix vm snapshot - List, create, restore, and delete VM disk and memory snapshots
phenix vm unmount¶
Unmount a VM's filesystem from the headnode
Synopsis¶
Unmount a VM's filesystem from the headnode
Unmount a previously mounted virtual machine filesystem from the headnode.
Options¶
SEE ALSO¶
- phenix vm - Virtual machine management