diff options
| author | Michael Biebl <biebl@debian.org> | 2021-10-01 23:05:04 +0200 |
|---|---|---|
| committer | Michael Biebl <biebl@debian.org> | 2021-10-01 23:05:04 +0200 |
| commit | e74c568b07b50b97873fb4ee1d776dedefbd54d6 (patch) | |
| tree | 3469f17ea9af91f7ff169b890633bda68b0cf76e /docs/libnm/html/NMSettingIP4Config.html | |
| parent | bfe522304da217296e2a61040f58e35ec5d6f3f2 (diff) | |
New upstream version 1.32.12 upstream/1.32.12
Diffstat (limited to 'docs/libnm/html/NMSettingIP4Config.html')
| -rw-r--r-- | docs/libnm/html/NMSettingIP4Config.html | 122 |
1 files changed, 5 insertions, 117 deletions
diff --git a/docs/libnm/html/NMSettingIP4Config.html b/docs/libnm/html/NMSettingIP4Config.html index 328d05b2..6c0038ff 100644 --- a/docs/libnm/html/NMSettingIP4Config.html +++ b/docs/libnm/html/NMSettingIP4Config.html @@ -15,9 +15,7 @@ <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="#NMSettingIP4Config.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> - <a href="#NMSettingIP4Config.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties"> <span class="dim">|</span> - <a href="#NMSettingIP4Config.properties" class="shortcut">Properties</a></span> + <a href="#NMSettingIP4Config.description" class="shortcut">Description</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="ch03.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> @@ -74,36 +72,6 @@ </table></div> </div> <div class="refsect1"> -<a name="NMSettingIP4Config.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"> -<span class="type">char</span> *</td> -<td class="property_name"><a class="link" href="NMSettingIP4Config.html#NMSettingIP4Config--dhcp-client-id" title="The “dhcp-client-id” property">dhcp-client-id</a></td> -<td class="property_flags">Read / Write</td> -</tr> -<tr> -<td class="property_type"> -<span class="type">char</span> *</td> -<td class="property_name"><a class="link" href="NMSettingIP4Config.html#NMSettingIP4Config--dhcp-fqdn" title="The “dhcp-fqdn” property">dhcp-fqdn</a></td> -<td class="property_flags">Read / Write</td> -</tr> -<tr> -<td class="property_type"> -<span class="type">char</span> *</td> -<td class="property_name"><a class="link" href="NMSettingIP4Config.html#NMSettingIP4Config--dhcp-vendor-class-identifier" title="The “dhcp-vendor-class-identifier” property">dhcp-vendor-class-identifier</a></td> -<td class="property_flags">Read / Write</td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect1"> <a name="NMSettingIP4Config.other"></a><h2>Types and Values</h2> <div class="informaltable"><table class="informaltable" width="100%" border="0"> <colgroup> @@ -147,28 +115,16 @@ <td class="define_keyword">#define</td> <td class="function_name"><a class="link" href="NMSettingIP4Config.html#NM-SETTING-IP4-CONFIG-METHOD-DISABLED:CAPS" title="NM_SETTING_IP4_CONFIG_METHOD_DISABLED">NM_SETTING_IP4_CONFIG_METHOD_DISABLED</a></td> </tr> -<tr> -<td class="datatype_keyword"> </td> -<td class="function_name"><a class="link" href="NMSettingIP4Config.html#NMSettingIP4Config-struct" title="NMSettingIP4Config">NMSettingIP4Config</a></td> -</tr> </tbody> </table></div> </div> <div class="refsect1"> -<a name="NMSettingIP4Config.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="NMSetting.html" title="NMSetting">NMSetting</a> - <span class="lineart">╰──</span> <a class="link" href="NMSettingIPConfig.html" title="NMSettingIPConfig">NMSettingIPConfig</a> - <span class="lineart">╰──</span> NMSettingIP4Config -</pre> -</div> -<div class="refsect1"> <a name="NMSettingIP4Config.description"></a><h2>Description</h2> <p>The <a class="link" href="NMSettingIP4Config.html" title="NMSettingIP4Config"><span class="type">NMSettingIP4Config</span></a> object is a <a class="link" href="NMSetting.html" title="NMSetting"><span class="type">NMSetting</span></a> subclass that describes properties related to IPv4 addressing, routing, and Domain Name Service.</p> <p><a class="link" href="NMSettingIP4Config.html" title="NMSettingIP4Config"><span class="type">NMSettingIP4Config</span></a> has few properties or methods of its own; it inherits almost everything from <a class="link" href="NMSettingIPConfig.html" title="NMSettingIPConfig"><span class="type">NMSettingIPConfig</span></a>.</p> -<p>NetworkManager supports 5 values for the <a class="link" href="NMSettingIPConfig.html#NMSettingIPConfig--method" title="The “method” property"><span class="type">“method”</span></a> property +<p>NetworkManager supports 5 values for the <a href="NMSettingIPConfig.html#NMSettingIPConfig--method"><span class="type">“method”</span></a> property for IPv4. 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 @@ -200,7 +156,7 @@ nm_setting_ip4_config_new (<em class="parameter"><code><span class="type">void</ <pre class="programlisting">const <span class="returnvalue">char</span> * nm_setting_ip4_config_get_dhcp_client_id (<em class="parameter"><code><a class="link" href="NMSettingIP4Config.html" title="NMSettingIP4Config"><span class="type">NMSettingIP4Config</span></a> *setting</code></em>);</pre> -<p>Returns the value contained in the <a class="link" href="NMSettingIP4Config.html#NMSettingIP4Config--dhcp-client-id" title="The “dhcp-client-id” property"><span class="type">“dhcp-client-id”</span></a> +<p>Returns the value contained in the <a href="NMSettingIP4Config.html#NMSettingIP4Config--dhcp-client-id"><span class="type">“dhcp-client-id”</span></a> property.</p> <div class="refsect3"> <a name="nm-setting-ip4-config-get-dhcp-client-id.parameters"></a><h4>Parameters</h4> @@ -228,7 +184,7 @@ addresses via DHCP.</p> <a name="nm-setting-ip4-config-get-dhcp-fqdn"></a><h3>nm_setting_ip4_config_get_dhcp_fqdn ()</h3> <pre class="programlisting">const <span class="returnvalue">char</span> * nm_setting_ip4_config_get_dhcp_fqdn (<em class="parameter"><code><a class="link" href="NMSettingIP4Config.html" title="NMSettingIP4Config"><span class="type">NMSettingIP4Config</span></a> *setting</code></em>);</pre> -<p>Returns the value contained in the <a class="link" href="NMSettingIP4Config.html#NMSettingIP4Config--dhcp-fqdn" title="The “dhcp-fqdn” property"><span class="type">“dhcp-fqdn”</span></a> +<p>Returns the value contained in the <a href="NMSettingIP4Config.html#NMSettingIP4Config--dhcp-fqdn"><span class="type">“dhcp-fqdn”</span></a> property.</p> <div class="refsect3"> <a name="nm-setting-ip4-config-get-dhcp-fqdn.parameters"></a><h4>Parameters</h4> @@ -257,7 +213,7 @@ property.</p> <pre class="programlisting">const <span class="returnvalue">char</span> * nm_setting_ip4_config_get_dhcp_vendor_class_identifier (<em class="parameter"><code><a class="link" href="NMSettingIP4Config.html" title="NMSettingIP4Config"><span class="type">NMSettingIP4Config</span></a> *setting</code></em>);</pre> -<p>Returns the value contained in the <a class="link" href="NMSettingIP4Config.html#NMSettingIP4Config--dhcp-vendor-class-identifier" title="The “dhcp-vendor-class-identifier” property"><span class="type">“dhcp_vendor_class_identifier”</span></a> +<p>Returns the value contained in the <a href="NMSettingIP4Config.html#NMSettingIP4Config--dhcp-vendor-class-identifier"><span class="type">“dhcp_vendor_class_identifier”</span></a> property.</p> <div class="refsect3"> <a name="nm-setting-ip4-config-get-dhcp-vendor-class-identifier.parameters"></a><h4>Parameters</h4> @@ -350,74 +306,6 @@ through that interface to the default network.</p> </pre> <p>This connection does not use or require IPv4 address and it should be disabled.</p> </div> -<hr> -<div class="refsect2"> -<a name="NMSettingIP4Config-struct"></a><h3>NMSettingIP4Config</h3> -<pre class="programlisting">typedef struct _NMSettingIP4Config NMSettingIP4Config;</pre> -<p>IPv4 Settings</p> -</div> -</div> -<div class="refsect1"> -<a name="NMSettingIP4Config.property-details"></a><h2>Property Details</h2> -<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">char</span> *</pre> -<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. -When the property is a hex string ('aa:bb:cc') it is interpreted as a -binary client ID, in which case the first byte is assumed to be the -'type' field as per RFC 2132 section 9.14 and the remaining bytes may be -an hardware address (e.g. '01:xx:xx:xx:xx:xx:xx' where 1 is the Ethernet -ARP type and the rest is a MAC address). -If the property is not a hex string it is considered as a -non-hardware-address client ID and the 'type' field is set to 0.</p> -<p>The special values "mac" and "perm-mac" are supported, which use the -current or permanent MAC address of the device to generate a client identifier -with type ethernet (01). Currently, these options only work for ethernet -type of links.</p> -<p>The special value "ipv6-duid" uses the DUID from "ipv6.dhcp-duid" property as -an RFC4361-compliant client identifier. As IAID it uses "ipv4.dhcp-iaid" -and falls back to "ipv6.dhcp-iaid" if unset.</p> -<p>The special value "duid" generates a RFC4361-compliant client identifier based -on "ipv4.dhcp-iaid" and uses a DUID generated by hashing /etc/machine-id.</p> -<p>The special value "stable" is supported to generate a type 0 client identifier based -on the stable-id (see connection.stable-id) and a per-host key. If you set the -stable-id, you may want to include the "${DEVICE}" or "${MAC}" specifier to get a -per-device key.</p> -<p>If unset, a globally configured default is used. If still unset, the default -depends on the DHCP plugin.</p> -<p>Owner: NMSettingIP4Config</p> -<p>Flags: Read / Write</p> -<p>Default value: NULL</p> -</div> -<hr> -<div class="refsect2"> -<a name="NMSettingIP4Config--dhcp-fqdn"></a><h3>The <code class="literal">“dhcp-fqdn”</code> property</h3> -<pre class="programlisting"> “dhcp-fqdn” <span class="type">char</span> *</pre> -<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 <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>, then the -specified FQDN will be sent to the DHCP server when acquiring a lease. This -property and <a class="link" href="NMSettingIPConfig.html#NMSettingIPConfig--dhcp-hostname" title="The “dhcp-hostname” property"><span class="type">“dhcp-hostname”</span></a> are mutually exclusive and -cannot be set at the same time.</p> -<p>Owner: NMSettingIP4Config</p> -<p>Flags: Read / Write</p> -<p>Default value: NULL</p> -<p class="since">Since: 1.2</p> -</div> -<hr> -<div class="refsect2"> -<a name="NMSettingIP4Config--dhcp-vendor-class-identifier"></a><h3>The <code class="literal">“dhcp-vendor-class-identifier”</code> property</h3> -<pre class="programlisting"> “dhcp-vendor-class-identifier” <span class="type">char</span> *</pre> -<p>The Vendor Class Identifier DHCP option (60). -Special characters in the data string may be escaped using C-style escapes, -nevertheless this property cannot contain nul bytes. -If the per-profile value is unspecified (the default), -a global connection default gets consulted. -If still unspecified, the DHCP option is not sent to the server.</p> -<p>Since 1.28</p> -<p>Owner: NMSettingIP4Config</p> -<p>Flags: Read / Write</p> -<p>Default value: NULL</p> -</div> </div> </div> <div class="footer"> |