diff options
Diffstat (limited to 'docs/libnm/html/NMDeviceVxlan.html')
| -rw-r--r-- | docs/libnm/html/NMDeviceVxlan.html | 305 |
1 files changed, 304 insertions, 1 deletions
diff --git a/docs/libnm/html/NMDeviceVxlan.html b/docs/libnm/html/NMDeviceVxlan.html index 745d07a3..1a6907e6 100644 --- a/docs/libnm/html/NMDeviceVxlan.html +++ b/docs/libnm/html/NMDeviceVxlan.html @@ -15,7 +15,9 @@ <table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle"> <td width="100%" align="left" class="shortcuts"> <a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span> - <a href="#NMDeviceVxlan.description" class="shortcut">Description</a></span> + <a href="#NMDeviceVxlan.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> + <a href="#NMDeviceVxlan.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties"> <span class="dim">|</span> + <a href="#NMDeviceVxlan.properties" class="shortcut">Properties</a></span> </td> <td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td> <td><a accesskey="u" href="ch04.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> @@ -185,6 +187,106 @@ </table></div> </div> <div class="refsect1"> +<a name="NMDeviceVxlan.properties"></a><h2>Properties</h2> +<div class="informaltable"><table class="informaltable" border="0"> +<colgroup> +<col width="150px" class="properties_type"> +<col width="300px" class="properties_name"> +<col width="200px" class="properties_flags"> +</colgroup> +<tbody> +<tr> +<td class="property_type"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a></td> +<td class="property_name"><a class="link" href="NMDeviceVxlan.html#NMDeviceVxlan--ageing" title="The “ageing” property">ageing</a></td> +<td class="property_flags">Read</td> +</tr> +<tr> +<td class="property_type"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></td> +<td class="property_name"><a class="link" href="NMDeviceVxlan.html#NMDeviceVxlan--carrier" title="The “carrier” property">carrier</a></td> +<td class="property_flags">Read</td> +</tr> +<tr> +<td class="property_type"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a></td> +<td class="property_name"><a class="link" href="NMDeviceVxlan.html#NMDeviceVxlan--dst-port" title="The “dst-port” property">dst-port</a></td> +<td class="property_flags">Read</td> +</tr> +<tr> +<td class="property_type"> +<span class="type">char</span> *</td> +<td class="property_name"><a class="link" href="NMDeviceVxlan.html#NMDeviceVxlan--group" title="The “group” property">group</a></td> +<td class="property_flags">Read</td> +</tr> +<tr> +<td class="property_type"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a></td> +<td class="property_name"><a class="link" href="NMDeviceVxlan.html#NMDeviceVxlan--id" title="The “id” property">id</a></td> +<td class="property_flags">Read</td> +</tr> +<tr> +<td class="property_type"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></td> +<td class="property_name"><a class="link" href="NMDeviceVxlan.html#NMDeviceVxlan--l2miss" title="The “l2miss” property">l2miss</a></td> +<td class="property_flags">Read</td> +</tr> +<tr> +<td class="property_type"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></td> +<td class="property_name"><a class="link" href="NMDeviceVxlan.html#NMDeviceVxlan--l3miss" title="The “l3miss” property">l3miss</a></td> +<td class="property_flags">Read</td> +</tr> +<tr> +<td class="property_type"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></td> +<td class="property_name"><a class="link" href="NMDeviceVxlan.html#NMDeviceVxlan--learning" title="The “learning” property">learning</a></td> +<td class="property_flags">Read</td> +</tr> +<tr> +<td class="property_type"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a></td> +<td class="property_name"><a class="link" href="NMDeviceVxlan.html#NMDeviceVxlan--limit" title="The “limit” property">limit</a></td> +<td class="property_flags">Read</td> +</tr> +<tr> +<td class="property_type"> +<span class="type">char</span> *</td> +<td class="property_name"><a class="link" href="NMDeviceVxlan.html#NMDeviceVxlan--local" title="The “local” property">local</a></td> +<td class="property_flags">Read</td> +</tr> +<tr> +<td class="property_type"> +<a class="link" href="NMDevice.html" title="NMDevice"><span class="type">NMDevice</span></a> *</td> +<td class="property_name"><a class="link" href="NMDeviceVxlan.html#NMDeviceVxlan--parent" title="The “parent” property">parent</a></td> +<td class="property_flags">Read</td> +</tr> +<tr> +<td class="property_type"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></td> +<td class="property_name"><a class="link" href="NMDeviceVxlan.html#NMDeviceVxlan--proxy" title="The “proxy” property">proxy</a></td> +<td class="property_flags">Read</td> +</tr> +<tr> +<td class="property_type"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></td> +<td class="property_name"><a class="link" href="NMDeviceVxlan.html#NMDeviceVxlan--rsc" title="The “rsc” property">rsc</a></td> +<td class="property_flags">Read</td> +</tr> +<tr> +<td class="property_type"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a></td> +<td class="property_name"><a class="link" href="NMDeviceVxlan.html#NMDeviceVxlan--src-port-max" title="The “src-port-max” property">src-port-max</a></td> +<td class="property_flags">Read</td> +</tr> +<tr> +<td class="property_type"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a></td> +<td class="property_name"><a class="link" href="NMDeviceVxlan.html#NMDeviceVxlan--src-port-min" title="The “src-port-min” property">src-port-min</a></td> +<td class="property_flags">Read</td> +</tr> +<tr> +<td class="property_type"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#guchar"><span class="type">guchar</span></a></td> +<td class="property_name"><a class="link" href="NMDeviceVxlan.html#NMDeviceVxlan--tos" title="The “tos” property">tos</a></td> +<td class="property_flags">Read</td> +</tr> +<tr> +<td class="property_type"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#guchar"><span class="type">guchar</span></a></td> +<td class="property_name"><a class="link" href="NMDeviceVxlan.html#NMDeviceVxlan--ttl" title="The “ttl” property">ttl</a></td> +<td class="property_flags">Read</td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect1"> <a name="NMDeviceVxlan.other"></a><h2>Types and Values</h2> <div class="informaltable"><table class="informaltable" width="100%" border="0"> <colgroup> @@ -264,10 +366,22 @@ <td class="define_keyword">#define</td> <td class="function_name"><a class="link" href="NMDeviceVxlan.html#NM-DEVICE-VXLAN-DST-PORT:CAPS" title="NM_DEVICE_VXLAN_DST_PORT">NM_DEVICE_VXLAN_DST_PORT</a></td> </tr> +<tr> +<td class="datatype_keyword"> </td> +<td class="function_name"><a class="link" href="NMDeviceVxlan.html#NMDeviceVxlan-struct" title="NMDeviceVxlan">NMDeviceVxlan</a></td> +</tr> </tbody> </table></div> </div> <div class="refsect1"> +<a name="NMDeviceVxlan.object-hierarchy"></a><h2>Object Hierarchy</h2> +<pre class="screen"> <a href="https://developer.gnome.org/gobject/unstable/gobject-The-Base-Object-Type.html#GObject-struct">GObject</a> + <span class="lineart">╰──</span> <a class="link" href="NMObject.html" title="NMObject">NMObject</a> + <span class="lineart">╰──</span> <a class="link" href="NMDevice.html" title="NMDevice">NMDevice</a> + <span class="lineart">╰──</span> NMDeviceVxlan +</pre> +</div> +<div class="refsect1"> <a name="NMDeviceVxlan.description"></a><h2>Description</h2> </div> <div class="refsect1"> @@ -302,6 +416,8 @@ nm_device_vxlan_get_carrier (<em class="parameter"><code><a class="link" href="N <div class="refsect3"> <a name="nm-device-vxlan-get-carrier.returns"></a><h4>Returns</h4> <p> <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the device has carrier.</p> +<p>This property is not implemented yet, and the function always returns +FALSE.</p> </div> <p class="since">Since: 1.2</p> </div> @@ -834,6 +950,193 @@ nm_device_vxlan_get_l3miss (<em class="parameter"><code><a class="link" href="NM <pre class="programlisting">#define NM_DEVICE_VXLAN_DST_PORT "dst-port" </pre> </div> +<hr> +<div class="refsect2"> +<a name="NMDeviceVxlan-struct"></a><h3>NMDeviceVxlan</h3> +<pre class="programlisting">typedef struct _NMDeviceVxlan NMDeviceVxlan;</pre> +</div> +</div> +<div class="refsect1"> +<a name="NMDeviceVxlan.property-details"></a><h2>Property Details</h2> +<div class="refsect2"> +<a name="NMDeviceVxlan--ageing"></a><h3>The <code class="literal">“ageing”</code> property</h3> +<pre class="programlisting"> “ageing” <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a></pre> +<p>The lifetime in seconds of FDB entries learnt by the kernel.</p> +<p>Owner: NMDeviceVxlan</p> +<p>Flags: Read</p> +<p>Default value: 0</p> +<p class="since">Since: 1.2</p> +</div> +<hr> +<div class="refsect2"> +<a name="NMDeviceVxlan--carrier"></a><h3>The <code class="literal">“carrier”</code> property</h3> +<pre class="programlisting"> “carrier” <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></pre> +<p>Whether the device has carrier.</p> +<p>This property is not implemented yet, and the property is always FALSE.</p> +<p>Owner: NMDeviceVxlan</p> +<p>Flags: Read</p> +<p>Default value: FALSE</p> +<p class="since">Since: 1.2</p> +</div> +<hr> +<div class="refsect2"> +<a name="NMDeviceVxlan--dst-port"></a><h3>The <code class="literal">“dst-port”</code> property</h3> +<pre class="programlisting"> “dst-port” <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a></pre> +<p>The UDP destination port used to communicate with the remote VXLAN tunnel +endpoint.</p> +<p>Owner: NMDeviceVxlan</p> +<p>Flags: Read</p> +<p>Allowed values: <= 65535</p> +<p>Default value: 0</p> +<p class="since">Since: 1.2</p> +</div> +<hr> +<div class="refsect2"> +<a name="NMDeviceVxlan--group"></a><h3>The <code class="literal">“group”</code> property</h3> +<pre class="programlisting"> “group” <span class="type">char</span> *</pre> +<p>The unicast destination IP address used in outgoing packets when the +destination link layer address is not known in the VXLAN device +forwarding database or the multicast IP address joined.</p> +<p>Owner: NMDeviceVxlan</p> +<p>Flags: Read</p> +<p>Default value: NULL</p> +<p class="since">Since: 1.2</p> +</div> +<hr> +<div class="refsect2"> +<a name="NMDeviceVxlan--id"></a><h3>The <code class="literal">“id”</code> property</h3> +<pre class="programlisting"> “id” <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a></pre> +<p>The device's VXLAN ID.</p> +<p>Owner: NMDeviceVxlan</p> +<p>Flags: Read</p> +<p>Allowed values: <= 16777215</p> +<p>Default value: 0</p> +<p class="since">Since: 1.2</p> +</div> +<hr> +<div class="refsect2"> +<a name="NMDeviceVxlan--l2miss"></a><h3>The <code class="literal">“l2miss”</code> property</h3> +<pre class="programlisting"> “l2miss” <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></pre> +<p>Whether netlink LL ADDR miss notifications are generated.</p> +<p>Owner: NMDeviceVxlan</p> +<p>Flags: Read</p> +<p>Default value: FALSE</p> +<p class="since">Since: 1.2</p> +</div> +<hr> +<div class="refsect2"> +<a name="NMDeviceVxlan--l3miss"></a><h3>The <code class="literal">“l3miss”</code> property</h3> +<pre class="programlisting"> “l3miss” <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></pre> +<p>Whether netlink IP ADDR miss notifications are generated.</p> +<p>Owner: NMDeviceVxlan</p> +<p>Flags: Read</p> +<p>Default value: FALSE</p> +<p class="since">Since: 1.2</p> +</div> +<hr> +<div class="refsect2"> +<a name="NMDeviceVxlan--learning"></a><h3>The <code class="literal">“learning”</code> property</h3> +<pre class="programlisting"> “learning” <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></pre> +<p>Whether unknown source link layer addresses and IP addresses are entered +into the VXLAN device forwarding database.</p> +<p>Owner: NMDeviceVxlan</p> +<p>Flags: Read</p> +<p>Default value: TRUE</p> +<p class="since">Since: 1.2</p> +</div> +<hr> +<div class="refsect2"> +<a name="NMDeviceVxlan--limit"></a><h3>The <code class="literal">“limit”</code> property</h3> +<pre class="programlisting"> “limit” <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a></pre> +<p>The maximum number of entries that can be added to the forwarding table.</p> +<p>Owner: NMDeviceVxlan</p> +<p>Flags: Read</p> +<p>Default value: 0</p> +<p class="since">Since: 1.2</p> +</div> +<hr> +<div class="refsect2"> +<a name="NMDeviceVxlan--local"></a><h3>The <code class="literal">“local”</code> property</h3> +<pre class="programlisting"> “local” <span class="type">char</span> *</pre> +<p>The source IP address to use in outgoing packets.</p> +<p>Owner: NMDeviceVxlan</p> +<p>Flags: Read</p> +<p>Default value: NULL</p> +<p class="since">Since: 1.2</p> +</div> +<hr> +<div class="refsect2"> +<a name="NMDeviceVxlan--parent"></a><h3>The <code class="literal">“parent”</code> property</h3> +<pre class="programlisting"> “parent” <a class="link" href="NMDevice.html" title="NMDevice"><span class="type">NMDevice</span></a> *</pre> +<p>The devices's parent device.</p> +<p>Owner: NMDeviceVxlan</p> +<p>Flags: Read</p> +<p class="since">Since: 1.2</p> +</div> +<hr> +<div class="refsect2"> +<a name="NMDeviceVxlan--proxy"></a><h3>The <code class="literal">“proxy”</code> property</h3> +<pre class="programlisting"> “proxy” <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></pre> +<p>Whether ARP proxy is turned on.</p> +<p>Owner: NMDeviceVxlan</p> +<p>Flags: Read</p> +<p>Default value: FALSE</p> +<p class="since">Since: 1.2</p> +</div> +<hr> +<div class="refsect2"> +<a name="NMDeviceVxlan--rsc"></a><h3>The <code class="literal">“rsc”</code> property</h3> +<pre class="programlisting"> “rsc” <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></pre> +<p>Whether route short circuit is turned on.</p> +<p>Owner: NMDeviceVxlan</p> +<p>Flags: Read</p> +<p>Default value: FALSE</p> +<p class="since">Since: 1.2</p> +</div> +<hr> +<div class="refsect2"> +<a name="NMDeviceVxlan--src-port-max"></a><h3>The <code class="literal">“src-port-max”</code> property</h3> +<pre class="programlisting"> “src-port-max” <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a></pre> +<p>The maximum UDP source port used to communicate with the remote VXLAN +tunnel endpoint.</p> +<p>Owner: NMDeviceVxlan</p> +<p>Flags: Read</p> +<p>Allowed values: <= 65535</p> +<p>Default value: 0</p> +<p class="since">Since: 1.2</p> +</div> +<hr> +<div class="refsect2"> +<a name="NMDeviceVxlan--src-port-min"></a><h3>The <code class="literal">“src-port-min”</code> property</h3> +<pre class="programlisting"> “src-port-min” <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a></pre> +<p>The minimum UDP source port used to communicate with the remote VXLAN +tunnel endpoint.</p> +<p>Owner: NMDeviceVxlan</p> +<p>Flags: Read</p> +<p>Allowed values: <= 65535</p> +<p>Default value: 0</p> +<p class="since">Since: 1.2</p> +</div> +<hr> +<div class="refsect2"> +<a name="NMDeviceVxlan--tos"></a><h3>The <code class="literal">“tos”</code> property</h3> +<pre class="programlisting"> “tos” <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#guchar"><span class="type">guchar</span></a></pre> +<p>The TOS value to use in outgoing packets.</p> +<p>Owner: NMDeviceVxlan</p> +<p>Flags: Read</p> +<p>Default value: 0</p> +<p class="since">Since: 1.2</p> +</div> +<hr> +<div class="refsect2"> +<a name="NMDeviceVxlan--ttl"></a><h3>The <code class="literal">“ttl”</code> property</h3> +<pre class="programlisting"> “ttl” <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#guchar"><span class="type">guchar</span></a></pre> +<p>The time-to-live value to use in outgoing packets.</p> +<p>Owner: NMDeviceVxlan</p> +<p>Flags: Read</p> +<p>Default value: 0</p> +<p class="since">Since: 1.2</p> +</div> </div> </div> <div class="footer"> |