Sys::Virt::DomainCheckpoint(3pm)

1Sys::Virt::DomainCheckpUosienrt(C3o)ntributed Perl DocumSeynst:a:tViiornt::DomainCheckpoint(3)
2
3
4

NAME

6       Sys::Virt::DomainCheckpoint - Represent & manage a libvirt guest domain
7       checkpoint
8

DESCRIPTION

10       The "Sys::Virt::DomainCheckpoint" module represents a guest domain
11       checkpoint managed by the virtual machine monitor.
12

METHODS

14       my $str = $domss->get_name()
15           Return the name of the checkpoint
16
17       my $xml = $domss->get_xml_description($flags)
18           Returns an XML document containing a complete description of the
19           domain's configuration. The $flags parameter accepts the following
20           constants
21
22           Sys::Virt::DomainCheckpoint::XML_SECURE
23               Include security sensitive information in the XML dump, such as
24               passwords.
25
26           Sys::Virt::DomainCheckpoint::XML_SIZE
27               Inlude dynamic per-<disk> size information
28
29           Sys::Virt::DomainCheckpoint::XML_NO_DOMAIN
30               Supress <domain> sub-element
31
32       $domss->delete($flags)
33           Deletes this checkpoint object & its data. The optional $flags
34           parameter controls what should be deleted via the
35           "Sys::Virt::DomainCheckpoint::DELETE_*" constants.
36
37       $parentss = $domss->get_parent();
38           Return the parent of the checkpoint, if any
39
40       $res = $domss->has_metadata()
41           Returns a true value if this checkpoint has metadata associated
42           with it.
43
44       my @checkpoints = $domss->list_all_children($flags)
45           Return a list of all domain checkpoints that are children of this
46           checkpoint. The elements in the returned list are instances of the
47           Sys::Virt::DomainCheckpoint class. The $flags parameter can be used
48           to filter the list of return domain checkpoints.
49

CONSTANTS

51   CHECKPOINT CREATION
52       The following constants are useful when creating checkpoints
53
54       Sys::Virt::DomainCheckpoint::CREATE_REDEFINE
55           Replace/set the metadata with the checkpoint
56
57       Sys::Virt::DomainCheckpoint::CREATE_QUIESCE
58           Quiesce the guest disks while taking the checkpoint
59
60   CHECKPOINT DELETION
61       The following constants are useful when deleting checkpoints
62
63       Sys::Virt::DomainCheckpoint::DELETE_CHILDREN
64           Recursively delete any child checkpoints
65
66       Sys::Virt::DomainCheckpoint::DELETE_CHILDREN_ONLY
67           Only delete the child checkpoints
68
69       Sys::Virt::DomainCheckpoint::DELETE_METADATA_ONLY
70           Only delete the checkpoint metadata
71
72   CHECKPOINT LIST
73       The following constants are useful when listing checkpoints
74
75       Sys::Virt::DomainCheckpoint::LIST_ROOTS
76           Only list checkpoints which are root nodes in the tree
77
78       Sys::Virt::DomainCheckpoint::LIST_DESCENDANTS
79           Only list checkpoints which are descendants of the current
80           checkpoint
81
82       Sys::Virt::DomainCheckpoint::LIST_LEAVES
83           Only list leaf nodes in the checkpoint tree
84
85       Sys::Virt::DomainCheckpoint::LIST_NO_LEAVES
86           Only list non-leaf nodes in the checkpoint tree
87
88       Sys::Virt::DomainCheckpoint::LIST_TOPOLOGICAL
89           Sort list in topological order wrt to parent/child relationships.
90

AUTHORS

92       Daniel P. Berrange <berrange@redhat.com>
93

COPYRIGHT

95       Copyright (C) 2006 Red Hat Copyright (C) 2006-2007 Daniel P. Berrange
96

LICENSE

98       This program is free software; you can redistribute it and/or modify it
99       under the terms of either the GNU General Public License as published
100       by the Free Software Foundation (either version 2 of the License, or at
101       your option any later version), or, the Artistic License, as specified
102       in the Perl README file.
103