<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml">
<!--
This file is autogenerated from html/libvirt-libvirt-nwfilter.html.in
Do not edit this file. Changes will be lost.
-->
<!--
This page was generated at Sun Jun 30 20:35:18 UTC 2019.
-->
<head>
<meta charset="UTF-8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<link rel="stylesheet" type="text/css" href="../main.css"/>
<link rel="apple-touch-icon" sizes="180x180" href="/apple-touch-icon.png"/>
<link rel="icon" type="image/png" sizes="32x32" href="/favicon-32x32.png"/>
<link rel="icon" type="image/png" sizes="16x16" href="/favicon-16x16.png"/>
<link rel="manifest" href="/manifest.json"/>
<meta name="theme-color" content="#ffffff"/>
<title>libvirt: Module libvirt-nwfilter from libvirt</title>
<meta name="description" content="libvirt, virtualization, virtualization API"/>
<script type="text/javascript" src="../js/main.js">
<!--// forces non-empty element-->
</script>
</head>
<body onload="pageload()">
<div id="body">
<div id="content">
<h1>Module libvirt-nwfilter from libvirt</h1>
<p>Provides APIs for the management of nwfilters Copyright (C) 2006-2014 Red Hat, Inc. This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version. This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details. You should have received a copy of the GNU Lesser General Public License along with this library. If not, see <a href="http://www.gnu.org/licenses/">http://www.gnu.org/licenses/</a>.</p>
<h2>Table of Contents</h2>
<h3>
<a href="#types">Types</a>
</h3>
<pre class="api"><span class="keyword">typedef</span> <span class="type">struct _virNWFilter</span> <a href="#virNWFilter">virNWFilter</a>
<span class="keyword">typedef</span> <span class="type">struct _virNWFilterBinding</span> <a href="#virNWFilterBinding">virNWFilterBinding</a>
<span class="keyword">typedef</span> <span class="type"><a href="libvirt-libvirt-nwfilter.html#virNWFilterBinding">virNWFilterBinding</a> *</span> <a name="virNWFilterBindingPtr">virNWFilterBindingPtr</a>
<span class="keyword">typedef</span> <span class="type"><a href="libvirt-libvirt-nwfilter.html#virNWFilter">virNWFilter</a> *</span> <a name="virNWFilterPtr">virNWFilterPtr</a>
</pre>
<h3>
<a href="#functions">Functions</a>
</h3>
<pre class="api"><span class="type">int</span> <a href="#virConnectListAllNWFilterBindings">virConnectListAllNWFilterBindings</a> (<span class="type"><a href="libvirt-libvirt-host.html#virConnectPtr">virConnectPtr</a></span> conn, <br/> <span class="type"><a href="libvirt-libvirt-nwfilter.html#virNWFilterBindingPtr">virNWFilterBindingPtr</a> **</span> bindings, <br/> <span class="type">unsigned int</span> flags)
<span class="type">int</span> <a href="#virConnectListAllNWFilters">virConnectListAllNWFilters</a> (<span class="type"><a href="libvirt-libvirt-host.html#virConnectPtr">virConnectPtr</a></span> conn, <br/> <span class="type"><a href="libvirt-libvirt-nwfilter.html#virNWFilterPtr">virNWFilterPtr</a> **</span> filters, <br/> <span class="type">unsigned int</span> flags)
<span class="type">int</span> <a href="#virConnectListNWFilters">virConnectListNWFilters</a> (<span class="type"><a href="libvirt-libvirt-host.html#virConnectPtr">virConnectPtr</a></span> conn, <br/> <span class="type">char ** const</span> names, <br/> <span class="type">int</span> maxnames)
<span class="type">int</span> <a href="#virConnectNumOfNWFilters">virConnectNumOfNWFilters</a> (<span class="type"><a href="libvirt-libvirt-host.html#virConnectPtr">virConnectPtr</a></span> conn)
<span class="type"><a href="libvirt-libvirt-nwfilter.html#virNWFilterBindingPtr">virNWFilterBindingPtr</a></span> <a href="#virNWFilterBindingCreateXML">virNWFilterBindingCreateXML</a> (<span class="type"><a href="libvirt-libvirt-host.html#virConnectPtr">virConnectPtr</a></span> conn, <br/> <span class="type">const char *</span> xml, <br/> <span class="type">unsigned int</span> flags)
<span class="type">int</span> <a href="#virNWFilterBindingDelete">virNWFilterBindingDelete</a> (<span class="type"><a href="libvirt-libvirt-nwfilter.html#virNWFilterBindingPtr">virNWFilterBindingPtr</a></span> binding)
<span class="type">int</span> <a href="#virNWFilterBindingFree">virNWFilterBindingFree</a> (<span class="type"><a href="libvirt-libvirt-nwfilter.html#virNWFilterBindingPtr">virNWFilterBindingPtr</a></span> binding)
<span class="type">const char *</span> <a href="#virNWFilterBindingGetFilterName">virNWFilterBindingGetFilterName</a> (<span class="type"><a href="libvirt-libvirt-nwfilter.html#virNWFilterBindingPtr">virNWFilterBindingPtr</a></span> binding)
<span class="type">const char *</span> <a href="#virNWFilterBindingGetPortDev">virNWFilterBindingGetPortDev</a> (<span class="type"><a href="libvirt-libvirt-nwfilter.html#virNWFilterBindingPtr">virNWFilterBindingPtr</a></span> binding)
<span class="type">char *</span> <a href="#virNWFilterBindingGetXMLDesc">virNWFilterBindingGetXMLDesc</a> (<span class="type"><a href="libvirt-libvirt-nwfilter.html#virNWFilterBindingPtr">virNWFilterBindingPtr</a></span> binding, <br/> <span class="type">unsigned int</span> flags)
<span class="type"><a href="libvirt-libvirt-nwfilter.html#virNWFilterBindingPtr">virNWFilterBindingPtr</a></span> <a href="#virNWFilterBindingLookupByPortDev">virNWFilterBindingLookupByPortDev</a> (<span class="type"><a href="libvirt-libvirt-host.html#virConnectPtr">virConnectPtr</a></span> conn, <br/> <span class="type">const char *</span> portdev)
<span class="type">int</span> <a href="#virNWFilterBindingRef">virNWFilterBindingRef</a> (<span class="type"><a href="libvirt-libvirt-nwfilter.html#virNWFilterBindingPtr">virNWFilterBindingPtr</a></span> binding)
<span class="type"><a href="libvirt-libvirt-nwfilter.html#virNWFilterPtr">virNWFilterPtr</a></span> <a href="#virNWFilterDefineXML">virNWFilterDefineXML</a> (<span class="type"><a href="libvirt-libvirt-host.html#virConnectPtr">virConnectPtr</a></span> conn, <br/> <span class="type">const char *</span> xmlDesc)
<span class="type">int</span> <a href="#virNWFilterFree">virNWFilterFree</a> (<span class="type"><a href="libvirt-libvirt-nwfilter.html#virNWFilterPtr">virNWFilterPtr</a></span> nwfilter)
<span class="type">const char *</span> <a href="#virNWFilterGetName">virNWFilterGetName</a> (<span class="type"><a href="libvirt-libvirt-nwfilter.html#virNWFilterPtr">virNWFilterPtr</a></span> nwfilter)
<span class="type">int</span> <a href="#virNWFilterGetUUID">virNWFilterGetUUID</a> (<span class="type"><a href="libvirt-libvirt-nwfilter.html#virNWFilterPtr">virNWFilterPtr</a></span> nwfilter, <br/> <span class="type">unsigned char *</span> uuid)
<span class="type">int</span> <a href="#virNWFilterGetUUIDString">virNWFilterGetUUIDString</a> (<span class="type"><a href="libvirt-libvirt-nwfilter.html#virNWFilterPtr">virNWFilterPtr</a></span> nwfilter, <br/> <span class="type">char *</span> buf)
<span class="type">char *</span> <a href="#virNWFilterGetXMLDesc">virNWFilterGetXMLDesc</a> (<span class="type"><a href="libvirt-libvirt-nwfilter.html#virNWFilterPtr">virNWFilterPtr</a></span> nwfilter, <br/> <span class="type">unsigned int</span> flags)
<span class="type"><a href="libvirt-libvirt-nwfilter.html#virNWFilterPtr">virNWFilterPtr</a></span> <a href="#virNWFilterLookupByName">virNWFilterLookupByName</a> (<span class="type"><a href="libvirt-libvirt-host.html#virConnectPtr">virConnectPtr</a></span> conn, <br/> <span class="type">const char *</span> name)
<span class="type"><a href="libvirt-libvirt-nwfilter.html#virNWFilterPtr">virNWFilterPtr</a></span> <a href="#virNWFilterLookupByUUID">virNWFilterLookupByUUID</a> (<span class="type"><a href="libvirt-libvirt-host.html#virConnectPtr">virConnectPtr</a></span> conn, <br/> <span class="type">const unsigned char *</span> uuid)
<span class="type"><a href="libvirt-libvirt-nwfilter.html#virNWFilterPtr">virNWFilterPtr</a></span> <a href="#virNWFilterLookupByUUIDString">virNWFilterLookupByUUIDString</a> (<span class="type"><a href="libvirt-libvirt-host.html#virConnectPtr">virConnectPtr</a></span> conn, <br/> <span class="type">const char *</span> uuidstr)
<span class="type">int</span> <a href="#virNWFilterRef">virNWFilterRef</a> (<span class="type"><a href="libvirt-libvirt-nwfilter.html#virNWFilterPtr">virNWFilterPtr</a></span> nwfilter)
<span class="type">int</span> <a href="#virNWFilterUndefine">virNWFilterUndefine</a> (<span class="type"><a href="libvirt-libvirt-nwfilter.html#virNWFilterPtr">virNWFilterPtr</a></span> nwfilter)
</pre>
<h2>Description</h2>
<h3>
<a name="types">Types</a>
</h3>
<h3>
<a name="virNWFilter">
<code>virNWFilter</code>
</a>
</h3>
<div class="api">
<pre><span class="keyword">struct </span>virNWFilter {
</pre>
<div class="undisclosed">The content of this structure is not made public by the API</div>
<pre>
}
</pre>
</div>
<h3>
<a name="virNWFilterBinding">
<code>virNWFilterBinding</code>
</a>
</h3>
<div class="api">
<pre><span class="keyword">struct </span>virNWFilterBinding {
</pre>
<div class="undisclosed">The content of this structure is not made public by the API</div>
<pre>
}
</pre>
</div>
<h3>
<a name="functions">Functions</a>
</h3>
<h3>
<a name="virConnectListAllNWFilterBindings">
<code>virConnectListAllNWFilterBindings</code>
</a>
</h3>
<pre class="api"><span class="type">int</span> virConnectListAllNWFilterBindings (<span class="type"><a href="libvirt-libvirt-host.html#virConnectPtr">virConnectPtr</a></span> conn,
<span class="type"><a href="libvirt-libvirt-nwfilter.html#virNWFilterBindingPtr">virNWFilterBindingPtr</a> **</span> bindings,
<span class="type">unsigned int</span> flags)</pre>
<div class="description">
<p>Collect the list of network filters, and allocate an array to store those objects.</p>
</div>
<dl class="variablelist">
<dt>conn</dt>
<dd>Pointer to the hypervisor connection.</dd>
<dt>bindings</dt>
<dd>Pointer to a variable to store the array containing the network filter objects or NULL if the list is not required (just returns number of network filters).</dd>
<dt>flags</dt>
<dd>extra flags; not used yet, so callers should always pass 0</dd>
<dt>Returns</dt>
<dd>the number of network filters found or -1 and sets @filters to NULL in case of error. On success, the array stored into @filters is guaranteed to have an extra allocated element set to NULL but not included in the return count, to make iteration easier. The caller is responsible for calling <a href="libvirt-libvirt-nwfilter.html#virNWFilterFree">virNWFilterFree</a>() on each array element, then calling free() on @filters.</dd>
</dl>
<div class="acl"/>
<h3>
<a name="virConnectListAllNWFilters">
<code>virConnectListAllNWFilters</code>
</a>
</h3>
<pre class="api"><span class="type">int</span> virConnectListAllNWFilters (<span class="type"><a href="libvirt-libvirt-host.html#virConnectPtr">virConnectPtr</a></span> conn,
<span class="type"><a href="libvirt-libvirt-nwfilter.html#virNWFilterPtr">virNWFilterPtr</a> **</span> filters,
<span class="type">unsigned int</span> flags)</pre>
<div class="description">
<p>Collect the list of network filters, and allocate an array to store those objects.</p>
</div>
<dl class="variablelist">
<dt>conn</dt>
<dd>Pointer to the hypervisor connection.</dd>
<dt>filters</dt>
<dd>Pointer to a variable to store the array containing the network filter objects or NULL if the list is not required (just returns number of network filters).</dd>
<dt>flags</dt>
<dd>extra flags; not used yet, so callers should always pass 0</dd>
<dt>Returns</dt>
<dd>the number of network filters found or -1 and sets @filters to NULL in case of error. On success, the array stored into @filters is guaranteed to have an extra allocated element set to NULL but not included in the return count, to make iteration easier. The caller is responsible for calling <a href="libvirt-libvirt-nwfilter.html#virNWFilterFree">virNWFilterFree</a>() on each array element, then calling free() on @filters.</dd>
</dl>
<div class="acl"/>
<h3>
<a name="virConnectListNWFilters">
<code>virConnectListNWFilters</code>
</a>
</h3>
<pre class="api"><span class="type">int</span> virConnectListNWFilters (<span class="type"><a href="libvirt-libvirt-host.html#virConnectPtr">virConnectPtr</a></span> conn,
<span class="type">char ** const</span> names,
<span class="type">int</span> maxnames)</pre>
<div class="description">
<p>Collect the list of network filters, and store their names in @names</p>
</div>
<dl class="variablelist">
<dt>conn</dt>
<dd>pointer to the hypervisor connection</dd>
<dt>names</dt>
<dd>array to collect the list of names of network filters</dd>
<dt>maxnames</dt>
<dd>size of @names</dd>
<dt>Returns</dt>
<dd>the number of network filters found or -1 in case of error</dd>
</dl>
<div class="acl"/>
<h3>
<a name="virConnectNumOfNWFilters">
<code>virConnectNumOfNWFilters</code>
</a>
</h3>
<pre class="api"><span class="type">int</span> virConnectNumOfNWFilters (<span class="type"><a href="libvirt-libvirt-host.html#virConnectPtr">virConnectPtr</a></span> conn)</pre>
<div class="description">
<p>Provides the number of nwfilters.</p>
</div>
<dl class="variablelist">
<dt>conn</dt>
<dd>pointer to the hypervisor connection</dd>
<dt>Returns</dt>
<dd>the number of nwfilters found or -1 in case of error</dd>
</dl>
<div class="acl"/>
<h3>
<a name="virNWFilterBindingCreateXML">
<code>virNWFilterBindingCreateXML</code>
</a>
</h3>
<pre class="api"><span class="type"><a href="libvirt-libvirt-nwfilter.html#virNWFilterBindingPtr">virNWFilterBindingPtr</a></span> virNWFilterBindingCreateXML (<span class="type"><a href="libvirt-libvirt-host.html#virConnectPtr">virConnectPtr</a></span> conn,
<span class="type">const char *</span> xml,
<span class="type">unsigned int</span> flags)</pre>
<div class="description">
<p>Define a new network filter, based on an XML description similar to the one returned by <a href="libvirt-libvirt-nwfilter.html#virNWFilterGetXMLDesc">virNWFilterGetXMLDesc</a>(). This API may be used to associate a filter with a currently running guest that does not have a filter defined for a specific network port. Since the bindings are generally automatically managed by the hypervisor, using this command to define a filter for a network port and then starting the guest afterwards may prevent the guest from starting if it attempts to use the network port and finds a filter already defined.</p>
<p><a href="libvirt-libvirt-nwfilter.html#virNWFilterFree">virNWFilterFree</a> should be used to free the resources after the binding object is no longer needed.</p>
</div>
<dl class="variablelist">
<dt>conn</dt>
<dd>pointer to the hypervisor connection</dd>
<dt>xml</dt>
<dd>an XML description of the binding</dd>
<dt>flags</dt>
<dd>currently unused, pass 0</dd>
<dt>Returns</dt>
<dd>a new binding object or NULL in case of failure</dd>
</dl>
<div class="acl"/>
<h3>
<a name="virNWFilterBindingDelete">
<code>virNWFilterBindingDelete</code>
</a>
</h3>
<pre class="api"><span class="type">int</span> virNWFilterBindingDelete (<span class="type"><a href="libvirt-libvirt-nwfilter.html#virNWFilterBindingPtr">virNWFilterBindingPtr</a></span> binding)</pre>
<div class="description">
<p>Delete the binding object. This does not free the associated <a href="libvirt-libvirt-nwfilter.html#virNWFilterBindingPtr">virNWFilterBindingPtr</a> object. This API may be used to remove the network port binding filter currently in use for the guest while the guest is running without needing to restart the guest. Restoring the network port binding filter for the running guest would be accomplished by using <a href="libvirt-libvirt-nwfilter.html#virNWFilterBindingCreateXML">virNWFilterBindingCreateXML</a>.</p>
</div>
<dl class="variablelist">
<dt>binding</dt>
<dd>a binding object</dd>
<dt>Returns</dt>
<dd>0 in case of success and -1 in case of failure.</dd>
</dl>
<div class="acl"/>
<h3>
<a name="virNWFilterBindingFree">
<code>virNWFilterBindingFree</code>
</a>
</h3>
<pre class="api"><span class="type">int</span> virNWFilterBindingFree (<span class="type"><a href="libvirt-libvirt-nwfilter.html#virNWFilterBindingPtr">virNWFilterBindingPtr</a></span> binding)</pre>
<div class="description">
<p>Free the binding object. The running instance is kept alive. The data structure is freed and should not be used thereafter.</p>
</div>
<dl class="variablelist">
<dt>binding</dt>
<dd>a binding object</dd>
<dt>Returns</dt>
<dd>0 in case of success and -1 in case of failure.</dd>
</dl>
<div class="acl"/>
<h3>
<a name="virNWFilterBindingGetFilterName">
<code>virNWFilterBindingGetFilterName</code>
</a>
</h3>
<pre class="api"><span class="type">const char *</span> virNWFilterBindingGetFilterName (<span class="type"><a href="libvirt-libvirt-nwfilter.html#virNWFilterBindingPtr">virNWFilterBindingPtr</a></span> binding)</pre>
<div class="description">
<p>Get the filter name for the network filter binding</p>
</div>
<dl class="variablelist">
<dt>binding</dt>
<dd>a binding object</dd>
<dt>Returns</dt>
<dd>a pointer to the name or NULL, the string need not be deallocated its lifetime will be the same as the binding object.</dd>
</dl>
<div class="acl"/>
<h3>
<a name="virNWFilterBindingGetPortDev">
<code>virNWFilterBindingGetPortDev</code>
</a>
</h3>
<pre class="api"><span class="type">const char *</span> virNWFilterBindingGetPortDev (<span class="type"><a href="libvirt-libvirt-nwfilter.html#virNWFilterBindingPtr">virNWFilterBindingPtr</a></span> binding)</pre>
<div class="description">
<p>Get the port dev name for the network filter binding</p>
</div>
<dl class="variablelist">
<dt>binding</dt>
<dd>a binding object</dd>
<dt>Returns</dt>
<dd>a pointer to the name or NULL, the string need not be deallocated its lifetime will be the same as the binding object.</dd>
</dl>
<div class="acl"/>
<h3>
<a name="virNWFilterBindingGetXMLDesc">
<code>virNWFilterBindingGetXMLDesc</code>
</a>
</h3>
<pre class="api"><span class="type">char *</span> virNWFilterBindingGetXMLDesc (<span class="type"><a href="libvirt-libvirt-nwfilter.html#virNWFilterBindingPtr">virNWFilterBindingPtr</a></span> binding,
<span class="type">unsigned int</span> flags)</pre>
<div class="description">
<p>Provide an XML description of the network filter. The description may be reused later to redefine the network filter with virNWFilterCreateXML().</p>
</div>
<dl class="variablelist">
<dt>binding</dt>
<dd>a binding object</dd>
<dt>flags</dt>
<dd>extra flags; not used yet, so callers should always pass 0</dd>
<dt>Returns</dt>
<dd>a 0 terminated UTF-8 encoded XML instance, or NULL in case of error. The caller must free() the returned value.</dd>
</dl>
<div class="acl"/>
<h3>
<a name="virNWFilterBindingLookupByPortDev">
<code>virNWFilterBindingLookupByPortDev</code>
</a>
</h3>
<pre class="api"><span class="type"><a href="libvirt-libvirt-nwfilter.html#virNWFilterBindingPtr">virNWFilterBindingPtr</a></span> virNWFilterBindingLookupByPortDev (<span class="type"><a href="libvirt-libvirt-host.html#virConnectPtr">virConnectPtr</a></span> conn,
<span class="type">const char *</span> portdev)</pre>
<div class="description">
<p>Try to lookup a network filter binding on the given hypervisor based on network port device name.</p>
<p><a href="libvirt-libvirt-nwfilter.html#virNWFilterBindingFree">virNWFilterBindingFree</a> should be used to free the resources after the binding object is no longer needed.</p>
</div>
<dl class="variablelist">
<dt>conn</dt>
<dd>pointer to the hypervisor connection</dd>
<dt>portdev</dt>
<dd>name for the network port device</dd>
<dt>Returns</dt>
<dd>a new binding object or NULL in case of failure. If the network filter cannot be found, then <a href="libvirt-virterror.html#VIR_ERR_NO_NWFILTER_BINDING">VIR_ERR_NO_NWFILTER_BINDING</a> error is raised.</dd>
</dl>
<div class="acl"/>
<h3>
<a name="virNWFilterBindingRef">
<code>virNWFilterBindingRef</code>
</a>
</h3>
<pre class="api"><span class="type">int</span> virNWFilterBindingRef (<span class="type"><a href="libvirt-libvirt-nwfilter.html#virNWFilterBindingPtr">virNWFilterBindingPtr</a></span> binding)</pre>
<div class="description">
<p>Increment the reference count on the binding. For each additional call to this method, there shall be a corresponding call to <a href="libvirt-libvirt-nwfilter.html#virNWFilterFree">virNWFilterFree</a> to release the reference count, once the caller no longer needs the reference to this object.</p>
<p>This method is typically useful for applications where multiple threads are using a connection, and it is required that the connection remain open until all threads have finished using it. ie, each new thread using an binding would increment the reference count.</p>
</div>
<dl class="variablelist">
<dt>binding</dt>
<dd>the binding to hold a reference on</dd>
<dt>Returns</dt>
<dd>0 in case of success, -1 in case of failure.</dd>
</dl>
<div class="acl"/>
<h3>
<a name="virNWFilterDefineXML">
<code>virNWFilterDefineXML</code>
</a>
</h3>
<pre class="api"><span class="type"><a href="libvirt-libvirt-nwfilter.html#virNWFilterPtr">virNWFilterPtr</a></span> virNWFilterDefineXML (<span class="type"><a href="libvirt-libvirt-host.html#virConnectPtr">virConnectPtr</a></span> conn,
<span class="type">const char *</span> xmlDesc)</pre>
<div class="description">
<p>Define a new network filter, based on an XML description similar to the one returned by <a href="libvirt-libvirt-nwfilter.html#virNWFilterGetXMLDesc">virNWFilterGetXMLDesc</a>()</p>
<p><a href="libvirt-libvirt-nwfilter.html#virNWFilterFree">virNWFilterFree</a> should be used to free the resources after the nwfilter object is no longer needed.</p>
</div>
<dl class="variablelist">
<dt>conn</dt>
<dd>pointer to the hypervisor connection</dd>
<dt>xmlDesc</dt>
<dd>an XML description of the nwfilter</dd>
<dt>Returns</dt>
<dd>a new nwfilter object or NULL in case of failure</dd>
</dl>
<div class="acl"/>
<h3>
<a name="virNWFilterFree">
<code>virNWFilterFree</code>
</a>
</h3>
<pre class="api"><span class="type">int</span> virNWFilterFree (<span class="type"><a href="libvirt-libvirt-nwfilter.html#virNWFilterPtr">virNWFilterPtr</a></span> nwfilter)</pre>
<div class="description">
<p>Free the nwfilter object. The running instance is kept alive. The data structure is freed and should not be used thereafter.</p>
</div>
<dl class="variablelist">
<dt>nwfilter</dt>
<dd>a nwfilter object</dd>
<dt>Returns</dt>
<dd>0 in case of success and -1 in case of failure.</dd>
</dl>
<div class="acl"/>
<h3>
<a name="virNWFilterGetName">
<code>virNWFilterGetName</code>
</a>
</h3>
<pre class="api"><span class="type">const char *</span> virNWFilterGetName (<span class="type"><a href="libvirt-libvirt-nwfilter.html#virNWFilterPtr">virNWFilterPtr</a></span> nwfilter)</pre>
<div class="description">
<p>Get the public name for the network filter</p>
</div>
<dl class="variablelist">
<dt>nwfilter</dt>
<dd>a nwfilter object</dd>
<dt>Returns</dt>
<dd>a pointer to the name or NULL, the string need not be deallocated its lifetime will be the same as the nwfilter object.</dd>
</dl>
<div class="acl"/>
<h3>
<a name="virNWFilterGetUUID">
<code>virNWFilterGetUUID</code>
</a>
</h3>
<pre class="api"><span class="type">int</span> virNWFilterGetUUID (<span class="type"><a href="libvirt-libvirt-nwfilter.html#virNWFilterPtr">virNWFilterPtr</a></span> nwfilter,
<span class="type">unsigned char *</span> uuid)</pre>
<div class="description">
<p>Get the UUID for a network filter</p>
</div>
<dl class="variablelist">
<dt>nwfilter</dt>
<dd>a nwfilter object</dd>
<dt>uuid</dt>
<dd>pointer to a <a href="libvirt-libvirt-host.html#VIR_UUID_BUFLEN">VIR_UUID_BUFLEN</a> bytes array</dd>
<dt>Returns</dt>
<dd>-1 in case of error, 0 in case of success</dd>
</dl>
<div class="acl"/>
<h3>
<a name="virNWFilterGetUUIDString">
<code>virNWFilterGetUUIDString</code>
</a>
</h3>
<pre class="api"><span class="type">int</span> virNWFilterGetUUIDString (<span class="type"><a href="libvirt-libvirt-nwfilter.html#virNWFilterPtr">virNWFilterPtr</a></span> nwfilter,
<span class="type">char *</span> buf)</pre>
<div class="description">
<p>Get the UUID for a network filter as string. For more information about UUID see RFC4122.</p>
</div>
<dl class="variablelist">
<dt>nwfilter</dt>
<dd>a nwfilter object</dd>
<dt>buf</dt>
<dd>pointer to a <a href="libvirt-libvirt-host.html#VIR_UUID_STRING_BUFLEN">VIR_UUID_STRING_BUFLEN</a> bytes array</dd>
<dt>Returns</dt>
<dd>-1 in case of error, 0 in case of success</dd>
</dl>
<div class="acl"/>
<h3>
<a name="virNWFilterGetXMLDesc">
<code>virNWFilterGetXMLDesc</code>
</a>
</h3>
<pre class="api"><span class="type">char *</span> virNWFilterGetXMLDesc (<span class="type"><a href="libvirt-libvirt-nwfilter.html#virNWFilterPtr">virNWFilterPtr</a></span> nwfilter,
<span class="type">unsigned int</span> flags)</pre>
<div class="description">
<p>Provide an XML description of the network filter. The description may be reused later to redefine the network filter with virNWFilterCreateXML().</p>
</div>
<dl class="variablelist">
<dt>nwfilter</dt>
<dd>a nwfilter object</dd>
<dt>flags</dt>
<dd>extra flags; not used yet, so callers should always pass 0</dd>
<dt>Returns</dt>
<dd>a 0 terminated UTF-8 encoded XML instance, or NULL in case of error. The caller must free() the returned value.</dd>
</dl>
<div class="acl"/>
<h3>
<a name="virNWFilterLookupByName">
<code>virNWFilterLookupByName</code>
</a>
</h3>
<pre class="api"><span class="type"><a href="libvirt-libvirt-nwfilter.html#virNWFilterPtr">virNWFilterPtr</a></span> virNWFilterLookupByName (<span class="type"><a href="libvirt-libvirt-host.html#virConnectPtr">virConnectPtr</a></span> conn,
<span class="type">const char *</span> name)</pre>
<div class="description">
<p>Try to lookup a network filter on the given hypervisor based on its name.</p>
<p><a href="libvirt-libvirt-nwfilter.html#virNWFilterFree">virNWFilterFree</a> should be used to free the resources after the nwfilter object is no longer needed.</p>
</div>
<dl class="variablelist">
<dt>conn</dt>
<dd>pointer to the hypervisor connection</dd>
<dt>name</dt>
<dd>name for the network filter</dd>
<dt>Returns</dt>
<dd>a new nwfilter object or NULL in case of failure. If the network filter cannot be found, then <a href="libvirt-virterror.html#VIR_ERR_NO_NWFILTER">VIR_ERR_NO_NWFILTER</a> error is raised.</dd>
</dl>
<div class="acl"/>
<h3>
<a name="virNWFilterLookupByUUID">
<code>virNWFilterLookupByUUID</code>
</a>
</h3>
<pre class="api"><span class="type"><a href="libvirt-libvirt-nwfilter.html#virNWFilterPtr">virNWFilterPtr</a></span> virNWFilterLookupByUUID (<span class="type"><a href="libvirt-libvirt-host.html#virConnectPtr">virConnectPtr</a></span> conn,
<span class="type">const unsigned char *</span> uuid)</pre>
<div class="description">
<p>Try to lookup a network filter on the given hypervisor based on its UUID.</p>
<p><a href="libvirt-libvirt-nwfilter.html#virNWFilterFree">virNWFilterFree</a> should be used to free the resources after the nwfilter object is no longer needed.</p>
</div>
<dl class="variablelist">
<dt>conn</dt>
<dd>pointer to the hypervisor connection</dd>
<dt>uuid</dt>
<dd>the raw UUID for the network filter</dd>
<dt>Returns</dt>
<dd>a new nwfilter object or NULL in case of failure. If the nwfdilter cannot be found, then <a href="libvirt-virterror.html#VIR_ERR_NO_NWFILTER">VIR_ERR_NO_NWFILTER</a> error is raised.</dd>
</dl>
<div class="acl"/>
<h3>
<a name="virNWFilterLookupByUUIDString">
<code>virNWFilterLookupByUUIDString</code>
</a>
</h3>
<pre class="api"><span class="type"><a href="libvirt-libvirt-nwfilter.html#virNWFilterPtr">virNWFilterPtr</a></span> virNWFilterLookupByUUIDString (<span class="type"><a href="libvirt-libvirt-host.html#virConnectPtr">virConnectPtr</a></span> conn,
<span class="type">const char *</span> uuidstr)</pre>
<div class="description">
<p>Try to lookup an nwfilter on the given hypervisor based on its UUID.</p>
<p><a href="libvirt-libvirt-nwfilter.html#virNWFilterFree">virNWFilterFree</a> should be used to free the resources after the nwfilter object is no longer needed.</p>
</div>
<dl class="variablelist">
<dt>conn</dt>
<dd>pointer to the hypervisor connection</dd>
<dt>uuidstr</dt>
<dd>the string UUID for the nwfilter</dd>
<dt>Returns</dt>
<dd>a new nwfilter object or NULL in case of failure. If the nwfilter cannot be found, then <a href="libvirt-virterror.html#VIR_ERR_NO_NWFILTER">VIR_ERR_NO_NWFILTER</a> error is raised.</dd>
</dl>
<div class="acl"/>
<h3>
<a name="virNWFilterRef">
<code>virNWFilterRef</code>
</a>
</h3>
<pre class="api"><span class="type">int</span> virNWFilterRef (<span class="type"><a href="libvirt-libvirt-nwfilter.html#virNWFilterPtr">virNWFilterPtr</a></span> nwfilter)</pre>
<div class="description">
<p>Increment the reference count on the nwfilter. For each additional call to this method, there shall be a corresponding call to <a href="libvirt-libvirt-nwfilter.html#virNWFilterFree">virNWFilterFree</a> to release the reference count, once the caller no longer needs the reference to this object.</p>
<p>This method is typically useful for applications where multiple threads are using a connection, and it is required that the connection remain open until all threads have finished using it. ie, each new thread using an nwfilter would increment the reference count.</p>
</div>
<dl class="variablelist">
<dt>nwfilter</dt>
<dd>the nwfilter to hold a reference on</dd>
<dt>Returns</dt>
<dd>0 in case of success, -1 in case of failure.</dd>
</dl>
<div class="acl"/>
<h3>
<a name="virNWFilterUndefine">
<code>virNWFilterUndefine</code>
</a>
</h3>
<pre class="api"><span class="type">int</span> virNWFilterUndefine (<span class="type"><a href="libvirt-libvirt-nwfilter.html#virNWFilterPtr">virNWFilterPtr</a></span> nwfilter)</pre>
<div class="description">
<p>Undefine the nwfilter object. This call will not succeed if a running VM is referencing the filter. This does not free the associated <a href="libvirt-libvirt-nwfilter.html#virNWFilterPtr">virNWFilterPtr</a> object.</p>
</div>
<dl class="variablelist">
<dt>nwfilter</dt>
<dd>a nwfilter object</dd>
<dt>Returns</dt>
<dd>0 in case of success and -1 in case of failure.</dd>
</dl>
<div class="acl"/>
</div>
</div>
<div id="nav">
<div id="home">
<a href="../index.html">Home</a>
</div>
<div id="jumplinks">
<ul>
<li>
<a href="../downloads.html">Download</a>
</li>
<li>
<a href="../contribute.html">Contribute</a>
</li>
<li>
<a href="../docs.html">Docs</a>
</li>
</ul>
</div>
<div id="search">
<form id="simplesearch" action="https://www.google.com/search" enctype="application/x-www-form-urlencoded" method="get">
<div>
<input id="searchsite" name="sitesearch" type="hidden" value="libvirt.org"/>
<input id="searchq" name="q" type="text" size="12" value=""/>
<input name="submit" type="submit" value="Go"/>
</div>
</form>
<div id="advancedsearch">
<span>
<input type="radio" name="what" id="whatwebsite" checked="checked" value="website"/>
<label for="whatwebsite">Website</label>
</span>
<span>
<input type="radio" name="what" id="whatwiki" value="wiki"/>
<label for="whatwiki">Wiki</label>
</span>
<span>
<input type="radio" name="what" id="whatdevs" value="devs"/>
<label for="whatdevs">Developers list</label>
</span>
<span>
<input type="radio" name="what" id="whatusers" value="users"/>
<label for="whatusers">Users list</label>
</span>
</div>
</div>
</div>
<div id="footer">
<div id="contact">
<h3>Contact</h3>
<ul>
<li>
<a href="../contact.html#email">email</a>
</li>
<li>
<a href="../contact.html#irc">irc</a>
</li>
</ul>
</div>
<div id="community">
<h3>Community</h3>
<ul>
<li>
<a href="https://twitter.com/hashtag/libvirt">twitter</a>
</li>
<li>
<a href="http://stackoverflow.com/questions/tagged/libvirt">stackoverflow</a>
</li>
<li>
<a href="http://serverfault.com/questions/tagged/libvirt">serverfault</a>
</li>
</ul>
</div>
<div id="conduct">
Participants in the libvirt project agree to abide by <a href="../governance.html#codeofconduct">the project code of conduct</a></div>
<br class="clear"/>
</div>
</body>
</html>
distrib
>
Mageia
>
7
>
armv7hl
>
media
>
core-updates
>
by-pkgid
>
0a67499d76b7ed32632abafb78e24a2f
>
files
>
142
