From mboxrd@z Thu Jan 1 00:00:00 1970 From: Bamvor Jian Zhang Subject: [RFC V5 3/5] docs: manpage for xl snapshot command Date: Mon, 7 Jul 2014 15:46:02 +0800 Message-ID: <1404719164-4983-4-git-send-email-bjzhang@suse.com> References: <1404719164-4983-1-git-send-email-bjzhang@suse.com> Mime-Version: 1.0 Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: 7bit Return-path: In-Reply-To: <1404719164-4983-1-git-send-email-bjzhang@suse.com> List-Unsubscribe: , List-Post: List-Help: List-Subscribe: , Sender: xen-devel-bounces@lists.xen.org Errors-To: xen-devel-bounces@lists.xen.org To: xen-devel@lists.xen.org Cc: zzhou@suse.com, ian.campbell@citrix.com, hahn@univention.de, ian.jackson@eu.citrix.com, cyliu@suse.com, jfehlig@suse.com, bjzhang@suse.com, anthony.perard@citrix.com, davidkiarie4@gmail.com List-Id: xen-devel@lists.xenproject.org This file will be a patch for docs/misc/xl.pod.1 =head1 SNAPSHOT There are two types of snapshots supported by libxl: disk snapshot and domain snapshot and four types of operations: create, delete, list and revert. Disk snapshot will only be crash-consistent if the domain is running. Disk snapshots can also be internal (qcow2) or external (snapshot in one file, delta in another). Domain snapshots include disk snapshots and domain state, allowing to resume the domain from the same state when the snapshot was created. This type of snapshot is also referred to as a domain checkpoint or system checkpoint. =over 4 =item B [I] [I] I create domain/disk snapshot. The create subcommand takes a config file as first argument: see L for full details of that file format and possible options. If I is missing, B creates the snapshot of domain from options. I has to be an absolute path to a file. It is allowed to use both I and I. Any conflict will be reportted and the program will exit. However, it is highly recommended that use I or I alone. This command allows dryrun mode. It will print domain snapshot configuration in libxl-json format after parsing options and the config file and checking the flags conflict. B =over 4 =item B<-n> domain/disk snapshot name. if ignored, it will be the epoch second from 1, Jan 1970. =item B<-D>, B<--disk-only> create the internal disk snapshot for all disk(s) except the read-only disk (e.g. cdrom). For external disk snapshot, user should give the proper options (such as the external file and format) in I. =back =item B [I] I delete domain/disk snapshot according to the snapshot configuration file, which may include the memory check point file, the disk snapshot state/file and the configuration file. B =over 4 =item B<-n> snapshot name. =back =item B [I] I Prints information for one or all snapshots for . If no snapshots are specified it prints out information about all snapshots for specific domain B =over 4 =item B<-n> snapshot name. =item B<-l>, B<--long> list the details for specific snapshot or all snapshots of specific domain. =back =item B [I] I revert domain snapshot according to domain snapshot configuration file. B =over 4 =item B<-n> snapshot name. =back =back