libnm Reference Manual: NMSettingIPConfig

Parameters

@@ -1116,8 +1114,9 @@ nm_ip_address_set_address_binary (addr must point to a buffer that is the correct size for address 's family. +[skip] -Parameters +Parameters

@@ -1164,7 +1163,6 @@ object. Returns the IP address prefix - @@ -1506,7 +1504,6 @@ to. Returns TRUE if the objects contain the same values, FALSE if they do not. - @@ -1563,7 +1560,6 @@ object. Returns the IP address family - @@ -1590,7 +1586,6 @@ nm_ip_route_get_dest ( Returns the IP address of the route's destination - @@ -1637,8 +1632,9 @@ nm_ip_route_get_dest_binary (dest must point to a buffer that is the correct size for route 's family. +[skip] -Parameters +Parameters

@@ -1670,8 +1666,9 @@ nm_ip_route_set_dest_binary (dest must point to a buffer that is the correct size for route 's family. +[skip] -Parameters +Parameters

@@ -1717,7 +1714,6 @@ nm_ip_route_get_prefix ( Returns the IP prefix - @@ -1775,7 +1771,6 @@ route has no next hop. Returns the IP address of the next hop, or NULL if this is a device route. - @@ -1823,8 +1818,9 @@ nm_ip_route_get_next_hop_binary (next_hop must point to a buffer that is the correct size for route 's family. +[skip] -Parameters +Parameters

@@ -1846,12 +1842,11 @@ nm_ip_route_get_next_hop_binary ( -Returns +Returns TRUE if route has a next hop, FALSE if not (in which case next_hop will be zeroed out) - @@ -1865,8 +1860,9 @@ nm_ip_route_set_next_hop_binary (NULL) must point to a buffer that is the correct size for route 's family. +[skip] -Parameters +Parameters

@@ -1914,7 +1910,6 @@ indicate "better" or more preferred routes; -1 indicates "default"
 
 Returns
  the route metric
-
 
 
 
@@ -2078,7 +2073,6 @@ nm_setting_ip_config_get_method ( the “method” property of the setting; see
 NMSettingIP4Config and NMSettingIP6Config for details of the
 methods available with each type.
-
 
 
 
@@ -2104,7 +2098,6 @@ nm_setting_ip_config_get_num_dns (
 Returns
  the number of configured DNS servers
-
 
 
 
@@ -2139,7 +2132,6 @@ nm_setting_ip_config_get_dns (Returns
  the IP address of the DNS server at index i
 
-
 
 
 
@@ -2175,7 +2167,6 @@ nm_setting_ip_config_add_dns (Returns
  TRUE if the DNS server was added; FALSE if the server was already
 known
-
 
 
 
@@ -2243,7 +2234,6 @@ nm_setting_ip_config_remove_dns_by_value
 
 Returns
  TRUE if the DNS server was found and removed; FALSE if it was not.
-
 
 
 
@@ -2292,7 +2282,6 @@ nm_setting_ip_config_get_num_dns_searches
 
 Returns
  the number of configured DNS search domains
-
 
 
 
@@ -2327,7 +2316,6 @@ nm_setting_ip_config_get_dns_search (Returns
  the DNS search domain at index i
 
-
 
 
 
@@ -2363,7 +2351,6 @@ nm_setting_ip_config_add_dns_search (Returns
  TRUE if the DNS search domain was added; FALSE if the search
 domain was already known
-
 
 
 
@@ -2433,7 +2420,6 @@ nm_setting_ip_config_remove_dns_search_by_value
 Returns
  TRUE if the DNS search domain was found and removed; FALSE if it was not.
 Since 0.9.10
-
 
 
 
@@ -2483,7 +2469,6 @@ nm_setting_ip_config_get_num_addresses
 
 Returns
  the number of configured addresses
-
 
 
 
@@ -2518,7 +2503,6 @@ nm_setting_ip_config_get_address (Returns
  the address at index i
 
-
 
 
 
@@ -2555,7 +2539,6 @@ given address is duplicated internally and is not changed by this function.
 Returns
  TRUE if the address was added; FALSE if the address was already
 known.
-
 
 
 
@@ -2623,7 +2606,6 @@ nm_setting_ip_config_remove_address_by_value
 
 Returns
  TRUE if the address was found and removed; FALSE if it was not.
-
 
 
 
@@ -2672,7 +2654,6 @@ nm_setting_ip_config_get_gateway (Returns
  the IP address of the gateway associated with this configuration, or
 NULL.
-
 
 
 
@@ -2698,7 +2679,6 @@ nm_setting_ip_config_get_num_routes (
 Returns
  the number of configured routes
-
 
 
 
@@ -2733,7 +2713,6 @@ nm_setting_ip_config_get_route (Returns
  the route at index i
 
-
 
 
 
@@ -2769,7 +2748,6 @@ given route is duplicated internally and is not changed by this function.
 
 Returns
  TRUE if the route was added; FALSE if the route was already known.
-
 
 
 
@@ -2837,7 +2815,6 @@ nm_setting_ip_config_remove_route_by_value
 
 Returns
  TRUE if the route was found and removed; FALSE if it was not.
-
 
 
 
@@ -2888,7 +2865,6 @@ property.
 Returns
  the route metric that is used for routes that don't explicitly
 specify a metric. See “route-metric” for more details.
-
 
 
 
@@ -2918,7 +2894,6 @@ property.
 Returns
  TRUE if automatically configured (ie via DHCP) routes should be
 ignored.
-
 
 
 
@@ -2948,7 +2923,6 @@ property.
 Returns
  TRUE if automatically configured (ie via DHCP) DNS information
 should be ignored.
-
 
 
 
@@ -2977,7 +2951,6 @@ property.
 
 Returns
  the configured hostname to send to the DHCP server
-
 
 
 
@@ -3008,7 +2981,6 @@ property.
  TRUE 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.
-
 
 
 
@@ -3038,7 +3010,6 @@ property.
 Returns
  TRUE if this connection should never be the default
 connection
-
 
 
 
@@ -3067,7 +3038,6 @@ property.
 Returns
  TRUE if this connection doesn't require this type of IP
 addressing to complete for the connection to succeed.
-
 
 
 
@@ -3077,104 +3047,78 @@ addressing to complete for the connection to succeed.
 NM_SETTING_IP_CONFIG_METHOD
 #define NM_SETTING_IP_CONFIG_METHOD             "method"
 
-
-
 
 
 
 NM_SETTING_IP_CONFIG_DNS
 #define NM_SETTING_IP_CONFIG_DNS                "dns"
 
-
-
 
 
 
 NM_SETTING_IP_CONFIG_DNS_SEARCH
 #define NM_SETTING_IP_CONFIG_DNS_SEARCH         "dns-search"
 
-
-
 
 
 
 NM_SETTING_IP_CONFIG_ADDRESSES
 #define NM_SETTING_IP_CONFIG_ADDRESSES          "addresses"
 
-
-
 
 
 
 NM_SETTING_IP_CONFIG_GATEWAY
 #define NM_SETTING_IP_CONFIG_GATEWAY            "gateway"
 
-
-
 
 
 
 NM_SETTING_IP_CONFIG_ROUTES
 #define NM_SETTING_IP_CONFIG_ROUTES             "routes"
 
-
-
 
 
 
 NM_SETTING_IP_CONFIG_ROUTE_METRIC
 #define NM_SETTING_IP_CONFIG_ROUTE_METRIC       "route-metric"
 
-
-
 
 
 
 NM_SETTING_IP_CONFIG_IGNORE_AUTO_ROUTES
 #define NM_SETTING_IP_CONFIG_IGNORE_AUTO_ROUTES "ignore-auto-routes"
 
-
-
 
 
 
 NM_SETTING_IP_CONFIG_IGNORE_AUTO_DNS
 #define NM_SETTING_IP_CONFIG_IGNORE_AUTO_DNS    "ignore-auto-dns"
 
-
-
 
 
 
 NM_SETTING_IP_CONFIG_DHCP_HOSTNAME
 #define NM_SETTING_IP_CONFIG_DHCP_HOSTNAME      "dhcp-hostname"
 
-
-
 
 
 
 NM_SETTING_IP_CONFIG_DHCP_SEND_HOSTNAME
 #define NM_SETTING_IP_CONFIG_DHCP_SEND_HOSTNAME "dhcp-send-hostname"
 
-
-
 
 
 
 NM_SETTING_IP_CONFIG_NEVER_DEFAULT
 #define NM_SETTING_IP_CONFIG_NEVER_DEFAULT      "never-default"
 
-
-
 
 
 
 NM_SETTING_IP_CONFIG_MAY_FAIL
 #define NM_SETTING_IP_CONFIG_MAY_FAIL           "may-fail"
 
-
-
 
 
 
@@ -3182,14 +3126,16 @@ addressing to complete for the connection to succeed.
 
 The “addresses” property
   “addresses”                GPtrArray *
-
+Array of IP addresses.
+Element-Type: NMIPAddress
 Flags: Read / Write
 
 
 
 The “dhcp-hostname” property
   “dhcp-hostname”            gchar *
-
+If the “dhcp-send-hostname” property is TRUE, then the
+specified name will be sent to the DHCP server when acquiring a lease.
 Flags: Read / Write
 Default value: NULL
 
@@ -3197,7 +3143,11 @@ addressing to complete for the connection to succeed.
 
 The “dhcp-send-hostname” property
   “dhcp-send-hostname”       gboolean
-
+If TRUE, 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
+“dhcp-hostname” property is NULL and this property is
+TRUE, the current persistent hostname of the computer is sent.
 Flags: Read / Write / Construct
 Default value: TRUE
 
@@ -3205,21 +3155,22 @@ addressing to complete for the connection to succeed.
 
 The “dns” property
   “dns”                      GStrv
-
+Array of IP addresses of DNS servers.
 Flags: Read / Write
 
 
 
 The “dns-search” property
   “dns-search”               GStrv
-
+Array of DNS search domains.
 Flags: Read / Write
 
 
 
 The “gateway” property
   “gateway”                  gchar *
-
+The gateway associated with this configuration. This is only meaningful
+if “addresses” is also set.
 Flags: Read / Write
 Default value: NULL
 
@@ -3227,7 +3178,11 @@ addressing to complete for the connection to succeed.
 
 The “ignore-auto-dns” property
   “ignore-auto-dns”          gboolean
-
+When “method” is set to "auto" and this property to
+TRUE, automatically configured nameservers and search domains are
+ignored and only nameservers and search domains specified in the
+“dns” and “dns-search” properties, if
+any, are used.
 Flags: Read / Write / Construct
 Default value: FALSE
 
@@ -3235,7 +3190,9 @@ addressing to complete for the connection to succeed.
 
 The “ignore-auto-routes” property
   “ignore-auto-routes”       gboolean
-
+When “method” is set to "auto" and this property to
+TRUE, automatically configured routes are ignored and only routes
+specified in the “routes” property, if any, are used.
 Flags: Read / Write / Construct
 Default value: FALSE
 
@@ -3243,7 +3200,13 @@ addressing to complete for the connection to succeed.
 
 The “may-fail” property
   “may-fail”                 gboolean
-
+If TRUE, 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
+TRUE on the NMSettingIP4Config allows the overall network configuration
+to succeed if IPv4 configuration fails but IPv6 configuration completes
+successfully.
 Flags: Read / Write / Construct
 Default value: TRUE
 
@@ -3251,7 +3214,17 @@ addressing to complete for the connection to succeed.
 
 The “method” property
   “method”                   gchar *
-
+IP configuration method.
+NMSettingIP4Config and NMSettingIP6Config both support "auto",
+"manual", and "link-local". See the subclass-specific documentation for
+other values.
+In general, for the "auto" method, properties such as
+“dns” and “routes” specify information
+that is added on to the information returned from automatic
+configuration.  The “ignore-auto-routes” and
+“ignore-auto-dns” properties modify this behavior.
+For methods that imply no upstream network, such as "shared" or
+"link-local", these properties must be empty.
 Flags: Read / Write
 Default value: NULL
 
@@ -3259,7 +3232,9 @@ addressing to complete for the connection to succeed.
 
 The “never-default” property
   “never-default”            gboolean
-
+If TRUE, this connection will never be the default connection for this
+IP type, meaning it will never be assigned the default route by
+NetworkManager.
 Flags: Read / Write / Construct
 Default value: FALSE
 
@@ -3267,7 +3242,16 @@ addressing to complete for the connection to succeed.
 
 The “route-metric” property
   “route-metric”             gint64
-
+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.
 Flags: Read / Write / Construct
 Allowed values: [-1,4294967295]
 Default value: -1
@@ -3276,7 +3260,8 @@ addressing to complete for the connection to succeed.
 
 The “routes” property
   “routes”                   GPtrArray *
-
+Array of IP routes.
+Element-Type: NMIPRoute
 Flags: Read / Write
 
 
@@ -3286,7 +3271,6 @@ addressing to complete for the connection to succeed.
 
 
 
-
-          Generated by GTK-Doc V1.21
+Generated by GTK-Doc V1.24
 
 
\ No newline at end of file
-- 
cgit 1.3.0-6-gf8a5