Sys::Virt::NodeDevice(3pm)

1Sys::Virt::NodeDevice(3Upsme)r Contributed Perl DocumentaStyiso:n:Virt::NodeDevice(3pm)
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->create($flags=0)
37           Start a node device whose configuration was previously defined
38           using the "define_node_device" method in Sys::Virt. The $flags
39           parameter is currently unused and defaults to zero.
40
41       $dev->undefine($flags=0)
42           Delete a node device whose configuration was previously defined
43           using the "define_node_device" method in Sys::Virt. The $flags
44           parameter is currently unused and defaults to zero.
45
46       $flag = $dev->get_autostart();
47           Return a true value if the node device is configured to
48           automatically start upon boot. Return false, otherwise
49
50       $dev->set_autostart($flag)
51           Set the state of the autostart flag, which determines whether the
52           node device will automatically start upon boot of the host OS.
53
54       $dev->is_active()
55           Returns a true value if the node device is currently running
56
57       $dev->is_persistent()
58           Returns a true value if the node device has a persistent
59           configuration file defined
60
61       $dev->destroy()
62           Destroy the virtual device releasing any OS resources associated
63           with it.
64
65       my @caps = $dev->list_capabilities()
66           Return a list of all capabilities in the device.
67

CONSTANTS

69       This section documents constants that are used with various APIs
70       described above
71
72   LIST FILTERING
73       The following constants are used to filter object lists
74
75       Sys::Virt::NodeDevice::LIST_CAP_NET
76           Include devices with the network capability
77
78       Sys::Virt::NodeDevice::LIST_CAP_PCI_DEV
79           Include devices with the PCI device capability
80
81       Sys::Virt::NodeDevice::LIST_CAP_SCSI
82           Include devices with the SCSI capability
83
84       Sys::Virt::NodeDevice::LIST_CAP_SCSI_HOST
85           Include devices with the SCSI host capability
86
87       Sys::Virt::NodeDevice::LIST_CAP_SCSI_TARGET
88           Include devices with the SCSI target capability
89
90       Sys::Virt::NodeDevice::LIST_CAP_STORAGE
91           Include devices with the storage capability
92
93       Sys::Virt::NodeDevice::LIST_CAP_SYSTEM
94           Include devices with the system capability
95
96       Sys::Virt::NodeDevice::LIST_CAP_USB_DEV
97           Include devices with the USB device capability
98
99       Sys::Virt::NodeDevice::LIST_CAP_USB_INTERFACE
100           Include devices with the USB interface capability
101
102       Sys::Virt::NodeDevice::LIST_CAP_FC_HOST
103           Include devices with the fibre channel host capability
104
105       Sys::Virt::NodeDevice::LIST_CAP_VPORTS
106           Include devices with the NPIV vport capability
107
108       Sys::Virt::NodeDevice::LIST_CAP_SCSI_GENERIC
109           Include devices with the SCSI generic capability
110
111       Sys::Virt::NodeDevice::LIST_CAP_DRM
112           Include devices with the DRM capability
113
114       Sys::Virt::NodeDevice::LIST_CAP_MDEV
115           Include mediated devices
116
117       Sys::Virt::NodeDevice::LIST_CAP_MDEV_TYPES
118           Include devices capable of mediated devices
119
120       Sys::Virt::NodeDevice::LIST_CAP_CCW_DEV
121           Include CCW devices
122
123       Sys::Virt::NodeDevice::LIST_CAP_CSS_DEV
124           Include CSS devices
125
126       Sys::Virt::NodeDevice::LIST_CAP_VDPA
127           Include VDPA devices
128
129       Sys::Virt::NodeDevice::LIST_CAP_AP_CARD
130           Include s390 AP card devices
131
132       Sys::Virt::NodeDevice::LIST_CAP_AP_MATRIX
133           Include s390 AP matrix devices
134
135       Sys::Virt::NodeDevice::LIST_CAP_AP_QUEUE
136           Include s390 AP queue devices
137
138       Sys::Virt::NodeDevice::LIST_CAP_VPD
139           Include PCI devices with VPD
140
141       Sys::Virt::NodeDevice::LIST_ACTIVE
142           Include active devices
143
144       Sys::Virt::NodeDevice::LIST_INACTIVE
145           Include inactive devices
146
147   EVENT ID CONSTANTS
148       Sys::Virt::NodeDevice::EVENT_ID_LIFECYCLE
149           Node device lifecycle events
150
151       Sys::Virt::NodeDevice::EVENT_ID_UPDATE
152           Node device config update events
153
154   LIFECYCLE CHANGE EVENTS
155       The following constants allow node device lifecycle change events to be
156       interpreted. The events contain both a state change, and a reason
157       though the reason is currently unused.
158
159       Sys::Virt::NodeDevice::EVENT_CREATED
160           Indicates that a device was created
161
162       Sys::Virt::NodeDevice::EVENT_DELETED
163           Indicates that a device has been deleted
164
165       Sys::Virt::NodeDevice::EVENT_DEFINED
166           Indicates that a device configuration has been created
167
168       Sys::Virt::NodeDevice::EVENT_UNDEFINED
169           Indicates that a device configuration has been deleted
170
171   NODE DEVICE CREATION
172       Sys::Virt::NodeDevice::CREATE_XML_VALIDATE
173           Validate the XML document against schema
174
175   NODE DEVICE DEFINE
176       Sys::Virt::NodeDevice::DEFINE_XML_VALIDATE
177           Validate the XML document against schema
178

AUTHORS

180       Daniel P. Berrange <berrange@redhat.com>
181

COPYRIGHT

183       Copyright (C) 2006-2009 Red Hat Copyright (C) 2006-2009 Daniel P.
184       Berrange
185

LICENSE

187       This program is free software; you can redistribute it and/or modify it
188       under the terms of either the GNU General Public License as published
189       by the Free Software Foundation (either version 2 of the License, or at
190       your option any later version), or, the Artistic License, as specified
191       in the Perl README file.
192