Codebase list libvirt / debian/0.8.3-2 docs / formatsnapshot.html.in
debian/0.8.3-2

Tree @debian/0.8.3-2 (Download .tar.gz)

formatsnapshot.html.in @debian/0.8.3-2 — raw · history · blame 

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
<html>
  <body>
    <h1>Snapshot XML format</h1>

    <ul id="toc"></ul>

    <h2><a name="SnapshotAttributes">Snapshot XML</a></h2>

    <p>
      Attributes of libvirt snapshots are stored as child elements of
      the <code>domainsnapshot</code> element.  At snapshot creation
      time, only the <code>name</code> and <code>description</code>
      elements are settable; the rest of the fields are informational
      (and readonly) and will be filled in by libvirt when the
      snapshot is created.
    </p>
    <p>
      The top-level <code>domainsnapshot</code> element may contain
      the following elements:
    </p>
    <dl>
      <dt><code>name</code></dt>
      <dd>The name for this snapshot.  If the name is specified when
      initially creating the snapshot, then the snapshot will have
      that particular name.  If the name is omitted when initially
      creating the snapshot, then libvirt will make up a name for the snapshot.
      </dd>
      <dt><code>description</code></dt>
      <dd>A human-readable description of the snapshot.  If the
        description is omitted when initially creating the snapshot,
        then this field will be empty.
      </dd>
      <dt><code>creationTime</code></dt>
      <dd>The time this snapshot was created.  The time is specified
      in seconds since the Epoch, UTC (i.e. Unix time).  Readonly.
      </dd>
      <dt><code>state</code></dt>
      <dd>The state of the domain at the time this snapshot was
      taken.  When the domain is reverted to this snapshot, the domain's state
      will be set to whatever is in this field.  Readonly.
      </dd>
      <dt><code>parent</code></dt>
      <dd>The parent of this snapshot.  This element contains exactly
      one child element, name.  This specifies the name of the parent
      snapshot of this snapshot, and is used to represent trees of
      snapshots.  Readonly.
      </dd>
      <dt><code>domain</code></dt>
      <dd>The domain that this snapshot was taken against.  This
      element contains exactly one child element, uuid.  This
      specifies the uuid of the domain that this snapshot was taken
      against.  Readonly.
      </dd>
    </dl>

    <h2><a name="example">Example</a></h2>

    <pre>
      &lt;domainsnapshot&gt;
         &lt;name&gt;os-updates&lt;/name&gt;
         &lt;description&gt;Snapshot of OS install and updates&lt;/description&gt;
         &lt;state&gt;running&lt;/state&gt;
         &lt;creationTime&gt;1270477159&lt;/creationTime&gt;
         &lt;parent&gt;
            &lt;name&gt;bare-os-install&lt;/name&gt;
         &lt;/parent&gt;
         &lt;domain&gt;
            &lt;uuid&gt;93a5c045-6457-2c09-e56c-927cdf34e178&lt;/uuid&gt;
         &lt;/domain&gt;
      &lt;/domainsnapshot&gt;</pre>
  </body>
</html>