Sys::Virt::StorageVol(3pm)

1Sys::Virt::StorageVol(3U)ser Contributed Perl DocumentatiSoyns::Virt::StorageVol(3)
2
3
4

NAME

6       Sys::Virt::StorageVol - Represent & manage a libvirt storage volume
7

DESCRIPTION

9       The "Sys::Virt::StorageVol" module represents a storage volume managed
10       by libvirt. A storage volume is always associated with a containing
11       storage pool ("Sys::Virt::StoragePool").
12

METHODS

14       my $name = $vol->get_name()
15           Returns a string with a locally unique name of the storage vol
16
17       my $name = $vol->get_key()
18           Returns a string with a globally unique key for the storage vol
19
20       my $name = $vol->get_path()
21           Returns a string with a locally unique file path of the storage vol
22
23       my $xml = $vol->get_xml_description()
24           Returns an XML document containing a complete description of the
25           storage vol's configuration
26
27       $vol->delete($flags)
28           Immediately delete the storage volume freeing its storage
29           resources.  The "flags" parameter indicates any special action to
30           be taken when deleting the volume.
31
32       $vol->wipe($flags = 0)
33           Clear the data in the storage volume to avoid future information
34           leak. The "flags" parameter indicates any special approach to be
35           taken when wiping the data. It defaults to zero, which causes the
36           volume to be filled with zeros.
37
38       my %info = $vol->get_info()
39           Retrieve live information about the storage volume. The returned
40           %info hash contains three keys. "type" indicates whether the volume
41           is a file or block device. "capacity" provides the maximum logical
42           size of the volume. "allocation" provides the current physical
43           usage of the volume. The allocation may be less than the capacity
44           for sparse, or grow-on-demand volumes. The allocation may also be
45           larger than the capacity, if there is a metadata overhead for the
46           volume format.
47

CONSTANTS

49       The following sets of constants are useful when dealing with storage
50       volumes
51
52   VOLUME TYPES
53       The following constants are useful for interpreting the "type" field in
54       the hash returned by the "get_info" method
55
56       Sys::Virt::StorageVol::TYPE_FILE
57           The volume is a plain file
58
59       Sys::Virt::StorageVol::TYPE_BLOCK
60           The volume is a block device
61
62   DELETE MODES
63       The following constants are useful for the "flags" parameter of the
64       "delete" method
65
66       Sys::Virt::StorageVol::DELETE_NORMAL
67           Do a plain delete without any attempt to scrub data.
68
69       Sys::Virt::StorageVol::DELETE_ZEROED
70           Zero out current allocated blocks when deleteing the volume
71

AUTHORS

73       Daniel P. Berrange <berrange@redhat.com>
74

COPYRIGHT

76       Copyright (C) 2006-2009 Red Hat Copyright (C) 2006-2009 Daniel P.
77       Berrange
78

LICENSE

80       This program is free software; you can redistribute it and/or modify it
81       under the terms of either the GNU General Public License as published
82       by the Free Software Foundation (either version 2 of the License, or at
83       your option any later version), or, the Artistic License, as specified
84       in the Perl README file.
85