Sys::Virt::DomainCheckpoint(3pm)

1Sys::Virt::DomainCheckpUosienrt(C3opnmt)ributed Perl DocSuymse:n:tVaitrito:n:DomainCheckpoint(3pm)
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 = $domchkp->get_name()
15           Return the name of the checkpoint
16
17       my $xml = $domchkp->get_xml_description($flags)
18           Returns an XML document containing a complete description of the
19           domain checkpoints' configuration. The $flags parameter accepts the
20           following 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               Include dynamic per-<disk> size information
28
29           Sys::Virt::DomainCheckpoint::XML_NO_DOMAIN
30               Suppress <domain> sub-element
31
32       $domchkp->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       $parentchkp = $domchkp->get_parent();
38           Return the parent of the checkpoint, if any
39
40       my @checkpoints = $domchkp->list_all_children($flags)
41           Return a list of all domain checkpoints that are children of this
42           checkpoint. The elements in the returned list are instances of the
43           Sys::Virt::DomainCheckpoint class. The $flags parameter can be used
44           to filter the list of return domain checkpoints.
45

CONSTANTS

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