Sys::Virt::Network(3) User Contributed Perl Documentation Sys::Virt::Network(3)

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

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

Returns a 16 byte long string containing the raw globally unique identifier (UUID) for the network.
Returns a printable string representation of the raw UUID, in the format 'XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX'.
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
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->update($command, $section, $parentIndex, $xml, $flags=0)
Update the network configuration with $xml. The $section parameter, which must be one of the XML SECTION CONSTANTS listed later, indicates what schema is used in $xml. The $command parameter determines what action is taken. Finally, the $flags parameter can be use to control which config is affected.
$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.
@leases = $net->get_dhcp_leases($mac=undef, $flags=0)
Get a list of all active DHCP leases. If $mac is undefined than leases for all VMs are returned, otherwise only leases for the matching MAC address are returned. The $flags parameter is currently unused and defaults to zero.

The elements in the returned array are hash references with the following fields

"iface"
Network interface name
"expirytime"
Seconds since the epoch until the lease expires
"type"
One of the Sys::Virt IP address type constants
"mac"
The MAC address of the lease
"iaid"
The IAID of the client
"ipaddr"
The IP address of the lease
"prefix"
The IP address prefix
"hostname"
The optional hostname associated with the lease
"clientid"
The client ID or DUID
@port = $net->list_all_ports($flags=0)
List all ports associated with the network. The return array elements are instances of the "Sys::Virt::NetworkPort" class.
$port = $net->create_port($xml, $flags=0)
Create a new network port from the given $xml description. The $flags parameter can optionally taken one or more of the network port creation constants. The returned $port object is an instance of the "Sys::Virt::NetworkPort" class.
$port = $net->get_port_by_uuid($uuid);
Lookup a network port from a raw or printable UUID. The returned $port object is an instance of the "Sys::Virt::NetworkPort" class.

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

NETWORK CREATION CONSTANTS

When creating networks zero or more of the following constants may be used

Validate the XML document against the XML schema

LIST FILTERING

The following constants are used to filter object lists

Include networks which are active
Include networks which are not active
Include networks which are set to autostart
Include networks which are not set to autostart
Include networks which are persistent
Include networks which are transient

NETWORK DEFINE

The following constants can be used to control the behaviour of network define operations

Validate the XML document against the XML schema

XML CONSTANTS

The following constants are used when querying XML

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

The following constants are used to refer to sections of the XML document

The bridge device element
The DNS host record section
The DNS SRV record section
The DNS TXT record section
The domain name section
The forward device section
The forward interface section
The forward physical function section
The IP address section
The IP address DHCP host section
The IP address DHCP range section
The port group section
The top level domain element

XML UPDATE FLAGS

Affect whatever the current object state is
Always update the config file
Always update the live config

XML UPDATE COMMANDS

No update
Remove the matching entry
Modify the matching entry
Insert the matching entry at the start
Insert the matching entry at the end

EVENT ID CONSTANTS

Network lifecycle events

LIFECYCLE CHANGE EVENTS

The following constants allow network lifecycle change events to be interpreted. The events contain both a state change, and a reason though the reason is currently unused.

Indicates that a persistent configuration has been defined for the network.
The network has started running
The network has stopped running
The persistent configuration has gone away

Daniel P. Berrange <berrange@redhat.com>

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

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.

Sys::Virt, Sys::Virt::Error, "http://libvirt.org"

2021-12-21 perl v5.34.0