diff options
Diffstat (limited to 'docs/libnm/html/NMSettingIP4Config.html')
| -rw-r--r-- | docs/libnm/html/NMSettingIP4Config.html | 251 |
1 files changed, 251 insertions, 0 deletions
diff --git a/docs/libnm/html/NMSettingIP4Config.html b/docs/libnm/html/NMSettingIP4Config.html new file mode 100644 index 000000000..cb7542b82 --- /dev/null +++ b/docs/libnm/html/NMSettingIP4Config.html @@ -0,0 +1,251 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>NMSettingIP4Config</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="NMSettingIPConfig.html" title="NMSettingIPConfig"> +<link rel="next" href="NMSettingIP6Config.html" title="NMSettingIP6Config"> +<meta name="generator" content="GTK-Doc V1.19 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"> +<tr valign="middle"> +<td><a accesskey="p" href="NMSettingIPConfig.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> +<td><a accesskey="u" href="ch03.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td> +<th width="100%" align="center">libnm Reference Manual</th> +<td><a accesskey="n" href="NMSettingIP6Config.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> +</tr> +<tr><td colspan="5" class="shortcuts"> +<a href="#NMSettingIP4Config.synopsis" class="shortcut">Top</a> + | + <a href="#NMSettingIP4Config.description" class="shortcut">Description</a> + | + <a href="#NMSettingIP4Config.object-hierarchy" class="shortcut">Object Hierarchy</a> + | + <a href="#NMSettingIP4Config.properties" class="shortcut">Properties</a> +</td></tr> +</table> +<div class="refentry"> +<a name="NMSettingIP4Config"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle"><a name="NMSettingIP4Config.top_of_page"></a>NMSettingIP4Config</span></h2> +<p>NMSettingIP4Config — Describes IPv4 addressing, routing, and name service properties</p> +</td> +<td valign="top" align="right"></td> +</tr></table></div> +<div class="refsynopsisdiv"> +<a name="NMSettingIP4Config.synopsis"></a><h2>Synopsis</h2> +<pre class="synopsis">#define <a class="link" href="NMSettingIP4Config.html#NM-SETTING-IP4-CONFIG-SETTING-NAME:CAPS" title="NM_SETTING_IP4_CONFIG_SETTING_NAME">NM_SETTING_IP4_CONFIG_SETTING_NAME</a> +#define <a class="link" href="NMSettingIP4Config.html#NM-SETTING-IP4-CONFIG-DHCP-CLIENT-ID:CAPS" title="NM_SETTING_IP4_CONFIG_DHCP_CLIENT_ID">NM_SETTING_IP4_CONFIG_DHCP_CLIENT_ID</a> +#define <a class="link" href="NMSettingIP4Config.html#NM-SETTING-IP4-CONFIG-METHOD-AUTO:CAPS" title="NM_SETTING_IP4_CONFIG_METHOD_AUTO">NM_SETTING_IP4_CONFIG_METHOD_AUTO</a> +#define <a class="link" href="NMSettingIP4Config.html#NM-SETTING-IP4-CONFIG-METHOD-LINK-LOCAL:CAPS" title="NM_SETTING_IP4_CONFIG_METHOD_LINK_LOCAL">NM_SETTING_IP4_CONFIG_METHOD_LINK_LOCAL</a> +#define <a class="link" href="NMSettingIP4Config.html#NM-SETTING-IP4-CONFIG-METHOD-MANUAL:CAPS" title="NM_SETTING_IP4_CONFIG_METHOD_MANUAL">NM_SETTING_IP4_CONFIG_METHOD_MANUAL</a> +#define <a class="link" href="NMSettingIP4Config.html#NM-SETTING-IP4-CONFIG-METHOD-SHARED:CAPS" title="NM_SETTING_IP4_CONFIG_METHOD_SHARED">NM_SETTING_IP4_CONFIG_METHOD_SHARED</a> +#define <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> +struct <a class="link" href="NMSettingIP4Config.html#NMSettingIP4Config-struct" title="struct NMSettingIP4Config">NMSettingIP4Config</a>; + <a class="link" href="NMSettingIP4Config.html#NMSettingIP4ConfigClass" title="NMSettingIP4ConfigClass">NMSettingIP4ConfigClass</a>; +<a class="link" href="NMSetting.html" title="NMSetting"><span class="returnvalue">NMSetting</span></a> * <a class="link" href="NMSettingIP4Config.html#nm-setting-ip4-config-new" title="nm_setting_ip4_config_new ()">nm_setting_ip4_config_new</a> (<em class="parameter"><code><span class="type">void</span></code></em>); +const <span class="returnvalue">char</span> * <a class="link" href="NMSettingIP4Config.html#nm-setting-ip4-config-get-dhcp-client-id" title="nm_setting_ip4_config_get_dhcp_client_id ()">nm_setting_ip4_config_get_dhcp_client_id</a> + (<em class="parameter"><code><a class="link" href="NMSettingIP4Config.html" title="NMSettingIP4Config"><span class="type">NMSettingIP4Config</span></a> *setting</code></em>); +</pre> +</div> +<div class="refsect1"> +<a name="NMSettingIP4Config.object-hierarchy"></a><h2>Object Hierarchy</h2> +<pre class="synopsis"> + <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a> + +----<a class="link" href="NMSetting.html" title="NMSetting">NMSetting</a> + +----<a class="link" href="NMSettingIPConfig.html" title="NMSettingIPConfig">NMSettingIPConfig</a> + +----NMSettingIP4Config +</pre> +</div> +<div class="refsect1"> +<a name="NMSettingIP4Config.properties"></a><h2>Properties</h2> +<pre class="synopsis"> + "<a class="link" href="NMSettingIP4Config.html#NMSettingIP4Config--dhcp-client-id" title='The "dhcp-client-id" property'>dhcp-client-id</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write +</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 +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 +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. +</p> +</div> +<div class="refsect1"> +<a name="NMSettingIP4Config.details"></a><h2>Details</h2> +<div class="refsect2"> +<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"> +<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-METHOD-AUTO:CAPS"></a><h3>NM_SETTING_IP4_CONFIG_METHOD_AUTO</h3> +<pre class="programlisting">#define NM_SETTING_IP4_CONFIG_METHOD_AUTO "auto" +</pre> +<p> +IPv4 configuration should be automatically determined via a method appropriate +for the hardware interface, ie DHCP or PPP or some other device-specific +manner. +</p> +</div> +<hr> +<div class="refsect2"> +<a name="NM-SETTING-IP4-CONFIG-METHOD-LINK-LOCAL:CAPS"></a><h3>NM_SETTING_IP4_CONFIG_METHOD_LINK_LOCAL</h3> +<pre class="programlisting">#define NM_SETTING_IP4_CONFIG_METHOD_LINK_LOCAL "link-local" +</pre> +<p> +IPv4 configuration should be automatically configured for link-local-only +operation. +</p> +</div> +<hr> +<div class="refsect2"> +<a name="NM-SETTING-IP4-CONFIG-METHOD-MANUAL:CAPS"></a><h3>NM_SETTING_IP4_CONFIG_METHOD_MANUAL</h3> +<pre class="programlisting">#define NM_SETTING_IP4_CONFIG_METHOD_MANUAL "manual" +</pre> +<p> +All necessary IPv4 configuration (addresses, prefix, DNS, etc) is specified +in the setting's properties. +</p> +</div> +<hr> +<div class="refsect2"> +<a name="NM-SETTING-IP4-CONFIG-METHOD-SHARED:CAPS"></a><h3>NM_SETTING_IP4_CONFIG_METHOD_SHARED</h3> +<pre class="programlisting">#define NM_SETTING_IP4_CONFIG_METHOD_SHARED "shared" +</pre> +<p> +This connection specifies configuration that allows other computers to +connect through it to the default network (usually the Internet). The +connection's interface will be assigned a private address, and a DHCP server, +caching DNS server, and Network Address Translation (NAT) functionality will +be started on this connection's interface to allow other devices to connect +through that interface to the default network. +</p> +</div> +<hr> +<div class="refsect2"> +<a name="NM-SETTING-IP4-CONFIG-METHOD-DISABLED:CAPS"></a><h3>NM_SETTING_IP4_CONFIG_METHOD_DISABLED</h3> +<pre class="programlisting">#define NM_SETTING_IP4_CONFIG_METHOD_DISABLED "disabled" +</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>struct NMSettingIP4Config</h3> +<pre class="programlisting">struct NMSettingIP4Config;</pre> +<p> +</p> +</div> +<hr> +<div class="refsect2"> +<a name="NMSettingIP4ConfigClass"></a><h3>NMSettingIP4ConfigClass</h3> +<pre class="programlisting">typedef struct { + NMSettingIPConfigClass parent; +} NMSettingIP4ConfigClass; +</pre> +<p> +</p> +</div> +<hr> +<div class="refsect2"> +<a name="nm-setting-ip4-config-new"></a><h3>nm_setting_ip4_config_new ()</h3> +<pre class="programlisting"><a class="link" href="NMSetting.html" title="NMSetting"><span class="returnvalue">NMSetting</span></a> * nm_setting_ip4_config_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre> +<p> +Creates a new <a class="link" href="NMSettingIP4Config.html" title="NMSettingIP4Config"><span class="type">NMSettingIP4Config</span></a> object with default values. +</p> +<div class="variablelist"><table border="0" class="variablelist"> +<colgroup> +<col align="left" valign="top"> +<col> +</colgroup> +<tbody><tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>the new empty <a class="link" href="NMSettingIP4Config.html" title="NMSettingIP4Config"><span class="type">NMSettingIP4Config</span></a> object. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span> +</td> +</tr></tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="nm-setting-ip4-config-get-dhcp-client-id"></a><h3>nm_setting_ip4_config_get_dhcp_client_id ()</h3> +<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> +property. +</p> +<div class="variablelist"><table border="0" class="variablelist"> +<colgroup> +<col align="left" valign="top"> +<col> +</colgroup> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>setting</code></em> :</span></p></td> +<td>the <a class="link" href="NMSettingIP4Config.html" title="NMSettingIP4Config"><span class="type">NMSettingIP4Config</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>the configured Client ID to send to the DHCP server when requesting +addresses via DHCP.</td> +</tr> +</tbody> +</table></div> +</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" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write</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. +</p> +<p>Default value: NULL</p> +</div> +</div> +</div> +<div class="footer"> +<hr> + Generated by GTK-Doc V1.19</div> +</body> +</html>
\ No newline at end of file |