Sys::Virt::DomainSnapshot(3pm)

1Sys::Virt::DomainSnapshUoste(r3)Contributed Perl DocumenStyast:i:oVnirt::DomainSnapshot(3)
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's configuration. The $flags parameter accepts the following
19           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   SNAPSHOT DELETION
99       The following constants are useful when deleting snapshots
100
101       Sys::Virt::DomainSnapshot::DELETE_CHILDREN
102           Recursively delete any child snapshots
103
104       Sys::Virt::DomainSnapshot::DELETE_CHILDREN_ONLY
105           Only delete the child snapshots
106
107       Sys::Virt::DomainSnapshot::DELETE_METADATA_ONLY
108           Only delete the snapshot metadata
109
110   SNAPSHOT LIST
111       The following constants are useful when listing snapshots
112
113       Sys::Virt::DomainSnapshot::LIST_METADATA
114           Only list snapshots which have metadata
115
116       Sys::Virt::DomainSnapshot::LIST_ROOTS
117           Only list snapshots which are root nodes in the tree
118
119       Sys::Virt::DomainSnapshot::LIST_DESCENDANTS
120           Only list snapshots which are descendants of the current snapshot
121
122       Sys::Virt::DomainSnapshot::LIST_LEAVES
123           Only list leaf nodes in the snapshot tree
124
125       Sys::Virt::DomainSnapshot::LIST_NO_LEAVES
126           Only list non-leaf nodes in the snapshot tree
127
128       Sys::Virt::DomainSnapshot::LIST_NO_METADATA
129           Only list snapshots without metadata
130
131       Sys::Virt::DomainSnapshot::LIST_ACTIVE
132           Only list snapshots taken while the guest was running
133
134       Sys::Virt::DomainSnapshot::LIST_INACTIVE
135           Only list snapshots taken while the guest was inactive
136
137       Sys::Virt::DomainSnapshot::LIST_EXTERNAL
138           Only list snapshots stored in external disk images
139
140       Sys::Virt::DomainSnapshot::LIST_INTERNAL
141           Only list snapshots stored in internal disk images
142
143       Sys::Virt::DomainSnapshot::LIST_DISK_ONLY
144           Only list snapshots taken while the guest was running, which did
145           not include memory state.
146
147   SNAPSHOT REVERT
148       The following constants are useful when reverting snapshots
149
150       Sys::Virt::DomainSnapshot::REVERT_PAUSED
151           Leave the guest CPUs paused after reverting to the snapshot state
152
153       Sys::Virt::DomainSnapshot::REVERT_RUNNING
154           Start the guest CPUs after reverting to the snapshot state
155
156       Sys::Virt::DomainSnapshot::REVERT_FORCE
157           Force the snapshot to revert, even if it is risky to do so
158

AUTHORS

160       Daniel P. Berrange <berrange@redhat.com>
161

COPYRIGHT

163       Copyright (C) 2006 Red Hat Copyright (C) 2006-2007 Daniel P. Berrange
164

LICENSE

166       This program is free software; you can redistribute it and/or modify it
167       under the terms of either the GNU General Public License as published
168       by the Free Software Foundation (either version 2 of the License, or at
169       your option any later version), or, the Artistic License, as specified
170       in the Perl README file.
171