Sys::Virt::NodeDevice(3pm)

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

NAME

6       Sys::Virt::NodeDevice - Represent & manage a libvirt storage pool
7

DESCRIPTION

9       The "Sys::Virt::NodeDevice" module represents a storage pool managed by
10       libvirt. There are a variety of storage pool implementations for LVM,
11       Local directories/filesystems, network filesystems, disk partitioning,
12       iSCSI, and SCSI.
13

METHODS

15       my $name = $dev->get_name()
16           Returns a string with a locally unique name of the device
17
18       my $parentname = $dev->get_parent()
19           Returns a string with a locally unique name of the parent of the
20           device, or undef if there is no parent
21
22       my $xml = $dev->get_xml_description()
23           Returns an XML document containing a complete description of the
24           storage dev's configuration
25
26       $dev->reattach()
27           Rebind the node device to the host OS device drivers.
28
29       $dev->dettach()
30           Unbind the node device from the host OS device driver
31
32       $dev->reset()
33           Reset the node device. The device must be unbound from the host OS
34           drivers for this to work
35
36       $dev->destroy()
37           Destroy the virtual device releasing any OS resources associated
38           with it.
39
40       my @caps = $dev->list_capabilities()
41           Return a list of all capabilities in the device.
42

CONSTANTS

44       This section documents constants that are used with various APIs
45       described above
46
47   LIST FILTERING
48       The following constants are used to filter object lists
49
50       Sys::Virt::NodeDevice::LIST_CAP_NET
51           Include devices with the network capability
52
53       Sys::Virt::NodeDevice::LIST_CAP_PCI_DEV
54           Include devices with the PCI device capability
55
56       Sys::Virt::NodeDevice::LIST_CAP_SCSI
57           Include devices with the SCSI capability
58
59       Sys::Virt::NodeDevice::LIST_CAP_SCSI_HOST
60           Include devices with the SCSI host capability
61
62       Sys::Virt::NodeDevice::LIST_CAP_SCSI_TARGET
63           Include devices with the SCSI target capability
64
65       Sys::Virt::NodeDevice::LIST_CAP_STORAGE
66           Include devices with the storage capability
67
68       Sys::Virt::NodeDevice::LIST_CAP_SYSTEM
69           Include devices with the system capability
70
71       Sys::Virt::NodeDevice::LIST_CAP_USB_DEV
72           Include devices with the USB device capability
73
74       Sys::Virt::NodeDevice::LIST_CAP_USB_INTERFACE
75           Include devices with the USB interface capability
76
77       Sys::Virt::NodeDevice::LIST_CAP_FC_HOST
78           Include devices with the fibre channel host capability
79
80       Sys::Virt::NodeDevice::LIST_CAP_VPORTS
81           Include devices with the NPIV vport capability
82
83       Sys::Virt::NodeDevice::LIST_CAP_SCSI_GENERIC
84           Include devices with the SCSI generic capability
85
86       Sys::Virt::NodeDevice::LIST_CAP_DRM
87           Include devices with the DRM capability
88
89       Sys::Virt::NodeDevice::LIST_CAP_MDEV
90           Include mediated devices
91
92       Sys::Virt::NodeDevice::LIST_CAP_MDEV_TYPES
93           Include devices capable of mediated devices
94
95       Sys::Virt::NodeDevice::LIST_CAP_CCW_DEV
96           Include CCW devices
97
98   EVENT ID CONSTANTS
99       Sys::Virt::NodeDevice::EVENT_ID_LIFECYCLE
100           Node device lifecycle events
101
102       Sys::Virt::NodeDevice::EVENT_ID_UPDATE
103           Node device config update events
104
105   LIFECYCLE CHANGE EVENTS
106       The following constants allow node device lifecycle change events to be
107       interpreted. The events contain both a state change, and a reason
108       though the reason is currently unused.
109
110       Sys::Virt::NodeDevice::EVENT_CREATED
111           Indicates that a device was created
112
113       Sys::Virt::NodeDevice::EVENT_DELETED
114           Indicates that a device has been deleted
115

AUTHORS

117       Daniel P. Berrange <berrange@redhat.com>
118

COPYRIGHT

120       Copyright (C) 2006-2009 Red Hat Copyright (C) 2006-2009 Daniel P.
121       Berrange
122

LICENSE

124       This program is free software; you can redistribute it and/or modify it
125       under the terms of either the GNU General Public License as published
126       by the Free Software Foundation (either version 2 of the License, or at
127       your option any later version), or, the Artistic License, as specified
128       in the Perl README file.
129