From 6449cb9014ae1ba9f87f64e535f7333c2f7e3e98 Mon Sep 17 00:00:00 2001 From: Chris Lalancette Date: Mon, 5 Apr 2010 11:17:42 -0400 Subject: [PATCH] Document snapshot virsh commands in the man page. Signed-off-by: Chris Lalancette --- tools/virsh.pod | 49 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 49 insertions(+) diff --git a/tools/virsh.pod b/tools/virsh.pod index 62395d7f12..0e14de99db 100644 --- a/tools/virsh.pod +++ b/tools/virsh.pod @@ -639,6 +639,55 @@ Output a list of UUIDs of known secrets to stdout. =back +=head1 SNAPSHOT COMMMANDS + +The following commands manipulate domain snapshots. Snapshots take the +disk, memory, and device state of a domain at a point-of-time, and save it +for future use. They have many uses, from saving a "clean" copy of an OS +image to saving a domain's state before a potentially destructive operation. +Snapshots are identified with a unique name. See +L for documentation of the XML format +used to represent properties of snapshots. + +=over 4 + +=item B I I + +Create a snapshot for domain I with the properties specified in +I. The only properties settable for a domain snapshot are the + and ; the rest of the fields are ignored, and +automatically filled in by libvirt. If I is completely omitted, +then libvirt will choose a value for all fields. + +=item B I + +Output the snapshot XML for the domain's current snapshot (if any). + +=item B I + +List all of the available snapshots for the given domain. + +=item B I I + +Output the snapshot XML for the domain's snapshot named I. + +=item B I I + +Revert the given domain to the snapshot specified by I. Be aware +that this is a destructive action; any changes in the domain since the +snapshot was taken will be lost. Also note that the state of the domain after +revert-to-snapshot is complete will be the state of the domain at the time +the original snapshot was taken. + +=item B I I I<--children> + +Delete the snapshot for the domain named I. If this snapshot +has child snapshots, changes from this snapshot will be merged into the +children. If I<--children> is passed, then delete this snapshot and any +children of this snapshot. + +=back + =head1 ENVIRONMENT The following environment variables can be set to alter the behaviour