From 2c032d8f1c6292c1338a615e6ec40252889ba85c Mon Sep 17 00:00:00 2001 From: Michael Biebl Date: Thu, 22 Jan 2015 00:29:39 +0100 Subject: Imported Upstream version 1.0.0 --- docs/libnm/html/NMSettingIP4Config.html | 251 ++++++++++++++++++++++++++++++++ 1 file changed, 251 insertions(+) create mode 100644 docs/libnm/html/NMSettingIP4Config.html (limited to 'docs/libnm/html/NMSettingIP4Config.html') diff --git a/docs/libnm/html/NMSettingIP4Config.html b/docs/libnm/html/NMSettingIP4Config.html new file mode 100644 index 00000000..cb7542b8 --- /dev/null +++ b/docs/libnm/html/NMSettingIP4Config.html @@ -0,0 +1,251 @@ + + + + +NMSettingIP4Config + + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+

NMSettingIP4Config

+

NMSettingIP4Config — Describes IPv4 addressing, routing, and name service properties

+
+
+

Synopsis

+
#define             NM_SETTING_IP4_CONFIG_SETTING_NAME
+#define             NM_SETTING_IP4_CONFIG_DHCP_CLIENT_ID
+#define             NM_SETTING_IP4_CONFIG_METHOD_AUTO
+#define             NM_SETTING_IP4_CONFIG_METHOD_LINK_LOCAL
+#define             NM_SETTING_IP4_CONFIG_METHOD_MANUAL
+#define             NM_SETTING_IP4_CONFIG_METHOD_SHARED
+#define             NM_SETTING_IP4_CONFIG_METHOD_DISABLED
+struct              NMSettingIP4Config;
+                    NMSettingIP4ConfigClass;
+NMSetting *         nm_setting_ip4_config_new           (void);
+const char *        nm_setting_ip4_config_get_dhcp_client_id
+                                                        (NMSettingIP4Config *setting);
+
+
+
+

Object Hierarchy

+
+  GObject
+   +----NMSetting
+         +----NMSettingIPConfig
+               +----NMSettingIP4Config
+
+
+
+

Properties

+
+  "dhcp-client-id"           gchar*                : Read / Write
+
+
+
+

Description

+

+The NMSettingIP4Config object is a NMSetting subclass that describes +properties related to IPv4 addressing, routing, and Domain Name Service. +

+

+NMSettingIP4Config has few properties or methods of its own; it inherits +almost everything from NMSettingIPConfig. +

+

+NetworkManager supports 5 values for the "method" 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. +

+
+
+

Details

+
+

NM_SETTING_IP4_CONFIG_SETTING_NAME

+
#define NM_SETTING_IP4_CONFIG_SETTING_NAME "ipv4"
+
+

+

+
+
+
+

NM_SETTING_IP4_CONFIG_DHCP_CLIENT_ID

+
#define NM_SETTING_IP4_CONFIG_DHCP_CLIENT_ID     "dhcp-client-id"
+
+

+

+
+
+
+

NM_SETTING_IP4_CONFIG_METHOD_AUTO

+
#define NM_SETTING_IP4_CONFIG_METHOD_AUTO       "auto"
+
+

+IPv4 configuration should be automatically determined via a method appropriate +for the hardware interface, ie DHCP or PPP or some other device-specific +manner. +

+
+
+
+

NM_SETTING_IP4_CONFIG_METHOD_LINK_LOCAL

+
#define NM_SETTING_IP4_CONFIG_METHOD_LINK_LOCAL "link-local"
+
+

+IPv4 configuration should be automatically configured for link-local-only +operation. +

+
+
+
+

NM_SETTING_IP4_CONFIG_METHOD_MANUAL

+
#define NM_SETTING_IP4_CONFIG_METHOD_MANUAL     "manual"
+
+

+All necessary IPv4 configuration (addresses, prefix, DNS, etc) is specified +in the setting's properties. +

+
+
+
+

NM_SETTING_IP4_CONFIG_METHOD_SHARED

+
#define NM_SETTING_IP4_CONFIG_METHOD_SHARED     "shared"
+
+

+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. +

+
+
+
+

NM_SETTING_IP4_CONFIG_METHOD_DISABLED

+
#define NM_SETTING_IP4_CONFIG_METHOD_DISABLED   "disabled"
+
+

+This connection does not use or require IPv4 address and it should be disabled. +

+
+
+
+

struct NMSettingIP4Config

+
struct NMSettingIP4Config;
+

+

+
+
+
+

NMSettingIP4ConfigClass

+
typedef struct {
+	NMSettingIPConfigClass parent;
+} NMSettingIP4ConfigClass;
+
+

+

+
+
+
+

nm_setting_ip4_config_new ()

+
NMSetting *         nm_setting_ip4_config_new           (void);
+

+Creates a new NMSettingIP4Config object with default values. +

+
++++ + + + + +

Returns :

the new empty NMSettingIP4Config object. [transfer full] +
+
+
+
+

nm_setting_ip4_config_get_dhcp_client_id ()

+
const char *        nm_setting_ip4_config_get_dhcp_client_id
+                                                        (NMSettingIP4Config *setting);
+

+Returns the value contained in the "dhcp-client-id" +property. +

+
++++ + + + + + + + + + + +

setting :

the NMSettingIP4Config +

Returns :

the configured Client ID to send to the DHCP server when requesting +addresses via DHCP.
+
+
+
+

Property Details

+
+

The "dhcp-client-id" property

+
  "dhcp-client-id"           gchar*                : Read / Write
+

+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. +

+

Default value: NULL

+
+
+
+
+
+ Generated by GTK-Doc V1.19
+ + \ No newline at end of file -- cgit 1.3.0-6-gf8a5