Sys::Virt::Interface(3pm)

1Sys::Virt::Interface(3)User Contributed Perl DocumentatioSnys::Virt::Interface(3)
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

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

AUTHORS

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

COPYRIGHT

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

LICENSE

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