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->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       $dev->destroy()
47           Destroy the virtual device releasing any OS resources associated
48           with it.
49
50       my @caps = $dev->list_capabilities()
51           Return a list of all capabilities in the device.
52

CONSTANTS

54       This section documents constants that are used with various APIs
55       described above
56
57   LIST FILTERING
58       The following constants are used to filter object lists
59
60       Sys::Virt::NodeDevice::LIST_CAP_NET
61           Include devices with the network capability
62
63       Sys::Virt::NodeDevice::LIST_CAP_PCI_DEV
64           Include devices with the PCI device capability
65
66       Sys::Virt::NodeDevice::LIST_CAP_SCSI
67           Include devices with the SCSI capability
68
69       Sys::Virt::NodeDevice::LIST_CAP_SCSI_HOST
70           Include devices with the SCSI host capability
71
72       Sys::Virt::NodeDevice::LIST_CAP_SCSI_TARGET
73           Include devices with the SCSI target capability
74
75       Sys::Virt::NodeDevice::LIST_CAP_STORAGE
76           Include devices with the storage capability
77
78       Sys::Virt::NodeDevice::LIST_CAP_SYSTEM
79           Include devices with the system capability
80
81       Sys::Virt::NodeDevice::LIST_CAP_USB_DEV
82           Include devices with the USB device capability
83
84       Sys::Virt::NodeDevice::LIST_CAP_USB_INTERFACE
85           Include devices with the USB interface capability
86
87       Sys::Virt::NodeDevice::LIST_CAP_FC_HOST
88           Include devices with the fibre channel host capability
89
90       Sys::Virt::NodeDevice::LIST_CAP_VPORTS
91           Include devices with the NPIV vport capability
92
93       Sys::Virt::NodeDevice::LIST_CAP_SCSI_GENERIC
94           Include devices with the SCSI generic capability
95
96       Sys::Virt::NodeDevice::LIST_CAP_DRM
97           Include devices with the DRM capability
98
99       Sys::Virt::NodeDevice::LIST_CAP_MDEV
100           Include mediated devices
101
102       Sys::Virt::NodeDevice::LIST_CAP_MDEV_TYPES
103           Include devices capable of mediated devices
104
105       Sys::Virt::NodeDevice::LIST_CAP_CCW_DEV
106           Include CCW devices
107
108       Sys::Virt::NodeDevice::LIST_CAP_CSS_DEV
109           Include CSS devices
110
111       Sys::Virt::NodeDevice::LIST_CAP_VDPA
112           Include VDPA devices
113
114       Sys::Virt::NodeDevice::LIST_CAP_AP_CARD
115           Include s390 AP card devices
116
117       Sys::Virt::NodeDevice::LIST_CAP_AP_MATRIX
118           Include s390 AP matrix devices
119
120       Sys::Virt::NodeDevice::LIST_CAP_AP_QUEUE
121           Include s390 AP queue devices
122
123       Sys::Virt::NodeDevice::LIST_ACTIVE
124           Include active devices
125
126       Sys::Virt::NodeDevice::LIST_INACTIVE
127           Include inactive devices
128
129   EVENT ID CONSTANTS
130       Sys::Virt::NodeDevice::EVENT_ID_LIFECYCLE
131           Node device lifecycle events
132
133       Sys::Virt::NodeDevice::EVENT_ID_UPDATE
134           Node device config update events
135
136   LIFECYCLE CHANGE EVENTS
137       The following constants allow node device lifecycle change events to be
138       interpreted. The events contain both a state change, and a reason
139       though the reason is currently unused.
140
141       Sys::Virt::NodeDevice::EVENT_CREATED
142           Indicates that a device was created
143
144       Sys::Virt::NodeDevice::EVENT_DELETED
145           Indicates that a device has been deleted
146
147       Sys::Virt::NodeDevice::EVENT_DEFINED
148           Indicates that a device configuration has been created
149
150       Sys::Virt::NodeDevice::EVENT_UNDEFINED
151           Indicates that a device configuration has been deleted
152

AUTHORS

154       Daniel P. Berrange <berrange@redhat.com>
155

COPYRIGHT

157       Copyright (C) 2006-2009 Red Hat Copyright (C) 2006-2009 Daniel P.
158       Berrange
159

LICENSE

161       This program is free software; you can redistribute it and/or modify it
162       under the terms of either the GNU General Public License as published
163       by the Free Software Foundation (either version 2 of the License, or at
164       your option any later version), or, the Artistic License, as specified
165       in the Perl README file.
166