NMSettingIPConfig

@@ -38,2543 +32,3261 @@

NMSettingIPConfig — Abstract base class for IPv4 and IPv6 addressing, routing, and name service properties

- +

Synopsis

-#include <nm-setting-ip-config.h>
-
-typedef             NMIPAddress;
-NMIPAddress *       nm_ip_address_new                   (int family,
-                                                         const char *addr,
-                                                         guint prefix,
-                                                         GError **error);
-NMIPAddress *       nm_ip_address_new_binary            (int family,
-                                                         gconstpointer addr,
-                                                         guint prefix,
-                                                         GError **error);
-void                nm_ip_address_ref                   (NMIPAddress *address);
-void                nm_ip_address_unref                 (NMIPAddress *address);
-gboolean            nm_ip_address_equal                 (NMIPAddress *address,
-                                                         NMIPAddress *other);
-NMIPAddress *       nm_ip_address_dup                   (NMIPAddress *address);
-int                 nm_ip_address_get_family            (NMIPAddress *address);
-const char *        nm_ip_address_get_address           (NMIPAddress *address);
-void                nm_ip_address_set_address           (NMIPAddress *address,
-                                                         const char *addr);
-void                nm_ip_address_get_address_binary    (NMIPAddress *address,
-                                                         gpointer addr);
-void                nm_ip_address_set_address_binary    (NMIPAddress *address,
-                                                         gconstpointer addr);
-guint               nm_ip_address_get_prefix            (NMIPAddress *address);
-void                nm_ip_address_set_prefix            (NMIPAddress *address,
-                                                         guint prefix);
-char **             nm_ip_address_get_attribute_names   (NMIPAddress *address);
-GVariant *          nm_ip_address_get_attribute         (NMIPAddress *address,
-                                                         const char *name);
-void                nm_ip_address_set_attribute         (NMIPAddress *address,
-                                                         const char *name,
-                                                         GVariant *value);
-typedef             NMIPRoute;
-NMIPRoute *         nm_ip_route_new                     (int family,
-                                                         const char *dest,
-                                                         guint prefix,
-                                                         const char *next_hop,
-                                                         gint64 metric,
-                                                         GError **error);
-NMIPRoute *         nm_ip_route_new_binary              (int family,
-                                                         gconstpointer dest,
-                                                         guint prefix,
-                                                         gconstpointer next_hop,
-                                                         gint64 metric,
-                                                         GError **error);
-void                nm_ip_route_ref                     (NMIPRoute *route);
-void                nm_ip_route_unref                   (NMIPRoute *route);
-gboolean            nm_ip_route_equal                   (NMIPRoute *route,
-                                                         NMIPRoute *other);
-NMIPRoute *         nm_ip_route_dup                     (NMIPRoute *route);
-int                 nm_ip_route_get_family              (NMIPRoute *route);
-const char *        nm_ip_route_get_dest                (NMIPRoute *route);
-void                nm_ip_route_set_dest                (NMIPRoute *route,
-                                                         const char *dest);
-void                nm_ip_route_get_dest_binary         (NMIPRoute *route,
-                                                         gpointer dest);
-void                nm_ip_route_set_dest_binary         (NMIPRoute *route,
-                                                         gconstpointer dest);
-guint               nm_ip_route_get_prefix              (NMIPRoute *route);
-void                nm_ip_route_set_prefix              (NMIPRoute *route,
-                                                         guint prefix);
-const char *        nm_ip_route_get_next_hop            (NMIPRoute *route);
-void                nm_ip_route_set_next_hop            (NMIPRoute *route,
-                                                         const char *next_hop);
-gboolean            nm_ip_route_get_next_hop_binary     (NMIPRoute *route,
-                                                         gpointer next_hop);
-void                nm_ip_route_set_next_hop_binary     (NMIPRoute *route,
-                                                         gconstpointer next_hop);
-gint64              nm_ip_route_get_metric              (NMIPRoute *route);
-void                nm_ip_route_set_metric              (NMIPRoute *route,
-                                                         gint64 metric);
-char **             nm_ip_route_get_attribute_names     (NMIPRoute *route);
-GVariant *          nm_ip_route_get_attribute           (NMIPRoute *route,
-                                                         const char *name);
-void                nm_ip_route_set_attribute           (NMIPRoute *route,
-                                                         const char *name,
-                                                         GVariant *value);
-#define             NM_SETTING_IP_CONFIG_METHOD
-#define             NM_SETTING_IP_CONFIG_DNS
-#define             NM_SETTING_IP_CONFIG_DNS_SEARCH
-#define             NM_SETTING_IP_CONFIG_ADDRESSES
-#define             NM_SETTING_IP_CONFIG_GATEWAY
-#define             NM_SETTING_IP_CONFIG_ROUTES
-#define             NM_SETTING_IP_CONFIG_ROUTE_METRIC
-#define             NM_SETTING_IP_CONFIG_IGNORE_AUTO_ROUTES
-#define             NM_SETTING_IP_CONFIG_IGNORE_AUTO_DNS
-#define             NM_SETTING_IP_CONFIG_DHCP_HOSTNAME
-#define             NM_SETTING_IP_CONFIG_DHCP_SEND_HOSTNAME
-#define             NM_SETTING_IP_CONFIG_NEVER_DEFAULT
-#define             NM_SETTING_IP_CONFIG_MAY_FAIL
-struct              NMSettingIPConfig;
-                    NMSettingIPConfigClass;
-const char *        nm_setting_ip_config_get_method     (NMSettingIPConfig *setting);
-guint               nm_setting_ip_config_get_num_dns    (NMSettingIPConfig *setting);
-const char *        nm_setting_ip_config_get_dns        (NMSettingIPConfig *setting,
-                                                         int i);
-gboolean            nm_setting_ip_config_add_dns        (NMSettingIPConfig *setting,
-                                                         const char *dns);
-void                nm_setting_ip_config_remove_dns     (NMSettingIPConfig *setting,
-                                                         int i);
-gboolean            nm_setting_ip_config_remove_dns_by_value
-                                                        (NMSettingIPConfig *setting,
-                                                         const char *dns);
-void                nm_setting_ip_config_clear_dns      (NMSettingIPConfig *setting);
-guint               nm_setting_ip_config_get_num_dns_searches
-                                                        (NMSettingIPConfig *setting);
-const char *        nm_setting_ip_config_get_dns_search (NMSettingIPConfig *setting,
-                                                         int i);
-gboolean            nm_setting_ip_config_add_dns_search (NMSettingIPConfig *setting,
-                                                         const char *dns_search);
-void                nm_setting_ip_config_remove_dns_search
-                                                        (NMSettingIPConfig *setting,
-                                                         int i);
-gboolean            nm_setting_ip_config_remove_dns_search_by_value
-                                                        (NMSettingIPConfig *setting,
-                                                         const char *dns_search);
-void                nm_setting_ip_config_clear_dns_searches
-                                                        (NMSettingIPConfig *setting);
-guint               nm_setting_ip_config_get_num_addresses
-                                                        (NMSettingIPConfig *setting);
-NMIPAddress *       nm_setting_ip_config_get_address    (NMSettingIPConfig *setting,
-                                                         int i);
-gboolean            nm_setting_ip_config_add_address    (NMSettingIPConfig *setting,
-                                                         NMIPAddress *address);
-void                nm_setting_ip_config_remove_address (NMSettingIPConfig *setting,
-                                                         int i);
-gboolean            nm_setting_ip_config_remove_address_by_value
-                                                        (NMSettingIPConfig *setting,
-                                                         NMIPAddress *address);
-void                nm_setting_ip_config_clear_addresses
-                                                        (NMSettingIPConfig *setting);
-const char *        nm_setting_ip_config_get_gateway    (NMSettingIPConfig *setting);
-guint               nm_setting_ip_config_get_num_routes (NMSettingIPConfig *setting);
-NMIPRoute *         nm_setting_ip_config_get_route      (NMSettingIPConfig *setting,
-                                                         int i);
-gboolean            nm_setting_ip_config_add_route      (NMSettingIPConfig *setting,
-                                                         NMIPRoute *route);
-void                nm_setting_ip_config_remove_route   (NMSettingIPConfig *setting,
-                                                         int i);
-gboolean            nm_setting_ip_config_remove_route_by_value
-                                                        (NMSettingIPConfig *setting,
-                                                         NMIPRoute *route);
-void                nm_setting_ip_config_clear_routes   (NMSettingIPConfig *setting);
-gint64              nm_setting_ip_config_get_route_metric
-                                                        (NMSettingIPConfig *setting);
-gboolean            nm_setting_ip_config_get_ignore_auto_routes
-                                                        (NMSettingIPConfig *setting);
-gboolean            nm_setting_ip_config_get_ignore_auto_dns
-                                                        (NMSettingIPConfig *setting);
-const char *        nm_setting_ip_config_get_dhcp_hostname
-                                                        (NMSettingIPConfig *setting);
-gboolean            nm_setting_ip_config_get_dhcp_send_hostname
-                                                        (NMSettingIPConfig *setting);
-gboolean            nm_setting_ip_config_get_never_default
-                                                        (NMSettingIPConfig *setting);
-gboolean            nm_setting_ip_config_get_may_fail   (NMSettingIPConfig *setting);
-

Object Hierarchy

-  GBoxed
-   +----NMIPAddress
-

-  GBoxed
-   +----NMIPRoute
-

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

Properties

-  "addresses"                GPtrArray*            : Read / Write
-  "dhcp-hostname"            gchar*                : Read / Write
-  "dhcp-send-hostname"       gboolean              : Read / Write / Construct
-  "dns"                      GStrv                 : Read / Write
-  "dns-search"               GStrv                 : Read / Write
-  "gateway"                  gchar*                : Read / Write
-  "ignore-auto-dns"          gboolean              : Read / Write / Construct
-  "ignore-auto-routes"       gboolean              : Read / Write / Construct
-  "may-fail"                 gboolean              : Read / Write / Construct
-  "method"                   gchar*                : Read / Write
-  "never-default"            gboolean              : Read / Write / Construct
-  "route-metric"             gint64                : Read / Write / Construct
-  "routes"                   GPtrArray*            : Read / Write
-

Description

-NMSettingIPConfig is the abstract base class of -NMSettingIP4Config and NMSettingIP6Config, providing properties -related to IP addressing, routing, and Domain Name Service. -

Details

NMIPAddress

typedef struct NMIPAddress NMIPAddress;
-

nm_ip_address_new ()

NMIPAddress *       nm_ip_address_new                   (int family,
-                                                         const char *addr,
-                                                         guint prefix,
-                                                         GError **error);

-Creates a new NMIPAddress object. -

Functions

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

`family` :	the IP address family (`AF_INET` or -`AF_INET6`)	+NMIPAddress * +	+nm_ip_address_new () +
`addr` :	the IP address	+NMIPAddress * +	+nm_ip_address_new_binary () +
`prefix` :	the address prefix length	+void +	+nm_ip_address_ref () +
`error` :	location to store error, or `NULL` +	+void +	+nm_ip_address_unref ()
Returns :	the new NMIPAddress object, or `NULL` on error. [transfer full] +	+gboolean +	+nm_ip_address_equal ()

nm_ip_address_new_binary ()

NMIPAddress *       nm_ip_address_new_binary            (int family,
-                                                         gconstpointer addr,
-                                                         guint prefix,
-                                                         GError **error);

-Creates a new NMIPAddress object. addr must point to a buffer of the -correct size for family. -

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

`family` :	the IP address family (`AF_INET` or -`AF_INET6`)	+NMIPAddress * +	+nm_ip_address_dup () +
`addr` :	the IP address	+int +	+nm_ip_address_get_family () +
`prefix` :	the address prefix length	const char * +	+nm_ip_address_get_address () +
`error` :	location to store error, or `NULL` +	+void +	+nm_ip_address_set_address ()
Returns :	the new NMIPAddress object, or `NULL` on error. [transfer full] +	+void +	+nm_ip_address_get_address_binary ()

nm_ip_address_ref ()

void                nm_ip_address_ref                   (NMIPAddress *address);

-Increases the reference count of the object. -

---- - - - + - -

`address` :	the NMIPAddress +
+void

nm_ip_address_unref ()

void                nm_ip_address_unref                 (NMIPAddress *address);

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

---- - - - - -

address :

the NMIPAddress +

+nm_ip_address_set_address_binary ()

nm_ip_address_equal ()

gboolean            nm_ip_address_equal                 (NMIPAddress *address,
-                                                         NMIPAddress *other);

-Determines if two NMIPAddress objects contain the same address and prefix -(attributes are not compared). -

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

`address` :	the NMIPAddress +	+guint +	+nm_ip_address_get_prefix ()
`other` :	the NMIPAddress to compare `address` to.	+void +	+nm_ip_address_set_prefix () +
Returns :	-`TRUE` if the objects contain the same values, `FALSE` if they do not.	+char ** +	+nm_ip_address_get_attribute_names () +

nm_ip_address_dup ()

NMIPAddress *       nm_ip_address_dup                   (NMIPAddress *address);

-Creates a copy of address -

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

`address` :	the NMIPAddress +	+GVariant * +	+nm_ip_address_get_attribute ()
Returns :	a copy of `address`. [transfer full] +	+void +	+nm_ip_address_set_attribute ()

nm_ip_address_get_family ()

int                 nm_ip_address_get_family            (NMIPAddress *address);

-Gets the IP address family (eg, AF_INET) property of this address -object. -

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

`address` :	the NMIPAddress +	+NMIPRoute * +	+nm_ip_route_new ()
Returns :	the IP address family	+NMIPRoute * +	+nm_ip_route_new_binary () +

nm_ip_address_get_address ()

const char *        nm_ip_address_get_address           (NMIPAddress *address);

-Gets the IP address property of this address object. -

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

`address` :	the NMIPAddress +	+void +	+nm_ip_route_ref ()
Returns :	the IP address	+void +	+nm_ip_route_unref () +

nm_ip_address_set_address ()

void                nm_ip_address_set_address           (NMIPAddress *address,
-                                                         const char *addr);

-Sets the IP address property of this address object. -

-addr must be a valid address of address's family. If you aren't sure you -have a valid address, use nm_utils_ipaddr_valid() to check it. -

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

`address` :	the NMIPAddress +	+gboolean +	+nm_ip_route_equal ()
`addr` :	the IP address, as a string	+NMIPRoute * +	+nm_ip_route_dup () +

nm_ip_address_get_address_binary ()

void                nm_ip_address_get_address_binary    (NMIPAddress *address,
-                                                         gpointer addr);

-Gets the IP address property of this address object. -

-addr must point to a buffer that is the correct size for address's family. -

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

`address` :	the NMIPAddress +	+int +	+nm_ip_route_get_family ()
`addr` :	a buffer in which to store the address in binary format.	const char * +	+nm_ip_route_get_dest () +

nm_ip_address_set_address_binary ()

void                nm_ip_address_set_address_binary    (NMIPAddress *address,
-                                                         gconstpointer addr);

-Sets the IP address property of this address object. -

-addr must point to a buffer that is the correct size for address's family. -

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

`address` :	the NMIPAddress +	+void +	+nm_ip_route_set_dest ()
`addr` :	the address, in binary format	+void +	+nm_ip_route_get_dest_binary () +

nm_ip_address_get_prefix ()

guint               nm_ip_address_get_prefix            (NMIPAddress *address);

-Gets the IP address prefix (ie "24" or "30" etc) property of this address -object. -

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

`address` :	the NMIPAddress +	+void +	+nm_ip_route_set_dest_binary ()
Returns :	the IP address prefix	+guint +	+nm_ip_route_get_prefix () +

nm_ip_address_set_prefix ()

void                nm_ip_address_set_prefix            (NMIPAddress *address,
-                                                         guint prefix);

-Sets the IP address prefix property of this address object. -

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

`address` :	the NMIPAddress +	+void +	+nm_ip_route_set_prefix ()
`prefix` :	the IP address prefix	const char * +	+nm_ip_route_get_next_hop () +

nm_ip_address_get_attribute_names ()

char **             nm_ip_address_get_attribute_names   (NMIPAddress *address);

-Gets an array of attribute names defined on address. -

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

`address` :	the NMIPAddress +	+void +	+nm_ip_route_set_next_hop ()
Returns :	a `NULL`-terminated array of attribute names,. [transfer full] +	+gboolean +	+nm_ip_route_get_next_hop_binary ()

nm_ip_address_get_attribute ()

GVariant *          nm_ip_address_get_attribute         (NMIPAddress *address,
-                                                         const char *name);

-Gets the value of the attribute with name name on address -

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

`address` :	the NMIPAddress +	+void +	+nm_ip_route_set_next_hop_binary ()
`name` :	the name of an address attribute	+gint64 +	+nm_ip_route_get_metric () +
Returns :	the value of the attribute with name `name` on -`address`, or `NULL` if `address` has no such attribute. [transfer none] +	+void +	+nm_ip_route_set_metric () +
+char ** +	+nm_ip_route_get_attribute_names () +
+GVariant * +	+nm_ip_route_get_attribute () +
+void +	+nm_ip_route_set_attribute () +
const char * +	+nm_setting_ip_config_get_method () +
+guint +	+nm_setting_ip_config_get_num_dns () +
const char * +	+nm_setting_ip_config_get_dns () +
+gboolean +	+nm_setting_ip_config_add_dns () +
+void +	+nm_setting_ip_config_remove_dns () +
+gboolean +	+nm_setting_ip_config_remove_dns_by_value () +
+void +	+nm_setting_ip_config_clear_dns () +
+guint +	+nm_setting_ip_config_get_num_dns_searches () +
const char * +	+nm_setting_ip_config_get_dns_search () +
+gboolean +	+nm_setting_ip_config_add_dns_search () +
+void +	+nm_setting_ip_config_remove_dns_search () +
+gboolean +	+nm_setting_ip_config_remove_dns_search_by_value () +
+void +	+nm_setting_ip_config_clear_dns_searches () +
+guint +	+nm_setting_ip_config_get_num_addresses () +
+NMIPAddress * +	+nm_setting_ip_config_get_address () +
+gboolean +	+nm_setting_ip_config_add_address () +
+void +	+nm_setting_ip_config_remove_address () +
+gboolean +	+nm_setting_ip_config_remove_address_by_value () +
+void +	+nm_setting_ip_config_clear_addresses () +
const char * +	+nm_setting_ip_config_get_gateway () +
+guint +	+nm_setting_ip_config_get_num_routes () +
+NMIPRoute * +	+nm_setting_ip_config_get_route () +
+gboolean +	+nm_setting_ip_config_add_route () +
+void +	+nm_setting_ip_config_remove_route () +
+gboolean +	+nm_setting_ip_config_remove_route_by_value () +
+void +	+nm_setting_ip_config_clear_routes () +
+gint64 +	+nm_setting_ip_config_get_route_metric () +
+gboolean +	+nm_setting_ip_config_get_ignore_auto_routes () +
+gboolean +	+nm_setting_ip_config_get_ignore_auto_dns () +
const char * +	+nm_setting_ip_config_get_dhcp_hostname () +
+gboolean +	+nm_setting_ip_config_get_dhcp_send_hostname () +
+gboolean +	+nm_setting_ip_config_get_never_default () +
+gboolean +	+nm_setting_ip_config_get_may_fail ()

nm_ip_address_set_attribute ()

void                nm_ip_address_set_attribute         (NMIPAddress *address,
-                                                         const char *name,
-                                                         GVariant *value);

-Sets or clears the named attribute on address to the given value. -

Properties

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

`address` :	the NMIPAddress -	+GPtrArray *	addresses	Read / Write
`name` :	the name of an address attribute	+gchar *	dhcp-hostname	Read / Write
`value` :	the value. [transfer none][allow-none] -	gboolean	dhcp-send-hostname	Read / Write / Construct
GStrv	dns	Read / Write
GStrv	dns-search	Read / Write
+gchar *	gateway	Read / Write
gboolean	ignore-auto-dns	Read / Write / Construct
gboolean	ignore-auto-routes	Read / Write / Construct
gboolean	may-fail	Read / Write / Construct
+gchar *	method	Read / Write
gboolean	never-default	Read / Write / Construct
gint64	route-metric	Read / Write / Construct
+GPtrArray *	routes	Read / Write

NMIPRoute

typedef struct NMIPRoute NMIPRoute;
-

nm_ip_route_new ()

NMIPRoute *         nm_ip_route_new                     (int family,
-                                                         const char *dest,
-                                                         guint prefix,
-                                                         const char *next_hop,
-                                                         gint64 metric,
-                                                         GError **error);

-Creates a new NMIPRoute object. -

Types and Values

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

`family` :	the IP address family (`AF_INET` or -`AF_INET6`)	#define	NM_SETTING_IP_CONFIG_METHOD
`dest` :	the IP address of the route's destination	#define	NM_SETTING_IP_CONFIG_DNS
`prefix` :	the address prefix length	#define	NM_SETTING_IP_CONFIG_DNS_SEARCH
`next_hop` :	the IP address of the next hop (or `NULL`). [allow-none] -	#define	NM_SETTING_IP_CONFIG_ADDRESSES
`metric` :	the route metric (or -1 for "default")	#define	NM_SETTING_IP_CONFIG_GATEWAY
`error` :	location to store error, or `NULL` -	#define	NM_SETTING_IP_CONFIG_ROUTES
Returns :	the new NMIPRoute object, or `NULL` on error. [transfer full] -	#define	NM_SETTING_IP_CONFIG_ROUTE_METRIC
#define	NM_SETTING_IP_CONFIG_IGNORE_AUTO_ROUTES
#define	NM_SETTING_IP_CONFIG_IGNORE_AUTO_DNS
#define	NM_SETTING_IP_CONFIG_DHCP_HOSTNAME
#define	NM_SETTING_IP_CONFIG_DHCP_SEND_HOSTNAME
#define	NM_SETTING_IP_CONFIG_NEVER_DEFAULT
#define	NM_SETTING_IP_CONFIG_MAY_FAIL

nm_ip_route_new_binary ()

NMIPRoute *         nm_ip_route_new_binary              (int family,
-                                                         gconstpointer dest,
-                                                         guint prefix,
-                                                         gconstpointer next_hop,
-                                                         gint64 metric,
-                                                         GError **error);

-Creates a new NMIPRoute object. dest and next_hop (if non-NULL) must -point to buffers of the correct size for family. -

---+

Object Hierarchy

    GBoxed
+    ├── NMIPAddress
+    ╰── NMIPRoute
+    GObject
+    ╰── NMSetting
+        ╰── NMSettingIPConfig
+            ├── NMSettingIP4Config
+            ╰── NMSettingIP6Config
+

Includes

#include <nm-setting-ip-config.h>
+

Description

NMSettingIPConfig is the abstract base class of +NMSettingIP4Config and NMSettingIP6Config, providing properties +related to IP addressing, routing, and Domain Name Service.

Functions

nm_ip_address_new ()

NMIPAddress *
+nm_ip_address_new (int family,
+                   const char *addr,
+                   guint prefix,
+                   GError **error);

Creates a new NMIPAddress object.

Parameters

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

`family` :	the IP address family (`AF_INET` or -`AF_INET6`)	family	the IP address family (`AF_INET` or +`AF_INET6`)
`dest` :	the IP address of the route's destination	addr	the IP address
`prefix` :	the address prefix length	prefix	the address prefix length
`next_hop` :	the IP address of the next hop (or `NULL`). [allow-none] -	error	location to store error, or `NULL`

Returns

the new NMIPAddress object, or NULL on error.

[transfer full]

nm_ip_address_new_binary ()

NMIPAddress *
+nm_ip_address_new_binary (int family,
+                          gconstpointer addr,
+                          guint prefix,
+                          GError **error);

Creates a new NMIPAddress object. addr + must point to a buffer of the +correct size for family +.

Parameters

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

family	the IP address family (`AF_INET` or +`AF_INET6`)
`metric` :	the route metric (or -1 for "default")	addr	the IP address
`error` :	location to store error, or `NULL` -	prefix	the address prefix length
Returns :	the new NMIPRoute object, or `NULL` on error. [transfer full] -	error	location to store error, or `NULL`

Returns

the new NMIPAddress object, or NULL on error.

[transfer full]

nm_ip_route_ref ()

void                nm_ip_route_ref                     (NMIPRoute *route);

-Increases the reference count of the object. -

nm_ip_address_ref ()

void
+nm_ip_address_ref (NMIPAddress *address);

Increases the reference count of the object.

Parameters

--+++ - - + + +

route :

the NMIPRoute -

address

the NMIPAddress

NM_SETTING_IP_CONFIG_METHOD

#define NM_SETTING_IP_CONFIG_METHOD             "method"
-

Returns

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

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

NMIPRoute *
+nm_ip_route_dup (NMIPRoute *route);

Creates a copy of route

Parameters

+++++ + + + + + +

route

the NMIPRoute

NM_SETTING_IP_CONFIG_ADDRESSES

#define NM_SETTING_IP_CONFIG_ADDRESSES          "addresses"
-

Returns

a copy of route +.

[transfer full]

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

int
+nm_ip_route_get_family (NMIPRoute *route);

Gets the IP address family (eg, AF_INET) property of this route +object.

Parameters

+++++ + + + + + +

route

the NMIPRoute

NM_SETTING_IP_CONFIG_ROUTE_METRIC

#define NM_SETTING_IP_CONFIG_ROUTE_METRIC       "route-metric"
-

Returns

the IP address family

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

const char *
+nm_ip_route_get_dest (NMIPRoute *route);

Gets the IP destination address property of this route object.

Parameters

+++++ + + + + + +

route

the NMIPRoute

Returns

the IP address of the route's destination

NM_SETTING_IP_CONFIG_DHCP_HOSTNAME

#define NM_SETTING_IP_CONFIG_DHCP_HOSTNAME      "dhcp-hostname"
-

nm_ip_route_set_dest ()

void
+nm_ip_route_set_dest (NMIPRoute *route,
+                      const char *dest);

Sets the destination property of this route object.

dest + must be a valid address of route +'s family. If you aren't sure you +have a valid address, use nm_utils_ipaddr_valid() to check it.

Parameters

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

route	the NMIPRoute
dest	the route's destination, as a string

NM_SETTING_IP_CONFIG_DHCP_SEND_HOSTNAME

#define NM_SETTING_IP_CONFIG_DHCP_SEND_HOSTNAME "dhcp-send-hostname"
-

nm_ip_route_get_dest_binary ()

void
+nm_ip_route_get_dest_binary (NMIPRoute *route,
+                             gpointer dest);

Gets the destination property of this route object.

dest + must point to a buffer that is the correct size for route +'s family.

Parameters

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

route	the NMIPRoute
dest	a buffer in which to store the destination in binary format.

NM_SETTING_IP_CONFIG_NEVER_DEFAULT

#define NM_SETTING_IP_CONFIG_NEVER_DEFAULT      "never-default"
-

nm_ip_route_set_dest_binary ()

void
+nm_ip_route_set_dest_binary (NMIPRoute *route,
+                             gconstpointer dest);

Sets the destination property of this route object.

dest + must point to a buffer that is the correct size for route +'s family.

Parameters

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

route	the NMIPRoute
dest	the route's destination, in binary format

NM_SETTING_IP_CONFIG_MAY_FAIL

#define NM_SETTING_IP_CONFIG_MAY_FAIL           "may-fail"
-

nm_ip_route_get_prefix ()

guint
+nm_ip_route_get_prefix (NMIPRoute *route);

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

Parameters

+++++ + + + + + +

route

the NMIPRoute

Returns

the IP prefix

struct NMSettingIPConfig

struct NMSettingIPConfig;

nm_ip_route_set_prefix ()

void
+nm_ip_route_set_prefix (NMIPRoute *route,
+                        guint prefix);

Sets the prefix property of this route object.

Parameters

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

route	the NMIPRoute
prefix	the route prefix

NMSettingIPConfigClass

typedef struct {
-	NMSettingClass parent;
-
-	/* Padding for future expansion */
-	gpointer padding[8];
-} NMSettingIPConfigClass;
-

nm_ip_route_get_next_hop ()

const char *
+nm_ip_route_get_next_hop (NMIPRoute *route);

Gets the IP address of the next hop of this route; this will be NULL if the +route has no next hop.

Parameters

+++++ + + + + + +

route

the NMIPRoute

Returns

the IP address of the next hop, or NULL if this is a device route.

nm_setting_ip_config_get_method ()

const char *        nm_setting_ip_config_get_method     (NMSettingIPConfig *setting);

nm_ip_route_set_next_hop ()

void
+nm_ip_route_set_next_hop (NMIPRoute *route,
+                          const char *next_hop);

Sets the next-hop property of this route object.

next_hop + (if non-NULL) must be a valid address of route +'s family. If you +aren't sure you have a valid address, use nm_utils_ipaddr_valid() to check +it.

Parameters

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

`setting` :	the NMSettingIPConfig -	route	the NMIPRoute
Returns :	the "method" property of the setting; see -NMSettingIP4Config and NMSettingIP6Config for details of the -methods available with each type.	next_hop	the route's next hop, as a string.	[allow-none]

nm_setting_ip_config_get_num_dns ()

guint               nm_setting_ip_config_get_num_dns    (NMSettingIPConfig *setting);

nm_ip_route_get_next_hop_binary ()

gboolean
+nm_ip_route_get_next_hop_binary (NMIPRoute *route,
+                                 gpointer next_hop);

Gets the next hop property of this route object.

next_hop + must point to a buffer that is the correct size for route +'s family.

Parameters

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

`setting` :	the NMSettingIPConfig -	route	the NMIPRoute
Returns :	the number of configured DNS servers	next_hop	a buffer in which to store the next hop in binary format.

Returns

TRUE if route +has a next hop, FALSE if not (in which case +next_hop +will be zeroed out)

nm_setting_ip_config_get_dns ()

const char *        nm_setting_ip_config_get_dns        (NMSettingIPConfig *setting,
-                                                         int i);

nm_ip_route_set_next_hop_binary ()

void
+nm_ip_route_set_next_hop_binary (NMIPRoute *route,
+                                 gconstpointer next_hop);

Sets the destination property of this route object.

next_hop + (if non-NULL) must point to a buffer that is the correct size for +route +'s family.

Parameters

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

`setting` :	the NMSettingIPConfig -
`i` :	index number of the DNS server to return	route	the NMIPRoute
Returns :	the IP address of the DNS server at index `i` -	next_hop	the route's next hop, in binary format

nm_setting_ip_config_add_dns ()

gboolean            nm_setting_ip_config_add_dns        (NMSettingIPConfig *setting,
-                                                         const char *dns);

-Adds a new DNS server to the setting. -

nm_ip_route_get_metric ()

gint64
+nm_ip_route_get_metric (NMIPRoute *route);

Gets the route metric property of this route object; lower values +indicate "better" or more preferred routes; -1 indicates "default" +(meaning NetworkManager will set it appropriately).

Parameters

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

route

the NMIPRoute

Returns

the route metric

nm_ip_route_set_metric ()

void
+nm_ip_route_set_metric (NMIPRoute *route,
+                        gint64 metric);

Sets the metric property of this route object.

Parameters

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

`setting` :	the NMSettingIPConfig -
`dns` :	the IP address of the DNS server to add	route	the NMIPRoute
Returns :	-`TRUE` if the DNS server was added; `FALSE` if the server was already -known	metric	the route metric (or -1 for "default")

nm_setting_ip_config_remove_dns ()

void                nm_setting_ip_config_remove_dns     (NMSettingIPConfig *setting,
-                                                         int i);

-Removes the DNS server at index i. +

nm_ip_route_get_attribute_names ()

char **
+nm_ip_route_get_attribute_names (NMIPRoute *route);

Gets an array of attribute names defined on route +.

Parameters

+++++ + + + + + +

route

the NMIPRoute

Returns

a NULL-terminated array of attribute names.

[transfer full]

nm_ip_route_get_attribute ()

GVariant *
+nm_ip_route_get_attribute (NMIPRoute *route,
+                           const char *name);

Gets the value of the attribute with name name + on route

Parameters

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

`setting` :	the NMSettingIPConfig -	route	the NMIPRoute
`i` :	index number of the DNS server to remove	name	the name of an route attribute

Returns

the value of the attribute with name name +on +route +, or NULL if route +has no such attribute.

[transfer none]

Property Details

Types and Values

The `"addresses"` property

  "addresses"                GPtrArray*            : Read / Write

-Array of IP addresses. -

NM_SETTING_IP_CONFIG_METHOD

#define NM_SETTING_IP_CONFIG_METHOD             "method"
+

-Element-Type: NMIPAddress

The `"dhcp-hostname"` property

  "dhcp-hostname"            gchar*                : Read / Write

NM_SETTING_IP_CONFIG_DNS

#define NM_SETTING_IP_CONFIG_DNS                "dns"
+

-If the "dhcp-send-hostname" property is TRUE, then the -specified name will be sent to the DHCP server when acquiring a lease.

Default value: NULL

The `"dhcp-send-hostname"` property

  "dhcp-send-hostname"       gboolean              : Read / Write / Construct

NM_SETTING_IP_CONFIG_DNS_SEARCH

#define NM_SETTING_IP_CONFIG_DNS_SEARCH         "dns-search"
+

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

Default value: TRUE

The `"dns"` property

  "dns"                      GStrv                 : Read / Write

NM_SETTING_IP_CONFIG_ADDRESSES

#define NM_SETTING_IP_CONFIG_ADDRESSES          "addresses"
+

-Array of IP addresses of DNS servers.

The `"dns-search"` property

  "dns-search"               GStrv                 : Read / Write

NM_SETTING_IP_CONFIG_GATEWAY

#define NM_SETTING_IP_CONFIG_GATEWAY            "gateway"
+

-Array of DNS search domains.

The `"gateway"` property

  "gateway"                  gchar*                : Read / Write

NM_SETTING_IP_CONFIG_ROUTES

#define NM_SETTING_IP_CONFIG_ROUTES             "routes"
+

-The gateway associated with this configuration. This is only meaningful -if "addresses" is also set.

Default value: NULL

The `"ignore-auto-dns"` property

  "ignore-auto-dns"          gboolean              : Read / Write / Construct

NM_SETTING_IP_CONFIG_ROUTE_METRIC

#define NM_SETTING_IP_CONFIG_ROUTE_METRIC       "route-metric"
+

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

Default value: FALSE

The `"ignore-auto-routes"` property

  "ignore-auto-routes"       gboolean              : Read / Write / Construct

NM_SETTING_IP_CONFIG_IGNORE_AUTO_ROUTES

#define NM_SETTING_IP_CONFIG_IGNORE_AUTO_ROUTES "ignore-auto-routes"
+

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

Default value: FALSE

The `"may-fail"` property

  "may-fail"                 gboolean              : Read / Write / Construct

NM_SETTING_IP_CONFIG_IGNORE_AUTO_DNS

#define NM_SETTING_IP_CONFIG_IGNORE_AUTO_DNS    "ignore-auto-dns"
+

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

Default value: TRUE

The `"method"` property

  "method"                   gchar*                : Read / Write

NM_SETTING_IP_CONFIG_DHCP_HOSTNAME

#define NM_SETTING_IP_CONFIG_DHCP_HOSTNAME      "dhcp-hostname"
+

-IP configuration method.

NM_SETTING_IP_CONFIG_DHCP_SEND_HOSTNAME

#define NM_SETTING_IP_CONFIG_DHCP_SEND_HOSTNAME "dhcp-send-hostname"
+

-NMSettingIP4Config and NMSettingIP6Config both support "auto", -"manual", and "link-local". See the subclass-specific documentation for -other values.

NM_SETTING_IP_CONFIG_NEVER_DEFAULT

#define NM_SETTING_IP_CONFIG_NEVER_DEFAULT      "never-default"
+

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

NM_SETTING_IP_CONFIG_MAY_FAIL

#define NM_SETTING_IP_CONFIG_MAY_FAIL           "may-fail"
+

-For methods that imply no upstream network, such as "shared" or -"link-local", these properties must be empty.

			libnm Reference Manual
-Top - \| - Description - \| - Object Hierarchy - \| - Properties -

`setting` :	the NMSettingIPConfig -	setting	the NMSettingIPConfig
Returns :	the number of configured DNS search domains	i	index number of the DNS server to return

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

`address` :	the new address to add	setting	the NMSettingIPConfig
Returns :	-`TRUE` if the address was added; `FALSE` if the address was already -known.	address	the new address to add

Synopsis

Object Hierarchy

Properties

Description

Details

NMIPAddress

nm_ip_address_new ()

Functions

nm_ip_address_new_binary ()

nm_ip_address_ref ()

nm_ip_address_unref ()

nm_ip_address_equal ()

nm_ip_address_dup ()

nm_ip_address_get_family ()

nm_ip_address_get_address ()

nm_ip_address_set_address ()

nm_ip_address_get_address_binary ()

nm_ip_address_set_address_binary ()

nm_ip_address_get_prefix ()

nm_ip_address_set_prefix ()

nm_ip_address_get_attribute_names ()

nm_ip_address_get_attribute ()

nm_ip_address_set_attribute ()

Properties

NMIPRoute

nm_ip_route_new ()

Types and Values

nm_ip_route_new_binary ()

Object Hierarchy

Includes

Description

Functions

nm_ip_address_new ()

Parameters

Returns

nm_ip_address_new_binary ()

Parameters

Returns

nm_ip_route_ref ()

nm_ip_address_ref ()

Parameters

nm_ip_route_unref ()

nm_ip_address_unref ()

Parameters

nm_ip_route_equal ()

nm_ip_address_equal ()

Parameters

Returns

nm_ip_route_dup ()

nm_ip_address_dup ()

Parameters

Returns

nm_ip_route_get_family ()

nm_ip_address_get_family ()

Parameters

Returns

nm_ip_route_get_dest ()

nm_ip_address_get_address ()

Parameters

Returns

nm_ip_route_set_dest ()

nm_ip_address_set_address ()

Parameters

nm_ip_route_get_dest_binary ()

nm_ip_address_get_address_binary ()

Parameters

nm_ip_route_set_dest_binary ()

nm_ip_address_set_address_binary ()

Parameters

nm_ip_route_get_prefix ()

nm_ip_address_get_prefix ()

Parameters

Returns

nm_ip_route_set_prefix ()

nm_ip_address_set_prefix ()

Parameters

nm_ip_route_get_next_hop ()

nm_ip_address_get_attribute_names ()

Parameters

Returns