Sys::Virt::Interface(3pm)

1Sys::Virt::Interface(3pUms)er Contributed Perl DocumentatSiyosn::Virt::Interface(3pm)
2
3
4

NAME

6       Sys::Virt::Interface - Represent & manage a libvirt host network
7       interface
8

DESCRIPTION

10       The "Sys::Virt::Interface" module represents a host network interface
11       allowing configuration of IP addresses, bonding, vlans and bridges.
12

METHODS

14       my $name = $iface->get_name()
15           Returns a string with a locally unique name of the network
16
17       $iface->is_active()
18           Returns a true value if the interface is currently running
19
20       my $name = $iface->get_mac()
21           Returns a string with the hardware MAC address of the interface
22
23       my $xml = $iface->get_xml_description()
24           Returns an XML document containing a complete description of the
25           network's configuration
26
27       $iface->create()
28           Start a network whose configuration was previously defined using
29           the "define_network" method in Sys::Virt.
30
31       $iface->undefine()
32           Remove the configuration associated with a network previously
33           defined with the "define_network" method in Sys::Virt. If the
34           network is running, you probably want to use the "shutdown" or
35           "destroy" methods instead.
36
37       $iface->destroy()
38           Immediately terminate the machine, and remove it from the virtual
39           machine monitor. The $iface handle is invalid after this call
40           completes and should not be used again.
41

CONSTANTS

43       This section documents constants that are used with various APIs
44       described above
45
46   LIST FILTERING
47       The following constants are used to filter object lists
48
49       Sys::Virt::Interface::LIST_ACTIVE
50           Include interfaces that are active
51
52       Sys::Virt::Interface::LIST_INACTIVE
53           Include interfaces that are not active
54
55   INTERFACE DEFINE
56       The following constants can be used to control the behaviour of
57       interface define operations
58
59       Sys::Virt::Interface::DEFINE_VALIDATE
60           Validate the XML document against the XML schema
61
62   XML CONSTANTS
63       The following constants are used when querying XML
64
65       Sys::Virt::Interface::XML_INACTIVE
66           Request the inactive XML, instead of the current possibly live
67           config.
68

AUTHORS

70       Daniel P. Berrange <berrange@redhat.com>
71

COPYRIGHT

73       Copyright (C) 2006-2009 Red Hat Copyright (C) 2006-2007 Daniel P.
74       Berrange
75

LICENSE

77       This program is free software; you can redistribute it and/or modify it
78       under the terms of either the GNU General Public License as published
79       by the Free Software Foundation (either version 2 of the License, or at
80       your option any later version), or, the Artistic License, as specified
81       in the Perl README file.
82