diff options
Diffstat (limited to 'docs/libnm/html/NMSettingBridgePort.html')
| -rw-r--r-- | docs/libnm/html/NMSettingBridgePort.html | 279 |
1 files changed, 279 insertions, 0 deletions
diff --git a/docs/libnm/html/NMSettingBridgePort.html b/docs/libnm/html/NMSettingBridgePort.html index 2aa8b1d3..cb16d0f8 100644 --- a/docs/libnm/html/NMSettingBridgePort.html +++ b/docs/libnm/html/NMSettingBridgePort.html @@ -73,6 +73,54 @@ <a class="link" href="NMSettingBridgePort.html#nm-setting-bridge-port-get-hairpin-mode" title="nm_setting_bridge_port_get_hairpin_mode ()">nm_setting_bridge_port_get_hairpin_mode</a> <span class="c_punctuation">()</span> </td> </tr> +<tr> +<td class="function_type"> +<span class="returnvalue">void</span> +</td> +<td class="function_name"> +<a class="link" href="NMSettingBridgePort.html#nm-setting-bridge-port-add-vlan" title="nm_setting_bridge_port_add_vlan ()">nm_setting_bridge_port_add_vlan</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a> +</td> +<td class="function_name"> +<a class="link" href="NMSettingBridgePort.html#nm-setting-bridge-port-get-num-vlans" title="nm_setting_bridge_port_get_num_vlans ()">nm_setting_bridge_port_get_num_vlans</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a class="link" href="NMSettingBridge.html#NMBridgeVlan"><span class="returnvalue">NMBridgeVlan</span></a> * +</td> +<td class="function_name"> +<a class="link" href="NMSettingBridgePort.html#nm-setting-bridge-port-get-vlan" title="nm_setting_bridge_port_get_vlan ()">nm_setting_bridge_port_get_vlan</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">void</span> +</td> +<td class="function_name"> +<a class="link" href="NMSettingBridgePort.html#nm-setting-bridge-port-remove-vlan" title="nm_setting_bridge_port_remove_vlan ()">nm_setting_bridge_port_remove_vlan</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> +</td> +<td class="function_name"> +<a class="link" href="NMSettingBridgePort.html#nm-setting-bridge-port-remove-vlan-by-vid" title="nm_setting_bridge_port_remove_vlan_by_vid ()">nm_setting_bridge_port_remove_vlan_by_vid</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">void</span> +</td> +<td class="function_name"> +<a class="link" href="NMSettingBridgePort.html#nm-setting-bridge-port-clear-vlans" title="nm_setting_bridge_port_clear_vlans ()">nm_setting_bridge_port_clear_vlans</a> <span class="c_punctuation">()</span> +</td> +</tr> </tbody> </table></div> </div> @@ -100,6 +148,12 @@ <td class="property_name"><a class="link" href="NMSettingBridgePort.html#NMSettingBridgePort--priority" title="The “priority” property">priority</a></td> <td class="property_flags">Read / Write / Construct</td> </tr> +<tr> +<td class="property_type"> +<a href="https://developer.gnome.org/glib/unstable/glib-Pointer-Arrays.html#GPtrArray"><span class="type">GPtrArray</span></a> *</td> +<td class="property_name"><a class="link" href="NMSettingBridgePort.html#NMSettingBridgePort--vlans" title="The “vlans” property">vlans</a></td> +<td class="property_flags">Read / Write</td> +</tr> </tbody> </table></div> </div> @@ -128,6 +182,10 @@ <td class="function_name"><a class="link" href="NMSettingBridgePort.html#NM-SETTING-BRIDGE-PORT-HAIRPIN-MODE:CAPS" title="NM_SETTING_BRIDGE_PORT_HAIRPIN_MODE">NM_SETTING_BRIDGE_PORT_HAIRPIN_MODE</a></td> </tr> <tr> +<td class="define_keyword">#define</td> +<td class="function_name"><a class="link" href="NMSettingBridgePort.html#NM-SETTING-BRIDGE-PORT-VLANS:CAPS" title="NM_SETTING_BRIDGE_PORT_VLANS">NM_SETTING_BRIDGE_PORT_VLANS</a></td> +</tr> +<tr> <td class="datatype_keyword"> </td> <td class="function_name"><a class="link" href="NMSettingBridgePort.html#NMSettingBridgePort-struct" title="NMSettingBridgePort">NMSettingBridgePort</a></td> </tr> @@ -235,6 +293,204 @@ nm_setting_bridge_port_get_hairpin_mode <p> the <a class="link" href="NMSettingBridgePort.html#NMSettingBridgePort--hairpin-mode" title="The “hairpin-mode” property"><span class="type">“hairpin-mode”</span></a> property of the setting</p> </div> </div> +<hr> +<div class="refsect2"> +<a name="nm-setting-bridge-port-add-vlan"></a><h3>nm_setting_bridge_port_add_vlan ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> +nm_setting_bridge_port_add_vlan (<em class="parameter"><code><a class="link" href="NMSettingBridgePort.html" title="NMSettingBridgePort"><span class="type">NMSettingBridgePort</span></a> *setting</code></em>, + <em class="parameter"><code><a class="link" href="NMSettingBridge.html#NMBridgeVlan"><span class="type">NMBridgeVlan</span></a> *vlan</code></em>);</pre> +<p>Appends a new vlan and associated information to the setting. The +given vlan gets sealed and a reference to it is added.</p> +<div class="refsect3"> +<a name="nm-setting-bridge-port-add-vlan.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>setting</p></td> +<td class="parameter_description"><p>the <a class="link" href="NMSettingBridgePort.html" title="NMSettingBridgePort"><span class="type">NMSettingBridgePort</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>vlan</p></td> +<td class="parameter_description"><p>the vlan to add</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<p class="since">Since: 1.18</p> +</div> +<hr> +<div class="refsect2"> +<a name="nm-setting-bridge-port-get-num-vlans"></a><h3>nm_setting_bridge_port_get_num_vlans ()</h3> +<pre class="programlisting"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a> +nm_setting_bridge_port_get_num_vlans (<em class="parameter"><code><a class="link" href="NMSettingBridgePort.html" title="NMSettingBridgePort"><span class="type">NMSettingBridgePort</span></a> *setting</code></em>);</pre> +<div class="refsect3"> +<a name="nm-setting-bridge-port-get-num-vlans.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody><tr> +<td class="parameter_name"><p>setting</p></td> +<td class="parameter_description"><p>the <a class="link" href="NMSettingBridgePort.html" title="NMSettingBridgePort"><span class="type">NMSettingBridgePort</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="nm-setting-bridge-port-get-num-vlans.returns"></a><h4>Returns</h4> +<p> the number of VLANs</p> +</div> +<p class="since">Since: 1.18</p> +</div> +<hr> +<div class="refsect2"> +<a name="nm-setting-bridge-port-get-vlan"></a><h3>nm_setting_bridge_port_get_vlan ()</h3> +<pre class="programlisting"><a class="link" href="NMSettingBridge.html#NMBridgeVlan"><span class="returnvalue">NMBridgeVlan</span></a> * +nm_setting_bridge_port_get_vlan (<em class="parameter"><code><a class="link" href="NMSettingBridgePort.html" title="NMSettingBridgePort"><span class="type">NMSettingBridgePort</span></a> *setting</code></em>, + <em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> idx</code></em>);</pre> +<div class="refsect3"> +<a name="nm-setting-bridge-port-get-vlan.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>setting</p></td> +<td class="parameter_description"><p>the <a class="link" href="NMSettingBridgePort.html" title="NMSettingBridgePort"><span class="type">NMSettingBridgePort</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>idx</p></td> +<td class="parameter_description"><p>index number of the VLAN to return</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="nm-setting-bridge-port-get-vlan.returns"></a><h4>Returns</h4> +<p>the VLAN at index <em class="parameter"><code>idx</code></em> +. </p> +<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p> +</div> +<p class="since">Since: 1.18</p> +</div> +<hr> +<div class="refsect2"> +<a name="nm-setting-bridge-port-remove-vlan"></a><h3>nm_setting_bridge_port_remove_vlan ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> +nm_setting_bridge_port_remove_vlan (<em class="parameter"><code><a class="link" href="NMSettingBridgePort.html" title="NMSettingBridgePort"><span class="type">NMSettingBridgePort</span></a> *setting</code></em>, + <em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> idx</code></em>);</pre> +<p>Removes the vlan at index <em class="parameter"><code>idx</code></em> +.</p> +<div class="refsect3"> +<a name="nm-setting-bridge-port-remove-vlan.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>setting</p></td> +<td class="parameter_description"><p>the <a class="link" href="NMSettingBridgePort.html" title="NMSettingBridgePort"><span class="type">NMSettingBridgePort</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>idx</p></td> +<td class="parameter_description"><p>index number of the VLAN.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<p class="since">Since: 1.18</p> +</div> +<hr> +<div class="refsect2"> +<a name="nm-setting-bridge-port-remove-vlan-by-vid"></a><h3>nm_setting_bridge_port_remove_vlan_by_vid ()</h3> +<pre class="programlisting"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> +nm_setting_bridge_port_remove_vlan_by_vid + (<em class="parameter"><code><a class="link" href="NMSettingBridgePort.html" title="NMSettingBridgePort"><span class="type">NMSettingBridgePort</span></a> *setting</code></em>, + <em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#guint16"><span class="type">guint16</span></a> vid_start</code></em>, + <em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#guint16"><span class="type">guint16</span></a> vid_end</code></em>);</pre> +<p>Remove the VLAN with range <em class="parameter"><code>vid_start</code></em> + to <em class="parameter"><code>vid_end</code></em> +. +If <em class="parameter"><code>vid_end</code></em> + is zero, it is assumed to be equal to <em class="parameter"><code>vid_start</code></em> + +and so the single-id VLAN with id <em class="parameter"><code>vid_start</code></em> + is removed.</p> +<div class="refsect3"> +<a name="nm-setting-bridge-port-remove-vlan-by-vid.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>setting</p></td> +<td class="parameter_description"><p>the <a class="link" href="NMSettingBridgePort.html" title="NMSettingBridgePort"><span class="type">NMSettingBridgePort</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>vid_start</p></td> +<td class="parameter_description"><p>the vlan start index</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>vid_end</p></td> +<td class="parameter_description"><p>the vlan end index</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="nm-setting-bridge-port-remove-vlan-by-vid.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 vlan was found and removed; <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise</p> +</div> +<p class="since">Since: 1.18</p> +</div> +<hr> +<div class="refsect2"> +<a name="nm-setting-bridge-port-clear-vlans"></a><h3>nm_setting_bridge_port_clear_vlans ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> +nm_setting_bridge_port_clear_vlans (<em class="parameter"><code><a class="link" href="NMSettingBridgePort.html" title="NMSettingBridgePort"><span class="type">NMSettingBridgePort</span></a> *setting</code></em>);</pre> +<p>Removes all configured VLANs.</p> +<div class="refsect3"> +<a name="nm-setting-bridge-port-clear-vlans.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody><tr> +<td class="parameter_name"><p>setting</p></td> +<td class="parameter_description"><p>the <a class="link" href="NMSettingBridgePort.html" title="NMSettingBridgePort"><span class="type">NMSettingBridgePort</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<p class="since">Since: 1.18</p> +</div> </div> <div class="refsect1"> <a name="NMSettingBridgePort.other_details"></a><h2>Types and Values</h2> @@ -263,6 +519,12 @@ nm_setting_bridge_port_get_hairpin_mode </div> <hr> <div class="refsect2"> +<a name="NM-SETTING-BRIDGE-PORT-VLANS:CAPS"></a><h3>NM_SETTING_BRIDGE_PORT_VLANS</h3> +<pre class="programlisting">#define NM_SETTING_BRIDGE_PORT_VLANS "vlans" +</pre> +</div> +<hr> +<div class="refsect2"> <a name="NMSettingBridgePort-struct"></a><h3>NMSettingBridgePort</h3> <pre class="programlisting">typedef struct _NMSettingBridgePort NMSettingBridgePort;</pre> <p>Bridge Port Settings</p> @@ -297,6 +559,23 @@ port.</p> <p>Allowed values: <= 63</p> <p>Default value: 32</p> </div> +<hr> +<div class="refsect2"> +<a name="NMSettingBridgePort--vlans"></a><h3>The <code class="literal">“vlans”</code> property</h3> +<pre class="programlisting"> “vlans” <a href="https://developer.gnome.org/glib/unstable/glib-Pointer-Arrays.html#GPtrArray"><span class="type">GPtrArray</span></a> *</pre> +<p>Array of bridge VLAN objects. In addition to the VLANs +specified here, the port will also have the default-pvid +VLAN configured on the bridge by the bridge.vlan-default-pvid +property.</p> +<p>In nmcli the VLAN list can be specified with the following +syntax:</p> +<p> $vid pvid [, $vid pvid]...</p> +<p>where $vid is either a single id between 1 and 4094 or a +range, represented as a couple of ids separated by a dash.</p> +<p><span class="annotation">[<acronym title="Override the parsed C type with given type."><span class="acronym">type</span></acronym> GPtrArray(NMBridgeVlan)]</span></p> +<p>Flags: Read / Write</p> +<p class="since">Since: 1.18</p> +</div> </div> </div> <div class="footer"> |