diff options
Diffstat (limited to 'docs/libnm/html/NMSettingWired.html')
| -rw-r--r-- | docs/libnm/html/NMSettingWired.html | 96 |
1 files changed, 39 insertions, 57 deletions
diff --git a/docs/libnm/html/NMSettingWired.html b/docs/libnm/html/NMSettingWired.html index a65d2e22d..6255f6c83 100644 --- a/docs/libnm/html/NMSettingWired.html +++ b/docs/libnm/html/NMSettingWired.html @@ -2,13 +2,13 @@ <html> <head> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>libnm Reference Manual: NMSettingWired</title> +<title>NMSettingWired: libnm Reference Manual</title> <meta name="generator" content="DocBook XSL Stylesheets V1.78.1"> <link rel="home" href="index.html" title="libnm Reference Manual"> <link rel="up" href="ch03.html" title="Connection and Setting API Reference"> <link rel="prev" href="NMSettingWimax.html" title="NMSettingWimax"> <link rel="next" href="NMSettingWireless.html" title="NMSettingWireless"> -<meta name="generator" content="GTK-Doc V1.21 (XML mode)"> +<meta name="generator" content="GTK-Doc V1.24 (XML mode)"> <link rel="stylesheet" href="style.css" type="text/css"> </head> <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> @@ -398,7 +398,6 @@ nm_setting_wired_get_port (<em class="parameter"><code><a class="link" href="NMS <div class="refsect3"> <a name="id-1.4.29.8.3.5"></a><h4>Returns</h4> <p> the <a class="link" href="NMSettingWired.html#NMSettingWired--port" title="The “port” property"><span class="type">“port”</span></a> property of the setting</p> -<p></p> </div> </div> <hr> @@ -424,7 +423,6 @@ nm_setting_wired_get_speed (<em class="parameter"><code><a class="link" href="NM <div class="refsect3"> <a name="id-1.4.29.8.4.5"></a><h4>Returns</h4> <p> the <a class="link" href="NMSettingWired.html#NMSettingWired--speed" title="The “speed” property"><span class="type">“speed”</span></a> property of the setting</p> -<p></p> </div> </div> <hr> @@ -450,7 +448,6 @@ nm_setting_wired_get_duplex (<em class="parameter"><code><a class="link" href="N <div class="refsect3"> <a name="id-1.4.29.8.5.5"></a><h4>Returns</h4> <p> the <a class="link" href="NMSettingWired.html#NMSettingWired--duplex" title="The “duplex” property"><span class="type">“duplex”</span></a> property of the setting</p> -<p></p> </div> </div> <hr> @@ -476,7 +473,6 @@ nm_setting_wired_get_auto_negotiate (<em class="parameter"><code><a class="link" <div class="refsect3"> <a name="id-1.4.29.8.6.5"></a><h4>Returns</h4> <p> the <a class="link" href="NMSettingWired.html#NMSettingWired--auto-negotiate" title="The “auto-negotiate” property"><span class="type">“auto-negotiate”</span></a> property of the setting</p> -<p></p> </div> </div> <hr> @@ -502,7 +498,6 @@ nm_setting_wired_get_mac_address (<em class="parameter"><code><a class="link" hr <div class="refsect3"> <a name="id-1.4.29.8.7.5"></a><h4>Returns</h4> <p> the <a class="link" href="NMSettingWired.html#NMSettingWired--mac-address" title="The “mac-address” property"><span class="type">“mac-address”</span></a> property of the setting</p> -<p></p> </div> </div> <hr> @@ -529,7 +524,6 @@ nm_setting_wired_get_cloned_mac_address <div class="refsect3"> <a name="id-1.4.29.8.8.5"></a><h4>Returns</h4> <p> the <a class="link" href="NMSettingWired.html#NMSettingWired--cloned-mac-address" title="The “cloned-mac-address” property"><span class="type">“cloned-mac-address”</span></a> property of the setting</p> -<p></p> </div> </div> <hr> @@ -556,7 +550,6 @@ nm_setting_wired_get_mac_address_blacklist <div class="refsect3"> <a name="id-1.4.29.8.9.5"></a><h4>Returns</h4> <p> the <a class="link" href="NMSettingWired.html#NMSettingWired--mac-address-blacklist" title="The “mac-address-blacklist” property"><span class="type">“mac-address-blacklist”</span></a> property of the setting</p> -<p></p> </div> </div> <hr> @@ -583,7 +576,6 @@ nm_setting_wired_get_num_mac_blacklist_items <div class="refsect3"> <a name="id-1.4.29.8.10.5"></a><h4>Returns</h4> <p> the number of blacklisted MAC addresses</p> -<p></p> </div> </div> <hr> @@ -620,7 +612,6 @@ nm_setting_wired_get_mac_blacklist_item <p> the blacklisted MAC address string (hex-digits-and-colons notation) at index <em class="parameter"><code>idx</code></em> </p> -<p></p> </div> </div> <hr> @@ -657,7 +648,6 @@ nm_setting_wired_add_mac_blacklist_item <a name="id-1.4.29.8.12.6"></a><h4>Returns</h4> <p> <code class="literal">TRUE</code> if the MAC address was added; <code class="literal">FALSE</code> if the MAC address is invalid or was already present</p> -<p></p> </div> </div> <hr> @@ -727,7 +717,6 @@ the blacklist</p></td> <div class="refsect3"> <a name="id-1.4.29.8.14.6"></a><h4>Returns</h4> <p> <code class="literal">TRUE</code> if the MAC address was found and removed; <code class="literal">FALSE</code> if it was not.</p> -<p></p> </div> </div> <hr> @@ -776,7 +765,6 @@ nm_setting_wired_get_mtu (<em class="parameter"><code><a class="link" href="NMSe <div class="refsect3"> <a name="id-1.4.29.8.16.5"></a><h4>Returns</h4> <p> the <a class="link" href="NMSettingWired.html#NMSettingWired--mtu" title="The “mtu” property"><span class="type">“mtu”</span></a> property of the setting</p> -<p></p> </div> </div> <hr> @@ -834,7 +822,6 @@ of 'qeth', 'lcs', or 'ctc'.</p> <div class="refsect3"> <a name="id-1.4.29.8.18.6"></a><h4>Returns</h4> <p> the s390 device type</p> -<p></p> </div> </div> <hr> @@ -863,7 +850,6 @@ option individually using <a class="link" href="NMSettingWired.html#nm-setting-w <div class="refsect3"> <a name="id-1.4.29.8.19.6"></a><h4>Returns</h4> <p> the number of s390-specific device options</p> -<p></p> </div> </div> <hr> @@ -920,7 +906,6 @@ modified. </p></td> <p> <code class="literal">TRUE</code> on success if the index was valid and an option was found, <code class="literal">FALSE</code> if the index was invalid (ie, greater than the number of options currently held by the setting)</p> -<p></p> </div> </div> <hr> @@ -959,7 +944,6 @@ nm_setting_wired_get_s390_option_by_key <a name="id-1.4.29.8.21.6"></a><h4>Returns</h4> <p> the value, or <code class="literal">NULL</code> if the key/value pair was never added to the setting; the value is owned by the setting and must not be modified</p> -<p></p> </div> </div> <hr> @@ -1004,7 +988,6 @@ may already exist.</p> <a name="id-1.4.29.8.22.6"></a><h4>Returns</h4> <p> <code class="literal">TRUE</code> if the option was valid and was added to the internal option list, <code class="literal">FALSE</code> if it was not.</p> -<p></p> </div> </div> <hr> @@ -1042,7 +1025,6 @@ list.</p> <a name="id-1.4.29.8.23.6"></a><h4>Returns</h4> <p> <code class="literal">TRUE</code> if the option was found and removed from the internal option list, <code class="literal">FALSE</code> if it was not.</p> -<p></p> </div> </div> <hr> @@ -1080,96 +1062,72 @@ nm_setting_wired_get_valid_s390_options <a name="NM-SETTING-WIRED-SETTING-NAME:CAPS"></a><h3>NM_SETTING_WIRED_SETTING_NAME</h3> <pre class="programlisting">#define NM_SETTING_WIRED_SETTING_NAME "802-3-ethernet" </pre> -<p> -</p> </div> <hr> <div class="refsect2"> <a name="NM-SETTING-WIRED-PORT:CAPS"></a><h3>NM_SETTING_WIRED_PORT</h3> <pre class="programlisting">#define NM_SETTING_WIRED_PORT "port" </pre> -<p> -</p> </div> <hr> <div class="refsect2"> <a name="NM-SETTING-WIRED-SPEED:CAPS"></a><h3>NM_SETTING_WIRED_SPEED</h3> <pre class="programlisting">#define NM_SETTING_WIRED_SPEED "speed" </pre> -<p> -</p> </div> <hr> <div class="refsect2"> <a name="NM-SETTING-WIRED-DUPLEX:CAPS"></a><h3>NM_SETTING_WIRED_DUPLEX</h3> <pre class="programlisting">#define NM_SETTING_WIRED_DUPLEX "duplex" </pre> -<p> -</p> </div> <hr> <div class="refsect2"> <a name="NM-SETTING-WIRED-AUTO-NEGOTIATE:CAPS"></a><h3>NM_SETTING_WIRED_AUTO_NEGOTIATE</h3> <pre class="programlisting">#define NM_SETTING_WIRED_AUTO_NEGOTIATE "auto-negotiate" </pre> -<p> -</p> </div> <hr> <div class="refsect2"> <a name="NM-SETTING-WIRED-MAC-ADDRESS:CAPS"></a><h3>NM_SETTING_WIRED_MAC_ADDRESS</h3> <pre class="programlisting">#define NM_SETTING_WIRED_MAC_ADDRESS "mac-address" </pre> -<p> -</p> </div> <hr> <div class="refsect2"> <a name="NM-SETTING-WIRED-CLONED-MAC-ADDRESS:CAPS"></a><h3>NM_SETTING_WIRED_CLONED_MAC_ADDRESS</h3> <pre class="programlisting">#define NM_SETTING_WIRED_CLONED_MAC_ADDRESS "cloned-mac-address" </pre> -<p> -</p> </div> <hr> <div class="refsect2"> <a name="NM-SETTING-WIRED-MAC-ADDRESS-BLACKLIST:CAPS"></a><h3>NM_SETTING_WIRED_MAC_ADDRESS_BLACKLIST</h3> <pre class="programlisting">#define NM_SETTING_WIRED_MAC_ADDRESS_BLACKLIST "mac-address-blacklist" </pre> -<p> -</p> </div> <hr> <div class="refsect2"> <a name="NM-SETTING-WIRED-MTU:CAPS"></a><h3>NM_SETTING_WIRED_MTU</h3> <pre class="programlisting">#define NM_SETTING_WIRED_MTU "mtu" </pre> -<p> -</p> </div> <hr> <div class="refsect2"> <a name="NM-SETTING-WIRED-S390-SUBCHANNELS:CAPS"></a><h3>NM_SETTING_WIRED_S390_SUBCHANNELS</h3> <pre class="programlisting">#define NM_SETTING_WIRED_S390_SUBCHANNELS "s390-subchannels" </pre> -<p> -</p> </div> <hr> <div class="refsect2"> <a name="NM-SETTING-WIRED-S390-NETTYPE:CAPS"></a><h3>NM_SETTING_WIRED_S390_NETTYPE</h3> <pre class="programlisting">#define NM_SETTING_WIRED_S390_NETTYPE "s390-nettype" </pre> -<p> -</p> </div> <hr> <div class="refsect2"> <a name="NM-SETTING-WIRED-S390-OPTIONS:CAPS"></a><h3>NM_SETTING_WIRED_S390_OPTIONS</h3> <pre class="programlisting">#define NM_SETTING_WIRED_S390_OPTIONS "s390-options" </pre> -<p> -</p> </div> </div> <div class="refsect1"> @@ -1177,7 +1135,9 @@ nm_setting_wired_get_valid_s390_options <div class="refsect2"> <a name="NMSettingWired--auto-negotiate"></a><h3>The <code class="literal">“auto-negotiate”</code> property</h3> <pre class="programlisting"> “auto-negotiate” <span class="type">gboolean</span></pre> -<p></p> +<p>If <code class="literal">TRUE</code>, allow auto-negotiation of port speed and duplex mode. If +<code class="literal">FALSE</code>, do not allow auto-negotiation, in which case the "speed" and +"duplex" properties should be set.</p> <p>Flags: Read / Write / Construct</p> <p>Default value: TRUE</p> </div> @@ -1185,7 +1145,8 @@ nm_setting_wired_get_valid_s390_options <div class="refsect2"> <a name="NMSettingWired--cloned-mac-address"></a><h3>The <code class="literal">“cloned-mac-address”</code> property</h3> <pre class="programlisting"> “cloned-mac-address” <span class="type">gchar</span> *</pre> -<p></p> +<p>If specified, request that the device use this MAC address instead of its +permanent MAC address. This is known as MAC cloning or spoofing.</p> <p>Flags: Read / Write</p> <p>Default value: NULL</p> </div> @@ -1193,7 +1154,8 @@ nm_setting_wired_get_valid_s390_options <div class="refsect2"> <a name="NMSettingWired--duplex"></a><h3>The <code class="literal">“duplex”</code> property</h3> <pre class="programlisting"> “duplex” <span class="type">gchar</span> *</pre> -<p></p> +<p>If specified, request that the device only use the specified duplex mode. +Either "half" or "full".</p> <p>Flags: Read / Write</p> <p>Default value: NULL</p> </div> @@ -1201,7 +1163,9 @@ nm_setting_wired_get_valid_s390_options <div class="refsect2"> <a name="NMSettingWired--mac-address"></a><h3>The <code class="literal">“mac-address”</code> property</h3> <pre class="programlisting"> “mac-address” <span class="type">gchar</span> *</pre> -<p></p> +<p>If specified, this connection will only apply to the Ethernet device +whose permanent MAC address matches. This property does not change the +MAC address of the device (i.e. MAC spoofing).</p> <p>Flags: Read / Write</p> <p>Default value: NULL</p> </div> @@ -1209,14 +1173,18 @@ nm_setting_wired_get_valid_s390_options <div class="refsect2"> <a name="NMSettingWired--mac-address-blacklist"></a><h3>The <code class="literal">“mac-address-blacklist”</code> property</h3> <pre class="programlisting"> “mac-address-blacklist” <span class="type">GStrv</span></pre> -<p></p> +<p>If specified, this connection will never apply to the Ethernet device +whose permanent MAC address matches an address in the list. Each MAC +address is in the standard hex-digits-and-colons notation +(00:11:22:33:44:55).</p> <p>Flags: Read / Write</p> </div> <hr> <div class="refsect2"> <a name="NMSettingWired--mtu"></a><h3>The <code class="literal">“mtu”</code> property</h3> <pre class="programlisting"> “mtu” <span class="type">guint</span></pre> -<p></p> +<p>If non-zero, only transmit packets of the specified size or smaller, +breaking larger packets up into multiple Ethernet frames.</p> <p>Flags: Read / Write / Construct</p> <p>Default value: 0</p> </div> @@ -1224,7 +1192,10 @@ nm_setting_wired_get_valid_s390_options <div class="refsect2"> <a name="NMSettingWired--port"></a><h3>The <code class="literal">“port”</code> property</h3> <pre class="programlisting"> “port” <span class="type">gchar</span> *</pre> -<p></p> +<p>Specific port type to use if multiple the device supports multiple +attachment methods. One of "tp" (Twisted Pair), "aui" (Attachment Unit +Interface), "bnc" (Thin Ethernet) or "mii" (Media Independent Interface. +If the device supports only one port type, this setting is ignored.</p> <p>Flags: Read / Write</p> <p>Default value: NULL</p> </div> @@ -1232,7 +1203,8 @@ nm_setting_wired_get_valid_s390_options <div class="refsect2"> <a name="NMSettingWired--s390-nettype"></a><h3>The <code class="literal">“s390-nettype”</code> property</h3> <pre class="programlisting"> “s390-nettype” <span class="type">gchar</span> *</pre> -<p></p> +<p>s390 network device type; one of "qeth", "lcs", or "ctc", representing +the different types of virtual network devices available on s390 systems.</p> <p>Flags: Read / Write</p> <p>Default value: NULL</p> </div> @@ -1240,28 +1212,38 @@ nm_setting_wired_get_valid_s390_options <div class="refsect2"> <a name="NMSettingWired--s390-options"></a><h3>The <code class="literal">“s390-options”</code> property</h3> <pre class="programlisting"> “s390-options” <span class="type">GHashTable</span> *</pre> -<p></p> +<p>Dictionary of key/value pairs of s390-specific device options. Both keys +and values must be strings. Allowed keys include "portno", "layer2", +"portname", "protocol", among others. Key names must contain only +alphanumeric characters (ie, [a-zA-Z0-9]).</p> +<p>Type: GHashTable(utf8,utf8)</p> <p>Flags: Read / Write</p> </div> <hr> <div class="refsect2"> <a name="NMSettingWired--s390-subchannels"></a><h3>The <code class="literal">“s390-subchannels”</code> property</h3> <pre class="programlisting"> “s390-subchannels” <span class="type">GStrv</span></pre> -<p></p> +<p>Identifies specific subchannels that this network device uses for +communication with z/VM or s390 host. Like the +<a class="link" href="NMSettingWired.html#NMSettingWired--mac-address" title="The “mac-address” property"><span class="type">“mac-address”</span></a> property for non-z/VM devices, this property +can be used to ensure this connection only applies to the network device +that uses these subchannels. The list should contain exactly 3 strings, +and each string may only be composed of hexadecimal characters and the +period (.) character.</p> <p>Flags: Read / Write</p> </div> <hr> <div class="refsect2"> <a name="NMSettingWired--speed"></a><h3>The <code class="literal">“speed”</code> property</h3> <pre class="programlisting"> “speed” <span class="type">guint</span></pre> -<p></p> +<p>If non-zero, request that the device use only the specified speed. In +Mbit/s, ie 100 == 100Mbit/s.</p> <p>Flags: Read / Write / Construct</p> <p>Default value: 0</p> </div> </div> </div> <div class="footer"> -<hr> - Generated by GTK-Doc V1.21</div> +<hr>Generated by GTK-Doc V1.24</div> </body> </html>
\ No newline at end of file |