Sys::Virt::DomainCheckpoint3pm
Represent & manage a libvirt guest domain checkpoint
Overview
The "Sys::Virt::DomainCheckpoint" module represents a guest domain checkpoint managed by the virtual machine monitor.
Methods
- my $str = $domchkp->
get_name() -
Return the name of the checkpoint
- my $xml = $domchkp->get_xml_description($flags)
-
Returns an XML document containing a complete description of the domain checkpoints' configuration. The
$flagsparameter accepts the following constants- Sys::Virt::DomainCheckpoint::XML_SECURE
-
Include security sensitive information in the XML dump, such as passwords.
- Sys::Virt::DomainCheckpoint::XML_SIZE
-
Include dynamic per-<disk> size information
- Sys::Virt::DomainCheckpoint::XML_NO_DOMAIN
-
Suppress <domain> sub-element
- $domchkp->delete($flags)
-
Deletes this checkpoint object & its data. The optional
$flagsparameter controls what should be deleted via the"Sys::Virt::DomainCheckpoint::DELETE_*"constants.
- $parentchkp = $domchkp->
get_parent(); -
Return the parent of the checkpoint, if any
- 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
$flagsparameter can be used to filter the list of return domain checkpoints.
Constants
Checkpoint creation
The following constants are useful when creating checkpoints
Sys::Virt::DomainCheckpoint::CREATE_REDEFINE
|
Replace/set the metadata with the checkpoint |
|---|---|
Sys::Virt::DomainCheckpoint::CREATE_QUIESCE
|
Quiesce the guest disks while taking the checkpoint |
Sys::Virt::DomainCheckpoint::CREATE_REDEFINE_VALIDATE
|
Validate disk data state |
Checkpoint deletion
The following constants are useful when deleting checkpoints
Sys::Virt::DomainCheckpoint::DELETE_CHILDREN
|
Recursively delete any child checkpoints |
|---|---|
Sys::Virt::DomainCheckpoint::DELETE_CHILDREN_ONLY
|
Only delete the child checkpoints |
Sys::Virt::DomainCheckpoint::DELETE_METADATA_ONLY
|
Only delete the checkpoint metadata |
Checkpoint list
The following constants are useful when listing checkpoints
Sys::Virt::DomainCheckpoint::LIST_ROOTS
|
Only list checkpoints which are root nodes in the tree |
|---|---|
Sys::Virt::DomainCheckpoint::LIST_DESCENDANTS
|
Only list checkpoints which are descendants of the current checkpoint |
Sys::Virt::DomainCheckpoint::LIST_LEAVES
|
Only list leaf nodes in the checkpoint tree |
Sys::Virt::DomainCheckpoint::LIST_NO_LEAVES
|
Only list non-leaf nodes in the checkpoint tree |
Sys::Virt::DomainCheckpoint::LIST_TOPOLOGICAL
|
Sort list in topological order w.r.t. to parent/child relationships. |
Releases
4 releases since Debian 11 (Bullseye); the text changed 3 times.