Sys::V...napshot(3pm)

📦
version 12.4.0 · 12 versions
, in epel 10

🦋 NAME 🦋

Sys::Virt::DomainSnapshot — bestie, this is the module that lets you represent and manage a snapshot of a libvirt guest domain 💅✨

(this page lives in the Perl User Contributed Documentation, and honestly? it ate)

🌸 DESCRIPTION 🌸

So the Sys::Virt::DomainSnapshot module represents a guest domain managed by the virtual machine monitor. That's the whole vibe — a snapshot object you can poke at with methods. Periodt 🫶

✨ METHODS ✨

  • my $str = $domss->get_name() — gives you back the name of the snapshot. iconic, short, useful 🎀
  • my $xml = $domss->get_xml_description($flags) — hands you back an XML document containing a complete description of the domain snapshot's configuration. The $flags parameter accepts the following constants:
    • Sys::Virt::DomainSnapshot::XML_SECURE — include security sensitive information in the XML dump, such as passwords 👀 (yes, like, actually passwords, be careful bestie)
  • $domss->delete($flags) — deletes this snapshot object & its data. The optional $flags parameter controls what should be deleted via the Sys::Virt::DomainSnapshot::DELETE_* constants 🗑️
  • $domss->revert_to($flags) — reverts the domain to the state associated with this snapshot. The optional $flags control the state of the VM after the revert via the Sys::Virt::DomainSnapshot::REVERT_* constants ⏪
  • $parentss = $domss->get_parent(); — returns the parent of the snapshot, if any. family tree moment 🧚
  • $res = $domss->is_current() — true value if this is the current snapshot, false otherwise. main character check 👑
  • $res = $domss->has_metadata() — true value if this snapshot has metadata associated with it 📝
  • $count = $domss->num_of_child_snapshots() — returns the number of saved snapshots which are children of this snapshot 🍓
  • @names = $domss->list_child_snapshot_names() — lists the names of all saved snapshots which are children of this snapshot. The names can be used with the lookup_snapshot_by_name 💖
  • @snapshots = $domss->list_child_snapshots() — returns a list of all snapshots that are children of this snapshot. The elements in the returned list are instances of the Sys::Virt::DomainSnapshot class. Heads up though: this method requires O(n) RPC calls, so the list_all_children method is recommended as a more efficient alternative 😭 (ngl, that's the one you want)
  • my @snapshots = $domss->list_all_children($flags) — returns a list of all domain snapshots that are children of this snapshot. The elements in the returned list are instances of the Sys::Virt::DomainSnapshot class. The $flags parameter can be used to filter the list of returned domain snapshots 🔥

💜 CONSTANTS 💜

💫 SNAPSHOT CREATION 💫

The following constants are useful when creating snapshots:

  • Sys::Virt::DomainSnapshot::CREATE_CURRENT — set the defined snapshot to be the current snapshot
  • Sys::Virt::DomainSnapshot::CREATE_DISK_ONLY — only snapshot the disk, not the memory state
  • Sys::Virt::DomainSnapshot::CREATE_HALT — stop the guest after creating the snapshot
  • Sys::Virt::DomainSnapshot::CREATE_NO_METADATA — do not save any metadata for the snapshot
  • Sys::Virt::DomainSnapshot::CREATE_REDEFINE — replace/set the metadata with the snapshot
  • Sys::Virt::DomainSnapshot::CREATE_QUIESCE — quiesce the guest disks while taking the snapshot
  • Sys::Virt::DomainSnapshot::CREATE_REUSE_EXT — reuse the existing snapshot data files (if any)
  • Sys::Virt::DomainSnapshot::CREATE_ATOMIC — create multiple disk snapshots atomically
  • Sys::Virt::DomainSnapshot::CREATE_LIVE — create snapshot while the guest is running
  • Sys::Virt::DomainSnapshot::CREATE_VALIDATE — validate the XML document against the schema

🗑️ SNAPSHOT DELETION 🗑️

The following constants are useful when deleting snapshots:

  • Sys::Virt::DomainSnapshot::DELETE_CHILDREN — recursively delete any child snapshots
  • Sys::Virt::DomainSnapshot::DELETE_CHILDREN_ONLY — only delete the child snapshots
  • Sys::Virt::DomainSnapshot::DELETE_METADATA_ONLY — only delete the snapshot metadata

📋 SNAPSHOT LIST 📋

The following constants are useful when listing snapshots:

  • Sys::Virt::DomainSnapshot::LIST_METADATA — only list snapshots which have metadata
  • Sys::Virt::DomainSnapshot::LIST_ROOTS — only list snapshots which are root nodes in the tree
  • Sys::Virt::DomainSnapshot::LIST_DESCENDANTS — only list snapshots which are descendants of the current snapshot
  • Sys::Virt::DomainSnapshot::LIST_LEAVES — only list leaf nodes in the snapshot tree
  • Sys::Virt::DomainSnapshot::LIST_NO_LEAVES — only list non-leaf nodes in the snapshot tree
  • Sys::Virt::DomainSnapshot::LIST_NO_METADATA — only list snapshots without metadata
  • Sys::Virt::DomainSnapshot::LIST_ACTIVE — only list snapshots taken while the guest was running
  • Sys::Virt::DomainSnapshot::LIST_INACTIVE — only list snapshots taken while the guest was inactive
  • Sys::Virt::DomainSnapshot::LIST_EXTERNAL — only list snapshots stored in external disk images
  • Sys::Virt::DomainSnapshot::LIST_INTERNAL — only list snapshots stored in internal disk images
  • Sys::Virt::DomainSnapshot::LIST_DISK_ONLY — only list snapshots taken while the guest was running, which did not include memory state.
  • Sys::Virt::DomainSnapshot::LIST_TOPOLOGICAL — sort list in topological order wrt to parent/child relationships.

⏪ SNAPSHOT REVERT ⏪

The following constants are useful when reverting snapshots:

  • Sys::Virt::DomainSnapshot::REVERT_PAUSED — leave the guest CPUs paused after reverting to the snapshot state
  • Sys::Virt::DomainSnapshot::REVERT_RUNNING — start the guest CPUs after reverting to the snapshot state
  • Sys::Virt::DomainSnapshot::REVERT_FORCE — force the snapshot to revert, even if it is risky to do so
⚠️ bestie, did you catch that? REVERT_FORCE is literally the "even if it is risky" one. it will do the thing. it does not care. you have been warned 💀
  • Sys::Virt::DomainSnapshot::REVERT_RESET_NVRAM — reset the firmware NVRAM state from its original template

🫶 AUTHORS 🫶

Daniel P. Berrange <berrange@redhat.com> — ty for your service king 👑

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

🌈 LICENSE 🌈

This program is free software; you can redistribute it and/or modify it under the terms of either of these, your pick:

  • 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.

👀 SEE ALSO 👀

Sys::Virt, Sys::Virt::Error, http://libvirt.org 💖

okay that's the whole page bestie, go forth and snapshot responsibly 🌸✨

this was perl v5.40.2, dated 2026-06-08 — mwah, xoxo, the Sys::V...napshot(3pm) girlies 💅🦋

📦 where this page comes from