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.
19
20       $domss->delete($flags)
21           Deletes this snapshot object & its data. The optional $flags
22           parameter controls what should be deleted via the
23           "Sys::Virt::DomainSnapshot::DELETE_*" constants.
24
25       $domss->revert_to($flags)
26           Revert the domain to the state associated with this snapshot. The
27           optional $flags control the state of the vm after the revert via
28           the "Sys::Virt::DomainSnapshot::REVERT_*" constants.
29
30       $parentss = $domss->get_parent();
31           Return the parent of the snapshot, if any
32
33       $res = $domss->is_current()
34           Returns a true value if this is the current snapshot. False
35           otherwise.
36
37       $res = $domss->has_metadata()
38           Returns a true value if this snapshot has metadata associated with
39           it.
40
41       $count = $domss->num_of_child_snapshots()
42           Return the number of saved snapshots which are children of this
43           snapshot
44
45       @names = $domss->list_child_snapshot_names()
46           List the names of all saved snapshots which are children of this
47           snapshot . The names can be used with the "lookup_snapshot_by_name"
48
49       @snapshots = $domss->list_child_snapshots()
50           Return a list of all snapshots that are children of this snapshot.
51           The elements in the returned list are instances of the
52           Sys::Virt::DomainSnapshot class.  This method requires O(n) RPC
53           calls, so the "list_all_children" method is recommended as a more
54           efficient alternative.
55
56       my @snapshots = $domss->list_all_children($flags)
57           Return a list of all domain snapshots that are children of this
58           snapshot. The elements in the returned list are instances of the
59           Sys::Virt::DomainSnapshot class. The $flags parameter can be used
60           to filter the list of return domain snapshots.
61

CONSTANTS

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

AUTHORS

155       Daniel P. Berrange <berrange@redhat.com>
156

COPYRIGHT

158       Copyright (C) 2006 Red Hat Copyright (C) 2006-2007 Daniel P. Berrange
159

LICENSE

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