Sys::Virt::DomainSnapshot(3pm)

1Sys::Virt::DomainSnapshUoste(r3pCmo)ntributed Perl DocumSeynst:a:tViiornt::DomainSnapshot(3pm)
2
3
4

NAME

6       Sys::Virt::DomainSnapshot - Represent & manage a libvirt guest domain
7

DESCRIPTION

9       The "Sys::Virt::DomainSnapshot" module represents a guest domain
10       managed by the virtual machine monitor.
11

METHODS

13       my $str = $domss->get_name()
14           Return the name of the snapshot
15
16       my $xml = $domss->get_xml_description($flags)
17           Returns an XML document containing a complete description of the
18           domain snapshot's configuration. The $flags parameter accepts the
19           following constants
20
21           Sys::Virt::DomainSnapshot::XML_SECURE
22               Include security sensitive information in the XML dump, such as
23               passwords.
24
25       $domss->delete($flags)
26           Deletes this snapshot object & its data. The optional $flags
27           parameter controls what should be deleted via the
28           "Sys::Virt::DomainSnapshot::DELETE_*" constants.
29
30       $domss->revert_to($flags)
31           Revert the domain to the state associated with this snapshot. The
32           optional $flags control the state of the VM after the revert via
33           the "Sys::Virt::DomainSnapshot::REVERT_*" constants.
34
35       $parentss = $domss->get_parent();
36           Return the parent of the snapshot, if any
37
38       $res = $domss->is_current()
39           Returns a true value if this is the current snapshot. False
40           otherwise.
41
42       $res = $domss->has_metadata()
43           Returns a true value if this snapshot has metadata associated with
44           it.
45
46       $count = $domss->num_of_child_snapshots()
47           Return the number of saved snapshots which are children of this
48           snapshot
49
50       @names = $domss->list_child_snapshot_names()
51           List the names of all saved snapshots which are children of this
52           snapshot . The names can be used with the "lookup_snapshot_by_name"
53
54       @snapshots = $domss->list_child_snapshots()
55           Return a list of all snapshots that are children of this snapshot.
56           The elements in the returned list are instances of the
57           Sys::Virt::DomainSnapshot class.  This method requires O(n) RPC
58           calls, so the "list_all_children" method is recommended as a more
59           efficient alternative.
60
61       my @snapshots = $domss->list_all_children($flags)
62           Return a list of all domain snapshots that are children of this
63           snapshot. The elements in the returned list are instances of the
64           Sys::Virt::DomainSnapshot class. The $flags parameter can be used
65           to filter the list of return domain snapshots.
66

CONSTANTS

68   SNAPSHOT CREATION
69       The following constants are useful when creating snapshots
70
71       Sys::Virt::DomainSnapshot::CREATE_CURRENT
72           Set the defined snapshot to be the current snapshot
73
74       Sys::Virt::DomainSnapshot::CREATE_DISK_ONLY
75           Only snapshot the disk, not the memory state
76
77       Sys::Virt::DomainSnapshot::CREATE_HALT
78           Stop the guest after creating the snapshot
79
80       Sys::Virt::DomainSnapshot::CREATE_NO_METADATA
81           Do not save any metadata for the snapshot
82
83       Sys::Virt::DomainSnapshot::CREATE_REDEFINE
84           Replace/set the metadata with the snapshot
85
86       Sys::Virt::DomainSnapshot::CREATE_QUIESCE
87           Quiesce the guest disks while taking the snapshot
88
89       Sys::Virt::DomainSnapshot::CREATE_REUSE_EXT
90           Reuse the existing snapshot data files (if any)
91
92       Sys::Virt::DomainSnapshot::CREATE_ATOMIC
93           Create multiple disk snapshots atomically
94
95       Sys::Virt::DomainSnapshot::CREATE_LIVE
96           Create snapshot while the guest is running
97
98       Sys::Virt::DomainSnapshot::CREATE_VALIDATE
99           Validate the XML document against the schema
100
101   SNAPSHOT DELETION
102       The following constants are useful when deleting snapshots
103
104       Sys::Virt::DomainSnapshot::DELETE_CHILDREN
105           Recursively delete any child snapshots
106
107       Sys::Virt::DomainSnapshot::DELETE_CHILDREN_ONLY
108           Only delete the child snapshots
109
110       Sys::Virt::DomainSnapshot::DELETE_METADATA_ONLY
111           Only delete the snapshot metadata
112
113   SNAPSHOT LIST
114       The following constants are useful when listing snapshots
115
116       Sys::Virt::DomainSnapshot::LIST_METADATA
117           Only list snapshots which have metadata
118
119       Sys::Virt::DomainSnapshot::LIST_ROOTS
120           Only list snapshots which are root nodes in the tree
121
122       Sys::Virt::DomainSnapshot::LIST_DESCENDANTS
123           Only list snapshots which are descendants of the current snapshot
124
125       Sys::Virt::DomainSnapshot::LIST_LEAVES
126           Only list leaf nodes in the snapshot tree
127
128       Sys::Virt::DomainSnapshot::LIST_NO_LEAVES
129           Only list non-leaf nodes in the snapshot tree
130
131       Sys::Virt::DomainSnapshot::LIST_NO_METADATA
132           Only list snapshots without metadata
133
134       Sys::Virt::DomainSnapshot::LIST_ACTIVE
135           Only list snapshots taken while the guest was running
136
137       Sys::Virt::DomainSnapshot::LIST_INACTIVE
138           Only list snapshots taken while the guest was inactive
139
140       Sys::Virt::DomainSnapshot::LIST_EXTERNAL
141           Only list snapshots stored in external disk images
142
143       Sys::Virt::DomainSnapshot::LIST_INTERNAL
144           Only list snapshots stored in internal disk images
145
146       Sys::Virt::DomainSnapshot::LIST_DISK_ONLY
147           Only list snapshots taken while the guest was running, which did
148           not include memory state.
149
150       Sys::Virt::DomainSnapshot::LIST_TOPOLOGICAL
151           Sort list in topological order wrt to parent/child relationships.
152
153   SNAPSHOT REVERT
154       The following constants are useful when reverting snapshots
155
156       Sys::Virt::DomainSnapshot::REVERT_PAUSED
157           Leave the guest CPUs paused after reverting to the snapshot state
158
159       Sys::Virt::DomainSnapshot::REVERT_RUNNING
160           Start the guest CPUs after reverting to the snapshot state
161
162       Sys::Virt::DomainSnapshot::REVERT_FORCE
163           Force the snapshot to revert, even if it is risky to do so
164
165       Sys::Virt::DomainSnapshot::REVERT_RESET_NVRAM
166           Reset the firmware NVRAM state from its original template
167

AUTHORS

169       Daniel P. Berrange <berrange@redhat.com>
170

COPYRIGHT

172       Copyright (C) 2006 Red Hat Copyright (C) 2006-2007 Daniel P. Berrange
173

LICENSE

175       This program is free software; you can redistribute it and/or modify it
176       under the terms of either the GNU General Public License as published
177       by the Free Software Foundation (either version 2 of the License, or at
178       your option any later version), or, the Artistic License, as specified
179       in the Perl README file.
180