.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Sys::Virt::DomainCheckpoint 3pm"
.TH Sys::Virt::DomainCheckpoint 3pm 2024-04-06 "perl v5.38.2" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
Sys::Virt::DomainCheckpoint \- Represent & manage a libvirt guest domain checkpoint
.SH DESCRIPTION
.IX Header "DESCRIPTION"
The \f(CW\*(C`Sys::Virt::DomainCheckpoint\*(C'\fR module represents a guest domain
checkpoint managed by the virtual machine monitor.
.SH METHODS
.IX Header "METHODS"
.ie n .IP "my $str = $domchkp\->\fBget_name()\fR" 4
.el .IP "my \f(CW$str\fR = \f(CW$domchkp\fR\->\fBget_name()\fR" 4
.IX Item "my $str = $domchkp->get_name()"
Return the name of the checkpoint
.ie n .IP "my $xml = $domchkp\->get_xml_description($flags)" 4
.el .IP "my \f(CW$xml\fR = \f(CW$domchkp\fR\->get_xml_description($flags)" 4
.IX Item "my $xml = $domchkp->get_xml_description($flags)"
Returns an XML document containing a complete description of
the domain checkpoints' configuration. The \f(CW$flags\fR parameter
accepts the following constants
.RS 4
.IP Sys::Virt::DomainCheckpoint::XML_SECURE 4
.IX Item "Sys::Virt::DomainCheckpoint::XML_SECURE"
Include security sensitive information in the XML dump, such as
passwords.
.IP Sys::Virt::DomainCheckpoint::XML_SIZE 4
.IX Item "Sys::Virt::DomainCheckpoint::XML_SIZE"
Include dynamic per\-<disk> size information
.IP Sys::Virt::DomainCheckpoint::XML_NO_DOMAIN 4
.IX Item "Sys::Virt::DomainCheckpoint::XML_NO_DOMAIN"
Suppress <domain> sub-element
.RE
.RS 4
.RE
.ie n .IP $domchkp\->delete($flags) 4
.el .IP \f(CW$domchkp\fR\->delete($flags) 4
.IX Item "$domchkp->delete($flags)"
Deletes this checkpoint object & its data. The optional \f(CW$flags\fR parameter controls
what should be deleted via the \f(CW\*(C`Sys::Virt::DomainCheckpoint::DELETE_*\*(C'\fR
constants.
.ie n .IP "$parentchkp = $domchkp\->\fBget_parent()\fR;" 4
.el .IP "\f(CW$parentchkp\fR = \f(CW$domchkp\fR\->\fBget_parent()\fR;" 4
.IX Item "$parentchkp = $domchkp->get_parent();"
Return the parent of the checkpoint, if any
.ie n .IP "my @checkpoints = $domchkp\->list_all_children($flags)" 4
.el .IP "my \f(CW@checkpoints\fR = \f(CW$domchkp\fR\->list_all_children($flags)" 4
.IX Item "my @checkpoints = $domchkp->list_all_children($flags)"
Return a list of all domain checkpoints that are children of this
checkpoint. The elements in the returned list are instances of the
Sys::Virt::DomainCheckpoint class. The \f(CW$flags\fR parameter can be
used to filter the list of return domain checkpoints.
.SH CONSTANTS
.IX Header "CONSTANTS"
.SS "CHECKPOINT CREATION"
.IX Subsection "CHECKPOINT CREATION"
The following constants are useful when creating checkpoints
.IP Sys::Virt::DomainCheckpoint::CREATE_REDEFINE 4
.IX Item "Sys::Virt::DomainCheckpoint::CREATE_REDEFINE"
Replace/set the metadata with the checkpoint
.IP Sys::Virt::DomainCheckpoint::CREATE_QUIESCE 4
.IX Item "Sys::Virt::DomainCheckpoint::CREATE_QUIESCE"
Quiesce the guest disks while taking the checkpoint
.IP Sys::Virt::DomainCheckpoint::CREATE_REDEFINE_VALIDATE 4
.IX Item "Sys::Virt::DomainCheckpoint::CREATE_REDEFINE_VALIDATE"
Validate disk data state
.SS "CHECKPOINT DELETION"
.IX Subsection "CHECKPOINT DELETION"
The following constants are useful when deleting checkpoints
.IP Sys::Virt::DomainCheckpoint::DELETE_CHILDREN 4
.IX Item "Sys::Virt::DomainCheckpoint::DELETE_CHILDREN"
Recursively delete any child checkpoints
.IP Sys::Virt::DomainCheckpoint::DELETE_CHILDREN_ONLY 4
.IX Item "Sys::Virt::DomainCheckpoint::DELETE_CHILDREN_ONLY"
Only delete the child checkpoints
.IP Sys::Virt::DomainCheckpoint::DELETE_METADATA_ONLY 4
.IX Item "Sys::Virt::DomainCheckpoint::DELETE_METADATA_ONLY"
Only delete the checkpoint metadata
.SS "CHECKPOINT LIST"
.IX Subsection "CHECKPOINT LIST"
The following constants are useful when listing checkpoints
.IP Sys::Virt::DomainCheckpoint::LIST_ROOTS 4
.IX Item "Sys::Virt::DomainCheckpoint::LIST_ROOTS"
Only list checkpoints which are root nodes in the tree
.IP Sys::Virt::DomainCheckpoint::LIST_DESCENDANTS 4
.IX Item "Sys::Virt::DomainCheckpoint::LIST_DESCENDANTS"
Only list checkpoints which are descendants of the current
checkpoint
.IP Sys::Virt::DomainCheckpoint::LIST_LEAVES 4
.IX Item "Sys::Virt::DomainCheckpoint::LIST_LEAVES"
Only list leaf nodes in the checkpoint tree
.IP Sys::Virt::DomainCheckpoint::LIST_NO_LEAVES 4
.IX Item "Sys::Virt::DomainCheckpoint::LIST_NO_LEAVES"
Only list non-leaf nodes in the checkpoint tree
.IP Sys::Virt::DomainCheckpoint::LIST_TOPOLOGICAL 4
.IX Item "Sys::Virt::DomainCheckpoint::LIST_TOPOLOGICAL"
Sort list in topological order w.r.t. to parent/child
relationships.
.SH AUTHORS
.IX Header "AUTHORS"
Daniel P. Berrange <berrange@redhat.com>
.SH COPYRIGHT
.IX Header "COPYRIGHT"
Copyright (C) 2006 Red Hat
Copyright (C) 2006\-2007 Daniel P. Berrange
.SH LICENSE
.IX Header "LICENSE"
This program is free software; you can redistribute it and/or modify
it under the terms of either the GNU General Public License as published
by the Free Software Foundation (either version 2 of the License, or at
your option any later version), or, the Artistic License, as specified
in the Perl README file.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Sys::Virt, Sys::Virt::Error, \f(CW\*(C`http://libvirt.org\*(C'\fR