NAME

Sys::Virt::Network - Represent & manage a libvirt virtual network

DESCRIPTION

The Sys::Virt::Network module represents a virtual network managed by the virtual machine monitor.

METHODS

my $uuid = $net->get_uuid()

Returns a 16 byte long string containing the raw globally unique identifier (UUID) for the network.

my $uuid = $net->get_uuid_string()

Returns a printable string representation of the raw UUID, in the format 'XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX'.

my $name = $net->get_name()

Returns a string with a locally unique name of the network

$net->is_active()

Returns a true value if the network is currently running

$net->is_persistent()

Returns a true value if the network has a persistent configuration file defined

my $xml = $net->get_xml_description()

Returns an XML document containing a complete description of the network's configuration

$net->create()

Start a network whose configuration was previously defined using the define_network method in Sys::Virt.

$net->undefine()

Remove the configuration associated with a network previously defined with the define_network method in Sys::Virt. If the network is running, you probably want to use the shutdown or destroy methods instead.

$net->destroy()

Immediately terminate the machine, and remove it from the virtual machine monitor. The $net handle is invalid after this call completes and should not be used again.

$net->get_bridge_name()

Return the name of the bridge device associated with the virtual network

$flag = $net->get_autostart();

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

$net->set_autostart($flag)

Set the state of the autostart flag, which determines whether the virtual network will automatically start upon boot of the host OS.

CONSTANTS

XML CONSTANTS

The following constants are used when querying XML

Sys::Virt::Network::XML_INACTIVE

Request the inactive XML, instead of the current possibly live config.

AUTHORS

Daniel P. Berrange <berrange@redhat.com>

COPYRIGHT

Copyright (C) 2006 Red Hat Copyright (C) 2006-2007 Daniel P. Berrange

LICENSE

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