sys::virt::secret(3pm) [debian man page]
Sys::Virt::Secret(3pm) User Contributed Perl Documentation Sys::Virt::Secret(3pm) NAME
Sys::Virt::Secret - Represent & manage a libvirt secret DESCRIPTION
The "Sys::Virt::Secret" module represents a secret managed by the virtual machine monitor. METHODS
my $uuid = $sec->get_uuid() Returns a 16 byte long string containing the raw globally unique identifier (UUID) for the secret. my $uuid = $sec->get_uuid_string() Returns a printable string representation of the raw UUID, in the format 'XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX'. my $type = $sec->get_usage_type() Returns the usage type of this secret. The usage type determines the format of the unique identifier for this secret. my $id = $sec->get_usage_id() Returns the identifier of the object with which the secret is to be used. For secrets with a usage type of volume, the identifier is the fully qualfied path. my $xml = $sec->get_xml_description() Returns an XML document containing a complete description of the secret's configuration $sec->undefine() Remove the configuration associated with a secret previously defined with the "define_secret" method in Sys::Virt. $bytes = $sec->get_value() Returns the raw bytes for the value of this secret, or undef if there is no value stored with the secret. $sec->set_value($bytes) Sets the value for the secret to be $bytes. CONSTANTS
Sys::Virt::Secret::USAGE_TYPE_NONE The constant for secrets which are not assigned for use with a particular object Sys::Virt::Secret::USAGE_TYPE_VOLUME The constant for secrets which are to be used for storage volume encryption. The usage ID for secrets will refer to the fully qualified volume path. Sys::Virt::Secret::USAGE_TYPE_CEPH The constant for secrets which are to be used for authenticating to CEPH storage volumes. The usage ID for secrets will refer to the server name. AUTHORS
Daniel P. Berrange <berrange@redhat.com> COPYRIGHT
Copyright (C) 2006-2009 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 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" perl v5.14.2 2012-05-21 Sys::Virt::Secret(3pm)
Check Out this Related Man Page
Sys::Virt::DomainSnapshot(3pm) User Contributed Perl Documentation Sys::Virt::DomainSnapshot(3pm) NAME
Sys::Virt::DomainSnapshot - Represent & manage a libvirt guest domain DESCRIPTION
The "Sys::Virt::DomainSnapshot" module represents a guest domain managed by the virtual machine monitor. METHODS
my $str = $domss->get_name() Return the name of the snapshot my $xml = $domss->get_xml_description($flags) Returns an XML document containing a complete description of the domain's configuration. $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) Revert 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(); Return the parent of the snapshot, if any $count = $domss->num_of_child_snapshots() Return the number of saved snapshots which are children of this snapshot @names = $domss->list_child_snapshot_names() List 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() Return 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. 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 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 leave nodes in the snapshot tree 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 AUTHORS
Daniel P. Berrange <berrange@redhat.com> COPYRIGHT
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 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" perl v5.14.2 2012-05-21 Sys::Virt::DomainSnapshot(3pm)