diff options
Diffstat (limited to 'docs/libnm-util/html/NMSettingIP4Config.html')
| -rw-r--r-- | docs/libnm-util/html/NMSettingIP4Config.html | 167 |
1 files changed, 80 insertions, 87 deletions
diff --git a/docs/libnm-util/html/NMSettingIP4Config.html b/docs/libnm-util/html/NMSettingIP4Config.html index c96dc86d..08d29926 100644 --- a/docs/libnm-util/html/NMSettingIP4Config.html +++ b/docs/libnm-util/html/NMSettingIP4Config.html @@ -2,13 +2,13 @@ <html> <head> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>libnm-util Reference Manual: NMSettingIP4Config</title> +<title>NMSettingIP4Config: libnm-util Reference Manual</title> <meta name="generator" content="DocBook XSL Stylesheets V1.78.1"> <link rel="home" href="index.html" title="libnm-util Reference Manual"> <link rel="up" href="ch01.html" title="libnm-util API Reference"> <link rel="prev" href="NMSetting8021x.html" title="NMSetting8021x"> <link rel="next" href="NMSettingIP6Config.html" title="NMSettingIP6Config"> -<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"> @@ -723,7 +723,6 @@ nm_setting_ip4_config_error_quark (<em class="parameter"><code><span class="type <div class="refsect3"> <a name="id-1.2.25.11.2.5"></a><h4>Returns</h4> <p> the error quark used for <a class="link" href="NMSettingIP4Config.html" title="NMSettingIP4Config"><span class="type">NMSettingIP4Config</span></a> errors.</p> -<p></p> </div> </div> <hr> @@ -843,7 +842,6 @@ to.</p></td> <div class="refsect3"> <a name="id-1.2.25.11.7.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> @@ -870,7 +868,6 @@ nm_ip4_address_get_address (<em class="parameter"><code><a class="link" href="NM <div class="refsect3"> <a name="id-1.2.25.11.8.6"></a><h4>Returns</h4> <p> the IPv4 address in network byte order</p> -<p></p> </div> </div> <hr> @@ -928,7 +925,6 @@ object.</p> <div class="refsect3"> <a name="id-1.2.25.11.10.6"></a><h4>Returns</h4> <p> the IPv4 address prefix</p> -<p></p> </div> </div> <hr> @@ -985,7 +981,6 @@ nm_ip4_address_get_gateway (<em class="parameter"><code><a class="link" href="NM <div class="refsect3"> <a name="id-1.2.25.11.12.6"></a><h4>Returns</h4> <p> the IPv4 gateway address in network byte order</p> -<p></p> </div> </div> <hr> @@ -1135,7 +1130,6 @@ to.</p></td> <div class="refsect3"> <a name="id-1.2.25.11.18.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> @@ -1162,7 +1156,6 @@ nm_ip4_route_get_dest (<em class="parameter"><code><a class="link" href="NMSetti <div class="refsect3"> <a name="id-1.2.25.11.19.6"></a><h4>Returns</h4> <p> the IPv4 address in network byte order</p> -<p></p> </div> </div> <hr> @@ -1219,7 +1212,6 @@ nm_ip4_route_get_prefix (<em class="parameter"><code><a class="link" href="NMSet <div class="refsect3"> <a name="id-1.2.25.11.21.6"></a><h4>Returns</h4> <p> the IPv4 prefix</p> -<p></p> </div> </div> <hr> @@ -1276,7 +1268,6 @@ nm_ip4_route_get_next_hop (<em class="parameter"><code><a class="link" href="NMS <div class="refsect3"> <a name="id-1.2.25.11.23.6"></a><h4>Returns</h4> <p> the IPv4 address in network byte order</p> -<p></p> </div> </div> <hr> @@ -1334,7 +1325,6 @@ nm_ip4_route_get_metric (<em class="parameter"><code><a class="link" href="NMSet <div class="refsect3"> <a name="id-1.2.25.11.25.6"></a><h4>Returns</h4> <p> the route metric</p> -<p></p> </div> </div> <hr> @@ -1403,7 +1393,6 @@ nm_setting_ip4_config_get_method (<em class="parameter"><code><a class="link" hr <div class="refsect3"> <a name="id-1.2.25.11.28.5"></a><h4>Returns</h4> <p> the <a class="link" href="NMSettingIP4Config.html#NMSettingIP4Config--method" title="The “method” property"><span class="type">“method”</span></a> property of the setting</p> -<p></p> </div> </div> <hr> @@ -1429,7 +1418,6 @@ nm_setting_ip4_config_get_num_dns (<em class="parameter"><code><a class="link" h <div class="refsect3"> <a name="id-1.2.25.11.29.5"></a><h4>Returns</h4> <p> the number of configured DNS servers</p> -<p></p> </div> </div> <hr> @@ -1465,7 +1453,6 @@ nm_setting_ip4_config_get_dns (<em class="parameter"><code><a class="link" href= <p> the IPv4 address (network byte order) of the DNS server at index <em class="parameter"><code>i</code></em> </p> -<p></p> </div> </div> <hr> @@ -1501,7 +1488,6 @@ nm_setting_ip4_config_add_dns (<em class="parameter"><code><a class="link" href= <a name="id-1.2.25.11.31.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> @@ -1570,9 +1556,8 @@ nm_setting_ip4_config_remove_dns_by_value <a name="id-1.2.25.11.33.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. domain was already known</p> -<p></p> </div> -<p class="since">Since 0.9.10</p> +<p class="since">Since: 0.9.10</p> </div> <hr> <div class="refsect2"> @@ -1620,7 +1605,6 @@ nm_setting_ip4_config_get_num_dns_searches <div class="refsect3"> <a name="id-1.2.25.11.35.5"></a><h4>Returns</h4> <p> the number of configured DNS search domains</p> -<p></p> </div> </div> <hr> @@ -1655,7 +1639,6 @@ nm_setting_ip4_config_get_dns_search (<em class="parameter"><code><a class="link <a name="id-1.2.25.11.36.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> @@ -1691,7 +1674,6 @@ nm_setting_ip4_config_add_dns_search (<em class="parameter"><code><a class="link <a name="id-1.2.25.11.37.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> @@ -1761,7 +1743,6 @@ nm_setting_ip4_config_remove_dns_search_by_value <a name="id-1.2.25.11.39.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> @@ -1811,7 +1792,6 @@ nm_setting_ip4_config_get_num_addresses <div class="refsect3"> <a name="id-1.2.25.11.41.5"></a><h4>Returns</h4> <p> the number of configured addresses</p> -<p></p> </div> </div> <hr> @@ -1846,7 +1826,6 @@ nm_setting_ip4_config_get_address (<em class="parameter"><code><a class="link" h <a name="id-1.2.25.11.42.5"></a><h4>Returns</h4> <p> the address at index <em class="parameter"><code>i</code></em> </p> -<p></p> </div> </div> <hr> @@ -1883,7 +1862,6 @@ given address is duplicated internally and is not changed by this function.</p> <a name="id-1.2.25.11.43.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> @@ -1951,9 +1929,8 @@ nm_setting_ip4_config_remove_address_by_value <div class="refsect3"> <a name="id-1.2.25.11.45.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> -<p class="since">Since 0.9.10</p> +<p class="since">Since: 0.9.10</p> </div> <hr> <div class="refsect2"> @@ -2000,7 +1977,6 @@ nm_setting_ip4_config_get_num_routes (<em class="parameter"><code><a class="link <div class="refsect3"> <a name="id-1.2.25.11.47.5"></a><h4>Returns</h4> <p> the number of configured routes</p> -<p></p> </div> </div> <hr> @@ -2035,7 +2011,6 @@ nm_setting_ip4_config_get_route (<em class="parameter"><code><a class="link" hre <a name="id-1.2.25.11.48.5"></a><h4>Returns</h4> <p> the route at index <em class="parameter"><code>i</code></em> </p> -<p></p> </div> </div> <hr> @@ -2071,7 +2046,6 @@ given route is duplicated internally and is not changed by this function.</p> <div class="refsect3"> <a name="id-1.2.25.11.49.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> @@ -2139,9 +2113,8 @@ nm_setting_ip4_config_remove_route_by_value <div class="refsect3"> <a name="id-1.2.25.11.51.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> -<p class="since">Since 0.9.10</p> +<p class="since">Since: 0.9.10</p> </div> <hr> <div class="refsect2"> @@ -2192,9 +2165,8 @@ property.</p> <a name="id-1.2.25.11.53.6"></a><h4>Returns</h4> <p> the route metric that is used for IPv4 routes that don't explicitly specify a metric. See <a class="link" href="NMSettingIP4Config.html#NMSettingIP4Config--route-metric" title="The “route-metric” property"><span class="type">“route-metric”</span></a> for more details.</p> -<p></p> </div> -<p class="since">Since 1.0</p> +<p class="since">Since: 1.0</p> </div> <hr> <div class="refsect2"> @@ -2223,7 +2195,6 @@ property.</p> <a name="id-1.2.25.11.54.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> @@ -2253,7 +2224,6 @@ property.</p> <a name="id-1.2.25.11.55.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> @@ -2283,7 +2253,6 @@ property.</p> <a name="id-1.2.25.11.56.6"></a><h4>Returns</h4> <p> the configured Client ID to send to the DHCP server when requesting addresses via DHCP.</p> -<p></p> </div> </div> <hr> @@ -2314,7 +2283,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> @@ -2343,7 +2311,6 @@ property.</p> <div class="refsect3"> <a name="id-1.2.25.11.58.6"></a><h4>Returns</h4> <p> the configured hostname to send to the DHCP server</p> -<p></p> </div> </div> <hr> @@ -2373,7 +2340,6 @@ property.</p> <a name="id-1.2.25.11.59.6"></a><h4>Returns</h4> <p> <code class="literal">TRUE</code> if this connection should never be the default connection for IPv4 addressing</p> -<p></p> </div> </div> <hr> @@ -2402,7 +2368,6 @@ property.</p> <a name="id-1.2.25.11.60.6"></a><h4>Returns</h4> <p> <code class="literal">TRUE</code> if this connection doesn't require IPv4 addressing to complete for the connection to succeed.</p> -<p></p> </div> </div> </div> @@ -2412,8 +2377,6 @@ for the connection to succeed.</p> <a name="NM-SETTING-IP4-CONFIG-SETTING-NAME:CAPS"></a><h3>NM_SETTING_IP4_CONFIG_SETTING_NAME</h3> <pre class="programlisting">#define NM_SETTING_IP4_CONFIG_SETTING_NAME "ipv4" </pre> -<p> -</p> </div> <hr> <div class="refsect2"> @@ -2466,112 +2429,84 @@ not valid with the given IP4 method</p> <a name="NM-SETTING-IP4-CONFIG-ERROR:CAPS"></a><h3>NM_SETTING_IP4_CONFIG_ERROR</h3> <pre class="programlisting">#define NM_SETTING_IP4_CONFIG_ERROR nm_setting_ip4_config_error_quark () </pre> -<p> -</p> </div> <hr> <div class="refsect2"> <a name="NM-SETTING-IP4-CONFIG-METHOD:CAPS"></a><h3>NM_SETTING_IP4_CONFIG_METHOD</h3> <pre class="programlisting">#define NM_SETTING_IP4_CONFIG_METHOD "method" </pre> -<p> -</p> </div> <hr> <div class="refsect2"> <a name="NM-SETTING-IP4-CONFIG-DNS:CAPS"></a><h3>NM_SETTING_IP4_CONFIG_DNS</h3> <pre class="programlisting">#define NM_SETTING_IP4_CONFIG_DNS "dns" </pre> -<p> -</p> </div> <hr> <div class="refsect2"> <a name="NM-SETTING-IP4-CONFIG-DNS-SEARCH:CAPS"></a><h3>NM_SETTING_IP4_CONFIG_DNS_SEARCH</h3> <pre class="programlisting">#define NM_SETTING_IP4_CONFIG_DNS_SEARCH "dns-search" </pre> -<p> -</p> </div> <hr> <div class="refsect2"> <a name="NM-SETTING-IP4-CONFIG-ADDRESSES:CAPS"></a><h3>NM_SETTING_IP4_CONFIG_ADDRESSES</h3> <pre class="programlisting">#define NM_SETTING_IP4_CONFIG_ADDRESSES "addresses" </pre> -<p> -</p> </div> <hr> <div class="refsect2"> <a name="NM-SETTING-IP4-CONFIG-ROUTES:CAPS"></a><h3>NM_SETTING_IP4_CONFIG_ROUTES</h3> <pre class="programlisting">#define NM_SETTING_IP4_CONFIG_ROUTES "routes" </pre> -<p> -</p> </div> <hr> <div class="refsect2"> <a name="NM-SETTING-IP4-CONFIG-ROUTE-METRIC:CAPS"></a><h3>NM_SETTING_IP4_CONFIG_ROUTE_METRIC</h3> <pre class="programlisting">#define NM_SETTING_IP4_CONFIG_ROUTE_METRIC "route-metric" </pre> -<p> -</p> </div> <hr> <div class="refsect2"> <a name="NM-SETTING-IP4-CONFIG-IGNORE-AUTO-ROUTES:CAPS"></a><h3>NM_SETTING_IP4_CONFIG_IGNORE_AUTO_ROUTES</h3> <pre class="programlisting">#define NM_SETTING_IP4_CONFIG_IGNORE_AUTO_ROUTES "ignore-auto-routes" </pre> -<p> -</p> </div> <hr> <div class="refsect2"> <a name="NM-SETTING-IP4-CONFIG-IGNORE-AUTO-DNS:CAPS"></a><h3>NM_SETTING_IP4_CONFIG_IGNORE_AUTO_DNS</h3> <pre class="programlisting">#define NM_SETTING_IP4_CONFIG_IGNORE_AUTO_DNS "ignore-auto-dns" </pre> -<p> -</p> </div> <hr> <div class="refsect2"> <a name="NM-SETTING-IP4-CONFIG-DHCP-CLIENT-ID:CAPS"></a><h3>NM_SETTING_IP4_CONFIG_DHCP_CLIENT_ID</h3> <pre class="programlisting">#define NM_SETTING_IP4_CONFIG_DHCP_CLIENT_ID "dhcp-client-id" </pre> -<p> -</p> </div> <hr> <div class="refsect2"> <a name="NM-SETTING-IP4-CONFIG-DHCP-SEND-HOSTNAME:CAPS"></a><h3>NM_SETTING_IP4_CONFIG_DHCP_SEND_HOSTNAME</h3> <pre class="programlisting">#define NM_SETTING_IP4_CONFIG_DHCP_SEND_HOSTNAME "dhcp-send-hostname" </pre> -<p> -</p> </div> <hr> <div class="refsect2"> <a name="NM-SETTING-IP4-CONFIG-DHCP-HOSTNAME:CAPS"></a><h3>NM_SETTING_IP4_CONFIG_DHCP_HOSTNAME</h3> <pre class="programlisting">#define NM_SETTING_IP4_CONFIG_DHCP_HOSTNAME "dhcp-hostname" </pre> -<p> -</p> </div> <hr> <div class="refsect2"> <a name="NM-SETTING-IP4-CONFIG-NEVER-DEFAULT:CAPS"></a><h3>NM_SETTING_IP4_CONFIG_NEVER_DEFAULT</h3> <pre class="programlisting">#define NM_SETTING_IP4_CONFIG_NEVER_DEFAULT "never-default" </pre> -<p> -</p> </div> <hr> <div class="refsect2"> <a name="NM-SETTING-IP4-CONFIG-MAY-FAIL:CAPS"></a><h3>NM_SETTING_IP4_CONFIG_MAY_FAIL</h3> <pre class="programlisting">#define NM_SETTING_IP4_CONFIG_MAY_FAIL "may-fail" </pre> -<p> -</p> </div> <hr> <div class="refsect2"> @@ -2623,14 +2558,22 @@ through that interface to the default network.</p> <div class="refsect2"> <a name="NMSettingIP4Config--addresses"></a><h3>The <code class="literal">“addresses”</code> property</h3> <pre class="programlisting"> “addresses” <span class="type">GPtrArray_GArray_guint__</span> *</pre> -<p></p> +<p>Array of IPv4 address structures. Each IPv4 address structure is +composed of 3 32-bit values; the first being the IPv4 address (network +byte order), the second the prefix (1 - 32), and last the IPv4 gateway +(network byte order). The gateway may be left as 0 if no gateway exists +for that subnet. For the "auto" method, given IP addresses are appended +to those returned by automatic configuration. Addresses cannot be used +with the "shared", "link-local", or "disabled" methods as addressing is +either automatic or disabled with these methods.</p> <p>Flags: Read / Write</p> </div> <hr> <div class="refsect2"> <a name="NMSettingIP4Config--dhcp-client-id"></a><h3>The <code class="literal">“dhcp-client-id”</code> property</h3> <pre class="programlisting"> “dhcp-client-id” <span class="type">gchar</span> *</pre> -<p></p> +<p>A string sent to the DHCP server to identify the local machine which the +DHCP server may use to customize the DHCP lease and options.</p> <p>Flags: Read / Write</p> <p>Default value: NULL</p> </div> @@ -2638,7 +2581,8 @@ through that interface to the default network.</p> <div class="refsect2"> <a name="NMSettingIP4Config--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="NMSettingIP4Config.html#NMSettingIP4Config--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> @@ -2646,7 +2590,11 @@ through that interface to the default network.</p> <div class="refsect2"> <a name="NMSettingIP4Config--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="NMSettingIP4Config.html#NMSettingIP4Config--dhcp-hostname" title="The “dhcp-hostname” property"><span class="type">“dhcp-hostname”</span></a> property is empty 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> @@ -2654,21 +2602,34 @@ through that interface to the default network.</p> <div class="refsect2"> <a name="NMSettingIP4Config--dns"></a><h3>The <code class="literal">“dns”</code> property</h3> <pre class="programlisting"> “dns” <span class="type">GArray_guint_</span> *</pre> -<p></p> +<p>List of DNS servers (network byte order). For the "auto" method, these +DNS servers are appended to those (if any) returned by automatic +configuration. DNS servers cannot be used with the "shared", +"link-local", or "disabled" methods as there is no upstream network. In +all other methods, these DNS servers are used as the only DNS servers for +this connection.</p> <p>Flags: Read / Write</p> </div> <hr> <div class="refsect2"> <a name="NMSettingIP4Config--dns-search"></a><h3>The <code class="literal">“dns-search”</code> property</h3> <pre class="programlisting"> “dns-search” <span class="type">GSList_gchararray_</span> *</pre> -<p></p> +<p>List of DNS search domains. For the "auto" method, these search domains +are appended to those returned by automatic configuration. Search domains +cannot be used with the "shared", "link-local", or "disabled" methods as +there is no upstream network. In all other methods, these search domains +are used as the only search domains for this connection.</p> <p>Flags: Read / Write</p> </div> <hr> <div class="refsect2"> <a name="NMSettingIP4Config--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 the method 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="NMSettingIP4Config.html#NMSettingIP4Config--dns" title="The “dns” property"><span class="type">“dns”</span></a> and <a class="link" href="NMSettingIP4Config.html#NMSettingIP4Config--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> @@ -2676,7 +2637,9 @@ through that interface to the default network.</p> <div class="refsect2"> <a name="NMSettingIP4Config--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 the method 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="NMSettingIP4Config.html#NMSettingIP4Config--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> @@ -2684,7 +2647,12 @@ through that interface to the default network.</p> <div class="refsect2"> <a name="NMSettingIP4Config--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 IPv4 +configuration 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> 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> @@ -2692,7 +2660,18 @@ through that interface to the default network.</p> <div class="refsect2"> <a name="NMSettingIP4Config--method"></a><h3>The <code class="literal">“method”</code> property</h3> <pre class="programlisting"> “method” <span class="type">gchar</span> *</pre> -<p></p> +<p>IPv4 configuration method. If "auto" is specified then the appropriate +automatic method (DHCP, PPP, etc) is used for the interface and most +other properties can be left unset. If "link-local" is specified, then a +link-local address in the 169.254/16 range will be assigned to the +interface. If "manual" is specified, static IP addressing is used and at +least one IP address must be given in the "addresses" property. If +"shared" is specified (indicating that this connection will provide +network access to other computers) then the interface is assigned an +address in the 10.42.x.1/24 range and a DHCP and forwarding DNS server +are started, and the interface is NAT-ed to the current default network +connection. "disabled" means IPv4 will not be used on this connection. +This property must be set.</p> <p>Flags: Read / Write</p> <p>Default value: NULL</p> </div> @@ -2700,7 +2679,8 @@ through that interface to the default network.</p> <div class="refsect2"> <a name="NMSettingIP4Config--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 IPv4 connection, +meaning it will never be assigned the default route by NetworkManager.</p> <p>Flags: Read / Write / Construct</p> <p>Default value: FALSE</p> </div> @@ -2708,23 +2688,36 @@ through that interface to the default network.</p> <div class="refsect2"> <a name="NMSettingIP4Config--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. +As the linux kernel accepts zero (0) as a valid metric, zero is +a valid value.</p> <p>Flags: Read / Write / Construct</p> <p>Allowed values: [-1,4294967295]</p> <p>Default value: -1</p> -<p class="since">Since 1.0</p> +<p class="since">Since: 1.0</p> </div> <hr> <div class="refsect2"> <a name="NMSettingIP4Config--routes"></a><h3>The <code class="literal">“routes”</code> property</h3> <pre class="programlisting"> “routes” <span class="type">GPtrArray_GArray_guint__</span> *</pre> -<p></p> +<p>Array of IPv4 route structures. Each IPv4 route structure is composed of +4 32-bit values; the first being the destination IPv4 network or address +(network byte order), the second the destination network or address +prefix (1 - 32), the third being the next-hop (network byte order) if +any, and the fourth being the route metric. For the "auto" method, given +IP routes are appended to those returned by automatic configuration. +Routes cannot be used with the "shared", "link-local", or "disabled" +methods because there is no upstream network.</p> <p>Flags: Read / Write</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 |