<?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-network.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-network 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-network from libvirt</h1>
<p>Provides APIs for the management of networks 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="#macros">Macros</a>
</h3>
<pre class="api"><span class="directive">#define</span> <a href="#VIR_NETWORK_EVENT_CALLBACK">VIR_NETWORK_EVENT_CALLBACK</a>
<span class="directive">#define</span> <a href="#VIR_NETWORK_PORT_BANDWIDTH_IN_AVERAGE">VIR_NETWORK_PORT_BANDWIDTH_IN_AVERAGE</a>
<span class="directive">#define</span> <a href="#VIR_NETWORK_PORT_BANDWIDTH_IN_BURST">VIR_NETWORK_PORT_BANDWIDTH_IN_BURST</a>
<span class="directive">#define</span> <a href="#VIR_NETWORK_PORT_BANDWIDTH_IN_FLOOR">VIR_NETWORK_PORT_BANDWIDTH_IN_FLOOR</a>
<span class="directive">#define</span> <a href="#VIR_NETWORK_PORT_BANDWIDTH_IN_PEAK">VIR_NETWORK_PORT_BANDWIDTH_IN_PEAK</a>
<span class="directive">#define</span> <a href="#VIR_NETWORK_PORT_BANDWIDTH_OUT_AVERAGE">VIR_NETWORK_PORT_BANDWIDTH_OUT_AVERAGE</a>
<span class="directive">#define</span> <a href="#VIR_NETWORK_PORT_BANDWIDTH_OUT_BURST">VIR_NETWORK_PORT_BANDWIDTH_OUT_BURST</a>
<span class="directive">#define</span> <a href="#VIR_NETWORK_PORT_BANDWIDTH_OUT_PEAK">VIR_NETWORK_PORT_BANDWIDTH_OUT_PEAK</a>
</pre>
<h3>
<a href="#types">Types</a>
</h3>
<pre class="api"><span class="keyword">typedef</span> <span class="keyword">enum</span> <a href="#virConnectListAllNetworksFlags">virConnectListAllNetworksFlags</a>
<span class="keyword">typedef</span> <span class="keyword">enum</span> <a href="#virIPAddrType">virIPAddrType</a>
<span class="keyword">typedef</span> <span class="type">struct _virNetwork</span> <a href="#virNetwork">virNetwork</a>
<span class="keyword">typedef</span> <span class="type">struct _virNetworkDHCPLease</span> <a href="#virNetworkDHCPLease">virNetworkDHCPLease</a>
<span class="keyword">typedef</span> <span class="type"><a href="libvirt-libvirt-network.html#virNetworkDHCPLease">virNetworkDHCPLease</a> *</span> <a name="virNetworkDHCPLeasePtr">virNetworkDHCPLeasePtr</a>
<span class="keyword">typedef</span> <span class="keyword">enum</span> <a href="#virNetworkEventID">virNetworkEventID</a>
<span class="keyword">typedef</span> <span class="keyword">enum</span> <a href="#virNetworkEventLifecycleType">virNetworkEventLifecycleType</a>
<span class="keyword">typedef</span> <span class="type">struct _virNetworkPort</span> <a href="#virNetworkPort">virNetworkPort</a>
<span class="keyword">typedef</span> <span class="keyword">enum</span> <a href="#virNetworkPortCreateFlags">virNetworkPortCreateFlags</a>
<span class="keyword">typedef</span> <span class="type"><a href="libvirt-libvirt-network.html#virNetworkPort">virNetworkPort</a> *</span> <a name="virNetworkPortPtr">virNetworkPortPtr</a>
<span class="keyword">typedef</span> <span class="type"><a href="libvirt-libvirt-network.html#virNetwork">virNetwork</a> *</span> <a name="virNetworkPtr">virNetworkPtr</a>
<span class="keyword">typedef</span> <span class="keyword">enum</span> <a href="#virNetworkUpdateCommand">virNetworkUpdateCommand</a>
<span class="keyword">typedef</span> <span class="keyword">enum</span> <a href="#virNetworkUpdateFlags">virNetworkUpdateFlags</a>
<span class="keyword">typedef</span> <span class="keyword">enum</span> <a href="#virNetworkUpdateSection">virNetworkUpdateSection</a>
<span class="keyword">typedef</span> <span class="keyword">enum</span> <a href="#virNetworkXMLFlags">virNetworkXMLFlags</a>
</pre>
<h3>
<a href="#functions">Functions</a>
</h3>
<pre class="api"><span class="type">int</span> <a href="#virConnectListAllNetworks">virConnectListAllNetworks</a> (<span class="type"><a href="libvirt-libvirt-host.html#virConnectPtr">virConnectPtr</a></span> conn, <br/> <span class="type"><a href="libvirt-libvirt-network.html#virNetworkPtr">virNetworkPtr</a> **</span> nets, <br/> <span class="type">unsigned int</span> flags)
<span class="type">int</span> <a href="#virConnectListDefinedNetworks">virConnectListDefinedNetworks</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="#virConnectListNetworks">virConnectListNetworks</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="#virConnectNetworkEventDeregisterAny">virConnectNetworkEventDeregisterAny</a> (<span class="type"><a href="libvirt-libvirt-host.html#virConnectPtr">virConnectPtr</a></span> conn, <br/> <span class="type">int</span> callbackID)
<span class="keyword">typedef</span> <a href="#virConnectNetworkEventGenericCallback">virConnectNetworkEventGenericCallback</a>
<span class="type">void</span> <a href="#virConnectNetworkEventGenericCallback">virConnectNetworkEventGenericCallback</a> (<span class="type"><a href="libvirt-libvirt-host.html#virConnectPtr">virConnectPtr</a></span> conn, <br/> <span class="type"><a href="libvirt-libvirt-network.html#virNetworkPtr">virNetworkPtr</a></span> net, <br/> <span class="type">void *</span> opaque)
<span class="keyword">typedef</span> <a href="#virConnectNetworkEventLifecycleCallback">virConnectNetworkEventLifecycleCallback</a>
<span class="type">void</span> <a href="#virConnectNetworkEventLifecycleCallback">virConnectNetworkEventLifecycleCallback</a> (<span class="type"><a href="libvirt-libvirt-host.html#virConnectPtr">virConnectPtr</a></span> conn, <br/> <span class="type"><a href="libvirt-libvirt-network.html#virNetworkPtr">virNetworkPtr</a></span> net, <br/> <span class="type">int</span> event, <br/> <span class="type">int</span> detail, <br/> <span class="type">void *</span> opaque)
<span class="type">int</span> <a href="#virConnectNetworkEventRegisterAny">virConnectNetworkEventRegisterAny</a> (<span class="type"><a href="libvirt-libvirt-host.html#virConnectPtr">virConnectPtr</a></span> conn, <br/> <span class="type"><a href="libvirt-libvirt-network.html#virNetworkPtr">virNetworkPtr</a></span> net, <br/> <span class="type">int</span> eventID, <br/> <span class="type"><a href="libvirt-libvirt-network.html#virConnectNetworkEventGenericCallback">virConnectNetworkEventGenericCallback</a></span> cb, <br/> <span class="type">void *</span> opaque, <br/> <span class="type"><a href="libvirt-libvirt-common.html#virFreeCallback">virFreeCallback</a></span> freecb)
<span class="type">int</span> <a href="#virConnectNumOfDefinedNetworks">virConnectNumOfDefinedNetworks</a> (<span class="type"><a href="libvirt-libvirt-host.html#virConnectPtr">virConnectPtr</a></span> conn)
<span class="type">int</span> <a href="#virConnectNumOfNetworks">virConnectNumOfNetworks</a> (<span class="type"><a href="libvirt-libvirt-host.html#virConnectPtr">virConnectPtr</a></span> conn)
<span class="type">int</span> <a href="#virNetworkCreate">virNetworkCreate</a> (<span class="type"><a href="libvirt-libvirt-network.html#virNetworkPtr">virNetworkPtr</a></span> network)
<span class="type"><a href="libvirt-libvirt-network.html#virNetworkPtr">virNetworkPtr</a></span> <a href="#virNetworkCreateXML">virNetworkCreateXML</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">void</span> <a href="#virNetworkDHCPLeaseFree">virNetworkDHCPLeaseFree</a> (<span class="type"><a href="libvirt-libvirt-network.html#virNetworkDHCPLeasePtr">virNetworkDHCPLeasePtr</a></span> lease)
<span class="type"><a href="libvirt-libvirt-network.html#virNetworkPtr">virNetworkPtr</a></span> <a href="#virNetworkDefineXML">virNetworkDefineXML</a> (<span class="type"><a href="libvirt-libvirt-host.html#virConnectPtr">virConnectPtr</a></span> conn, <br/> <span class="type">const char *</span> xml)
<span class="type">int</span> <a href="#virNetworkDestroy">virNetworkDestroy</a> (<span class="type"><a href="libvirt-libvirt-network.html#virNetworkPtr">virNetworkPtr</a></span> network)
<span class="type">int</span> <a href="#virNetworkFree">virNetworkFree</a> (<span class="type"><a href="libvirt-libvirt-network.html#virNetworkPtr">virNetworkPtr</a></span> network)
<span class="type">int</span> <a href="#virNetworkGetAutostart">virNetworkGetAutostart</a> (<span class="type"><a href="libvirt-libvirt-network.html#virNetworkPtr">virNetworkPtr</a></span> network, <br/> <span class="type">int *</span> autostart)
<span class="type">char *</span> <a href="#virNetworkGetBridgeName">virNetworkGetBridgeName</a> (<span class="type"><a href="libvirt-libvirt-network.html#virNetworkPtr">virNetworkPtr</a></span> network)
<span class="type"><a href="libvirt-libvirt-host.html#virConnectPtr">virConnectPtr</a></span> <a href="#virNetworkGetConnect">virNetworkGetConnect</a> (<span class="type"><a href="libvirt-libvirt-network.html#virNetworkPtr">virNetworkPtr</a></span> net)
<span class="type">int</span> <a href="#virNetworkGetDHCPLeases">virNetworkGetDHCPLeases</a> (<span class="type"><a href="libvirt-libvirt-network.html#virNetworkPtr">virNetworkPtr</a></span> network, <br/> <span class="type">const char *</span> mac, <br/> <span class="type"><a href="libvirt-libvirt-network.html#virNetworkDHCPLeasePtr">virNetworkDHCPLeasePtr</a> **</span> leases, <br/> <span class="type">unsigned int</span> flags)
<span class="type">const char *</span> <a href="#virNetworkGetName">virNetworkGetName</a> (<span class="type"><a href="libvirt-libvirt-network.html#virNetworkPtr">virNetworkPtr</a></span> network)
<span class="type">int</span> <a href="#virNetworkGetUUID">virNetworkGetUUID</a> (<span class="type"><a href="libvirt-libvirt-network.html#virNetworkPtr">virNetworkPtr</a></span> network, <br/> <span class="type">unsigned char *</span> uuid)
<span class="type">int</span> <a href="#virNetworkGetUUIDString">virNetworkGetUUIDString</a> (<span class="type"><a href="libvirt-libvirt-network.html#virNetworkPtr">virNetworkPtr</a></span> network, <br/> <span class="type">char *</span> buf)
<span class="type">char *</span> <a href="#virNetworkGetXMLDesc">virNetworkGetXMLDesc</a> (<span class="type"><a href="libvirt-libvirt-network.html#virNetworkPtr">virNetworkPtr</a></span> network, <br/> <span class="type">unsigned int</span> flags)
<span class="type">int</span> <a href="#virNetworkIsActive">virNetworkIsActive</a> (<span class="type"><a href="libvirt-libvirt-network.html#virNetworkPtr">virNetworkPtr</a></span> net)
<span class="type">int</span> <a href="#virNetworkIsPersistent">virNetworkIsPersistent</a> (<span class="type"><a href="libvirt-libvirt-network.html#virNetworkPtr">virNetworkPtr</a></span> net)
<span class="type">int</span> <a href="#virNetworkListAllPorts">virNetworkListAllPorts</a> (<span class="type"><a href="libvirt-libvirt-network.html#virNetworkPtr">virNetworkPtr</a></span> network, <br/> <span class="type"><a href="libvirt-libvirt-network.html#virNetworkPortPtr">virNetworkPortPtr</a> **</span> ports, <br/> <span class="type">unsigned int</span> flags)
<span class="type"><a href="libvirt-libvirt-network.html#virNetworkPtr">virNetworkPtr</a></span> <a href="#virNetworkLookupByName">virNetworkLookupByName</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-network.html#virNetworkPtr">virNetworkPtr</a></span> <a href="#virNetworkLookupByUUID">virNetworkLookupByUUID</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-network.html#virNetworkPtr">virNetworkPtr</a></span> <a href="#virNetworkLookupByUUIDString">virNetworkLookupByUUIDString</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"><a href="libvirt-libvirt-network.html#virNetworkPortPtr">virNetworkPortPtr</a></span> <a href="#virNetworkPortCreateXML">virNetworkPortCreateXML</a> (<span class="type"><a href="libvirt-libvirt-network.html#virNetworkPtr">virNetworkPtr</a></span> net, <br/> <span class="type">const char *</span> xmldesc, <br/> <span class="type">unsigned int</span> flags)
<span class="type">int</span> <a href="#virNetworkPortDelete">virNetworkPortDelete</a> (<span class="type"><a href="libvirt-libvirt-network.html#virNetworkPortPtr">virNetworkPortPtr</a></span> port, <br/> <span class="type">unsigned int</span> flags)
<span class="type">int</span> <a href="#virNetworkPortFree">virNetworkPortFree</a> (<span class="type"><a href="libvirt-libvirt-network.html#virNetworkPortPtr">virNetworkPortPtr</a></span> port)
<span class="type"><a href="libvirt-libvirt-network.html#virNetworkPtr">virNetworkPtr</a></span> <a href="#virNetworkPortGetNetwork">virNetworkPortGetNetwork</a> (<span class="type"><a href="libvirt-libvirt-network.html#virNetworkPortPtr">virNetworkPortPtr</a></span> port)
<span class="type">int</span> <a href="#virNetworkPortGetParameters">virNetworkPortGetParameters</a> (<span class="type"><a href="libvirt-libvirt-network.html#virNetworkPortPtr">virNetworkPortPtr</a></span> port, <br/> <span class="type"><a href="libvirt-libvirt-common.html#virTypedParameterPtr">virTypedParameterPtr</a> *</span> params, <br/> <span class="type">int *</span> nparams, <br/> <span class="type">unsigned int</span> flags)
<span class="type">int</span> <a href="#virNetworkPortGetUUID">virNetworkPortGetUUID</a> (<span class="type"><a href="libvirt-libvirt-network.html#virNetworkPortPtr">virNetworkPortPtr</a></span> port, <br/> <span class="type">unsigned char *</span> uuid)
<span class="type">int</span> <a href="#virNetworkPortGetUUIDString">virNetworkPortGetUUIDString</a> (<span class="type"><a href="libvirt-libvirt-network.html#virNetworkPortPtr">virNetworkPortPtr</a></span> port, <br/> <span class="type">char *</span> buf)
<span class="type">char *</span> <a href="#virNetworkPortGetXMLDesc">virNetworkPortGetXMLDesc</a> (<span class="type"><a href="libvirt-libvirt-network.html#virNetworkPortPtr">virNetworkPortPtr</a></span> port, <br/> <span class="type">unsigned int</span> flags)
<span class="type"><a href="libvirt-libvirt-network.html#virNetworkPortPtr">virNetworkPortPtr</a></span> <a href="#virNetworkPortLookupByUUID">virNetworkPortLookupByUUID</a> (<span class="type"><a href="libvirt-libvirt-network.html#virNetworkPtr">virNetworkPtr</a></span> net, <br/> <span class="type">const unsigned char *</span> uuid)
<span class="type"><a href="libvirt-libvirt-network.html#virNetworkPortPtr">virNetworkPortPtr</a></span> <a href="#virNetworkPortLookupByUUIDString">virNetworkPortLookupByUUIDString</a> (<span class="type"><a href="libvirt-libvirt-network.html#virNetworkPtr">virNetworkPtr</a></span> net, <br/> <span class="type">const char *</span> uuidstr)
<span class="type">int</span> <a href="#virNetworkPortRef">virNetworkPortRef</a> (<span class="type"><a href="libvirt-libvirt-network.html#virNetworkPortPtr">virNetworkPortPtr</a></span> port)
<span class="type">int</span> <a href="#virNetworkPortSetParameters">virNetworkPortSetParameters</a> (<span class="type"><a href="libvirt-libvirt-network.html#virNetworkPortPtr">virNetworkPortPtr</a></span> port, <br/> <span class="type"><a href="libvirt-libvirt-common.html#virTypedParameterPtr">virTypedParameterPtr</a></span> params, <br/> <span class="type">int</span> nparams, <br/> <span class="type">unsigned int</span> flags)
<span class="type">int</span> <a href="#virNetworkRef">virNetworkRef</a> (<span class="type"><a href="libvirt-libvirt-network.html#virNetworkPtr">virNetworkPtr</a></span> network)
<span class="type">int</span> <a href="#virNetworkSetAutostart">virNetworkSetAutostart</a> (<span class="type"><a href="libvirt-libvirt-network.html#virNetworkPtr">virNetworkPtr</a></span> network, <br/> <span class="type">int</span> autostart)
<span class="type">int</span> <a href="#virNetworkUndefine">virNetworkUndefine</a> (<span class="type"><a href="libvirt-libvirt-network.html#virNetworkPtr">virNetworkPtr</a></span> network)
<span class="type">int</span> <a href="#virNetworkUpdate">virNetworkUpdate</a> (<span class="type"><a href="libvirt-libvirt-network.html#virNetworkPtr">virNetworkPtr</a></span> network, <br/> <span class="type">unsigned int</span> command, <br/> <span class="type">unsigned int</span> section, <br/> <span class="type">int</span> parentIndex, <br/> <span class="type">const char *</span> xml, <br/> <span class="type">unsigned int</span> flags)
</pre>
<h2>Description</h2>
<h3>
<a name="macros">Macros</a>
</h3>
<h3>
<a name="VIR_NETWORK_EVENT_CALLBACK">
<code>VIR_NETWORK_EVENT_CALLBACK</code>
</a>
</h3>
<pre class="api"><span class="directive">#define</span> VIR_NETWORK_EVENT_CALLBACK</pre>
<div class="description">
<p>Used to cast the event specific callback into the generic one for use for <a href="libvirt-libvirt-network.html#virConnectNetworkEventRegisterAny">virConnectNetworkEventRegisterAny</a>()</p>
</div>
<h3>
<a name="VIR_NETWORK_PORT_BANDWIDTH_IN_AVERAGE">
<code>VIR_NETWORK_PORT_BANDWIDTH_IN_AVERAGE</code>
</a>
</h3>
<pre class="api"><span class="directive">#define</span> VIR_NETWORK_PORT_BANDWIDTH_IN_AVERAGE</pre>
<div class="description">
<p>Macro represents the inbound average of NIC bandwidth, as a uint.</p>
</div>
<h3>
<a name="VIR_NETWORK_PORT_BANDWIDTH_IN_BURST">
<code>VIR_NETWORK_PORT_BANDWIDTH_IN_BURST</code>
</a>
</h3>
<pre class="api"><span class="directive">#define</span> VIR_NETWORK_PORT_BANDWIDTH_IN_BURST</pre>
<div class="description">
<p>Macro represents the inbound burst of NIC bandwidth, as a uint.</p>
</div>
<h3>
<a name="VIR_NETWORK_PORT_BANDWIDTH_IN_FLOOR">
<code>VIR_NETWORK_PORT_BANDWIDTH_IN_FLOOR</code>
</a>
</h3>
<pre class="api"><span class="directive">#define</span> VIR_NETWORK_PORT_BANDWIDTH_IN_FLOOR</pre>
<div class="description">
<p>Macro represents the inbound floor of NIC bandwidth, as a uint.</p>
</div>
<h3>
<a name="VIR_NETWORK_PORT_BANDWIDTH_IN_PEAK">
<code>VIR_NETWORK_PORT_BANDWIDTH_IN_PEAK</code>
</a>
</h3>
<pre class="api"><span class="directive">#define</span> VIR_NETWORK_PORT_BANDWIDTH_IN_PEAK</pre>
<div class="description">
<p>Macro represents the inbound peak of NIC bandwidth, as a uint.</p>
</div>
<h3>
<a name="VIR_NETWORK_PORT_BANDWIDTH_OUT_AVERAGE">
<code>VIR_NETWORK_PORT_BANDWIDTH_OUT_AVERAGE</code>
</a>
</h3>
<pre class="api"><span class="directive">#define</span> VIR_NETWORK_PORT_BANDWIDTH_OUT_AVERAGE</pre>
<div class="description">
<p>Macro represents the outbound average of NIC bandwidth, as a uint.</p>
</div>
<h3>
<a name="VIR_NETWORK_PORT_BANDWIDTH_OUT_BURST">
<code>VIR_NETWORK_PORT_BANDWIDTH_OUT_BURST</code>
</a>
</h3>
<pre class="api"><span class="directive">#define</span> VIR_NETWORK_PORT_BANDWIDTH_OUT_BURST</pre>
<div class="description">
<p>Macro represents the outbound burst of NIC bandwidth, as a uint.</p>
</div>
<h3>
<a name="VIR_NETWORK_PORT_BANDWIDTH_OUT_PEAK">
<code>VIR_NETWORK_PORT_BANDWIDTH_OUT_PEAK</code>
</a>
</h3>
<pre class="api"><span class="directive">#define</span> VIR_NETWORK_PORT_BANDWIDTH_OUT_PEAK</pre>
<div class="description">
<p>Macro represents the outbound peak of NIC bandwidth, as a uint.</p>
</div>
<h3>
<a name="types">Types</a>
</h3>
<h3>
<a name="virConnectListAllNetworksFlags">
<code>virConnectListAllNetworksFlags</code>
</a>
</h3>
<div class="api">
<pre><span class="keyword">enum</span> virConnectListAllNetworksFlags {
</pre>
<table>
<tr>
<td>
<a name="VIR_CONNECT_LIST_NETWORKS_INACTIVE">VIR_CONNECT_LIST_NETWORKS_INACTIVE</a>
</td>
<td> = </td>
<td colspan="2" class="enumvalue">1 (0x1; 1 << 0)</td>
</tr>
<tr>
<td>
<a name="VIR_CONNECT_LIST_NETWORKS_ACTIVE">VIR_CONNECT_LIST_NETWORKS_ACTIVE</a>
</td>
<td> = </td>
<td colspan="2" class="enumvalue">2 (0x2; 1 << 1)</td>
</tr>
<tr>
<td>
<a name="VIR_CONNECT_LIST_NETWORKS_PERSISTENT">VIR_CONNECT_LIST_NETWORKS_PERSISTENT</a>
</td>
<td> = </td>
<td colspan="2" class="enumvalue">4 (0x4; 1 << 2)</td>
</tr>
<tr>
<td>
<a name="VIR_CONNECT_LIST_NETWORKS_TRANSIENT">VIR_CONNECT_LIST_NETWORKS_TRANSIENT</a>
</td>
<td> = </td>
<td colspan="2" class="enumvalue">8 (0x8; 1 << 3)</td>
</tr>
<tr>
<td>
<a name="VIR_CONNECT_LIST_NETWORKS_AUTOSTART">VIR_CONNECT_LIST_NETWORKS_AUTOSTART</a>
</td>
<td> = </td>
<td colspan="2" class="enumvalue">16 (0x10; 1 << 4)</td>
</tr>
<tr>
<td>
<a name="VIR_CONNECT_LIST_NETWORKS_NO_AUTOSTART">VIR_CONNECT_LIST_NETWORKS_NO_AUTOSTART</a>
</td>
<td> = </td>
<td colspan="2" class="enumvalue">32 (0x20; 1 << 5)</td>
</tr>
</table>
<pre>}
</pre>
</div>
<h3>
<a name="virIPAddrType">
<code>virIPAddrType</code>
</a>
</h3>
<div class="api">
<pre><span class="keyword">enum</span> virIPAddrType {
</pre>
<table>
<tr>
<td>
<a name="VIR_IP_ADDR_TYPE_IPV4">VIR_IP_ADDR_TYPE_IPV4</a>
</td>
<td> = </td>
<td colspan="2" class="enumvalue">0 (0x0)</td>
</tr>
<tr>
<td>
<a name="VIR_IP_ADDR_TYPE_IPV6">VIR_IP_ADDR_TYPE_IPV6</a>
</td>
<td> = </td>
<td colspan="2" class="enumvalue">1 (0x1)</td>
</tr>
<tr>
<td>
<a name="VIR_IP_ADDR_TYPE_LAST">VIR_IP_ADDR_TYPE_LAST</a>
</td>
<td> = </td>
<td colspan="2" class="enumvalue">2 (0x2)</td>
</tr>
</table>
<pre>}
</pre>
</div>
<h3>
<a name="virNetwork">
<code>virNetwork</code>
</a>
</h3>
<div class="api">
<pre><span class="keyword">struct </span>virNetwork {
</pre>
<div class="undisclosed">The content of this structure is not made public by the API</div>
<pre>
}
</pre>
</div>
<h3>
<a name="virNetworkDHCPLease">
<code>virNetworkDHCPLease</code>
</a>
</h3>
<div class="api">
<pre><span class="keyword">struct </span>virNetworkDHCPLease {
</pre>
<table>
<tr>
<td>
<span class="type">char *</span>
</td>
<td>iface</td>
<td>
<div class="comment">Network interface name</div>
</td>
</tr>
<tr>
<td>
<span class="type">long long</span>
</td>
<td>expirytime</td>
<td>
<div class="comment">Seconds since epoch</div>
</td>
</tr>
<tr>
<td>
<span class="type">int</span>
</td>
<td>type</td>
<td>
<div class="comment">
<a href="libvirt-libvirt-network.html#virIPAddrType">virIPAddrType</a>
</div>
</td>
</tr>
<tr>
<td>
<span class="type">char *</span>
</td>
<td>mac</td>
<td>
<div class="comment">MAC address</div>
</td>
</tr>
<tr>
<td>
<span class="type">char *</span>
</td>
<td>iaid</td>
<td>
<div class="comment">IAID</div>
</td>
</tr>
<tr>
<td>
<span class="type">char *</span>
</td>
<td>ipaddr</td>
<td>
<div class="comment">IP address</div>
</td>
</tr>
<tr>
<td>
<span class="type">unsigned int</span>
</td>
<td>prefix</td>
<td>
<div class="comment">IP address prefix</div>
</td>
</tr>
<tr>
<td>
<span class="type">char *</span>
</td>
<td>hostname</td>
<td>
<div class="comment">Hostname</div>
</td>
</tr>
<tr>
<td>
<span class="type">char *</span>
</td>
<td>clientid</td>
<td>
<div class="comment">Client ID or DUID</div>
</td>
</tr>
</table>
<pre>
}
</pre>
</div>
<h3>
<a name="virNetworkEventID">
<code>virNetworkEventID</code>
</a>
</h3>
<div class="api">
<pre><span class="keyword">enum</span> virNetworkEventID {
</pre>
<table>
<tr>
<td>
<a name="VIR_NETWORK_EVENT_ID_LIFECYCLE">VIR_NETWORK_EVENT_ID_LIFECYCLE</a>
</td>
<td> = </td>
<td class="enumvalue">0 (0x0)</td>
<td>
<div class="comment">
<a href="libvirt-libvirt-network.html#virConnectNetworkEventLifecycleCallback">virConnectNetworkEventLifecycleCallback</a>
</div>
</td>
</tr>
<tr>
<td>
<a name="VIR_NETWORK_EVENT_ID_LAST">VIR_NETWORK_EVENT_ID_LAST</a>
</td>
<td> = </td>
<td class="enumvalue">1 (0x1)</td>
<td>
<div class="comment">NB: this enum value will increase over time as new events are added to the libvirt API. It reflects the last event ID supported by this version of the libvirt API.</div>
</td>
</tr>
</table>
<pre>}
</pre>
</div>
<h3>
<a name="virNetworkEventLifecycleType">
<code>virNetworkEventLifecycleType</code>
</a>
</h3>
<div class="api">
<pre><span class="keyword">enum</span> virNetworkEventLifecycleType {
</pre>
<table>
<tr>
<td>
<a name="VIR_NETWORK_EVENT_DEFINED">VIR_NETWORK_EVENT_DEFINED</a>
</td>
<td> = </td>
<td colspan="2" class="enumvalue">0 (0x0)</td>
</tr>
<tr>
<td>
<a name="VIR_NETWORK_EVENT_UNDEFINED">VIR_NETWORK_EVENT_UNDEFINED</a>
</td>
<td> = </td>
<td colspan="2" class="enumvalue">1 (0x1)</td>
</tr>
<tr>
<td>
<a name="VIR_NETWORK_EVENT_STARTED">VIR_NETWORK_EVENT_STARTED</a>
</td>
<td> = </td>
<td colspan="2" class="enumvalue">2 (0x2)</td>
</tr>
<tr>
<td>
<a name="VIR_NETWORK_EVENT_STOPPED">VIR_NETWORK_EVENT_STOPPED</a>
</td>
<td> = </td>
<td colspan="2" class="enumvalue">3 (0x3)</td>
</tr>
<tr>
<td>
<a name="VIR_NETWORK_EVENT_LAST">VIR_NETWORK_EVENT_LAST</a>
</td>
<td> = </td>
<td colspan="2" class="enumvalue">4 (0x4)</td>
</tr>
</table>
<pre>}
</pre>
</div>
<h3>
<a name="virNetworkPort">
<code>virNetworkPort</code>
</a>
</h3>
<div class="api">
<pre><span class="keyword">struct </span>virNetworkPort {
</pre>
<div class="undisclosed">The content of this structure is not made public by the API</div>
<pre>
}
</pre>
</div>
<h3>
<a name="virNetworkPortCreateFlags">
<code>virNetworkPortCreateFlags</code>
</a>
</h3>
<div class="api">
<pre><span class="keyword">enum</span> virNetworkPortCreateFlags {
</pre>
<table>
<tr>
<td>
<a name="VIR_NETWORK_PORT_CREATE_RECLAIM">VIR_NETWORK_PORT_CREATE_RECLAIM</a>
</td>
<td> = </td>
<td class="enumvalue">1 (0x1; 1 << 0)</td>
<td>
<div class="comment">reclaim existing used resources</div>
</td>
</tr>
</table>
<pre>}
</pre>
</div>
<h3>
<a name="virNetworkUpdateCommand">
<code>virNetworkUpdateCommand</code>
</a>
</h3>
<div class="api">
<pre><span class="keyword">enum</span> virNetworkUpdateCommand {
</pre>
<table>
<tr>
<td>
<a name="VIR_NETWORK_UPDATE_COMMAND_NONE">VIR_NETWORK_UPDATE_COMMAND_NONE</a>
</td>
<td> = </td>
<td class="enumvalue">0 (0x0)</td>
<td>
<div class="comment">(invalid)</div>
</td>
</tr>
<tr>
<td>
<a name="VIR_NETWORK_UPDATE_COMMAND_MODIFY">VIR_NETWORK_UPDATE_COMMAND_MODIFY</a>
</td>
<td> = </td>
<td class="enumvalue">1 (0x1)</td>
<td>
<div class="comment">modify an existing element</div>
</td>
</tr>
<tr>
<td>
<a name="VIR_NETWORK_UPDATE_COMMAND_DELETE">VIR_NETWORK_UPDATE_COMMAND_DELETE</a>
</td>
<td> = </td>
<td class="enumvalue">2 (0x2)</td>
<td>
<div class="comment">delete an existing element</div>
</td>
</tr>
<tr>
<td>
<a name="VIR_NETWORK_UPDATE_COMMAND_ADD_LAST">VIR_NETWORK_UPDATE_COMMAND_ADD_LAST</a>
</td>
<td> = </td>
<td class="enumvalue">3 (0x3)</td>
<td>
<div class="comment">add an element at end of list</div>
</td>
</tr>
<tr>
<td>
<a name="VIR_NETWORK_UPDATE_COMMAND_ADD_FIRST">VIR_NETWORK_UPDATE_COMMAND_ADD_FIRST</a>
</td>
<td> = </td>
<td class="enumvalue">4 (0x4)</td>
<td>
<div class="comment">add an element at start of list</div>
</td>
</tr>
<tr>
<td>
<a name="VIR_NETWORK_UPDATE_COMMAND_LAST">VIR_NETWORK_UPDATE_COMMAND_LAST</a>
</td>
<td> = </td>
<td colspan="2" class="enumvalue">5 (0x5)</td>
</tr>
</table>
<pre>}
</pre>
</div>
<h3>
<a name="virNetworkUpdateFlags">
<code>virNetworkUpdateFlags</code>
</a>
</h3>
<div class="api">
<pre><span class="keyword">enum</span> virNetworkUpdateFlags {
</pre>
<table>
<tr>
<td>
<a name="VIR_NETWORK_UPDATE_AFFECT_CURRENT">VIR_NETWORK_UPDATE_AFFECT_CURRENT</a>
</td>
<td> = </td>
<td class="enumvalue">0 (0x0)</td>
<td>
<div class="comment">affect live if network is active, config if it's not active</div>
</td>
</tr>
<tr>
<td>
<a name="VIR_NETWORK_UPDATE_AFFECT_LIVE">VIR_NETWORK_UPDATE_AFFECT_LIVE</a>
</td>
<td> = </td>
<td class="enumvalue">1 (0x1; 1 << 0)</td>
<td>
<div class="comment">affect live state of network only</div>
</td>
</tr>
<tr>
<td>
<a name="VIR_NETWORK_UPDATE_AFFECT_CONFIG">VIR_NETWORK_UPDATE_AFFECT_CONFIG</a>
</td>
<td> = </td>
<td class="enumvalue">2 (0x2; 1 << 1)</td>
<td>
<div class="comment">affect persistent config only</div>
</td>
</tr>
</table>
<pre>}
</pre>
</div>
<h3>
<a name="virNetworkUpdateSection">
<code>virNetworkUpdateSection</code>
</a>
</h3>
<div class="api">
<pre><span class="keyword">enum</span> virNetworkUpdateSection {
</pre>
<table>
<tr>
<td>
<a name="VIR_NETWORK_SECTION_NONE">VIR_NETWORK_SECTION_NONE</a>
</td>
<td> = </td>
<td class="enumvalue">0 (0x0)</td>
<td>
<div class="comment">(invalid)</div>
</td>
</tr>
<tr>
<td>
<a name="VIR_NETWORK_SECTION_BRIDGE">VIR_NETWORK_SECTION_BRIDGE</a>
</td>
<td> = </td>
<td class="enumvalue">1 (0x1)</td>
<td>
<div class="comment"><bridge></div>
</td>
</tr>
<tr>
<td>
<a name="VIR_NETWORK_SECTION_DOMAIN">VIR_NETWORK_SECTION_DOMAIN</a>
</td>
<td> = </td>
<td class="enumvalue">2 (0x2)</td>
<td>
<div class="comment"><domain></div>
</td>
</tr>
<tr>
<td>
<a name="VIR_NETWORK_SECTION_IP">VIR_NETWORK_SECTION_IP</a>
</td>
<td> = </td>
<td class="enumvalue">3 (0x3)</td>
<td>
<div class="comment"><ip></div>
</td>
</tr>
<tr>
<td>
<a name="VIR_NETWORK_SECTION_IP_DHCP_HOST">VIR_NETWORK_SECTION_IP_DHCP_HOST</a>
</td>
<td> = </td>
<td class="enumvalue">4 (0x4)</td>
<td>
<div class="comment"><ip>/<dhcp>/<host></div>
</td>
</tr>
<tr>
<td>
<a name="VIR_NETWORK_SECTION_IP_DHCP_RANGE">VIR_NETWORK_SECTION_IP_DHCP_RANGE</a>
</td>
<td> = </td>
<td class="enumvalue">5 (0x5)</td>
<td>
<div class="comment"><ip>/<dhcp>/<range></div>
</td>
</tr>
<tr>
<td>
<a name="VIR_NETWORK_SECTION_FORWARD">VIR_NETWORK_SECTION_FORWARD</a>
</td>
<td> = </td>
<td class="enumvalue">6 (0x6)</td>
<td>
<div class="comment"><forward></div>
</td>
</tr>
<tr>
<td>
<a name="VIR_NETWORK_SECTION_FORWARD_INTERFACE">VIR_NETWORK_SECTION_FORWARD_INTERFACE</a>
</td>
<td> = </td>
<td class="enumvalue">7 (0x7)</td>
<td>
<div class="comment"><forward>/<interface></div>
</td>
</tr>
<tr>
<td>
<a name="VIR_NETWORK_SECTION_FORWARD_PF">VIR_NETWORK_SECTION_FORWARD_PF</a>
</td>
<td> = </td>
<td class="enumvalue">8 (0x8)</td>
<td>
<div class="comment"><forward>/<pf></div>
</td>
</tr>
<tr>
<td>
<a name="VIR_NETWORK_SECTION_PORTGROUP">VIR_NETWORK_SECTION_PORTGROUP</a>
</td>
<td> = </td>
<td class="enumvalue">9 (0x9)</td>
<td>
<div class="comment"><portgroup></div>
</td>
</tr>
<tr>
<td>
<a name="VIR_NETWORK_SECTION_DNS_HOST">VIR_NETWORK_SECTION_DNS_HOST</a>
</td>
<td> = </td>
<td class="enumvalue">10 (0xa)</td>
<td>
<div class="comment"><dns>/<host></div>
</td>
</tr>
<tr>
<td>
<a name="VIR_NETWORK_SECTION_DNS_TXT">VIR_NETWORK_SECTION_DNS_TXT</a>
</td>
<td> = </td>
<td class="enumvalue">11 (0xb)</td>
<td>
<div class="comment"><dns>/<txt></div>
</td>
</tr>
<tr>
<td>
<a name="VIR_NETWORK_SECTION_DNS_SRV">VIR_NETWORK_SECTION_DNS_SRV</a>
</td>
<td> = </td>
<td class="enumvalue">12 (0xc)</td>
<td>
<div class="comment"><dns>/<srv></div>
</td>
</tr>
<tr>
<td>
<a name="VIR_NETWORK_SECTION_LAST">VIR_NETWORK_SECTION_LAST</a>
</td>
<td> = </td>
<td colspan="2" class="enumvalue">13 (0xd)</td>
</tr>
</table>
<pre>}
</pre>
</div>
<h3>
<a name="virNetworkXMLFlags">
<code>virNetworkXMLFlags</code>
</a>
</h3>
<div class="api">
<pre><span class="keyword">enum</span> virNetworkXMLFlags {
</pre>
<table>
<tr>
<td>
<a name="VIR_NETWORK_XML_INACTIVE">VIR_NETWORK_XML_INACTIVE</a>
</td>
<td> = </td>
<td class="enumvalue">1 (0x1; 1 << 0)</td>
<td>
<div class="comment">dump inactive network information</div>
</td>
</tr>
</table>
<pre>}
</pre>
</div>
<h3>
<a name="functions">Functions</a>
</h3>
<h3>
<a name="virConnectListAllNetworks">
<code>virConnectListAllNetworks</code>
</a>
</h3>
<pre class="api"><span class="type">int</span> virConnectListAllNetworks (<span class="type"><a href="libvirt-libvirt-host.html#virConnectPtr">virConnectPtr</a></span> conn,
<span class="type"><a href="libvirt-libvirt-network.html#virNetworkPtr">virNetworkPtr</a> **</span> nets,
<span class="type">unsigned int</span> flags)</pre>
<div class="description">
<p>Collect the list of networks, and allocate an array to store those objects. This API solves the race inherent between <a href="libvirt-libvirt-network.html#virConnectListNetworks">virConnectListNetworks</a> and <a href="libvirt-libvirt-network.html#virConnectListDefinedNetworks">virConnectListDefinedNetworks</a>.</p>
<p>Normally, all networks are returned; however, @flags can be used to filter the results for a smaller list of targeted networks. The valid flags are divided into groups, where each group contains bits that describe mutually exclusive attributes of a network, and where all bits within a group describe all possible networks.</p>
<p>The first group of @flags is <a href="libvirt-libvirt-network.html#VIR_CONNECT_LIST_NETWORKS_ACTIVE">VIR_CONNECT_LIST_NETWORKS_ACTIVE</a> (up) and <a href="libvirt-libvirt-network.html#VIR_CONNECT_LIST_NETWORKS_INACTIVE">VIR_CONNECT_LIST_NETWORKS_INACTIVE</a> (down) to filter the networks by state.</p>
<p>The second group of @flags is <a href="libvirt-libvirt-network.html#VIR_CONNECT_LIST_NETWORKS_PERSISTENT">VIR_CONNECT_LIST_NETWORKS_PERSISTENT</a> (defined) and <a href="libvirt-libvirt-network.html#VIR_CONNECT_LIST_NETWORKS_TRANSIENT">VIR_CONNECT_LIST_NETWORKS_TRANSIENT</a> (running but not defined), to filter the networks by whether they have persistent config or not.</p>
<p>The third group of @flags is <a href="libvirt-libvirt-network.html#VIR_CONNECT_LIST_NETWORKS_AUTOSTART">VIR_CONNECT_LIST_NETWORKS_AUTOSTART</a> and <a href="libvirt-libvirt-network.html#VIR_CONNECT_LIST_NETWORKS_NO_AUTOSTART">VIR_CONNECT_LIST_NETWORKS_NO_AUTOSTART</a>, to filter the networks by whether they are marked as autostart or not.</p>
</div>
<dl class="variablelist">
<dt>conn</dt>
<dd>Pointer to the hypervisor connection.</dd>
<dt>nets</dt>
<dd>Pointer to a variable to store the array containing the network objects or NULL if the list is not required (just returns number of networks).</dd>
<dt>flags</dt>
<dd>bitwise-OR of <a href="libvirt-libvirt-network.html#virConnectListAllNetworksFlags">virConnectListAllNetworksFlags</a>.</dd>
<dt>Returns</dt>
<dd>the number of networks found or -1 and sets @nets to NULL in case of error. On success, the array stored into @nets 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-network.html#virNetworkFree">virNetworkFree</a>() on each array element, then calling free() on @nets.</dd>
</dl>
<div class="acl"/>
<h3>
<a name="virConnectListDefinedNetworks">
<code>virConnectListDefinedNetworks</code>
</a>
</h3>
<pre class="api"><span class="type">int</span> virConnectListDefinedNetworks (<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>list the inactive networks, stores the pointers to the names in @names</p>
<p>For more control over the results, see <a href="libvirt-libvirt-network.html#virConnectListAllNetworks">virConnectListAllNetworks</a>().</p>
</div>
<dl class="variablelist">
<dt>conn</dt>
<dd>pointer to the hypervisor connection</dd>
<dt>names</dt>
<dd>pointer to an array to store the names</dd>
<dt>maxnames</dt>
<dd>size of the array</dd>
<dt>Returns</dt>
<dd>the number of names provided in the array or -1 in case of error. Note that this command is inherently racy; a network can be defined between a call to <a href="libvirt-libvirt-network.html#virConnectNumOfDefinedNetworks">virConnectNumOfDefinedNetworks</a>() and this call; you are only guaranteed that all currently defined networks were listed if the return is less than @maxnames. The client must call free() on each returned name.</dd>
</dl>
<div class="acl"/>
<h3>
<a name="virConnectListNetworks">
<code>virConnectListNetworks</code>
</a>
</h3>
<pre class="api"><span class="type">int</span> virConnectListNetworks (<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 active networks, and store their names in @names</p>
<p>For more control over the results, see <a href="libvirt-libvirt-network.html#virConnectListAllNetworks">virConnectListAllNetworks</a>().</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 active networks</dd>
<dt>maxnames</dt>
<dd>size of @names</dd>
<dt>Returns</dt>
<dd>the number of networks found or -1 in case of error. Note that this command is inherently racy; a network can be started between a call to <a href="libvirt-libvirt-network.html#virConnectNumOfNetworks">virConnectNumOfNetworks</a>() and this call; you are only guaranteed that all currently active networks were listed if the return is less than @maxnames. The client must call free() on each returned name.</dd>
</dl>
<div class="acl"/>
<h3>
<a name="virConnectNetworkEventDeregisterAny">
<code>virConnectNetworkEventDeregisterAny</code>
</a>
</h3>
<pre class="api"><span class="type">int</span> virConnectNetworkEventDeregisterAny (<span class="type"><a href="libvirt-libvirt-host.html#virConnectPtr">virConnectPtr</a></span> conn,
<span class="type">int</span> callbackID)</pre>
<div class="description">
<p>Removes an event callback. The callbackID parameter should be the value obtained from a previous <a href="libvirt-libvirt-network.html#virConnectNetworkEventRegisterAny">virConnectNetworkEventRegisterAny</a>() method.</p>
</div>
<dl class="variablelist">
<dt>conn</dt>
<dd>pointer to the connection</dd>
<dt>callbackID</dt>
<dd>the callback identifier</dd>
<dt>Returns</dt>
<dd>0 on success, -1 on failure</dd>
</dl>
<div class="acl"/>
<h3>
<a name="virConnectNetworkEventGenericCallback">
<code>virConnectNetworkEventGenericCallback</code>
</a>
</h3>
<pre class="api"><span class="keyword">typedef</span> <span class="type">void</span> (*virConnectNetworkEventGenericCallback) (<span class="type"><a href="libvirt-libvirt-host.html#virConnectPtr">virConnectPtr</a></span> conn,
<span class="type"><a href="libvirt-libvirt-network.html#virNetworkPtr">virNetworkPtr</a></span> net,
<span class="type">void *</span> opaque)
</pre>
<div class="description">
<p>A generic network event callback handler, for use with <a href="libvirt-libvirt-network.html#virConnectNetworkEventRegisterAny">virConnectNetworkEventRegisterAny</a>(). Specific events usually have a customization with extra parameters, often with @opaque being passed in a different parameter position; use <a href="libvirt-libvirt-network.html#VIR_NETWORK_EVENT_CALLBACK">VIR_NETWORK_EVENT_CALLBACK</a>() when registering an appropriate handler.</p>
</div>
<dl class="variablelist">
<dt>conn</dt>
<dd>the connection pointer</dd>
<dt>net</dt>
<dd>the network pointer</dd>
<dt>opaque</dt>
<dd>application specified data</dd>
</dl>
<br/>
<h3>
<a name="virConnectNetworkEventLifecycleCallback">
<code>virConnectNetworkEventLifecycleCallback</code>
</a>
</h3>
<pre class="api"><span class="keyword">typedef</span> <span class="type">void</span> (*virConnectNetworkEventLifecycleCallback) (<span class="type"><a href="libvirt-libvirt-host.html#virConnectPtr">virConnectPtr</a></span> conn,
<span class="type"><a href="libvirt-libvirt-network.html#virNetworkPtr">virNetworkPtr</a></span> net,
<span class="type">int</span> event,
<span class="type">int</span> detail,
<span class="type">void *</span> opaque)
</pre>
<div class="description">
<p>This callback occurs when the network is started or stopped.</p>
<p>The callback signature to use when registering for an event of type <a href="libvirt-libvirt-network.html#VIR_NETWORK_EVENT_ID_LIFECYCLE">VIR_NETWORK_EVENT_ID_LIFECYCLE</a> with <a href="libvirt-libvirt-network.html#virConnectNetworkEventRegisterAny">virConnectNetworkEventRegisterAny</a>()</p>
</div>
<dl class="variablelist">
<dt>conn</dt>
<dd>connection object</dd>
<dt>net</dt>
<dd>network on which the event occurred</dd>
<dt>event</dt>
<dd>The specific virNetworkEventLifeCycleType which occurred</dd>
<dt>detail</dt>
<dd>contains some details on the reason of the event. It will be 0 for the while.</dd>
<dt>opaque</dt>
<dd>application specified data</dd>
</dl>
<br/>
<h3>
<a name="virConnectNetworkEventRegisterAny">
<code>virConnectNetworkEventRegisterAny</code>
</a>
</h3>
<pre class="api"><span class="type">int</span> virConnectNetworkEventRegisterAny (<span class="type"><a href="libvirt-libvirt-host.html#virConnectPtr">virConnectPtr</a></span> conn,
<span class="type"><a href="libvirt-libvirt-network.html#virNetworkPtr">virNetworkPtr</a></span> net,
<span class="type">int</span> eventID,
<span class="type"><a href="libvirt-libvirt-network.html#virConnectNetworkEventGenericCallback">virConnectNetworkEventGenericCallback</a></span> cb,
<span class="type">void *</span> opaque,
<span class="type"><a href="libvirt-libvirt-common.html#virFreeCallback">virFreeCallback</a></span> freecb)</pre>
<div class="description">
<p>Adds a callback to receive notifications of arbitrary network events occurring on a network. This function requires that an event loop has been previously registered with <a href="libvirt-libvirt-event.html#virEventRegisterImpl">virEventRegisterImpl</a>() or <a href="libvirt-libvirt-event.html#virEventRegisterDefaultImpl">virEventRegisterDefaultImpl</a>().</p>
<p>If @net is NULL, then events will be monitored for any network. If @net is non-NULL, then only the specific network will be monitored.</p>
<p>Most types of event have a callback providing a custom set of parameters for the event. When registering an event, it is thus necessary to use the <a href="libvirt-libvirt-network.html#VIR_NETWORK_EVENT_CALLBACK">VIR_NETWORK_EVENT_CALLBACK</a>() macro to cast the supplied function pointer to match the signature of this method.</p>
<p>The <a href="libvirt-libvirt-network.html#virNetworkPtr">virNetworkPtr</a> object handle passed into the callback upon delivery of an event is only valid for the duration of execution of the callback. If the callback wishes to keep the network object after the callback returns, it shall take a reference to it, by calling <a href="libvirt-libvirt-network.html#virNetworkRef">virNetworkRef</a>(). The reference can be released once the object is no longer required by calling <a href="libvirt-libvirt-network.html#virNetworkFree">virNetworkFree</a>().</p>
<p>The return value from this method is a positive integer identifier for the callback. To unregister a callback, this callback ID should be passed to the <a href="libvirt-libvirt-network.html#virConnectNetworkEventDeregisterAny">virConnectNetworkEventDeregisterAny</a>() method.</p>
</div>
<dl class="variablelist">
<dt>conn</dt>
<dd>pointer to the connection</dd>
<dt>net</dt>
<dd>pointer to the network</dd>
<dt>eventID</dt>
<dd>the event type to receive</dd>
<dt>cb</dt>
<dd>callback to the function handling network events</dd>
<dt>opaque</dt>
<dd>opaque data to pass on to the callback</dd>
<dt>freecb</dt>
<dd>optional function to deallocate opaque when not used anymore</dd>
<dt>Returns</dt>
<dd>a callback identifier on success, -1 on failure.</dd>
</dl>
<div class="acl"/>
<h3>
<a name="virConnectNumOfDefinedNetworks">
<code>virConnectNumOfDefinedNetworks</code>
</a>
</h3>
<pre class="api"><span class="type">int</span> virConnectNumOfDefinedNetworks (<span class="type"><a href="libvirt-libvirt-host.html#virConnectPtr">virConnectPtr</a></span> conn)</pre>
<div class="description">
<p>Provides the number of inactive networks.</p>
</div>
<dl class="variablelist">
<dt>conn</dt>
<dd>pointer to the hypervisor connection</dd>
<dt>Returns</dt>
<dd>the number of networks found or -1 in case of error</dd>
</dl>
<div class="acl"/>
<h3>
<a name="virConnectNumOfNetworks">
<code>virConnectNumOfNetworks</code>
</a>
</h3>
<pre class="api"><span class="type">int</span> virConnectNumOfNetworks (<span class="type"><a href="libvirt-libvirt-host.html#virConnectPtr">virConnectPtr</a></span> conn)</pre>
<div class="description">
<p>Provides the number of active networks.</p>
</div>
<dl class="variablelist">
<dt>conn</dt>
<dd>pointer to the hypervisor connection</dd>
<dt>Returns</dt>
<dd>the number of network found or -1 in case of error</dd>
</dl>
<div class="acl"/>
<h3>
<a name="virNetworkCreate">
<code>virNetworkCreate</code>
</a>
</h3>
<pre class="api"><span class="type">int</span> virNetworkCreate (<span class="type"><a href="libvirt-libvirt-network.html#virNetworkPtr">virNetworkPtr</a></span> network)</pre>
<div class="description">
<p>Create and start a defined network. If the call succeed the network moves from the defined to the running networks pools.</p>
</div>
<dl class="variablelist">
<dt>network</dt>
<dd>pointer to a defined network</dd>
<dt>Returns</dt>
<dd>0 in case of success, -1 in case of error</dd>
</dl>
<div class="acl"/>
<h3>
<a name="virNetworkCreateXML">
<code>virNetworkCreateXML</code>
</a>
</h3>
<pre class="api"><span class="type"><a href="libvirt-libvirt-network.html#virNetworkPtr">virNetworkPtr</a></span> virNetworkCreateXML (<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>Create and start a new virtual network, based on an XML description similar to the one returned by <a href="libvirt-libvirt-network.html#virNetworkGetXMLDesc">virNetworkGetXMLDesc</a>()</p>
<p><a href="libvirt-libvirt-network.html#virNetworkFree">virNetworkFree</a> should be used to free the resources after the network 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 network</dd>
<dt>Returns</dt>
<dd>a new network object or NULL in case of failure</dd>
</dl>
<div class="acl"/>
<h3>
<a name="virNetworkDHCPLeaseFree">
<code>virNetworkDHCPLeaseFree</code>
</a>
</h3>
<pre class="api"><span class="type">void</span> virNetworkDHCPLeaseFree (<span class="type"><a href="libvirt-libvirt-network.html#virNetworkDHCPLeasePtr">virNetworkDHCPLeasePtr</a></span> lease)</pre>
<div class="description">
<p>Frees all the memory occupied by @lease.</p>
</div>
<dl class="variablelist">
<dt>lease</dt>
<dd>pointer to a leases object</dd>
</dl>
<div class="acl"/>
<h3>
<a name="virNetworkDefineXML">
<code>virNetworkDefineXML</code>
</a>
</h3>
<pre class="api"><span class="type"><a href="libvirt-libvirt-network.html#virNetworkPtr">virNetworkPtr</a></span> virNetworkDefineXML (<span class="type"><a href="libvirt-libvirt-host.html#virConnectPtr">virConnectPtr</a></span> conn,
<span class="type">const char *</span> xml)</pre>
<div class="description">
<p>Define an inactive persistent virtual network or modify an existing persistent one from the XML description.</p>
<p><a href="libvirt-libvirt-network.html#virNetworkFree">virNetworkFree</a> should be used to free the resources after the network object is no longer needed.</p>
</div>
<dl class="variablelist">
<dt>conn</dt>
<dd>pointer to the hypervisor connection</dd>
<dt>xml</dt>
<dd>the XML description for the network, preferably in UTF-8</dd>
<dt>Returns</dt>
<dd>NULL in case of error, a pointer to the network otherwise</dd>
</dl>
<div class="acl"/>
<h3>
<a name="virNetworkDestroy">
<code>virNetworkDestroy</code>
</a>
</h3>
<pre class="api"><span class="type">int</span> virNetworkDestroy (<span class="type"><a href="libvirt-libvirt-network.html#virNetworkPtr">virNetworkPtr</a></span> network)</pre>
<div class="description">
<p>Destroy the network object. The running instance is shutdown if not down already and all resources used by it are given back to the hypervisor. This does not free the associated <a href="libvirt-libvirt-network.html#virNetworkPtr">virNetworkPtr</a> object. This function may require privileged access</p>
</div>
<dl class="variablelist">
<dt>network</dt>
<dd>a network 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="virNetworkFree">
<code>virNetworkFree</code>
</a>
</h3>
<pre class="api"><span class="type">int</span> virNetworkFree (<span class="type"><a href="libvirt-libvirt-network.html#virNetworkPtr">virNetworkPtr</a></span> network)</pre>
<div class="description">
<p>Free the network object. The running instance is kept alive. The data structure is freed and should not be used thereafter.</p>
</div>
<dl class="variablelist">
<dt>network</dt>
<dd>a network 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="virNetworkGetAutostart">
<code>virNetworkGetAutostart</code>
</a>
</h3>
<pre class="api"><span class="type">int</span> virNetworkGetAutostart (<span class="type"><a href="libvirt-libvirt-network.html#virNetworkPtr">virNetworkPtr</a></span> network,
<span class="type">int *</span> autostart)</pre>
<div class="description">
<p>Provides a boolean value indicating whether the network configured to be automatically started when the host machine boots.</p>
</div>
<dl class="variablelist">
<dt>network</dt>
<dd>a network object</dd>
<dt>autostart</dt>
<dd>the value returned</dd>
<dt>Returns</dt>
<dd>-1 in case of error, 0 in case of success</dd>
</dl>
<div class="acl"/>
<h3>
<a name="virNetworkGetBridgeName">
<code>virNetworkGetBridgeName</code>
</a>
</h3>
<pre class="api"><span class="type">char *</span> virNetworkGetBridgeName (<span class="type"><a href="libvirt-libvirt-network.html#virNetworkPtr">virNetworkPtr</a></span> network)</pre>
<div class="description">
<p>Provides a bridge interface name to which a domain may connect a network interface in order to join the network.</p>
</div>
<dl class="variablelist">
<dt>network</dt>
<dd>a network object</dd>
<dt>Returns</dt>
<dd>a 0 terminated interface name, or NULL in case of error. The caller must free() the returned value.</dd>
</dl>
<div class="acl"/>
<h3>
<a name="virNetworkGetConnect">
<code>virNetworkGetConnect</code>
</a>
</h3>
<pre class="api"><span class="type"><a href="libvirt-libvirt-host.html#virConnectPtr">virConnectPtr</a></span> virNetworkGetConnect (<span class="type"><a href="libvirt-libvirt-network.html#virNetworkPtr">virNetworkPtr</a></span> net)</pre>
<div class="description">
<p>Provides the connection pointer associated with a network. The reference counter on the connection is not increased by this call.</p>
</div>
<dl class="variablelist">
<dt>net</dt>
<dd>pointer to a network</dd>
<dt>Returns</dt>
<dd>the <a href="libvirt-libvirt-host.html#virConnectPtr">virConnectPtr</a> or NULL in case of failure.</dd>
</dl>
<div class="acl"/>
<h3>
<a name="virNetworkGetDHCPLeases">
<code>virNetworkGetDHCPLeases</code>
</a>
</h3>
<pre class="api"><span class="type">int</span> virNetworkGetDHCPLeases (<span class="type"><a href="libvirt-libvirt-network.html#virNetworkPtr">virNetworkPtr</a></span> network,
<span class="type">const char *</span> mac,
<span class="type"><a href="libvirt-libvirt-network.html#virNetworkDHCPLeasePtr">virNetworkDHCPLeasePtr</a> **</span> leases,
<span class="type">unsigned int</span> flags)</pre>
<div class="description">
<p>For DHCPv4, the information returned: - Network Interface Name - Expiry Time - MAC address - IAID (NULL) - IPv4 address (with type and prefix) - Hostname (can be NULL) - Client ID (can be NULL)</p>
<p>For DHCPv6, the information returned: - Network Interface Name - Expiry Time - MAC address - IAID (can be NULL, only in rare cases) - IPv6 address (with type and prefix) - Hostname (can be NULL) - Client DUID</p>
<p>Note: @mac, @iaid, @ipaddr, @clientid are in ASCII form, not raw bytes. Note: @expirytime can 0, in case the lease is for infinite time.</p>
<p>The API fetches leases info of guests in the specified network. If the optional parameter @mac is specified, the returned list will contain only lease info about a specific guest interface with @mac. There can be multiple leases for a single @mac because this API supports DHCPv6 too.</p>
<p>On success, the array stored into @leases 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-network.html#virNetworkDHCPLeaseFree">virNetworkDHCPLeaseFree</a>() on each array element, then calling free() on @leases.</p>
<p>See also virNetworkGetDHCPLeasesForMAC() as a convenience for filtering the list to a single MAC address.</p>
<p>Example of usage:</p>
<pre class="code">virNetworkDHCPLeasePtr *leases = NULL;
virNetworkPtr network = ... obtain a network pointer here ...;
size_t i;
int nleases;
unsigned int flags = 0;
nleases = virNetworkGetDHCPLeases(network, NULL, &leases, flags);
if (nleases < 0)
error();
... do something with returned values, for example:
for (i = 0; i < nleases; i++) {
virNetworkDHCPLeasePtr lease = leases[i];
printf("Time(epoch): %lu, MAC address: %s, "
"IP address: %s, Hostname: %s, ClientID: %s\n",
lease->expirytime, lease->mac, lease->ipaddr,
lease->hostname, lease->clientid);
virNetworkDHCPLeaseFree(leases[i]);
}
free(leases);</pre>
</div>
<dl class="variablelist">
<dt>network</dt>
<dd>Pointer to network object</dd>
<dt>mac</dt>
<dd>Optional ASCII formatted MAC address of an interface</dd>
<dt>leases</dt>
<dd>Pointer to a variable to store the array containing details on obtained leases, or NULL if the list is not required (just returns number of leases).</dd>
<dt>flags</dt>
<dd>Extra flags, not used yet, so callers should always pass 0</dd>
<dt>Returns</dt>
<dd>the number of leases found or -1 and sets @leases to NULL in case of error.</dd>
</dl>
<div class="acl"/>
<h3>
<a name="virNetworkGetName">
<code>virNetworkGetName</code>
</a>
</h3>
<pre class="api"><span class="type">const char *</span> virNetworkGetName (<span class="type"><a href="libvirt-libvirt-network.html#virNetworkPtr">virNetworkPtr</a></span> network)</pre>
<div class="description">
<p>Get the public name for that network</p>
</div>
<dl class="variablelist">
<dt>network</dt>
<dd>a network 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 network object.</dd>
</dl>
<div class="acl"/>
<h3>
<a name="virNetworkGetUUID">
<code>virNetworkGetUUID</code>
</a>
</h3>
<pre class="api"><span class="type">int</span> virNetworkGetUUID (<span class="type"><a href="libvirt-libvirt-network.html#virNetworkPtr">virNetworkPtr</a></span> network,
<span class="type">unsigned char *</span> uuid)</pre>
<div class="description">
<p>Get the UUID for a network</p>
</div>
<dl class="variablelist">
<dt>network</dt>
<dd>a network 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="virNetworkGetUUIDString">
<code>virNetworkGetUUIDString</code>
</a>
</h3>
<pre class="api"><span class="type">int</span> virNetworkGetUUIDString (<span class="type"><a href="libvirt-libvirt-network.html#virNetworkPtr">virNetworkPtr</a></span> network,
<span class="type">char *</span> buf)</pre>
<div class="description">
<p>Get the UUID for a network as string. For more information about UUID see RFC4122.</p>
</div>
<dl class="variablelist">
<dt>network</dt>
<dd>a network 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="virNetworkGetXMLDesc">
<code>virNetworkGetXMLDesc</code>
</a>
</h3>
<pre class="api"><span class="type">char *</span> virNetworkGetXMLDesc (<span class="type"><a href="libvirt-libvirt-network.html#virNetworkPtr">virNetworkPtr</a></span> network,
<span class="type">unsigned int</span> flags)</pre>
<div class="description">
<p>Provide an XML description of the network. The description may be reused later to relaunch the network with <a href="libvirt-libvirt-network.html#virNetworkCreateXML">virNetworkCreateXML</a>().</p>
<p>Normally, if a network included a physical function, the output includes all virtual functions tied to that physical interface. If @flags includes <a href="libvirt-libvirt-network.html#VIR_NETWORK_XML_INACTIVE">VIR_NETWORK_XML_INACTIVE</a>, then the expansion of virtual interfaces is not performed.</p>
</div>
<dl class="variablelist">
<dt>network</dt>
<dd>a network object</dd>
<dt>flags</dt>
<dd>bitwise-OR of <a href="libvirt-libvirt-network.html#virNetworkXMLFlags">virNetworkXMLFlags</a></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="virNetworkIsActive">
<code>virNetworkIsActive</code>
</a>
</h3>
<pre class="api"><span class="type">int</span> virNetworkIsActive (<span class="type"><a href="libvirt-libvirt-network.html#virNetworkPtr">virNetworkPtr</a></span> net)</pre>
<div class="description">
<p>Determine if the network is currently running</p>
</div>
<dl class="variablelist">
<dt>net</dt>
<dd>pointer to the network object</dd>
<dt>Returns</dt>
<dd>1 if running, 0 if inactive, -1 on error</dd>
</dl>
<div class="acl"/>
<h3>
<a name="virNetworkIsPersistent">
<code>virNetworkIsPersistent</code>
</a>
</h3>
<pre class="api"><span class="type">int</span> virNetworkIsPersistent (<span class="type"><a href="libvirt-libvirt-network.html#virNetworkPtr">virNetworkPtr</a></span> net)</pre>
<div class="description">
<p>Determine if the network has a persistent configuration which means it will still exist after shutting down</p>
</div>
<dl class="variablelist">
<dt>net</dt>
<dd>pointer to the network object</dd>
<dt>Returns</dt>
<dd>1 if persistent, 0 if transient, -1 on error</dd>
</dl>
<div class="acl"/>
<h3>
<a name="virNetworkListAllPorts">
<code>virNetworkListAllPorts</code>
</a>
</h3>
<pre class="api"><span class="type">int</span> virNetworkListAllPorts (<span class="type"><a href="libvirt-libvirt-network.html#virNetworkPtr">virNetworkPtr</a></span> network,
<span class="type"><a href="libvirt-libvirt-network.html#virNetworkPortPtr">virNetworkPortPtr</a> **</span> ports,
<span class="type">unsigned int</span> flags)</pre>
<div class="description">
<p>Collect the list of network ports, and allocate an array to store those objects.</p>
</div>
<dl class="variablelist">
<dt>network</dt>
<dd>pointer to a network object</dd>
<dt>ports</dt>
<dd>Pointer to a variable to store the array containing network port objects or NULL if the list is not required (just returns number of ports).</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 ports found or -1 and sets @ports to NULL in case of error. On success, the array stored into @ports 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-network.html#virNetworkPortFree">virNetworkPortFree</a>() on each array element, then calling free() on @ports.</dd>
</dl>
<div class="acl"/>
<h3>
<a name="virNetworkLookupByName">
<code>virNetworkLookupByName</code>
</a>
</h3>
<pre class="api"><span class="type"><a href="libvirt-libvirt-network.html#virNetworkPtr">virNetworkPtr</a></span> virNetworkLookupByName (<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 on the given hypervisor based on its name.</p>
<p><a href="libvirt-libvirt-network.html#virNetworkFree">virNetworkFree</a> should be used to free the resources after the network 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</dd>
<dt>Returns</dt>
<dd>a new network object or NULL in case of failure. If the network cannot be found, then <a href="libvirt-virterror.html#VIR_ERR_NO_NETWORK">VIR_ERR_NO_NETWORK</a> error is raised.</dd>
</dl>
<div class="acl"/>
<h3>
<a name="virNetworkLookupByUUID">
<code>virNetworkLookupByUUID</code>
</a>
</h3>
<pre class="api"><span class="type"><a href="libvirt-libvirt-network.html#virNetworkPtr">virNetworkPtr</a></span> virNetworkLookupByUUID (<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 on the given hypervisor based on its UUID.</p>
<p><a href="libvirt-libvirt-network.html#virNetworkFree">virNetworkFree</a> should be used to free the resources after the network 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</dd>
<dt>Returns</dt>
<dd>a new network object or NULL in case of failure. If the network cannot be found, then <a href="libvirt-virterror.html#VIR_ERR_NO_NETWORK">VIR_ERR_NO_NETWORK</a> error is raised.</dd>
</dl>
<div class="acl"/>
<h3>
<a name="virNetworkLookupByUUIDString">
<code>virNetworkLookupByUUIDString</code>
</a>
</h3>
<pre class="api"><span class="type"><a href="libvirt-libvirt-network.html#virNetworkPtr">virNetworkPtr</a></span> virNetworkLookupByUUIDString (<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 a network on the given hypervisor based on its UUID.</p>
</div>
<dl class="variablelist">
<dt>conn</dt>
<dd>pointer to the hypervisor connection</dd>
<dt>uuidstr</dt>
<dd>the string UUID for the network</dd>
<dt>Returns</dt>
<dd>a new network object or NULL in case of failure. If the network cannot be found, then <a href="libvirt-virterror.html#VIR_ERR_NO_NETWORK">VIR_ERR_NO_NETWORK</a> error is raised.</dd>
</dl>
<div class="acl"/>
<h3>
<a name="virNetworkPortCreateXML">
<code>virNetworkPortCreateXML</code>
</a>
</h3>
<pre class="api"><span class="type"><a href="libvirt-libvirt-network.html#virNetworkPortPtr">virNetworkPortPtr</a></span> virNetworkPortCreateXML (<span class="type"><a href="libvirt-libvirt-network.html#virNetworkPtr">virNetworkPtr</a></span> net,
<span class="type">const char *</span> xmldesc,
<span class="type">unsigned int</span> flags)</pre>
<div class="description">
<p>Create a new network port, based on an XML description similar to the one returned by <a href="libvirt-libvirt-network.html#virNetworkPortGetXMLDesc">virNetworkPortGetXMLDesc</a>()</p>
<p><a href="libvirt-libvirt-network.html#virNetworkPortFree">virNetworkPortFree</a> should be used to free the resources after the network port object is no longer needed.</p>
</div>
<dl class="variablelist">
<dt>net</dt>
<dd>pointer to the network object</dd>
<dt>xmldesc</dt>
<dd>an XML description of the port</dd>
<dt>flags</dt>
<dd>currently unused, pass 0</dd>
<dt>Returns</dt>
<dd>a new network port object or NULL in case of failure</dd>
</dl>
<div class="acl"/>
<h3>
<a name="virNetworkPortDelete">
<code>virNetworkPortDelete</code>
</a>
</h3>
<pre class="api"><span class="type">int</span> virNetworkPortDelete (<span class="type"><a href="libvirt-libvirt-network.html#virNetworkPortPtr">virNetworkPortPtr</a></span> port,
<span class="type">unsigned int</span> flags)</pre>
<div class="description">
<p>Delete the network port. This does not free the associated <a href="libvirt-libvirt-network.html#virNetworkPortPtr">virNetworkPortPtr</a> object. It is the caller's responsibility to ensure the port is not still in use by a virtual machine before deleting port.</p>
</div>
<dl class="variablelist">
<dt>port</dt>
<dd>a port object</dd>
<dt>flags</dt>
<dd>currently unused, pass 0</dd>
<dt>Returns</dt>
<dd>0 in case of success and -1 in case of failure.</dd>
</dl>
<div class="acl"/>
<h3>
<a name="virNetworkPortFree">
<code>virNetworkPortFree</code>
</a>
</h3>
<pre class="api"><span class="type">int</span> virNetworkPortFree (<span class="type"><a href="libvirt-libvirt-network.html#virNetworkPortPtr">virNetworkPortPtr</a></span> port)</pre>
<div class="description">
<p>Free the network port object. The data structure is freed and should not be used thereafter.</p>
</div>
<dl class="variablelist">
<dt>port</dt>
<dd>a network port 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="virNetworkPortGetNetwork">
<code>virNetworkPortGetNetwork</code>
</a>
</h3>
<pre class="api"><span class="type"><a href="libvirt-libvirt-network.html#virNetworkPtr">virNetworkPtr</a></span> virNetworkPortGetNetwork (<span class="type"><a href="libvirt-libvirt-network.html#virNetworkPortPtr">virNetworkPortPtr</a></span> port)</pre>
<div class="description">
<p>Provides the network pointer associated with a port. The reference counter on the connection is not increased by this call.</p>
</div>
<dl class="variablelist">
<dt>port</dt>
<dd>pointer to a network port</dd>
<dt>Returns</dt>
<dd>the <a href="libvirt-libvirt-network.html#virNetworkPtr">virNetworkPtr</a> or NULL in case of failure.</dd>
</dl>
<div class="acl"/>
<h3>
<a name="virNetworkPortGetParameters">
<code>virNetworkPortGetParameters</code>
</a>
</h3>
<pre class="api"><span class="type">int</span> virNetworkPortGetParameters (<span class="type"><a href="libvirt-libvirt-network.html#virNetworkPortPtr">virNetworkPortPtr</a></span> port,
<span class="type"><a href="libvirt-libvirt-common.html#virTypedParameterPtr">virTypedParameterPtr</a> *</span> params,
<span class="type">int *</span> nparams,
<span class="type">unsigned int</span> flags)</pre>
<div class="description">
<p>Get all interface parameters. On input, @params should be initialized to NULL. On return @params will be allocated with the size large enough to hold all parameters, and @nparams will be updated to say how many parameters are present. @params should be freed by the caller on success.</p>
</div>
<dl class="variablelist">
<dt>port</dt>
<dd>a network port object</dd>
<dt>params</dt>
<dd>pointer to pointer of interface parameter objects</dd>
<dt>nparams</dt>
<dd>pointer to received number of interface parameter</dd>
<dt>flags</dt>
<dd>currently unused, pass 0</dd>
<dt>Returns</dt>
<dd>-1 in case of error, 0 in case of success.</dd>
</dl>
<div class="acl"/>
<h3>
<a name="virNetworkPortGetUUID">
<code>virNetworkPortGetUUID</code>
</a>
</h3>
<pre class="api"><span class="type">int</span> virNetworkPortGetUUID (<span class="type"><a href="libvirt-libvirt-network.html#virNetworkPortPtr">virNetworkPortPtr</a></span> port,
<span class="type">unsigned char *</span> uuid)</pre>
<div class="description">
<p>Get the UUID for a network port</p>
</div>
<dl class="variablelist">
<dt>port</dt>
<dd>a network port 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="virNetworkPortGetUUIDString">
<code>virNetworkPortGetUUIDString</code>
</a>
</h3>
<pre class="api"><span class="type">int</span> virNetworkPortGetUUIDString (<span class="type"><a href="libvirt-libvirt-network.html#virNetworkPortPtr">virNetworkPortPtr</a></span> port,
<span class="type">char *</span> buf)</pre>
<div class="description">
<p>Get the UUID for a network as string. For more information about UUID see RFC4122.</p>
</div>
<dl class="variablelist">
<dt>port</dt>
<dd>a network port 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="virNetworkPortGetXMLDesc">
<code>virNetworkPortGetXMLDesc</code>
</a>
</h3>
<pre class="api"><span class="type">char *</span> virNetworkPortGetXMLDesc (<span class="type"><a href="libvirt-libvirt-network.html#virNetworkPortPtr">virNetworkPortPtr</a></span> port,
<span class="type">unsigned int</span> flags)</pre>
<div class="description">
<p>Provide an XML description of the network port. The description may be reused later to recreate the port with <a href="libvirt-libvirt-network.html#virNetworkPortCreateXML">virNetworkPortCreateXML</a>().</p>
</div>
<dl class="variablelist">
<dt>port</dt>
<dd>a network port object</dd>
<dt>flags</dt>
<dd>currently unused, 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="virNetworkPortLookupByUUID">
<code>virNetworkPortLookupByUUID</code>
</a>
</h3>
<pre class="api"><span class="type"><a href="libvirt-libvirt-network.html#virNetworkPortPtr">virNetworkPortPtr</a></span> virNetworkPortLookupByUUID (<span class="type"><a href="libvirt-libvirt-network.html#virNetworkPtr">virNetworkPtr</a></span> net,
<span class="type">const unsigned char *</span> uuid)</pre>
<div class="description">
<p>Try to lookup a port on the given network based on its UUID.</p>
<p><a href="libvirt-libvirt-network.html#virNetworkPortFree">virNetworkPortFree</a> should be used to free the resources after the network port object is no longer needed.</p>
</div>
<dl class="variablelist">
<dt>net</dt>
<dd>pointer to the network object</dd>
<dt>uuid</dt>
<dd>the raw UUID for the network port</dd>
<dt>Returns</dt>
<dd>a new network port object or NULL in case of failure. If the network port cannot be found, then <a href="libvirt-virterror.html#VIR_ERR_NO_NETWORK_PORT">VIR_ERR_NO_NETWORK_PORT</a> error is raised.</dd>
</dl>
<div class="acl"/>
<h3>
<a name="virNetworkPortLookupByUUIDString">
<code>virNetworkPortLookupByUUIDString</code>
</a>
</h3>
<pre class="api"><span class="type"><a href="libvirt-libvirt-network.html#virNetworkPortPtr">virNetworkPortPtr</a></span> virNetworkPortLookupByUUIDString (<span class="type"><a href="libvirt-libvirt-network.html#virNetworkPtr">virNetworkPtr</a></span> net,
<span class="type">const char *</span> uuidstr)</pre>
<div class="description">
<p>Try to lookup a port on the given network based on its UUID.</p>
</div>
<dl class="variablelist">
<dt>net</dt>
<dd>pointer to the network object</dd>
<dt>uuidstr</dt>
<dd>the string UUID for the port</dd>
<dt>Returns</dt>
<dd>a new network port object or NULL in case of failure. If the network port cannot be found, then <a href="libvirt-virterror.html#VIR_ERR_NO_NETWORK_PORT">VIR_ERR_NO_NETWORK_PORT</a> error is raised.</dd>
</dl>
<div class="acl"/>
<h3>
<a name="virNetworkPortRef">
<code>virNetworkPortRef</code>
</a>
</h3>
<pre class="api"><span class="type">int</span> virNetworkPortRef (<span class="type"><a href="libvirt-libvirt-network.html#virNetworkPortPtr">virNetworkPortPtr</a></span> port)</pre>
<div class="description">
<p>Increment the reference count on the network port. For each additional call to this method, there shall be a corresponding call to <a href="libvirt-libvirt-network.html#virNetworkPortFree">virNetworkPortFree</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 network port, and it is required that the port remain resident until all threads have finished using it. ie, each new thread using a network port would increment the reference count.</p>
</div>
<dl class="variablelist">
<dt>port</dt>
<dd>a network port object</dd>
<dt>Returns</dt>
<dd>0 in case of success, -1 in case of failure.</dd>
</dl>
<div class="acl"/>
<h3>
<a name="virNetworkPortSetParameters">
<code>virNetworkPortSetParameters</code>
</a>
</h3>
<pre class="api"><span class="type">int</span> virNetworkPortSetParameters (<span class="type"><a href="libvirt-libvirt-network.html#virNetworkPortPtr">virNetworkPortPtr</a></span> port,
<span class="type"><a href="libvirt-libvirt-common.html#virTypedParameterPtr">virTypedParameterPtr</a></span> params,
<span class="type">int</span> nparams,
<span class="type">unsigned int</span> flags)</pre>
<div class="description">
<p>Change a subset or all parameters of the network port; currently this includes bandwidth parameters.</p>
</div>
<dl class="variablelist">
<dt>port</dt>
<dd>a network port object</dd>
<dt>params</dt>
<dd>pointer to interface parameter objects</dd>
<dt>nparams</dt>
<dd>number of interface parameter (this value can be the same or less than the number of parameters supported)</dd>
<dt>flags</dt>
<dd>currently unused, pass 0</dd>
<dt>Returns</dt>
<dd>-1 in case of error, 0 in case of success.</dd>
</dl>
<div class="acl"/>
<h3>
<a name="virNetworkRef">
<code>virNetworkRef</code>
</a>
</h3>
<pre class="api"><span class="type">int</span> virNetworkRef (<span class="type"><a href="libvirt-libvirt-network.html#virNetworkPtr">virNetworkPtr</a></span> network)</pre>
<div class="description">
<p>Increment the reference count on the network. For each additional call to this method, there shall be a corresponding call to <a href="libvirt-libvirt-network.html#virNetworkFree">virNetworkFree</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 a network would increment the reference count.</p>
</div>
<dl class="variablelist">
<dt>network</dt>
<dd>the network 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="virNetworkSetAutostart">
<code>virNetworkSetAutostart</code>
</a>
</h3>
<pre class="api"><span class="type">int</span> virNetworkSetAutostart (<span class="type"><a href="libvirt-libvirt-network.html#virNetworkPtr">virNetworkPtr</a></span> network,
<span class="type">int</span> autostart)</pre>
<div class="description">
<p>Configure the network to be automatically started when the host machine boots.</p>
</div>
<dl class="variablelist">
<dt>network</dt>
<dd>a network object</dd>
<dt>autostart</dt>
<dd>whether the network should be automatically started 0 or 1</dd>
<dt>Returns</dt>
<dd>-1 in case of error, 0 in case of success</dd>
</dl>
<div class="acl"/>
<h3>
<a name="virNetworkUndefine">
<code>virNetworkUndefine</code>
</a>
</h3>
<pre class="api"><span class="type">int</span> virNetworkUndefine (<span class="type"><a href="libvirt-libvirt-network.html#virNetworkPtr">virNetworkPtr</a></span> network)</pre>
<div class="description">
<p>Undefine a network but does not stop it if it is running</p>
</div>
<dl class="variablelist">
<dt>network</dt>
<dd>pointer to a defined network</dd>
<dt>Returns</dt>
<dd>0 in case of success, -1 in case of error</dd>
</dl>
<div class="acl"/>
<h3>
<a name="virNetworkUpdate">
<code>virNetworkUpdate</code>
</a>
</h3>
<pre class="api"><span class="type">int</span> virNetworkUpdate (<span class="type"><a href="libvirt-libvirt-network.html#virNetworkPtr">virNetworkPtr</a></span> network,
<span class="type">unsigned int</span> command,
<span class="type">unsigned int</span> section,
<span class="type">int</span> parentIndex,
<span class="type">const char *</span> xml,
<span class="type">unsigned int</span> flags)</pre>
<div class="description">
<p>Update the definition of an existing network, either its live running state, its persistent configuration, or both.</p>
</div>
<dl class="variablelist">
<dt>network</dt>
<dd>pointer to a defined network</dd>
<dt>command</dt>
<dd>what action to perform (add/delete/modify) (see <a href="libvirt-libvirt-network.html#virNetworkUpdateCommand">virNetworkUpdateCommand</a> for descriptions)</dd>
<dt>section</dt>
<dd>which section of the network to update (see <a href="libvirt-libvirt-network.html#virNetworkUpdateSection">virNetworkUpdateSection</a> for descriptions)</dd>
<dt>parentIndex</dt>
<dd>which parent element, if there are multiple parents of the same type (e.g. which <ip> element when modifying a <dhcp>/<host> element), or "-1" for "don't care" or "automatically find appropriate one".</dd>
<dt>xml</dt>
<dd>the XML description for the network, preferably in UTF-8</dd>
<dt>flags</dt>
<dd>bitwise OR of <a href="libvirt-libvirt-network.html#virNetworkUpdateFlags">virNetworkUpdateFlags</a>.</dd>
<dt>Returns</dt>
<dd>0 in case of success, -1 in case of error <a href="libvirt-libvirt-network.html#virNetworkUpdateCommand">virNetworkUpdateCommand</a> <a href="libvirt-libvirt-network.html#virNetworkUpdateSection">virNetworkUpdateSection</a></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
>
140
