.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" 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
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    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 >0, 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
.\" ========================================================================
.\"
.IX Title "Sys::Virt::NWFilter 3pm"
.TH Sys::Virt::NWFilter 3pm 2024-01-21 "perl v5.38.2" "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::NWFilter \- Represent & manage a libvirt virtual network
.SH DESCRIPTION
.IX Header "DESCRIPTION"
The \f(CW\*(C`Sys::Virt::NWFilter\*(C'\fR module represents a virtual network managed
by the virtual machine monitor.
.SH METHODS
.IX Header "METHODS"
.ie n .IP "my $uuid = $filter\->\fBget_uuid()\fR" 4
.el .IP "my \f(CW$uuid\fR = \f(CW$filter\fR\->\fBget_uuid()\fR" 4
.IX Item "my $uuid = $filter->get_uuid()"
Returns a 16 byte long string containing the raw globally unique identifier
(UUID) for the network.
.ie n .IP "my $uuid = $filter\->\fBget_uuid_string()\fR" 4
.el .IP "my \f(CW$uuid\fR = \f(CW$filter\fR\->\fBget_uuid_string()\fR" 4
.IX Item "my $uuid = $filter->get_uuid_string()"
Returns a printable string representation of the raw UUID, in the format
\&'XXXXXXXX\-XXXX\-XXXX\-XXXX\-XXXXXXXXXXXX'.
.ie n .IP "my $name = $filter\->\fBget_name()\fR" 4
.el .IP "my \f(CW$name\fR = \f(CW$filter\fR\->\fBget_name()\fR" 4
.IX Item "my $name = $filter->get_name()"
Returns a string with a locally unique name of the network
.ie n .IP "my $xml = $filter\->\fBget_xml_description()\fR" 4
.el .IP "my \f(CW$xml\fR = \f(CW$filter\fR\->\fBget_xml_description()\fR" 4
.IX Item "my $xml = $filter->get_xml_description()"
Returns an XML document containing a complete description of
the network's configuration
.ie n .IP $filter\->\fBundefine()\fR 4
.el .IP \f(CW$filter\fR\->\fBundefine()\fR 4
.IX Item "$filter->undefine()"
Remove the configuration associated with a network filter previously defined
with the \f(CW\*(C`define_nwfilter\*(C'\fR method in Sys::Virt.
.SH CONSTANTS
.IX Header "CONSTANTS"
This section documents constants that are used with various
APIs described above
.SS "NWFILTER DEFINE"
.IX Subsection "NWFILTER DEFINE"
The following constants can be used to control the behaviour
of network filter define operations
.IP Sys::Virt::NWFilter::DEFINE_VALIDATE 4
.IX Item "Sys::Virt::NWFilter::DEFINE_VALIDATE"
Validate the XML document against the XML schema
.SH AUTHORS
.IX Header "AUTHORS"
Daniel P. Berrange <berrange@redhat.com>
.SH COPYRIGHT
.IX Header "COPYRIGHT"
Copyright (C) 2006 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 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.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Sys::Virt, Sys::Virt::Error, \f(CW\*(C`http://libvirt.org\*(C'\fR