.\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.28)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{
.    if \nF \{
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "Sys::Virt::Interface 3pm"
.TH Sys::Virt::Interface 3pm "2014-10-02" "perl v5.20.1" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
Sys::Virt::Interface \- Represent & manage a libvirt host network interface
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
The \f(CW\*(C`Sys::Virt::Interface\*(C'\fR module represents a host network interface
allowing configuration of \s-1IP\s0 addresses, bonding, vlans and bridges.
.SH "METHODS"
.IX Header "METHODS"
.ie n .IP "my $name = $iface\->\fIget_name()\fR" 4
.el .IP "my \f(CW$name\fR = \f(CW$iface\fR\->\fIget_name()\fR" 4
.IX Item "my $name = $iface->get_name()"
Returns a string with a locally unique name of the network
.ie n .IP "$iface\->\fIis_active()\fR" 4
.el .IP "\f(CW$iface\fR\->\fIis_active()\fR" 4
.IX Item "$iface->is_active()"
Returns a true value if the interface is currently running
.ie n .IP "my $name = $iface\->\fIget_mac()\fR" 4
.el .IP "my \f(CW$name\fR = \f(CW$iface\fR\->\fIget_mac()\fR" 4
.IX Item "my $name = $iface->get_mac()"
Returns a string with the hardware \s-1MAC\s0 address of the interface
.ie n .IP "my $xml = $iface\->\fIget_xml_description()\fR" 4
.el .IP "my \f(CW$xml\fR = \f(CW$iface\fR\->\fIget_xml_description()\fR" 4
.IX Item "my $xml = $iface->get_xml_description()"
Returns an \s-1XML\s0 document containing a complete description of
the network's configuration
.ie n .IP "$iface\->\fIcreate()\fR" 4
.el .IP "\f(CW$iface\fR\->\fIcreate()\fR" 4
.IX Item "$iface->create()"
Start a network whose configuration was previously defined using the
\&\f(CW\*(C`define_network\*(C'\fR method in Sys::Virt.
.ie n .IP "$iface\->\fIundefine()\fR" 4
.el .IP "\f(CW$iface\fR\->\fIundefine()\fR" 4
.IX Item "$iface->undefine()"
Remove the configuration associated with a network previously defined
with the \f(CW\*(C`define_network\*(C'\fR method in Sys::Virt. If the network is
running, you probably want to use the \f(CW\*(C`shutdown\*(C'\fR or \f(CW\*(C`destroy\*(C'\fR
methods instead.
.ie n .IP "$iface\->\fIdestroy()\fR" 4
.el .IP "\f(CW$iface\fR\->\fIdestroy()\fR" 4
.IX Item "$iface->destroy()"
Immediately terminate the machine, and remove it from the virtual
machine monitor. The \f(CW$iface\fR handle is invalid after this call
completes and should not be used again.
.SH "CONSTANTS"
.IX Header "CONSTANTS"
.SH "CONSTANTS"
.IX Header "CONSTANTS"
This section documents constants that are used with various
APIs described above
.SS "\s-1LIST FILTERING\s0"
.IX Subsection "LIST FILTERING"
The following constants are used to filter object lists
.IP "Sys::Virt::Interface::LIST_ACTIVE" 4
.IX Item "Sys::Virt::Interface::LIST_ACTIVE"
Include interfaces that are active
.IP "Sys::Virt::Interface::LIST_INACTIVE" 4
.IX Item "Sys::Virt::Interface::LIST_INACTIVE"
Include interfaces that are not active
.SS "\s-1XML CONSTANTS\s0"
.IX Subsection "XML CONSTANTS"
The following constants are used when querying \s-1XML\s0
.IP "Sys::Virt::Interface::XML_INACTIVE" 4
.IX Item "Sys::Virt::Interface::XML_INACTIVE"
Request the inactive \s-1XML,\s0 instead of the current possibly live config.
.SH "AUTHORS"
.IX Header "AUTHORS"
Daniel P. Berrange <berrange@redhat.com>
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
Copyright (C) 2006\-2009 Red Hat
Copyright (C) 2006\-2007 Daniel P. Berrange
.SH "LICENSE"
.IX Header "LICENSE"
This program is free software; you can redistribute it and/or modify
it under the terms of either the \s-1GNU\s0 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 \s-1README\s0 file.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Sys::Virt, Sys::Virt::Error, \f(CW\*(C`http://libvirt.org\*(C'\fR