From 86fe2ba6dcd31469d6600b24762568a0ba76cd40 Mon Sep 17 00:00:00 2001 From: Chris Lalancette Date: Mon, 5 Apr 2010 13:27:41 -0400 Subject: [PATCH] Website documentation for the snapshot XML. Signed-off-by: Chris Lalancette --- docs/formatsnapshot.html.in | 72 +++++++++++++++++++++++++++++++++++++ docs/sitemap.html.in | 4 +++ 2 files changed, 76 insertions(+) create mode 100644 docs/formatsnapshot.html.in diff --git a/docs/formatsnapshot.html.in b/docs/formatsnapshot.html.in new file mode 100644 index 0000000000..79ed1d234a --- /dev/null +++ b/docs/formatsnapshot.html.in @@ -0,0 +1,72 @@ + + +

Snapshot XML format

+ + + +

Snapshot XML

+ +

+ Attributes of libvirt snapshots are stored as child elements of + the domainsnapshot element. At snapshot creation + time, only the name and description + elements are settable; the rest of the fields are informational + (and readonly) and will be filled in by libvirt when the + snapshot is created. +

+

+ The top-level domainsnapshot element may contain + the following elements: +

+
+
name
+
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. +
+
description
+
A human-readable description of the snapshot. If the + description is omitted when initially creating the snapshot, + then this field will be empty. +
+
creationTime
+
The time this snapshot was created. The time is specified + in seconds since the Epoch, UTC (i.e. Unix time). Readonly. +
+
state
+
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. +
+
parent
+
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. +
+
domain
+
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. +
+
+ +

Example

+ + 
+      <domainsnapshot>
+         <name>os-updates</name>
+         <description>Snapshot of OS install and updates</description>
+         <state>running</state>
+         <creationTime>1270477159</creationTime>
+         <parent>
+            <name>bare-os-install</name>
+         </parent>
+         <domain>
+            <uuid>93a5c045-6457-2c09-e56c-927cdf34e178</uuid>
+         </domain>
+      </domainsnapshot>
+ + diff --git a/docs/sitemap.html.in b/docs/sitemap.html.in index 76d8faa7c8..0c3f0c3e07 100644 --- a/docs/sitemap.html.in +++ b/docs/sitemap.html.in @@ -114,6 +114,10 @@ Secrets The secret XML format +
  • + Snapshots + The snapshot XML format +