Scroll to navigation

Sys::Virt::DomainCheckpoint(3pm) User Contributed Perl Documentation Sys::Virt::DomainCheckpoint(3pm)


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


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


Return the name of the checkpoint
Returns an XML document containing a complete description of the domain checkpoints' configuration. The $flags parameter accepts the following constants
Include security sensitive information in the XML dump, such as passwords.
Include dynamic per-<disk> size information
Suppress <domain> sub-element
Deletes this checkpoint object & its data. The optional $flags parameter controls what should be deleted via the "Sys::Virt::DomainCheckpoint::DELETE_*" constants.
$parentchkp = $domchkp->get_parent();
Return the parent of the checkpoint, if any
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 $flags parameter can be used to filter the list of return domain checkpoints.



The following constants are useful when creating checkpoints

Replace/set the metadata with the checkpoint
Quiesce the guest disks while taking the checkpoint
Validate disk data state


The following constants are useful when deleting checkpoints

Recursively delete any child checkpoints
Only delete the child checkpoints
Only delete the checkpoint metadata


The following constants are useful when listing checkpoints

Only list checkpoints which are root nodes in the tree
Only list checkpoints which are descendants of the current checkpoint
Only list leaf nodes in the checkpoint tree
Only list non-leaf nodes in the checkpoint tree
Sort list in topological order w.r.t. to parent/child relationships.


Daniel P. Berrange <>


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


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.


Sys::Virt, Sys::Virt::Error, ""

2022-11-20 perl v5.36.0