xen-devel.lists.xenproject.org archive mirror
 help / color / mirror / Atom feed
From: Bamvor Jian Zhang <bjzhang@suse.com>
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
Subject: [RFC V5 3/5] docs: manpage for xl snapshot command
Date: Mon,  7 Jul 2014 15:46:02 +0800	[thread overview]
Message-ID: <1404719164-4983-4-git-send-email-bjzhang@suse.com> (raw)
In-Reply-To: <1404719164-4983-1-git-send-email-bjzhang@suse.com>

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<snapshot-create> [I<configfile>] [I<OPTIONS>] I<domain-id>

create domain/disk snapshot.

The create subcommand takes a config file as first argument: see
L<xl.snapshot.cfg(5)> for full details of that file format and possible options.
If I<configfile> is missing, B<XL> creates the snapshot of domain from options.
I<configfile> has to be an absolute path to a file.
It is allowed to use both I<configfile> and I<OPTIONS>. Any conflict will be
reportted and the program will exit. However, it is highly recommended that use
I<configfile> or I<OPTIONS> 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<OPTIONS>

=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<configfile>.

=back

=item B<snapshot-delete> [I<OPTIONS>] I<domain-id>

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<OPTIONS>

=over 4

=item B<-n>

snapshot name.

=back

=item B<snapshot-list> [I<OPTIONS>] I<domain-id>

Prints information for one or all snapshots for <domain-id>. If no snapshots
are specified it prints out information about all snapshots for specific domain

B<OPTIONS>

=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<snapshot-revert> [I<OPTIONS>] I<domain-id>

revert domain snapshot according to domain snapshot configuration file.

B<OPTIONS>

=over 4

=item B<-n>

snapshot name.

=back

=back

  parent reply	other threads:[~2014-07-07  7:46 UTC|newest]

Thread overview: 14+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2014-07-07  7:45 [RFC V5 0/5] domain snapshot document and discussion Bamvor Jian Zhang
2014-07-07  7:46 ` [RFC V5 1/5] docs: libxl Domain Snapshot HOWTO Bamvor Jian Zhang
2014-07-07  7:46 ` [RFC V5 2/5] Libxl Domain Snapshot API Design Bamvor Jian Zhang
2014-07-11 12:47   ` Ian Campbell
2014-07-11 13:19     ` Ian Jackson
2014-07-11 15:43       ` Bamvor Jian Zhang
2014-07-14 14:42     ` Bamvor Jian Zhang
2014-07-14 15:18       ` Ian Campbell
2014-07-16  9:27         ` Bamvor Jian Zhang
2014-07-16  9:50           ` Ian Campbell
2014-07-17  8:02             ` Bamvor Jian Zhang
2014-07-07  7:46 ` Bamvor Jian Zhang [this message]
2014-07-07  7:46 ` [RFC V5 4/5] xl snapshot-xxx implementation details Bamvor Jian Zhang
2014-07-07  7:46 ` [RFC V5 5/5] docs: man page for xl.snapshot.cfg Bamvor Jian Zhang

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=1404719164-4983-4-git-send-email-bjzhang@suse.com \
    --to=bjzhang@suse.com \
    --cc=anthony.perard@citrix.com \
    --cc=cyliu@suse.com \
    --cc=davidkiarie4@gmail.com \
    --cc=hahn@univention.de \
    --cc=ian.campbell@citrix.com \
    --cc=ian.jackson@eu.citrix.com \
    --cc=jfehlig@suse.com \
    --cc=xen-devel@lists.xen.org \
    --cc=zzhou@suse.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).