diff options
Diffstat (limited to 'docs/libnm/html/NMSettingIPConfig.html')
| -rw-r--r-- | docs/libnm/html/NMSettingIPConfig.html | 156 |
1 files changed, 70 insertions, 86 deletions
diff --git a/docs/libnm/html/NMSettingIPConfig.html b/docs/libnm/html/NMSettingIPConfig.html index ae386b27..9ec05095 100644 --- a/docs/libnm/html/NMSettingIPConfig.html +++ b/docs/libnm/html/NMSettingIPConfig.html @@ -2,13 +2,13 @@ <html> <head> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>libnm Reference Manual: NMSettingIPConfig</title> +<title>NMSettingIPConfig: 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="NMSettingInfiniband.html" title="NMSettingInfiniband"> <link rel="next" href="NMSettingIP4Config.html" title="NMSettingIP4Config"> -<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"> @@ -952,7 +952,6 @@ to.</p></td> <div class="refsect3"> <a name="id-1.4.17.11.6.6"></a><h4>Returns</h4> <p> <code class="literal">TRUE</code> if the objects contain the same values, <code class="literal">FALSE</code> if they do not.</p> -<p></p> </div> </div> <hr> @@ -1009,7 +1008,6 @@ object.</p> <div class="refsect3"> <a name="id-1.4.17.11.8.6"></a><h4>Returns</h4> <p> the IP address family</p> -<p></p> </div> </div> <hr> @@ -1036,7 +1034,6 @@ nm_ip_address_get_address (<em class="parameter"><code><a class="link" href="NMS <div class="refsect3"> <a name="id-1.4.17.11.9.6"></a><h4>Returns</h4> <p> the IP address</p> -<p></p> </div> </div> <hr> @@ -1083,8 +1080,9 @@ nm_ip_address_get_address_binary (<em class="parameter"><code><a class="link" hr <p><em class="parameter"><code>addr</code></em> must point to a buffer that is the correct size for <em class="parameter"><code>address</code></em> 's family.</p> +<p><span class="annotation">[<acronym title="Exposed in C code, not necessarily available in other languages."><span class="acronym">skip</span></acronym>]</span></p> <div class="refsect3"> -<a name="id-1.4.17.11.11.6"></a><h4>Parameters</h4> +<a name="id-1.4.17.11.11.7"></a><h4>Parameters</h4> <div class="informaltable"><table width="100%" border="0"> <colgroup> <col width="150px" class="parameters_name"> @@ -1116,8 +1114,9 @@ nm_ip_address_set_address_binary (<em class="parameter"><code><a class="link" hr <p><em class="parameter"><code>addr</code></em> must point to a buffer that is the correct size for <em class="parameter"><code>address</code></em> 's family.</p> +<p><span class="annotation">[<acronym title="Exposed in C code, not necessarily available in other languages."><span class="acronym">skip</span></acronym>]</span></p> <div class="refsect3"> -<a name="id-1.4.17.11.12.6"></a><h4>Parameters</h4> +<a name="id-1.4.17.11.12.7"></a><h4>Parameters</h4> <div class="informaltable"><table width="100%" border="0"> <colgroup> <col width="150px" class="parameters_name"> @@ -1164,7 +1163,6 @@ object.</p> <div class="refsect3"> <a name="id-1.4.17.11.13.6"></a><h4>Returns</h4> <p> the IP address prefix</p> -<p></p> </div> </div> <hr> @@ -1506,7 +1504,6 @@ to.</p></td> <div class="refsect3"> <a name="id-1.4.17.11.22.6"></a><h4>Returns</h4> <p> <code class="literal">TRUE</code> if the objects contain the same values, <code class="literal">FALSE</code> if they do not.</p> -<p></p> </div> </div> <hr> @@ -1563,7 +1560,6 @@ object.</p> <div class="refsect3"> <a name="id-1.4.17.11.24.6"></a><h4>Returns</h4> <p> the IP address family</p> -<p></p> </div> </div> <hr> @@ -1590,7 +1586,6 @@ nm_ip_route_get_dest (<em class="parameter"><code><a class="link" href="NMSettin <div class="refsect3"> <a name="id-1.4.17.11.25.6"></a><h4>Returns</h4> <p> the IP address of the route's destination</p> -<p></p> </div> </div> <hr> @@ -1637,8 +1632,9 @@ nm_ip_route_get_dest_binary (<em class="parameter"><code><a class="link" href="N <p><em class="parameter"><code>dest</code></em> must point to a buffer that is the correct size for <em class="parameter"><code>route</code></em> 's family.</p> +<p><span class="annotation">[<acronym title="Exposed in C code, not necessarily available in other languages."><span class="acronym">skip</span></acronym>]</span></p> <div class="refsect3"> -<a name="id-1.4.17.11.27.6"></a><h4>Parameters</h4> +<a name="id-1.4.17.11.27.7"></a><h4>Parameters</h4> <div class="informaltable"><table width="100%" border="0"> <colgroup> <col width="150px" class="parameters_name"> @@ -1670,8 +1666,9 @@ nm_ip_route_set_dest_binary (<em class="parameter"><code><a class="link" href="N <p><em class="parameter"><code>dest</code></em> must point to a buffer that is the correct size for <em class="parameter"><code>route</code></em> 's family.</p> +<p><span class="annotation">[<acronym title="Exposed in C code, not necessarily available in other languages."><span class="acronym">skip</span></acronym>]</span></p> <div class="refsect3"> -<a name="id-1.4.17.11.28.6"></a><h4>Parameters</h4> +<a name="id-1.4.17.11.28.7"></a><h4>Parameters</h4> <div class="informaltable"><table width="100%" border="0"> <colgroup> <col width="150px" class="parameters_name"> @@ -1717,7 +1714,6 @@ nm_ip_route_get_prefix (<em class="parameter"><code><a class="link" href="NMSett <div class="refsect3"> <a name="id-1.4.17.11.29.6"></a><h4>Returns</h4> <p> the IP prefix</p> -<p></p> </div> </div> <hr> @@ -1775,7 +1771,6 @@ route has no next hop.</p> <div class="refsect3"> <a name="id-1.4.17.11.31.6"></a><h4>Returns</h4> <p> the IP address of the next hop, or <code class="literal">NULL</code> if this is a device route.</p> -<p></p> </div> </div> <hr> @@ -1823,8 +1818,9 @@ nm_ip_route_get_next_hop_binary (<em class="parameter"><code><a class="link" hre <p><em class="parameter"><code>next_hop</code></em> must point to a buffer that is the correct size for <em class="parameter"><code>route</code></em> 's family.</p> +<p><span class="annotation">[<acronym title="Exposed in C code, not necessarily available in other languages."><span class="acronym">skip</span></acronym>]</span></p> <div class="refsect3"> -<a name="id-1.4.17.11.33.6"></a><h4>Parameters</h4> +<a name="id-1.4.17.11.33.7"></a><h4>Parameters</h4> <div class="informaltable"><table width="100%" border="0"> <colgroup> <col width="150px" class="parameters_name"> @@ -1846,12 +1842,11 @@ nm_ip_route_get_next_hop_binary (<em class="parameter"><code><a class="link" hre </table></div> </div> <div class="refsect3"> -<a name="id-1.4.17.11.33.7"></a><h4>Returns</h4> +<a name="id-1.4.17.11.33.8"></a><h4>Returns</h4> <p> <code class="literal">TRUE</code> if <em class="parameter"><code>route</code></em> has a next hop, <code class="literal">FALSE</code> if not (in which case <em class="parameter"><code>next_hop</code></em> will be zeroed out)</p> -<p></p> </div> </div> <hr> @@ -1865,8 +1860,9 @@ nm_ip_route_set_next_hop_binary (<em class="parameter"><code><a class="link" hre (if non-<code class="literal">NULL</code>) must point to a buffer that is the correct size for <em class="parameter"><code>route</code></em> 's family.</p> +<p><span class="annotation">[<acronym title="Exposed in C code, not necessarily available in other languages."><span class="acronym">skip</span></acronym>]</span></p> <div class="refsect3"> -<a name="id-1.4.17.11.34.6"></a><h4>Parameters</h4> +<a name="id-1.4.17.11.34.7"></a><h4>Parameters</h4> <div class="informaltable"><table width="100%" border="0"> <colgroup> <col width="150px" class="parameters_name"> @@ -1914,7 +1910,6 @@ indicate "better" or more preferred routes; -1 indicates "default" <div class="refsect3"> <a name="id-1.4.17.11.35.6"></a><h4>Returns</h4> <p> the route metric</p> -<p></p> </div> </div> <hr> @@ -2078,7 +2073,6 @@ nm_setting_ip_config_get_method (<em class="parameter"><code><a class="link" hre <p> the <a class="link" href="NMSettingIPConfig.html#NMSettingIPConfig--method" title="The “method” property"><span class="type">“method”</span></a> property of the setting; see <a class="link" href="NMSettingIP4Config.html" title="NMSettingIP4Config"><span class="type">NMSettingIP4Config</span></a> and <a class="link" href="NMSettingIP6Config.html" title="NMSettingIP6Config"><span class="type">NMSettingIP6Config</span></a> for details of the methods available with each type.</p> -<p></p> </div> </div> <hr> @@ -2104,7 +2098,6 @@ nm_setting_ip_config_get_num_dns (<em class="parameter"><code><a class="link" hr <div class="refsect3"> <a name="id-1.4.17.11.41.5"></a><h4>Returns</h4> <p> the number of configured DNS servers</p> -<p></p> </div> </div> <hr> @@ -2139,7 +2132,6 @@ nm_setting_ip_config_get_dns (<em class="parameter"><code><a class="link" href=" <a name="id-1.4.17.11.42.5"></a><h4>Returns</h4> <p> the IP address of the DNS server at index <em class="parameter"><code>i</code></em> </p> -<p></p> </div> </div> <hr> @@ -2175,7 +2167,6 @@ nm_setting_ip_config_add_dns (<em class="parameter"><code><a class="link" href=" <a name="id-1.4.17.11.43.6"></a><h4>Returns</h4> <p> <code class="literal">TRUE</code> if the DNS server was added; <code class="literal">FALSE</code> if the server was already known</p> -<p></p> </div> </div> <hr> @@ -2243,7 +2234,6 @@ nm_setting_ip_config_remove_dns_by_value <div class="refsect3"> <a name="id-1.4.17.11.45.6"></a><h4>Returns</h4> <p> <code class="literal">TRUE</code> if the DNS server was found and removed; <code class="literal">FALSE</code> if it was not.</p> -<p></p> </div> </div> <hr> @@ -2292,7 +2282,6 @@ nm_setting_ip_config_get_num_dns_searches <div class="refsect3"> <a name="id-1.4.17.11.47.5"></a><h4>Returns</h4> <p> the number of configured DNS search domains</p> -<p></p> </div> </div> <hr> @@ -2327,7 +2316,6 @@ nm_setting_ip_config_get_dns_search (<em class="parameter"><code><a class="link" <a name="id-1.4.17.11.48.5"></a><h4>Returns</h4> <p> the DNS search domain at index <em class="parameter"><code>i</code></em> </p> -<p></p> </div> </div> <hr> @@ -2363,7 +2351,6 @@ nm_setting_ip_config_add_dns_search (<em class="parameter"><code><a class="link" <a name="id-1.4.17.11.49.6"></a><h4>Returns</h4> <p> <code class="literal">TRUE</code> if the DNS search domain was added; <code class="literal">FALSE</code> if the search domain was already known</p> -<p></p> </div> </div> <hr> @@ -2433,7 +2420,6 @@ nm_setting_ip_config_remove_dns_search_by_value <a name="id-1.4.17.11.51.6"></a><h4>Returns</h4> <p> <code class="literal">TRUE</code> if the DNS search domain was found and removed; <code class="literal">FALSE</code> if it was not.</p> <p>Since 0.9.10</p> -<p></p> </div> </div> <hr> @@ -2483,7 +2469,6 @@ nm_setting_ip_config_get_num_addresses <div class="refsect3"> <a name="id-1.4.17.11.53.5"></a><h4>Returns</h4> <p> the number of configured addresses</p> -<p></p> </div> </div> <hr> @@ -2518,7 +2503,6 @@ nm_setting_ip_config_get_address (<em class="parameter"><code><a class="link" hr <a name="id-1.4.17.11.54.5"></a><h4>Returns</h4> <p> the address at index <em class="parameter"><code>i</code></em> </p> -<p></p> </div> </div> <hr> @@ -2555,7 +2539,6 @@ given address is duplicated internally and is not changed by this function.</p> <a name="id-1.4.17.11.55.6"></a><h4>Returns</h4> <p> <code class="literal">TRUE</code> if the address was added; <code class="literal">FALSE</code> if the address was already known.</p> -<p></p> </div> </div> <hr> @@ -2623,7 +2606,6 @@ nm_setting_ip_config_remove_address_by_value <div class="refsect3"> <a name="id-1.4.17.11.57.6"></a><h4>Returns</h4> <p> <code class="literal">TRUE</code> if the address was found and removed; <code class="literal">FALSE</code> if it was not.</p> -<p></p> </div> </div> <hr> @@ -2672,7 +2654,6 @@ nm_setting_ip_config_get_gateway (<em class="parameter"><code><a class="link" hr <a name="id-1.4.17.11.59.5"></a><h4>Returns</h4> <p> the IP address of the gateway associated with this configuration, or <code class="literal">NULL</code>.</p> -<p></p> </div> </div> <hr> @@ -2698,7 +2679,6 @@ nm_setting_ip_config_get_num_routes (<em class="parameter"><code><a class="link" <div class="refsect3"> <a name="id-1.4.17.11.60.5"></a><h4>Returns</h4> <p> the number of configured routes</p> -<p></p> </div> </div> <hr> @@ -2733,7 +2713,6 @@ nm_setting_ip_config_get_route (<em class="parameter"><code><a class="link" href <a name="id-1.4.17.11.61.5"></a><h4>Returns</h4> <p> the route at index <em class="parameter"><code>i</code></em> </p> -<p></p> </div> </div> <hr> @@ -2769,7 +2748,6 @@ given route is duplicated internally and is not changed by this function.</p> <div class="refsect3"> <a name="id-1.4.17.11.62.6"></a><h4>Returns</h4> <p> <code class="literal">TRUE</code> if the route was added; <code class="literal">FALSE</code> if the route was already known.</p> -<p></p> </div> </div> <hr> @@ -2837,7 +2815,6 @@ nm_setting_ip_config_remove_route_by_value <div class="refsect3"> <a name="id-1.4.17.11.64.6"></a><h4>Returns</h4> <p> <code class="literal">TRUE</code> if the route was found and removed; <code class="literal">FALSE</code> if it was not.</p> -<p></p> </div> </div> <hr> @@ -2888,7 +2865,6 @@ property.</p> <a name="id-1.4.17.11.66.6"></a><h4>Returns</h4> <p> the route metric that is used for routes that don't explicitly specify a metric. See <a class="link" href="NMSettingIPConfig.html#NMSettingIPConfig--route-metric" title="The “route-metric” property"><span class="type">“route-metric”</span></a> for more details.</p> -<p></p> </div> </div> <hr> @@ -2918,7 +2894,6 @@ property.</p> <a name="id-1.4.17.11.67.6"></a><h4>Returns</h4> <p> <code class="literal">TRUE</code> if automatically configured (ie via DHCP) routes should be ignored.</p> -<p></p> </div> </div> <hr> @@ -2948,7 +2923,6 @@ property.</p> <a name="id-1.4.17.11.68.6"></a><h4>Returns</h4> <p> <code class="literal">TRUE</code> if automatically configured (ie via DHCP) DNS information should be ignored.</p> -<p></p> </div> </div> <hr> @@ -2977,7 +2951,6 @@ property.</p> <div class="refsect3"> <a name="id-1.4.17.11.69.6"></a><h4>Returns</h4> <p> the configured hostname to send to the DHCP server</p> -<p></p> </div> </div> <hr> @@ -3008,7 +2981,6 @@ property.</p> <p> <code class="literal">TRUE</code> if NetworkManager should send the machine hostname to the DHCP server when requesting addresses to allow the server to automatically update DNS information for this machine.</p> -<p></p> </div> </div> <hr> @@ -3038,7 +3010,6 @@ property.</p> <a name="id-1.4.17.11.71.6"></a><h4>Returns</h4> <p> <code class="literal">TRUE</code> if this connection should never be the default connection</p> -<p></p> </div> </div> <hr> @@ -3067,7 +3038,6 @@ property.</p> <a name="id-1.4.17.11.72.6"></a><h4>Returns</h4> <p> <code class="literal">TRUE</code> if this connection doesn't require this type of IP addressing to complete for the connection to succeed.</p> -<p></p> </div> </div> </div> @@ -3077,104 +3047,78 @@ addressing to complete for the connection to succeed.</p> <a name="NM-SETTING-IP-CONFIG-METHOD:CAPS"></a><h3>NM_SETTING_IP_CONFIG_METHOD</h3> <pre class="programlisting">#define NM_SETTING_IP_CONFIG_METHOD "method" </pre> -<p> -</p> </div> <hr> <div class="refsect2"> <a name="NM-SETTING-IP-CONFIG-DNS:CAPS"></a><h3>NM_SETTING_IP_CONFIG_DNS</h3> <pre class="programlisting">#define NM_SETTING_IP_CONFIG_DNS "dns" </pre> -<p> -</p> </div> <hr> <div class="refsect2"> <a name="NM-SETTING-IP-CONFIG-DNS-SEARCH:CAPS"></a><h3>NM_SETTING_IP_CONFIG_DNS_SEARCH</h3> <pre class="programlisting">#define NM_SETTING_IP_CONFIG_DNS_SEARCH "dns-search" </pre> -<p> -</p> </div> <hr> <div class="refsect2"> <a name="NM-SETTING-IP-CONFIG-ADDRESSES:CAPS"></a><h3>NM_SETTING_IP_CONFIG_ADDRESSES</h3> <pre class="programlisting">#define NM_SETTING_IP_CONFIG_ADDRESSES "addresses" </pre> -<p> -</p> </div> <hr> <div class="refsect2"> <a name="NM-SETTING-IP-CONFIG-GATEWAY:CAPS"></a><h3>NM_SETTING_IP_CONFIG_GATEWAY</h3> <pre class="programlisting">#define NM_SETTING_IP_CONFIG_GATEWAY "gateway" </pre> -<p> -</p> </div> <hr> <div class="refsect2"> <a name="NM-SETTING-IP-CONFIG-ROUTES:CAPS"></a><h3>NM_SETTING_IP_CONFIG_ROUTES</h3> <pre class="programlisting">#define NM_SETTING_IP_CONFIG_ROUTES "routes" </pre> -<p> -</p> </div> <hr> <div class="refsect2"> <a name="NM-SETTING-IP-CONFIG-ROUTE-METRIC:CAPS"></a><h3>NM_SETTING_IP_CONFIG_ROUTE_METRIC</h3> <pre class="programlisting">#define NM_SETTING_IP_CONFIG_ROUTE_METRIC "route-metric" </pre> -<p> -</p> </div> <hr> <div class="refsect2"> <a name="NM-SETTING-IP-CONFIG-IGNORE-AUTO-ROUTES:CAPS"></a><h3>NM_SETTING_IP_CONFIG_IGNORE_AUTO_ROUTES</h3> <pre class="programlisting">#define NM_SETTING_IP_CONFIG_IGNORE_AUTO_ROUTES "ignore-auto-routes" </pre> -<p> -</p> </div> <hr> <div class="refsect2"> <a name="NM-SETTING-IP-CONFIG-IGNORE-AUTO-DNS:CAPS"></a><h3>NM_SETTING_IP_CONFIG_IGNORE_AUTO_DNS</h3> <pre class="programlisting">#define NM_SETTING_IP_CONFIG_IGNORE_AUTO_DNS "ignore-auto-dns" </pre> -<p> -</p> </div> <hr> <div class="refsect2"> <a name="NM-SETTING-IP-CONFIG-DHCP-HOSTNAME:CAPS"></a><h3>NM_SETTING_IP_CONFIG_DHCP_HOSTNAME</h3> <pre class="programlisting">#define NM_SETTING_IP_CONFIG_DHCP_HOSTNAME "dhcp-hostname" </pre> -<p> -</p> </div> <hr> <div class="refsect2"> <a name="NM-SETTING-IP-CONFIG-DHCP-SEND-HOSTNAME:CAPS"></a><h3>NM_SETTING_IP_CONFIG_DHCP_SEND_HOSTNAME</h3> <pre class="programlisting">#define NM_SETTING_IP_CONFIG_DHCP_SEND_HOSTNAME "dhcp-send-hostname" </pre> -<p> -</p> </div> <hr> <div class="refsect2"> <a name="NM-SETTING-IP-CONFIG-NEVER-DEFAULT:CAPS"></a><h3>NM_SETTING_IP_CONFIG_NEVER_DEFAULT</h3> <pre class="programlisting">#define NM_SETTING_IP_CONFIG_NEVER_DEFAULT "never-default" </pre> -<p> -</p> </div> <hr> <div class="refsect2"> <a name="NM-SETTING-IP-CONFIG-MAY-FAIL:CAPS"></a><h3>NM_SETTING_IP_CONFIG_MAY_FAIL</h3> <pre class="programlisting">#define NM_SETTING_IP_CONFIG_MAY_FAIL "may-fail" </pre> -<p> -</p> </div> </div> <div class="refsect1"> @@ -3182,14 +3126,16 @@ addressing to complete for the connection to succeed.</p> <div class="refsect2"> <a name="NMSettingIPConfig--addresses"></a><h3>The <code class="literal">“addresses”</code> property</h3> <pre class="programlisting"> “addresses” <span class="type">GPtrArray</span> *</pre> -<p></p> +<p>Array of IP addresses.</p> +<p>Element-Type: NMIPAddress</p> <p>Flags: Read / Write</p> </div> <hr> <div class="refsect2"> <a name="NMSettingIPConfig--dhcp-hostname"></a><h3>The <code class="literal">“dhcp-hostname”</code> property</h3> <pre class="programlisting"> “dhcp-hostname” <span class="type">gchar</span> *</pre> -<p></p> +<p>If the <a class="link" href="NMSettingIPConfig.html#NMSettingIPConfig--dhcp-send-hostname" title="The “dhcp-send-hostname” property"><span class="type">“dhcp-send-hostname”</span></a> property is <code class="literal">TRUE</code>, then the +specified name will be sent to the DHCP server when acquiring a lease.</p> <p>Flags: Read / Write</p> <p>Default value: NULL</p> </div> @@ -3197,7 +3143,11 @@ addressing to complete for the connection to succeed.</p> <div class="refsect2"> <a name="NMSettingIPConfig--dhcp-send-hostname"></a><h3>The <code class="literal">“dhcp-send-hostname”</code> property</h3> <pre class="programlisting"> “dhcp-send-hostname” <span class="type">gboolean</span></pre> -<p></p> +<p>If <code class="literal">TRUE</code>, a hostname is sent to the DHCP server when acquiring a lease. +Some DHCP servers use this hostname to update DNS databases, essentially +providing a static hostname for the computer. If the +<a class="link" href="NMSettingIPConfig.html#NMSettingIPConfig--dhcp-hostname" title="The “dhcp-hostname” property"><span class="type">“dhcp-hostname”</span></a> property is <code class="literal">NULL</code> and this property is +<code class="literal">TRUE</code>, the current persistent hostname of the computer is sent.</p> <p>Flags: Read / Write / Construct</p> <p>Default value: TRUE</p> </div> @@ -3205,21 +3155,22 @@ addressing to complete for the connection to succeed.</p> <div class="refsect2"> <a name="NMSettingIPConfig--dns"></a><h3>The <code class="literal">“dns”</code> property</h3> <pre class="programlisting"> “dns” <span class="type">GStrv</span></pre> -<p></p> +<p>Array of IP addresses of DNS servers.</p> <p>Flags: Read / Write</p> </div> <hr> <div class="refsect2"> <a name="NMSettingIPConfig--dns-search"></a><h3>The <code class="literal">“dns-search”</code> property</h3> <pre class="programlisting"> “dns-search” <span class="type">GStrv</span></pre> -<p></p> +<p>Array of DNS search domains.</p> <p>Flags: Read / Write</p> </div> <hr> <div class="refsect2"> <a name="NMSettingIPConfig--gateway"></a><h3>The <code class="literal">“gateway”</code> property</h3> <pre class="programlisting"> “gateway” <span class="type">gchar</span> *</pre> -<p></p> +<p>The gateway associated with this configuration. This is only meaningful +if <a class="link" href="NMSettingIPConfig.html#NMSettingIPConfig--addresses" title="The “addresses” property"><span class="type">“addresses”</span></a> is also set.</p> <p>Flags: Read / Write</p> <p>Default value: NULL</p> </div> @@ -3227,7 +3178,11 @@ addressing to complete for the connection to succeed.</p> <div class="refsect2"> <a name="NMSettingIPConfig--ignore-auto-dns"></a><h3>The <code class="literal">“ignore-auto-dns”</code> property</h3> <pre class="programlisting"> “ignore-auto-dns” <span class="type">gboolean</span></pre> -<p></p> +<p>When <a class="link" href="NMSettingIPConfig.html#NMSettingIPConfig--method" title="The “method” property"><span class="type">“method”</span></a> is set to "auto" and this property to +<code class="literal">TRUE</code>, automatically configured nameservers and search domains are +ignored and only nameservers and search domains specified in the +<a class="link" href="NMSettingIPConfig.html#NMSettingIPConfig--dns" title="The “dns” property"><span class="type">“dns”</span></a> and <a class="link" href="NMSettingIPConfig.html#NMSettingIPConfig--dns-search" title="The “dns-search” property"><span class="type">“dns-search”</span></a> properties, if +any, are used.</p> <p>Flags: Read / Write / Construct</p> <p>Default value: FALSE</p> </div> @@ -3235,7 +3190,9 @@ addressing to complete for the connection to succeed.</p> <div class="refsect2"> <a name="NMSettingIPConfig--ignore-auto-routes"></a><h3>The <code class="literal">“ignore-auto-routes”</code> property</h3> <pre class="programlisting"> “ignore-auto-routes” <span class="type">gboolean</span></pre> -<p></p> +<p>When <a class="link" href="NMSettingIPConfig.html#NMSettingIPConfig--method" title="The “method” property"><span class="type">“method”</span></a> is set to "auto" and this property to +<code class="literal">TRUE</code>, automatically configured routes are ignored and only routes +specified in the <a class="link" href="NMSettingIPConfig.html#NMSettingIPConfig--routes" title="The “routes” property"><span class="type">“routes”</span></a> property, if any, are used.</p> <p>Flags: Read / Write / Construct</p> <p>Default value: FALSE</p> </div> @@ -3243,7 +3200,13 @@ addressing to complete for the connection to succeed.</p> <div class="refsect2"> <a name="NMSettingIPConfig--may-fail"></a><h3>The <code class="literal">“may-fail”</code> property</h3> <pre class="programlisting"> “may-fail” <span class="type">gboolean</span></pre> -<p></p> +<p>If <code class="literal">TRUE</code>, allow overall network configuration to proceed even if the +configuration specified by this property times out. Note that at least +one IP configuration must succeed or overall network configuration will +still fail. For example, in IPv6-only networks, setting this property to +<code class="literal">TRUE</code> on the <a class="link" href="NMSettingIP4Config.html" title="NMSettingIP4Config"><span class="type">NMSettingIP4Config</span></a> allows the overall network configuration +to succeed if IPv4 configuration fails but IPv6 configuration completes +successfully.</p> <p>Flags: Read / Write / Construct</p> <p>Default value: TRUE</p> </div> @@ -3251,7 +3214,17 @@ addressing to complete for the connection to succeed.</p> <div class="refsect2"> <a name="NMSettingIPConfig--method"></a><h3>The <code class="literal">“method”</code> property</h3> <pre class="programlisting"> “method” <span class="type">gchar</span> *</pre> -<p></p> +<p>IP configuration method.</p> +<p><a class="link" href="NMSettingIP4Config.html" title="NMSettingIP4Config"><span class="type">NMSettingIP4Config</span></a> and <a class="link" href="NMSettingIP6Config.html" title="NMSettingIP6Config"><span class="type">NMSettingIP6Config</span></a> both support "auto", +"manual", and "link-local". See the subclass-specific documentation for +other values.</p> +<p>In general, for the "auto" method, properties such as +<a class="link" href="NMSettingIPConfig.html#NMSettingIPConfig--dns" title="The “dns” property"><span class="type">“dns”</span></a> and <a class="link" href="NMSettingIPConfig.html#NMSettingIPConfig--routes" title="The “routes” property"><span class="type">“routes”</span></a> specify information +that is added on to the information returned from automatic +configuration. The <a class="link" href="NMSettingIPConfig.html#NMSettingIPConfig--ignore-auto-routes" title="The “ignore-auto-routes” property"><span class="type">“ignore-auto-routes”</span></a> and +<a class="link" href="NMSettingIPConfig.html#NMSettingIPConfig--ignore-auto-dns" title="The “ignore-auto-dns” property"><span class="type">“ignore-auto-dns”</span></a> properties modify this behavior.</p> +<p>For methods that imply no upstream network, such as "shared" or +"link-local", these properties must be empty.</p> <p>Flags: Read / Write</p> <p>Default value: NULL</p> </div> @@ -3259,7 +3232,9 @@ addressing to complete for the connection to succeed.</p> <div class="refsect2"> <a name="NMSettingIPConfig--never-default"></a><h3>The <code class="literal">“never-default”</code> property</h3> <pre class="programlisting"> “never-default” <span class="type">gboolean</span></pre> -<p></p> +<p>If <code class="literal">TRUE</code>, this connection will never be the default connection for this +IP type, meaning it will never be assigned the default route by +NetworkManager.</p> <p>Flags: Read / Write / Construct</p> <p>Default value: FALSE</p> </div> @@ -3267,7 +3242,16 @@ addressing to complete for the connection to succeed.</p> <div class="refsect2"> <a name="NMSettingIPConfig--route-metric"></a><h3>The <code class="literal">“route-metric”</code> property</h3> <pre class="programlisting"> “route-metric” <span class="type">gint64</span></pre> -<p></p> +<p>The default metric for routes that don't explicitly specify a metric. +The default value -1 means that the metric is choosen automatically +based on the device type. +The metric applies to dynamic routes, manual (static) routes that +don't have an explicit metric setting, address prefix routes, and +the default route. +Note that for IPv6, the kernel accepts zero (0) but coerces it to +1024 (user default). Hence, setting this property to zero effectively +mean setting it to 1024. +For IPv4, zero is a regular value for the metric.</p> <p>Flags: Read / Write / Construct</p> <p>Allowed values: [-1,4294967295]</p> <p>Default value: -1</p> @@ -3276,7 +3260,8 @@ addressing to complete for the connection to succeed.</p> <div class="refsect2"> <a name="NMSettingIPConfig--routes"></a><h3>The <code class="literal">“routes”</code> property</h3> <pre class="programlisting"> “routes” <span class="type">GPtrArray</span> *</pre> -<p></p> +<p>Array of IP routes.</p> +<p>Element-Type: NMIPRoute</p> <p>Flags: Read / Write</p> </div> </div> @@ -3286,7 +3271,6 @@ addressing to complete for the connection to succeed.</p> </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 |