.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "Sys::Virt::NodeDevice 3pm"
.TH Sys::Virt::NodeDevice 3pm "2023-02-01" "perl v5.36.0" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
Sys::Virt::NodeDevice \- Represent & manage a libvirt storage pool
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
The \f(CW\*(C`Sys::Virt::NodeDevice\*(C'\fR module represents a storage pool managed
by libvirt. There are a variety of storage pool implementations for
\&\s-1LVM,\s0 Local directories/filesystems, network filesystems, disk
partitioning, iSCSI, and \s-1SCSI.\s0
.SH "METHODS"
.IX Header "METHODS"
.ie n .IP "my $name = $dev\->\fBget_name()\fR" 4
.el .IP "my \f(CW$name\fR = \f(CW$dev\fR\->\fBget_name()\fR" 4
.IX Item "my $name = $dev->get_name()"
Returns a string with a locally unique name of the device
.ie n .IP "my $parentname = $dev\->\fBget_parent()\fR" 4
.el .IP "my \f(CW$parentname\fR = \f(CW$dev\fR\->\fBget_parent()\fR" 4
.IX Item "my $parentname = $dev->get_parent()"
Returns a string with a locally unique name of the parent
of the device, or undef if there is no parent
.ie n .IP "my $xml = $dev\->\fBget_xml_description()\fR" 4
.el .IP "my \f(CW$xml\fR = \f(CW$dev\fR\->\fBget_xml_description()\fR" 4
.IX Item "my $xml = $dev->get_xml_description()"
Returns an \s-1XML\s0 document containing a complete description of
the storage dev's configuration
.ie n .IP "$dev\->\fBreattach()\fR" 4
.el .IP "\f(CW$dev\fR\->\fBreattach()\fR" 4
.IX Item "$dev->reattach()"
Rebind the node device to the host \s-1OS\s0 device drivers.
.ie n .IP "$dev\->\fBdettach()\fR" 4
.el .IP "\f(CW$dev\fR\->\fBdettach()\fR" 4
.IX Item "$dev->dettach()"
Unbind the node device from the host \s-1OS\s0 device driver
.ie n .IP "$dev\->\fBreset()\fR" 4
.el .IP "\f(CW$dev\fR\->\fBreset()\fR" 4
.IX Item "$dev->reset()"
Reset the node device. The device must be unbound from the host
\&\s-1OS\s0 drivers for this to work
.ie n .IP "$dev\->create($flags=0)" 4
.el .IP "\f(CW$dev\fR\->create($flags=0)" 4
.IX Item "$dev->create($flags=0)"
Start a node device whose configuration was previously defined using the
\&\f(CW\*(C`define_node_device\*(C'\fR method in Sys::Virt. The \f(CW$flags\fR parameter is
currently unused and defaults to zero.
.ie n .IP "$dev\->undefine($flags=0)" 4
.el .IP "\f(CW$dev\fR\->undefine($flags=0)" 4
.IX Item "$dev->undefine($flags=0)"
Delete a node device whose configuration was previously defined using the
\&\f(CW\*(C`define_node_device\*(C'\fR method in Sys::Virt. The \f(CW$flags\fR parameter is
currently unused and defaults to zero.
.ie n .IP "$flag = $dev\->\fBget_autostart()\fR;" 4
.el .IP "\f(CW$flag\fR = \f(CW$dev\fR\->\fBget_autostart()\fR;" 4
.IX Item "$flag = $dev->get_autostart();"
Return a true value if the node device is configured to automatically
start upon boot. Return false, otherwise
.ie n .IP "$dev\->set_autostart($flag)" 4
.el .IP "\f(CW$dev\fR\->set_autostart($flag)" 4
.IX Item "$dev->set_autostart($flag)"
Set the state of the autostart flag, which determines whether the
node device will automatically start upon boot of the host \s-1OS.\s0
.ie n .IP "$dev\->\fBis_active()\fR" 4
.el .IP "\f(CW$dev\fR\->\fBis_active()\fR" 4
.IX Item "$dev->is_active()"
Returns a true value if the node device is currently running
.ie n .IP "$dev\->\fBis_persistent()\fR" 4
.el .IP "\f(CW$dev\fR\->\fBis_persistent()\fR" 4
.IX Item "$dev->is_persistent()"
Returns a true value if the node device has a persistent configuration
file defined
.ie n .IP "$dev\->\fBdestroy()\fR" 4
.el .IP "\f(CW$dev\fR\->\fBdestroy()\fR" 4
.IX Item "$dev->destroy()"
Destroy the virtual device releasing any \s-1OS\s0 resources associated
with it.
.ie n .IP "my @caps = $dev\->\fBlist_capabilities()\fR" 4
.el .IP "my \f(CW@caps\fR = \f(CW$dev\fR\->\fBlist_capabilities()\fR" 4
.IX Item "my @caps = $dev->list_capabilities()"
Return a list of all capabilities in the device.
.SH "CONSTANTS"
.IX Header "CONSTANTS"
This section documents constants that are used with various
APIs described above
.SS "\s-1LIST FILTERING\s0"
.IX Subsection "LIST FILTERING"
The following constants are used to filter object lists
.IP "Sys::Virt::NodeDevice::LIST_CAP_NET" 4
.IX Item "Sys::Virt::NodeDevice::LIST_CAP_NET"
Include devices with the network capability
.IP "Sys::Virt::NodeDevice::LIST_CAP_PCI_DEV" 4
.IX Item "Sys::Virt::NodeDevice::LIST_CAP_PCI_DEV"
Include devices with the \s-1PCI\s0 device capability
.IP "Sys::Virt::NodeDevice::LIST_CAP_SCSI" 4
.IX Item "Sys::Virt::NodeDevice::LIST_CAP_SCSI"
Include devices with the \s-1SCSI\s0 capability
.IP "Sys::Virt::NodeDevice::LIST_CAP_SCSI_HOST" 4
.IX Item "Sys::Virt::NodeDevice::LIST_CAP_SCSI_HOST"
Include devices with the \s-1SCSI\s0 host capability
.IP "Sys::Virt::NodeDevice::LIST_CAP_SCSI_TARGET" 4
.IX Item "Sys::Virt::NodeDevice::LIST_CAP_SCSI_TARGET"
Include devices with the \s-1SCSI\s0 target capability
.IP "Sys::Virt::NodeDevice::LIST_CAP_STORAGE" 4
.IX Item "Sys::Virt::NodeDevice::LIST_CAP_STORAGE"
Include devices with the storage capability
.IP "Sys::Virt::NodeDevice::LIST_CAP_SYSTEM" 4
.IX Item "Sys::Virt::NodeDevice::LIST_CAP_SYSTEM"
Include devices with the system capability
.IP "Sys::Virt::NodeDevice::LIST_CAP_USB_DEV" 4
.IX Item "Sys::Virt::NodeDevice::LIST_CAP_USB_DEV"
Include devices with the \s-1USB\s0 device capability
.IP "Sys::Virt::NodeDevice::LIST_CAP_USB_INTERFACE" 4
.IX Item "Sys::Virt::NodeDevice::LIST_CAP_USB_INTERFACE"
Include devices with the \s-1USB\s0 interface capability
.IP "Sys::Virt::NodeDevice::LIST_CAP_FC_HOST" 4
.IX Item "Sys::Virt::NodeDevice::LIST_CAP_FC_HOST"
Include devices with the fibre channel host capability
.IP "Sys::Virt::NodeDevice::LIST_CAP_VPORTS" 4
.IX Item "Sys::Virt::NodeDevice::LIST_CAP_VPORTS"
Include devices with the \s-1NPIV\s0 vport capability
.IP "Sys::Virt::NodeDevice::LIST_CAP_SCSI_GENERIC" 4
.IX Item "Sys::Virt::NodeDevice::LIST_CAP_SCSI_GENERIC"
Include devices with the \s-1SCSI\s0 generic capability
.IP "Sys::Virt::NodeDevice::LIST_CAP_DRM" 4
.IX Item "Sys::Virt::NodeDevice::LIST_CAP_DRM"
Include devices with the \s-1DRM\s0 capability
.IP "Sys::Virt::NodeDevice::LIST_CAP_MDEV" 4
.IX Item "Sys::Virt::NodeDevice::LIST_CAP_MDEV"
Include mediated devices
.IP "Sys::Virt::NodeDevice::LIST_CAP_MDEV_TYPES" 4
.IX Item "Sys::Virt::NodeDevice::LIST_CAP_MDEV_TYPES"
Include devices capable of mediated devices
.IP "Sys::Virt::NodeDevice::LIST_CAP_CCW_DEV" 4
.IX Item "Sys::Virt::NodeDevice::LIST_CAP_CCW_DEV"
Include \s-1CCW\s0 devices
.IP "Sys::Virt::NodeDevice::LIST_CAP_CSS_DEV" 4
.IX Item "Sys::Virt::NodeDevice::LIST_CAP_CSS_DEV"
Include \s-1CSS\s0 devices
.IP "Sys::Virt::NodeDevice::LIST_CAP_VDPA" 4
.IX Item "Sys::Virt::NodeDevice::LIST_CAP_VDPA"
Include \s-1VDPA\s0 devices
.IP "Sys::Virt::NodeDevice::LIST_CAP_AP_CARD" 4
.IX Item "Sys::Virt::NodeDevice::LIST_CAP_AP_CARD"
Include s390 \s-1AP\s0 card devices
.IP "Sys::Virt::NodeDevice::LIST_CAP_AP_MATRIX" 4
.IX Item "Sys::Virt::NodeDevice::LIST_CAP_AP_MATRIX"
Include s390 \s-1AP\s0 matrix devices
.IP "Sys::Virt::NodeDevice::LIST_CAP_AP_QUEUE" 4
.IX Item "Sys::Virt::NodeDevice::LIST_CAP_AP_QUEUE"
Include s390 \s-1AP\s0 queue devices
.IP "Sys::Virt::NodeDevice::LIST_CAP_VPD" 4
.IX Item "Sys::Virt::NodeDevice::LIST_CAP_VPD"
Include \s-1PCI\s0 devices with \s-1VPD\s0
.IP "Sys::Virt::NodeDevice::LIST_ACTIVE" 4
.IX Item "Sys::Virt::NodeDevice::LIST_ACTIVE"
Include active devices
.IP "Sys::Virt::NodeDevice::LIST_INACTIVE" 4
.IX Item "Sys::Virt::NodeDevice::LIST_INACTIVE"
Include inactive devices
.SS "\s-1EVENT ID CONSTANTS\s0"
.IX Subsection "EVENT ID CONSTANTS"
.IP "Sys::Virt::NodeDevice::EVENT_ID_LIFECYCLE" 4
.IX Item "Sys::Virt::NodeDevice::EVENT_ID_LIFECYCLE"
Node device lifecycle events
.IP "Sys::Virt::NodeDevice::EVENT_ID_UPDATE" 4
.IX Item "Sys::Virt::NodeDevice::EVENT_ID_UPDATE"
Node device config update events
.SS "\s-1LIFECYCLE CHANGE EVENTS\s0"
.IX Subsection "LIFECYCLE CHANGE EVENTS"
The following constants allow node device lifecycle change events to be
interpreted. The events contain both a state change, and a
reason though the reason is currently unused.
.IP "Sys::Virt::NodeDevice::EVENT_CREATED" 4
.IX Item "Sys::Virt::NodeDevice::EVENT_CREATED"
Indicates that a device was created
.IP "Sys::Virt::NodeDevice::EVENT_DELETED" 4
.IX Item "Sys::Virt::NodeDevice::EVENT_DELETED"
Indicates that a device has been deleted
.IP "Sys::Virt::NodeDevice::EVENT_DEFINED" 4
.IX Item "Sys::Virt::NodeDevice::EVENT_DEFINED"
Indicates that a device configuration has been created
.IP "Sys::Virt::NodeDevice::EVENT_UNDEFINED" 4
.IX Item "Sys::Virt::NodeDevice::EVENT_UNDEFINED"
Indicates that a device configuration has been deleted
.SS "\s-1NODE DEVICE CREATION\s0"
.IX Subsection "NODE DEVICE CREATION"
.IP "Sys::Virt::NodeDevice::CREATE_XML_VALIDATE" 4
.IX Item "Sys::Virt::NodeDevice::CREATE_XML_VALIDATE"
Validate the \s-1XML\s0 document against schema
.SS "\s-1NODE DEVICE DEFINE\s0"
.IX Subsection "NODE DEVICE DEFINE"
.IP "Sys::Virt::NodeDevice::DEFINE_XML_VALIDATE" 4
.IX Item "Sys::Virt::NodeDevice::DEFINE_XML_VALIDATE"
Validate the \s-1XML\s0 document against schema
.SH "AUTHORS"
.IX Header "AUTHORS"
Daniel P. Berrange <berrange@redhat.com>
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
Copyright (C) 2006\-2009 Red Hat
Copyright (C) 2006\-2009 Daniel P. Berrange
.SH "LICENSE"
.IX Header "LICENSE"
This program is free software; you can redistribute it and/or modify
it under the terms of either the \s-1GNU\s0 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 \s-1README\s0 file.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Sys::Virt, Sys::Virt::Error, \f(CW\*(C`http://libvirt.org\*(C'\fR