From 50a58f0fabd8a34c1b6108a107e08abe3c1ccd24 Mon Sep 17 00:00:00 2001 From: Michael Biebl Date: Tue, 14 Jul 2015 19:38:58 +0200 Subject: Imported Upstream version 1.0.4 --- docs/libnm-util/html/NMSettingIP4Config.html | 167 +++++++++++++-------------- 1 file changed, 80 insertions(+), 87 deletions(-) (limited to 'docs/libnm-util/html/NMSettingIP4Config.html') 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 @@ -libnm-util Reference Manual: NMSettingIP4Config +NMSettingIP4Config: libnm-util Reference Manual - + @@ -723,7 +723,6 @@ nm_setting_ip4_config_error_quark (

Returns

the error quark used for NMSettingIP4Config errors.

-

@@ -843,7 +842,6 @@ to.

Returns

TRUE if the objects contain the same values, FALSE if they do not.

-

@@ -870,7 +868,6 @@ nm_ip4_address_get_address (

Returns

the IPv4 address in network byte order

-

@@ -928,7 +925,6 @@ object.

Returns

the IPv4 address prefix

-

@@ -985,7 +981,6 @@ nm_ip4_address_get_gateway (

Returns

the IPv4 gateway address in network byte order

-

@@ -1135,7 +1130,6 @@ to.

Returns

TRUE if the objects contain the same values, FALSE if they do not.

-

@@ -1162,7 +1156,6 @@ nm_ip4_route_get_dest (

Returns

the IPv4 address in network byte order

-

@@ -1219,7 +1212,6 @@ nm_ip4_route_get_prefix (

Returns

the IPv4 prefix

-

@@ -1276,7 +1268,6 @@ nm_ip4_route_get_next_hop (

Returns

the IPv4 address in network byte order

-

@@ -1334,7 +1325,6 @@ nm_ip4_route_get_metric (

Returns

the route metric

-

@@ -1403,7 +1393,6 @@ nm_setting_ip4_config_get_method (

Returns

the “method” property of the setting

-

@@ -1429,7 +1418,6 @@ nm_setting_ip4_config_get_num_dns (

Returns

the number of configured DNS servers

-

@@ -1465,7 +1453,6 @@ nm_setting_ip4_config_get_dns ( the IPv4 address (network byte order) of the DNS server at index i

-

@@ -1501,7 +1488,6 @@ nm_setting_ip4_config_add_dns (

Returns

TRUE if the DNS server was added; FALSE if the server was already known

-

@@ -1570,9 +1556,8 @@ nm_setting_ip4_config_remove_dns_by_value

Returns

TRUE if the DNS server was found and removed; FALSE if it was not. domain was already known

-

-

Since 0.9.10

+

Since: 0.9.10

@@ -1620,7 +1605,6 @@ nm_setting_ip4_config_get_num_dns_searches

Returns

the number of configured DNS search domains

-

@@ -1655,7 +1639,6 @@ nm_setting_ip4_config_get_dns_search (

Returns

the DNS search domain at index i

-

@@ -1691,7 +1674,6 @@ nm_setting_ip4_config_add_dns_search (

Returns

TRUE if the DNS search domain was added; FALSE if the search domain was already known

-

@@ -1761,7 +1743,6 @@ nm_setting_ip4_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

-

@@ -1811,7 +1792,6 @@ nm_setting_ip4_config_get_num_addresses

Returns

the number of configured addresses

-

@@ -1846,7 +1826,6 @@ nm_setting_ip4_config_get_address (

Returns

the address at index i

-

@@ -1883,7 +1862,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.

-

@@ -1951,9 +1929,8 @@ nm_setting_ip4_config_remove_address_by_value

Returns

TRUE if the address was found and removed; FALSE if it was not.

-

-

Since 0.9.10

+

Since: 0.9.10

@@ -2000,7 +1977,6 @@ nm_setting_ip4_config_get_num_routes (

Returns

the number of configured routes

-

@@ -2035,7 +2011,6 @@ nm_setting_ip4_config_get_route (

Returns

the route at index i

-

@@ -2071,7 +2046,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.

-

@@ -2139,9 +2113,8 @@ nm_setting_ip4_config_remove_route_by_value

Returns

TRUE if the route was found and removed; FALSE if it was not.

-

-

Since 0.9.10

+

Since: 0.9.10

@@ -2192,9 +2165,8 @@ property.

Returns

the route metric that is used for IPv4 routes that don't explicitly specify a metric. See “route-metric” for more details.

-

-

Since 1.0

+

Since: 1.0

@@ -2223,7 +2195,6 @@ property.

Returns

TRUE if automatically configured (ie via DHCP) routes should be ignored.

-

@@ -2253,7 +2224,6 @@ property.

Returns

TRUE if automatically configured (ie via DHCP) DNS information should be ignored.

-

@@ -2283,7 +2253,6 @@ property.

Returns

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

-

@@ -2314,7 +2283,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.

-

@@ -2343,7 +2311,6 @@ property.

Returns

the configured hostname to send to the DHCP server

-

@@ -2373,7 +2340,6 @@ property.

Returns

TRUE if this connection should never be the default connection for IPv4 addressing

-

@@ -2402,7 +2368,6 @@ property.

Returns

TRUE if this connection doesn't require IPv4 addressing to complete for the connection to succeed.

-

@@ -2412,8 +2377,6 @@ for the connection to succeed.

NM_SETTING_IP4_CONFIG_SETTING_NAME

#define NM_SETTING_IP4_CONFIG_SETTING_NAME "ipv4"
-

-

@@ -2466,112 +2429,84 @@ not valid with the given IP4 method

NM_SETTING_IP4_CONFIG_ERROR

#define NM_SETTING_IP4_CONFIG_ERROR nm_setting_ip4_config_error_quark ()
-

-

NM_SETTING_IP4_CONFIG_METHOD

#define NM_SETTING_IP4_CONFIG_METHOD             "method"
-

-

NM_SETTING_IP4_CONFIG_DNS

#define NM_SETTING_IP4_CONFIG_DNS                "dns"
-

-

NM_SETTING_IP4_CONFIG_DNS_SEARCH

#define NM_SETTING_IP4_CONFIG_DNS_SEARCH         "dns-search"
-

-

NM_SETTING_IP4_CONFIG_ADDRESSES

#define NM_SETTING_IP4_CONFIG_ADDRESSES          "addresses"
-

-

NM_SETTING_IP4_CONFIG_ROUTES

#define NM_SETTING_IP4_CONFIG_ROUTES             "routes"
-

-

NM_SETTING_IP4_CONFIG_ROUTE_METRIC

#define NM_SETTING_IP4_CONFIG_ROUTE_METRIC       "route-metric"
-

-

NM_SETTING_IP4_CONFIG_IGNORE_AUTO_ROUTES

#define NM_SETTING_IP4_CONFIG_IGNORE_AUTO_ROUTES "ignore-auto-routes"
-

-

NM_SETTING_IP4_CONFIG_IGNORE_AUTO_DNS

#define NM_SETTING_IP4_CONFIG_IGNORE_AUTO_DNS    "ignore-auto-dns"
-

-

NM_SETTING_IP4_CONFIG_DHCP_CLIENT_ID

#define NM_SETTING_IP4_CONFIG_DHCP_CLIENT_ID     "dhcp-client-id"
-

-

NM_SETTING_IP4_CONFIG_DHCP_SEND_HOSTNAME

#define NM_SETTING_IP4_CONFIG_DHCP_SEND_HOSTNAME "dhcp-send-hostname"
-

-

NM_SETTING_IP4_CONFIG_DHCP_HOSTNAME

#define NM_SETTING_IP4_CONFIG_DHCP_HOSTNAME      "dhcp-hostname"
-

-

NM_SETTING_IP4_CONFIG_NEVER_DEFAULT

#define NM_SETTING_IP4_CONFIG_NEVER_DEFAULT      "never-default"
-

-

NM_SETTING_IP4_CONFIG_MAY_FAIL

#define NM_SETTING_IP4_CONFIG_MAY_FAIL           "may-fail"
-

-

@@ -2623,14 +2558,22 @@ through that interface to the default network.

The “addresses” property

  “addresses”                GPtrArray_GArray_guint__ *
-

+

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.

Flags: Read / Write

The “dhcp-client-id” property

  “dhcp-client-id”           gchar *
-

+

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.

Flags: Read / Write

Default value: NULL

@@ -2638,7 +2581,8 @@ through that interface to the default network.

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

@@ -2646,7 +2590,11 @@ through that interface to the default network.

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 empty and this property is +TRUE, the current persistent hostname of the computer is sent.

Flags: Read / Write / Construct

Default value: TRUE

@@ -2654,21 +2602,34 @@ through that interface to the default network.

The “dns” property

  “dns”                      GArray_guint_ *
-

+

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.

Flags: Read / Write

The “dns-search” property

  “dns-search”               GSList_gchararray_ *
-

+

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.

Flags: Read / Write

The “ignore-auto-dns” property

  “ignore-auto-dns”          gboolean
-

+

When the 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

@@ -2676,7 +2637,9 @@ through that interface to the default network.

The “ignore-auto-routes” property

  “ignore-auto-routes”       gboolean
-

+

When the 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

@@ -2684,7 +2647,12 @@ through that interface to the default network.

The “may-fail” property

  “may-fail”                 gboolean
-

+

If TRUE, 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 TRUE allows the overall +network configuration to succeed if IPv4 configuration fails but IPv6 +configuration completes successfully.

Flags: Read / Write / Construct

Default value: TRUE

@@ -2692,7 +2660,18 @@ through that interface to the default network.

The “method” property

  “method”                   gchar *
-

+

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.

Flags: Read / Write

Default value: NULL

@@ -2700,7 +2679,8 @@ through that interface to the default network.

The “never-default” property

  “never-default”            gboolean
-

+

If TRUE, this connection will never be the default IPv4 connection, +meaning it will never be assigned the default route by NetworkManager.

Flags: Read / Write / Construct

Default value: FALSE

@@ -2708,23 +2688,36 @@ through that interface to the default network.

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. +As the linux kernel accepts zero (0) as a valid metric, zero is +a valid value.

Flags: Read / Write / Construct

Allowed values: [-1,4294967295]

Default value: -1

-

Since 1.0

+

Since: 1.0

The “routes” property

  “routes”                   GPtrArray_GArray_guint__ *
-

+

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.

Flags: Read / Write

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