libnm-util Reference Manual: NMSettingIP4Config

NMSettingIP4Config

typedef struct _NMSettingIP4Config NMSettingIP4Config;

NMSettingIP4ConfigClass

typedef struct {
+	NMSettingClass parent;
+
+	/* Padding for future expansion */
+	void (*_reserved1) (void);
+	void (*_reserved2) (void);
+	void (*_reserved3) (void);
+	void (*_reserved4) (void);
+} NMSettingIP4ConfigClass;
+

nm_ip4_route_unref ()

void
-nm_ip4_route_unref (NMIP4Route *route);

Decreases the reference count of the object. If the reference count -reaches zero, the object will be destroyed.

Parameters

nm_setting_ip4_config_new ()

NMSetting *         nm_setting_ip4_config_new           (void);

+Creates a new NMSettingIP4Config object with default values. +

---++ - - - + +

route

Returns :

the new empty NMSettingIP4Config object. [transfer full] +

nm_ip4_route_compare ()

gboolean
-nm_ip4_route_compare (NMIP4Route *route,
-                      NMIP4Route *other);

Determines if two NMIP4Route objects contain the same values.

Parameters

nm_setting_ip4_config_get_method ()

const char *        nm_setting_ip4_config_get_method    (NMSettingIP4Config *setting);

---++ - - - + + - - - + +

route	the NMIP4Route		`setting` :	the NMSettingIP4Config +
other	the NMIP4Route to compare `route` -to.		Returns :	the "method" property of the setting

Returns

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

nm_ip4_route_get_dest ()

guint32
-nm_ip4_route_get_dest (NMIP4Route *route);

Gets the IPv4 destination address property of this route object.

Parameters

----- - - - - - -

route

Returns

the IPv4 address in network byte order

nm_ip4_route_set_dest ()

void
-nm_ip4_route_set_dest (NMIP4Route *route,
-                       guint32 dest);

Sets the IPv4 destination address property of this route object.

Parameters

nm_setting_ip4_config_get_num_dns ()

guint32             nm_setting_ip4_config_get_num_dns   (NMSettingIP4Config *setting);

---++ - - - + + - - - + +

route	the NMIP4Route		`setting` :	the NMSettingIP4Config +
dest	the destination address in network byte order		Returns :	the number of configured DNS servers

nm_ip4_route_get_prefix ()

guint32
-nm_ip4_route_get_prefix (NMIP4Route *route);

Gets the IPv4 prefix (ie "24" or "30" etc) of this route.

Parameters

nm_setting_ip4_config_get_dns ()

guint32             nm_setting_ip4_config_get_dns       (NMSettingIP4Config *setting,
+                                                         guint32 i);

---++ - - - - - + + + + + + + + + + + + + +

route	the NMIP4Route
`setting` :	the NMSettingIP4Config +
`i` :	index number of the DNS server to return
Returns :	the IPv4 address (network byte order) of the DNS server at index +`i` +

Returns

the IPv4 prefix

nm_ip4_route_set_prefix ()

void
-nm_ip4_route_set_prefix (NMIP4Route *route,
-                         guint32 prefix);

Sets the IPv4 prefix of this route.

Parameters

nm_setting_ip4_config_add_dns ()

gboolean            nm_setting_ip4_config_add_dns       (NMSettingIP4Config *setting,
+                                                         guint32 dns);

+Adds a new DNS server to the setting. +

---++ - - - + + + + + + - - - + +

route	the NMIP4Route	`setting` :	the NMSettingIP4Config +
`dns` :	the IPv4 address (network byte order) of the DNS server to add
prefix	the prefix, a number between 1 and 32 inclusive	Returns :	+`TRUE` if the DNS server was added; `FALSE` if the server was already +known

nm_ip4_route_get_next_hop ()

guint32
-nm_ip4_route_get_next_hop (NMIP4Route *route);

Gets the IPv4 address of the next hop of this route.

Parameters

nm_setting_ip4_config_remove_dns ()

void                nm_setting_ip4_config_remove_dns    (NMSettingIP4Config *setting,
+                                                         guint32 i);

+Removes the DNS server at index i. +

---++ - - - - - + + + + + + + + + +

route	the NMIP4Route
`setting` :	the NMSettingIP4Config +
`i` :	index number of the DNS server to remove

Returns

the IPv4 address in network byte order

nm_ip4_route_set_next_hop ()

void
-nm_ip4_route_set_next_hop (NMIP4Route *route,
-                           guint32 next_hop);

Sets the IPv4 address of the next hop of this route.

Parameters

nm_setting_ip4_config_remove_dns_by_value ()

gboolean            nm_setting_ip4_config_remove_dns_by_value
+                                                        (NMSettingIP4Config *setting,
+                                                         guint32 dns);

+Removes the DNS server dns. +

---++ - - - + + + + + + - - - + +

route	the NMIP4Route	`setting` :	the NMSettingIP4Config +
`dns` :	the DNS server to remove
next_hop	the IPv4 address of the next hop in network byte order	Returns :	+`TRUE` if the DNS server was found and removed; `FALSE` if it was not. +domain was already known

Since 0.9.10

nm_ip4_route_get_metric ()

guint32
-nm_ip4_route_get_metric (NMIP4Route *route);

Gets the route metric property of this route object; lower values indicate -"better" or more preferred routes.

Parameters

nm_setting_ip4_config_clear_dns ()

void                nm_setting_ip4_config_clear_dns     (NMSettingIP4Config *setting);

+Removes all configured DNS servers. +

---++ - - - + +

route

setting :

Returns

the route metric

nm_ip4_route_set_metric ()

void
-nm_ip4_route_set_metric (NMIP4Route *route,
-                         guint32 metric);

Sets the route metric property of this route object; lower values indicate -"better" or more preferred routes.

Parameters

nm_setting_ip4_config_get_num_dns_searches ()

guint32             nm_setting_ip4_config_get_num_dns_searches
+                                                        (NMSettingIP4Config *setting);

---++ - - - + + - - - + +

route	the NMIP4Route		`setting` :	the NMSettingIP4Config +
metric	the route metric		Returns :	the number of configured DNS search domains

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_method ()

const char *
-nm_setting_ip4_config_get_method (NMSettingIP4Config *setting);

Parameters

----- - - - - - -

setting

Returns

the “method” property of the setting

nm_setting_ip4_config_get_num_dns ()

guint32
-nm_setting_ip4_config_get_num_dns (NMSettingIP4Config *setting);

Parameters

nm_setting_ip4_config_get_dns_search ()

const char *        nm_setting_ip4_config_get_dns_search
+                                                        (NMSettingIP4Config *setting,
+                                                         guint32 i);

---++ - - - - - + + + + + + + + + + + + + +

setting	the NMSettingIP4Config
`setting` :	the NMSettingIP4Config +
`i` :	index number of the DNS search domain to return
Returns :	the DNS search domain at index `i` +

Returns

the number of configured DNS servers

nm_setting_ip4_config_get_dns ()

guint32
-nm_setting_ip4_config_get_dns (NMSettingIP4Config *setting,
-                               guint32 i);

Parameters

nm_setting_ip4_config_add_dns_search ()

gboolean            nm_setting_ip4_config_add_dns_search
+                                                        (NMSettingIP4Config *setting,
+                                                         const char *dns_search);

+Adds a new DNS search domain to the setting. +

---++ - - - + + + + + + - - - + +

setting	the NMSettingIP4Config	`setting` :	the NMSettingIP4Config +
`dns_search` :	the search domain to add
i	index number of the DNS server to return	Returns :	+`TRUE` if the DNS search domain was added; `FALSE` if the search +domain was already known

Returns

the IPv4 address (network byte order) of the DNS server at index -i -

nm_setting_ip4_config_add_dns ()

gboolean
-nm_setting_ip4_config_add_dns (NMSettingIP4Config *setting,
-                               guint32 dns);

Adds a new DNS server to the setting.

Parameters

nm_setting_ip4_config_remove_dns_search ()

void                nm_setting_ip4_config_remove_dns_search
+                                                        (NMSettingIP4Config *setting,
+                                                         guint32 i);

+Removes the DNS search domain at index i. +

---++ - - - + + - - - + +

setting	the NMSettingIP4Config		`setting` :	the NMSettingIP4Config +
dns	the IPv4 address (network byte order) of the DNS server to add		`i` :	index number of the DNS search domain

Returns

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

nm_setting_ip4_config_remove_dns ()

void
-nm_setting_ip4_config_remove_dns (NMSettingIP4Config *setting,
-                                  guint32 i);

Removes the DNS server at index i -.

Parameters

nm_setting_ip4_config_remove_dns_search_by_value ()

gboolean            nm_setting_ip4_config_remove_dns_search_by_value
+                                                        (NMSettingIP4Config *setting,
+                                                         const char *dns_search);

+Removes the DNS search domain dns_search. +

---++ - - - + + + + + + - - - + +

setting	the NMSettingIP4Config	`setting` :	the NMSettingIP4Config +
`dns_search` :	the search domain to remove
i	index number of the DNS server to remove	Returns :	+`TRUE` if the DNS search domain was found and removed; `FALSE` if it was not. +Since 0.9.10

nm_setting_ip4_config_clear_dns ()

void
-nm_setting_ip4_config_clear_dns (NMSettingIP4Config *setting);

Removes all configured DNS servers.

Parameters

nm_setting_ip4_config_clear_dns_searches ()

void                nm_setting_ip4_config_clear_dns_searches
+                                                        (NMSettingIP4Config *setting);

+Removes all configured DNS search domains. +

---++ - - - + +

setting

setting :

nm_setting_ip4_config_get_num_dns_searches ()

guint32
-nm_setting_ip4_config_get_num_dns_searches
-                               (NMSettingIP4Config *setting);

Parameters

nm_setting_ip4_config_get_num_addresses ()

guint32             nm_setting_ip4_config_get_num_addresses
+                                                        (NMSettingIP4Config *setting);

---++ - - - - - + + + + + + + + + +

setting	the NMSettingIP4Config
`setting` :	the NMSettingIP4Config +
Returns :	the number of configured addresses

Returns

the number of configured DNS search domains

nm_setting_ip4_config_get_dns_search ()

const char *
-nm_setting_ip4_config_get_dns_search (NMSettingIP4Config *setting,
-                                      guint32 i);

Parameters

nm_setting_ip4_config_get_address ()

NMIP4Address *      nm_setting_ip4_config_get_address   (NMSettingIP4Config *setting,
+                                                         guint32 i);

---++ - - - + + + + + + - - - + +

setting	the NMSettingIP4Config	`setting` :	the NMSettingIP4Config +
`i` :	index number of the address to return
i	index number of the DNS search domain to return	Returns :	the address at index `i` +

Returns

the DNS search domain at index i -

nm_setting_ip4_config_add_dns_search ()

gboolean
-nm_setting_ip4_config_add_dns_search (NMSettingIP4Config *setting,
-                                      const char *dns_search);

Adds a new DNS search domain to the setting.

Parameters

nm_setting_ip4_config_add_address ()

gboolean            nm_setting_ip4_config_add_address   (NMSettingIP4Config *setting,
+                                                         NMIP4Address *address);

+Adds a new IPv4 address and associated information to the setting. The +given address is duplicated internally and is not changed by this function. +

---++ - - - + + + + + + - - - + +

setting	the NMSettingIP4Config	`setting` :	the NMSettingIP4Config +
`address` :	the new address to add
dns_search	the search domain to add	Returns :	+`TRUE` if the address was added; `FALSE` if the address was already +known.

Returns

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

nm_setting_ip4_config_remove_dns_search ()

void
-nm_setting_ip4_config_remove_dns_search
-                               (NMSettingIP4Config *setting,
-                                guint32 i);

Removes the DNS search domain at index i -.

Parameters

nm_setting_ip4_config_remove_address ()

void                nm_setting_ip4_config_remove_address
+                                                        (NMSettingIP4Config *setting,
+                                                         guint32 i);

+Removes the address at index i. +

---++ - - - + + - - - + +

setting	the NMSettingIP4Config		`setting` :	the NMSettingIP4Config +
i	index number of the DNS search domain		`i` :	index number of the address to remove

nm_setting_ip4_config_clear_dns_searches ()

void
-nm_setting_ip4_config_clear_dns_searches
-                               (NMSettingIP4Config *setting);

Removes all configured DNS search domains.

Parameters

nm_setting_ip4_config_remove_address_by_value ()

gboolean            nm_setting_ip4_config_remove_address_by_value
+                                                        (NMSettingIP4Config *setting,
+                                                         NMIP4Address *address);

+Removes the address address. +

---++ - - - - - + + + + + + + + + + + + + +

setting	the NMSettingIP4Config
`setting` :	the NMSettingIP4Config +
`address` :	the IP address to remove
Returns :	+`TRUE` if the address was found and removed; `FALSE` if it was not.

Since 0.9.10

nm_setting_ip4_config_get_num_addresses ()

guint32
-nm_setting_ip4_config_get_num_addresses
-                               (NMSettingIP4Config *setting);

Parameters

nm_setting_ip4_config_clear_addresses ()

void                nm_setting_ip4_config_clear_addresses
+                                                        (NMSettingIP4Config *setting);

+Removes all configured addresses. +

---++ - - - + +

setting

setting :

Returns

the number of configured addresses

nm_setting_ip4_config_get_address ()

NMIP4Address *
-nm_setting_ip4_config_get_address (NMSettingIP4Config *setting,
-                                   guint32 i);

Parameters

nm_setting_ip4_config_get_num_routes ()

guint32             nm_setting_ip4_config_get_num_routes
+                                                        (NMSettingIP4Config *setting);

---++ - - - + + - - - + +

setting	the NMSettingIP4Config		`setting` :	the NMSettingIP4Config +
i	index number of the address to return		Returns :	the number of configured routes

Returns

the address at index i -

nm_setting_ip4_config_add_address ()

gboolean
-nm_setting_ip4_config_add_address (NMSettingIP4Config *setting,
-                                   NMIP4Address *address);

Adds a new IPv4 address and associated information to the setting. The -given address is duplicated internally and is not changed by this function.

Parameters

nm_setting_ip4_config_get_route ()

NMIP4Route *        nm_setting_ip4_config_get_route     (NMSettingIP4Config *setting,
+                                                         guint32 i);

---++ - - - - - - - - + + - -

setting	the NMSettingIP4Config
address	the new address to add		`setting` :	the NMSettingIP4Config +

Returns

TRUE if the address was added; FALSE if the address was already -known.

nm_setting_ip4_config_remove_address ()

void
-nm_setting_ip4_config_remove_address (NMSettingIP4Config *setting,
-                                      guint32 i);

Removes the address at index i -.

Parameters

----- - - - - + + - - - + +

setting	the NMSettingIP4Config		`i` :	index number of the route to return
i	index number of the address to remove		Returns :	the route at index `i` +

nm_setting_ip4_config_clear_addresses ()

void
-nm_setting_ip4_config_clear_addresses (NMSettingIP4Config *setting);

Removes all configured addresses.

Parameters

----- - - - - - -

setting

nm_setting_ip4_config_get_num_routes ()

guint32
-nm_setting_ip4_config_get_num_routes (NMSettingIP4Config *setting);

Parameters

----- - - - - - -

setting

Returns

the number of configured routes

nm_setting_ip4_config_get_route ()

NMIP4Route *
-nm_setting_ip4_config_get_route (NMSettingIP4Config *setting,
-                                 guint32 i);

Parameters

nm_setting_ip4_config_add_route ()

gboolean            nm_setting_ip4_config_add_route     (NMSettingIP4Config *setting,
+                                                         NMIP4Route *route);

+Adds a new IPv4 route and associated information to the setting. The +given route is duplicated internally and is not changed by this function. +

---++ - - - + + + + + + - - - + +

setting	the NMSettingIP4Config	`setting` :	the NMSettingIP4Config +
`route` :	the route to add
i	index number of the route to return	Returns :	+`TRUE` if the route was added; `FALSE` if the route was already known.

Returns

the route at index i -

nm_setting_ip4_config_add_route ()

gboolean
-nm_setting_ip4_config_add_route (NMSettingIP4Config *setting,
-                                 NMIP4Route *route);

Adds a new IPv4 route and associated information to the setting. The -given route is duplicated internally and is not changed by this function.

Parameters

nm_setting_ip4_config_remove_route ()

void                nm_setting_ip4_config_remove_route  (NMSettingIP4Config *setting,
+                                                         guint32 i);

+Removes the route at index i. +

---++ - - - + + - - - + +

setting	the NMSettingIP4Config		`setting` :	the NMSettingIP4Config +
route	the route to add		`i` :	index number of the route

Returns

TRUE if the route was added; FALSE if the route was already known.

nm_setting_ip4_config_remove_route ()

void
-nm_setting_ip4_config_remove_route (NMSettingIP4Config *setting,
-                                    guint32 i);

Removes the route at index i -.

Parameters

nm_setting_ip4_config_remove_route_by_value ()

gboolean            nm_setting_ip4_config_remove_route_by_value
+                                                        (NMSettingIP4Config *setting,
+                                                         NMIP4Route *route);

+Removes the route route. +

---++ - - - + + + + + + - - - + +

setting	the NMSettingIP4Config	`setting` :	the NMSettingIP4Config +
`route` :	the route to remove
i	index number of the route	Returns :	+`TRUE` if the route was found and removed; `FALSE` if it was not.

Since 0.9.10

nm_setting_ip4_config_clear_routes ()

void
-nm_setting_ip4_config_clear_routes (NMSettingIP4Config *setting);

Removes all configured routes.

Parameters

nm_setting_ip4_config_clear_routes ()

void                nm_setting_ip4_config_clear_routes  (NMSettingIP4Config *setting);

+Removes all configured routes. +

---++ - - - + +

setting

setting :

nm_setting_ip4_config_get_ignore_auto_routes ()

gboolean
-nm_setting_ip4_config_get_ignore_auto_routes
-                               (NMSettingIP4Config *setting);

Returns the value contained in the “ignore-auto-routes” -property.

Parameters

nm_setting_ip4_config_get_ignore_auto_routes ()

gboolean            nm_setting_ip4_config_get_ignore_auto_routes
+                                                        (NMSettingIP4Config *setting);

+Returns the value contained in the "ignore-auto-routes" +property. +

---++ - - - - - + + + + + + + + + +

setting	the NMSettingIP4Config
`setting` :	the NMSettingIP4Config +
Returns :	+`TRUE` if automatically configured (ie via DHCP) routes should be +ignored.

Returns

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

nm_setting_ip4_config_get_ignore_auto_dns ()

gboolean
-nm_setting_ip4_config_get_ignore_auto_dns
-                               (NMSettingIP4Config *setting);

Returns the value contained in the “ignore-auto-dns” -property.

Parameters

nm_setting_ip4_config_get_ignore_auto_dns ()

gboolean            nm_setting_ip4_config_get_ignore_auto_dns
+                                                        (NMSettingIP4Config *setting);

+Returns the value contained in the "ignore-auto-dns" +property. +

---++ - - - - - + + + + + + + + + +

setting	the NMSettingIP4Config
`setting` :	the NMSettingIP4Config +
Returns :	+`TRUE` if automatically configured (ie via DHCP) DNS information +should be ignored.

Returns

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

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.

Parameters

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
`setting` :	the NMSettingIP4Config +
Returns :	the configured Client ID to send to the DHCP server when requesting +addresses via DHCP.

Returns

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

nm_setting_ip4_config_get_dhcp_send_hostname ()

gboolean
-nm_setting_ip4_config_get_dhcp_send_hostname
-                               (NMSettingIP4Config *setting);

Returns the value contained in the “dhcp-send-hostname” -property.

Parameters

nm_setting_ip4_config_get_dhcp_send_hostname ()

gboolean            nm_setting_ip4_config_get_dhcp_send_hostname
+                                                        (NMSettingIP4Config *setting);

+Returns the value contained in the "dhcp-send-hostname" +property. +

---++ - - - - - -

setting

Returns

TRUE if NetworkManager should send the machine hostname to the + + +

setting :

+the NMSettingIP4Config + + + +

Returns :

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

nm_setting_ip4_config_get_dhcp_hostname ()

const char *
-nm_setting_ip4_config_get_dhcp_hostname
-                               (NMSettingIP4Config *setting);

Returns the value contained in the “dhcp-hostname” -property.

Parameters

----- - - - - - +update DNS information for this machine. + +

setting

Returns

the configured hostname to send to the DHCP server

nm_setting_ip4_config_get_never_default ()

gboolean
-nm_setting_ip4_config_get_never_default
-                               (NMSettingIP4Config *setting);

Returns the value contained in the “never-default” -property.

Parameters

nm_setting_ip4_config_get_dhcp_hostname ()

const char *        nm_setting_ip4_config_get_dhcp_hostname
+                                                        (NMSettingIP4Config *setting);

+Returns the value contained in the "dhcp-hostname" +property. +

---++ - - - - - + + + + + + + + + +

setting	the NMSettingIP4Config
`setting` :	the NMSettingIP4Config +
Returns :	the configured hostname to send to the DHCP server

Returns

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

nm_setting_ip4_config_get_may_fail ()

gboolean
-nm_setting_ip4_config_get_may_fail (NMSettingIP4Config *setting);

Returns the value contained in the “may-fail” -property.

Parameters

----- - - - - - -

setting