Sys::Virt::NodeDevice3pm

Overview

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($flags=0)

Returns an XML document containing a complete description of the node device's configuration. The optional $flags parameter controls generation of the XML document, defaulting to 0 if omitted. It can be one or more of the XML DUMP constants listed later in this document.

$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->create($flags=0)

Start a node device whose configuration was previously defined using the "define_node_device" method in Sys::Virt. The $flags parameter is currently unused and defaults to zero.

$dev->undefine($flags=0)

Delete a node device whose configuration was previously defined using the "define_node_device" method in Sys::Virt. The $flags parameter is currently unused and defaults to zero.

$flag = $dev->get_autostart();

Return a true value if the node device is configured to automatically start upon boot. Return false, otherwise

$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 OS.

$dev->is_active()

Returns a true value if the node device is currently running

$dev->is_persistent()

Returns a true value if the node device has a persistent configuration file defined

$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.

$dev->update($xml, $flags=0)

Update the definition of an existing node device with $xml. The $flags parameter can be use to control which config is affected (see XML UPDATE FLAGS) and defaults to zero (affect current state of the node device).

Constants

This section documents constants that are used with various APIs described above