Sys::Virt::NodeDevice(3pm) | User Contributed Perl Documentation | Sys::Virt::NodeDevice(3pm) |
NAME¶
Sys::Virt::NodeDevice - Represent & manage a libvirt storage poolDESCRIPTION¶
The "Sys::Virt::NodeDevice" module represents a storage pool managed by libvirt. There are a variety of storage pool implementations for LVM, Local directories/filesystems, network filesystems, disk partitioning, iSCSI, and SCSI.METHODS¶
- my $name = $dev->get_name()
- Returns a string with a locally unique name of the device
- 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
- my $xml = $dev->get_xml_description()
- Returns an XML document containing a complete description of the storage dev's configuration
- $dev->reattach()
- Rebind the node device to the host OS device drivers.
- $dev->dettach()
- Unbind the node device from the host OS device driver
- $dev->reset()
- Reset the node device. The device must be unbound from the host OS drivers for this to work
- $dev->destroy()
- Destroy the virtual device releasing any OS resources associated with it.
- my @caps = $dev->list_capabilities()
- Return a list of all capabilities in the device.
CONSTANTS¶
This section documents constants that are used with various APIs described aboveLIST FILTERING¶
The following constants are used to filter object lists- Sys::Virt::NodeDevice::LIST_CAP_NET
- Include devices with the network capability
- Sys::Virt::NodeDevice::LIST_CAP_PCI_DEV
- Include devices with the PCI device capability
- Sys::Virt::NodeDevice::LIST_CAP_SCSI
- Include devices with the SCSI capability
- Sys::Virt::NodeDevice::LIST_CAP_SCSI_HOST
- Include devices with the SCSI host capability
- Sys::Virt::NodeDevice::LIST_CAP_SCSI_TARGET
- Include devices with the SCSI target capability
- Sys::Virt::NodeDevice::LIST_CAP_STORAGE
- Include devices with the storage capability
- Sys::Virt::NodeDevice::LIST_CAP_SYSTEM
- Include devices with the system capability
- Sys::Virt::NodeDevice::LIST_CAP_USB_DEV
- Include devices with the USB device capability
- Sys::Virt::NodeDevice::LIST_CAP_USB_INTERFACE
- Include devices with the USB interface capability
- Sys::Virt::NodeDevice::LIST_CAP_FC_HOST
- Include devices with the fibre channel host capability
- Sys::Virt::NodeDevice::LIST_CAP_VPORTS
- Include devices with the NPIV vport capability
- Sys::Virt::NodeDevice::LIST_CAP_SCSI_GENERIC
- Include devices with the SCSI generic capability
EVENT ID CONSTANTS¶
- Sys::Virt::NodeDevice::EVENT_ID_LIFECYCLE
- Node device lifecycle events
- Sys::Virt::NodeDevice::EVENT_ID_UPDATE
- Node device config update events
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 unsed.- Sys::Virt::StoragePool::EVENT_CREATED
- Indicates that a device was created
- Sys::Virt::StoragePool::EVENT_DELETED
- Indicates that a device has been deleted
AUTHORS¶
Daniel P. Berrange <berrange@redhat.com>COPYRIGHT¶
Copyright (C) 2006-2009 Red Hat Copyright (C) 2006-2009 Daniel P. BerrangeLICENSE¶
This program is free software; you can redistribute it and/or modify it under the terms of either the GNU 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 README file.SEE ALSO¶
Sys::Virt, Sys::Virt::Error, "http://libvirt.org"2017-01-25 | perl v5.24.1 |