NMSettingIP4Config

@@ -37,2152 +31,2700 @@

NMSettingIP4Config

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

- +

Synopsis

-#include <nm-setting-ip4-config.h>
-
-#define             NM_SETTING_IP4_CONFIG_SETTING_NAME
-enum                NMSettingIP4ConfigError;
-#define             NM_SETTING_IP4_CONFIG_ERROR
-GQuark              nm_setting_ip4_config_error_quark   (void);
-#define             NM_SETTING_IP4_CONFIG_METHOD
-#define             NM_SETTING_IP4_CONFIG_DNS
-#define             NM_SETTING_IP4_CONFIG_DNS_SEARCH
-#define             NM_SETTING_IP4_CONFIG_ADDRESSES
-#define             NM_SETTING_IP4_CONFIG_ROUTES
-#define             NM_SETTING_IP4_CONFIG_ROUTE_METRIC
-#define             NM_SETTING_IP4_CONFIG_IGNORE_AUTO_ROUTES
-#define             NM_SETTING_IP4_CONFIG_IGNORE_AUTO_DNS
-#define             NM_SETTING_IP4_CONFIG_DHCP_CLIENT_ID
-#define             NM_SETTING_IP4_CONFIG_DHCP_SEND_HOSTNAME
-#define             NM_SETTING_IP4_CONFIG_DHCP_HOSTNAME
-#define             NM_SETTING_IP4_CONFIG_NEVER_DEFAULT
-#define             NM_SETTING_IP4_CONFIG_MAY_FAIL
-#define             NM_SETTING_IP4_CONFIG_METHOD_AUTO
-#define             NM_SETTING_IP4_CONFIG_METHOD_LINK_LOCAL
-#define             NM_SETTING_IP4_CONFIG_METHOD_MANUAL
-#define             NM_SETTING_IP4_CONFIG_METHOD_SHARED
-#define             NM_SETTING_IP4_CONFIG_METHOD_DISABLED
-typedef             NMIP4Address;
-NMIP4Address *      nm_ip4_address_new                  (void);
-NMIP4Address *      nm_ip4_address_dup                  (NMIP4Address *source);
-void                nm_ip4_address_ref                  (NMIP4Address *address);
-void                nm_ip4_address_unref                (NMIP4Address *address);
-gboolean            nm_ip4_address_compare              (NMIP4Address *address,
-                                                         NMIP4Address *other);
-guint32             nm_ip4_address_get_address          (NMIP4Address *address);
-void                nm_ip4_address_set_address          (NMIP4Address *address,
-                                                         guint32 addr);
-guint32             nm_ip4_address_get_prefix           (NMIP4Address *address);
-void                nm_ip4_address_set_prefix           (NMIP4Address *address,
-                                                         guint32 prefix);
-guint32             nm_ip4_address_get_gateway          (NMIP4Address *address);
-void                nm_ip4_address_set_gateway          (NMIP4Address *address,
-                                                         guint32 gateway);
-typedef             NMIP4Route;
-NMIP4Route *        nm_ip4_route_new                    (void);
-NMIP4Route *        nm_ip4_route_dup                    (NMIP4Route *source);
-void                nm_ip4_route_ref                    (NMIP4Route *route);
-void                nm_ip4_route_unref                  (NMIP4Route *route);
-gboolean            nm_ip4_route_compare                (NMIP4Route *route,
-                                                         NMIP4Route *other);
-guint32             nm_ip4_route_get_dest               (NMIP4Route *route);
-void                nm_ip4_route_set_dest               (NMIP4Route *route,
-                                                         guint32 dest);
-guint32             nm_ip4_route_get_prefix             (NMIP4Route *route);
-void                nm_ip4_route_set_prefix             (NMIP4Route *route,
-                                                         guint32 prefix);
-guint32             nm_ip4_route_get_next_hop           (NMIP4Route *route);
-void                nm_ip4_route_set_next_hop           (NMIP4Route *route,
-                                                         guint32 next_hop);
-guint32             nm_ip4_route_get_metric             (NMIP4Route *route);
-void                nm_ip4_route_set_metric             (NMIP4Route *route,
-                                                         guint32 metric);
-                    NMSettingIP4Config;
-                    NMSettingIP4ConfigClass;
-NMSetting *         nm_setting_ip4_config_new           (void);
-const char *        nm_setting_ip4_config_get_method    (NMSettingIP4Config *setting);
-guint32             nm_setting_ip4_config_get_num_dns   (NMSettingIP4Config *setting);
-guint32             nm_setting_ip4_config_get_dns       (NMSettingIP4Config *setting,
-                                                         guint32 i);
-gboolean            nm_setting_ip4_config_add_dns       (NMSettingIP4Config *setting,
-                                                         guint32 dns);
-void                nm_setting_ip4_config_remove_dns    (NMSettingIP4Config *setting,
-                                                         guint32 i);
-gboolean            nm_setting_ip4_config_remove_dns_by_value
-                                                        (NMSettingIP4Config *setting,
-                                                         guint32 dns);
-void                nm_setting_ip4_config_clear_dns     (NMSettingIP4Config *setting);
-guint32             nm_setting_ip4_config_get_num_dns_searches
-                                                        (NMSettingIP4Config *setting);
-const char *        nm_setting_ip4_config_get_dns_search
-                                                        (NMSettingIP4Config *setting,
-                                                         guint32 i);
-gboolean            nm_setting_ip4_config_add_dns_search
-                                                        (NMSettingIP4Config *setting,
-                                                         const char *dns_search);
-void                nm_setting_ip4_config_remove_dns_search
-                                                        (NMSettingIP4Config *setting,
-                                                         guint32 i);
-gboolean            nm_setting_ip4_config_remove_dns_search_by_value
-                                                        (NMSettingIP4Config *setting,
-                                                         const char *dns_search);
-void                nm_setting_ip4_config_clear_dns_searches
-                                                        (NMSettingIP4Config *setting);
-guint32             nm_setting_ip4_config_get_num_addresses
-                                                        (NMSettingIP4Config *setting);
-NMIP4Address *      nm_setting_ip4_config_get_address   (NMSettingIP4Config *setting,
-                                                         guint32 i);
-gboolean            nm_setting_ip4_config_add_address   (NMSettingIP4Config *setting,
-                                                         NMIP4Address *address);
-void                nm_setting_ip4_config_remove_address
-                                                        (NMSettingIP4Config *setting,
-                                                         guint32 i);
-gboolean            nm_setting_ip4_config_remove_address_by_value
-                                                        (NMSettingIP4Config *setting,
-                                                         NMIP4Address *address);
-void                nm_setting_ip4_config_clear_addresses
-                                                        (NMSettingIP4Config *setting);
-guint32             nm_setting_ip4_config_get_num_routes
-                                                        (NMSettingIP4Config *setting);
-NMIP4Route *        nm_setting_ip4_config_get_route     (NMSettingIP4Config *setting,
-                                                         guint32 i);
-gboolean            nm_setting_ip4_config_add_route     (NMSettingIP4Config *setting,
-                                                         NMIP4Route *route);
-void                nm_setting_ip4_config_remove_route  (NMSettingIP4Config *setting,
-                                                         guint32 i);
-gboolean            nm_setting_ip4_config_remove_route_by_value
-                                                        (NMSettingIP4Config *setting,
-                                                         NMIP4Route *route);
-void                nm_setting_ip4_config_clear_routes  (NMSettingIP4Config *setting);
-gint64              nm_setting_ip4_config_get_route_metric
-                                                        (NMSettingIP4Config *setting);
-gboolean            nm_setting_ip4_config_get_ignore_auto_routes
-                                                        (NMSettingIP4Config *setting);
-gboolean            nm_setting_ip4_config_get_ignore_auto_dns
-                                                        (NMSettingIP4Config *setting);
-const char *        nm_setting_ip4_config_get_dhcp_client_id
-                                                        (NMSettingIP4Config *setting);
-gboolean            nm_setting_ip4_config_get_dhcp_send_hostname
-                                                        (NMSettingIP4Config *setting);
-const char *        nm_setting_ip4_config_get_dhcp_hostname
-                                                        (NMSettingIP4Config *setting);
-gboolean            nm_setting_ip4_config_get_never_default
-                                                        (NMSettingIP4Config *setting);
-gboolean            nm_setting_ip4_config_get_may_fail  (NMSettingIP4Config *setting);
-

Object Hierarchy

-  GEnum
-   +----NMSettingIP4ConfigError
-

-  GBoxed
-   +----NMIP4Address
-

-  GBoxed
-   +----NMIP4Route
-

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

Properties

-  "addresses"                GPtrArray_GArray_guint__*  : Read / Write
-  "dhcp-client-id"           gchar*                : Read / Write
-  "dhcp-hostname"            gchar*                : Read / Write
-  "dhcp-send-hostname"       gboolean              : Read / Write / Construct
-  "dns"                      GArray_guint_*        : Read / Write
-  "dns-search"               GSList_gchararray_*   : 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_GArray_guint__*  : Read / Write
-

Description

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

Details

NM_SETTING_IP4_CONFIG_SETTING_NAME

#define NM_SETTING_IP4_CONFIG_SETTING_NAME "ipv4"
-

enum NMSettingIP4ConfigError

typedef enum {
-	NM_SETTING_IP4_CONFIG_ERROR_UNKNOWN = 0,           /*< nick=UnknownError >*/
-	NM_SETTING_IP4_CONFIG_ERROR_INVALID_PROPERTY,      /*< nick=InvalidProperty >*/
-	NM_SETTING_IP4_CONFIG_ERROR_MISSING_PROPERTY,      /*< nick=MissingProperty >*/
-	NM_SETTING_IP4_CONFIG_ERROR_NOT_ALLOWED_FOR_METHOD /*< nick=NotAllowedForMethod >*/
-} NMSettingIP4ConfigError;
-

Functions

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

`NM_SETTING_IP4_CONFIG_ERROR_UNKNOWN`	unknown or unclassified error +	+GQuark +	+nm_setting_ip4_config_error_quark () +
+NMIP4Address * +	+nm_ip4_address_new () +
+NMIP4Address * +	+nm_ip4_address_dup () +
+void +	+nm_ip4_address_ref () +
+void +	+nm_ip4_address_unref () +
+gboolean +	+nm_ip4_address_compare () +
+guint32 +	+nm_ip4_address_get_address () +
+void +	+nm_ip4_address_set_address () +
+guint32 +	+nm_ip4_address_get_prefix () +
+void +	+nm_ip4_address_set_prefix () +
+guint32 +	+nm_ip4_address_get_gateway () +
+void +	+nm_ip4_address_set_gateway () +
+NMIP4Route * +	+nm_ip4_route_new () +
+NMIP4Route * +	+nm_ip4_route_dup () +
+void +	+nm_ip4_route_ref () +
+void +	+nm_ip4_route_unref () +
+gboolean +	+nm_ip4_route_compare () +
+guint32 +	+nm_ip4_route_get_dest () +
+void +	+nm_ip4_route_set_dest () +
+guint32 +	+nm_ip4_route_get_prefix () +
+void +	+nm_ip4_route_set_prefix () +
+guint32 +	+nm_ip4_route_get_next_hop () +
+void +	+nm_ip4_route_set_next_hop () +
+guint32 +	+nm_ip4_route_get_metric () +
+void +	+nm_ip4_route_set_metric () +
+NMSetting * +	+nm_setting_ip4_config_new () +
const char * +	+nm_setting_ip4_config_get_method () +
+guint32 +	+nm_setting_ip4_config_get_num_dns () +
+guint32 +	+nm_setting_ip4_config_get_dns () +
+gboolean +	+nm_setting_ip4_config_add_dns () +
+void +	+nm_setting_ip4_config_remove_dns () +
+gboolean +	+nm_setting_ip4_config_remove_dns_by_value () +
+void +	+nm_setting_ip4_config_clear_dns () +
+guint32 +	+nm_setting_ip4_config_get_num_dns_searches () +
const char * +	+nm_setting_ip4_config_get_dns_search () +
+gboolean +	+nm_setting_ip4_config_add_dns_search () +
+void +	+nm_setting_ip4_config_remove_dns_search () +
+gboolean +	+nm_setting_ip4_config_remove_dns_search_by_value () +
+void +	+nm_setting_ip4_config_clear_dns_searches () +
+guint32 +	+nm_setting_ip4_config_get_num_addresses () +
+NMIP4Address * +	+nm_setting_ip4_config_get_address () +
+gboolean +	+nm_setting_ip4_config_add_address () +
+void +	+nm_setting_ip4_config_remove_address () +
+gboolean +	+nm_setting_ip4_config_remove_address_by_value () +
+void +	+nm_setting_ip4_config_clear_addresses () +
+guint32 +	+nm_setting_ip4_config_get_num_routes () +
+NMIP4Route * +	+nm_setting_ip4_config_get_route () +
+gboolean +	+nm_setting_ip4_config_add_route () +
+void +	+nm_setting_ip4_config_remove_route ()
`NM_SETTING_IP4_CONFIG_ERROR_INVALID_PROPERTY`	the property was invalid +	+gboolean +	+nm_setting_ip4_config_remove_route_by_value ()
`NM_SETTING_IP4_CONFIG_ERROR_MISSING_PROPERTY`	the property was missing and is -required +	+void +	+nm_setting_ip4_config_clear_routes ()
`NM_SETTING_IP4_CONFIG_ERROR_NOT_ALLOWED_FOR_METHOD`	the property's value is -not valid with the given IP4 method +	+gint64 +	+nm_setting_ip4_config_get_route_metric () +
+gboolean +	+nm_setting_ip4_config_get_ignore_auto_routes () +
+gboolean +	+nm_setting_ip4_config_get_ignore_auto_dns () +
const char * +	+nm_setting_ip4_config_get_dhcp_client_id () +
+gboolean +	+nm_setting_ip4_config_get_dhcp_send_hostname () +
const char * +	+nm_setting_ip4_config_get_dhcp_hostname () +
+gboolean +	+nm_setting_ip4_config_get_never_default () +
+gboolean +	+nm_setting_ip4_config_get_may_fail ()

NM_SETTING_IP4_CONFIG_ERROR

#define NM_SETTING_IP4_CONFIG_ERROR nm_setting_ip4_config_error_quark ()
-

nm_setting_ip4_config_error_quark ()

GQuark              nm_setting_ip4_config_error_quark   (void);

-Registers an error quark for NMSettingIP4Config if necessary. -

Properties

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

Returns :	the error quark used for NMSettingIP4Config errors.
+GPtrArray_GArray_guint__ *	addresses	Read / Write
+gchar *	dhcp-client-id	Read / Write
+gchar *	dhcp-hostname	Read / Write
gboolean	dhcp-send-hostname	Read / Write / Construct
+GArray_guint_ *	dns	Read / Write
+GSList_gchararray_ *	dns-search	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_GArray_guint__ *	routes	Read / Write

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

Types and Values

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

#define	NM_SETTING_IP4_CONFIG_SETTING_NAME
enum	NMSettingIP4ConfigError
#define	NM_SETTING_IP4_CONFIG_ERROR
#define	NM_SETTING_IP4_CONFIG_METHOD
#define	NM_SETTING_IP4_CONFIG_DNS
#define	NM_SETTING_IP4_CONFIG_DNS_SEARCH
#define	NM_SETTING_IP4_CONFIG_ADDRESSES
#define	NM_SETTING_IP4_CONFIG_ROUTES
#define	NM_SETTING_IP4_CONFIG_ROUTE_METRIC
#define	NM_SETTING_IP4_CONFIG_IGNORE_AUTO_ROUTES
#define	NM_SETTING_IP4_CONFIG_IGNORE_AUTO_DNS
#define	NM_SETTING_IP4_CONFIG_DHCP_CLIENT_ID
#define	NM_SETTING_IP4_CONFIG_DHCP_SEND_HOSTNAME
#define	NM_SETTING_IP4_CONFIG_DHCP_HOSTNAME
#define	NM_SETTING_IP4_CONFIG_NEVER_DEFAULT
#define	NM_SETTING_IP4_CONFIG_MAY_FAIL
#define	NM_SETTING_IP4_CONFIG_METHOD_AUTO
#define	NM_SETTING_IP4_CONFIG_METHOD_LINK_LOCAL
#define	NM_SETTING_IP4_CONFIG_METHOD_MANUAL
#define	NM_SETTING_IP4_CONFIG_METHOD_SHARED
#define	NM_SETTING_IP4_CONFIG_METHOD_DISABLED

NM_SETTING_IP4_CONFIG_DHCP_HOSTNAME

#define NM_SETTING_IP4_CONFIG_DHCP_HOSTNAME      "dhcp-hostname"
+
+Object Hierarchy
+    GBoxed
+    ├── NMIP4Address
+    ╰── NMIP4Route
+    GEnum
+    ╰── NMSettingIP4ConfigError
+    GObject
+    ╰── NMSetting
+        ╰── NMSettingIP4Config
 
-
-
 
-
-
-NM_SETTING_IP4_CONFIG_NEVER_DEFAULT
-#define NM_SETTING_IP4_CONFIG_NEVER_DEFAULT      "never-default"
+
+Includes
+#include <nm-setting-ip4-config.h>
 
-
-
 
-
-
-NM_SETTING_IP4_CONFIG_MAY_FAIL
-#define NM_SETTING_IP4_CONFIG_MAY_FAIL           "may-fail"
-
-
-
+
+Description
+The NMSettingIP4Config object is a NMSetting subclass that describes
+properties related to IPv4 addressing, routing, and Domain Name Service
 
-
+
+Functions
 
-NM_SETTING_IP4_CONFIG_METHOD_AUTO
-#define NM_SETTING_IP4_CONFIG_METHOD_AUTO       "auto"
-
-
-IPv4 configuration should be automatically determined via a method appropriate
-for the hardware interface, ie DHCP or PPP or some other device-specific
-manner.
-
+nm_setting_ip4_config_error_quark ()
+GQuark
+nm_setting_ip4_config_error_quark (void);
+Registers an error quark for NMSettingIP4Config if necessary.
+
+Returns
+ the error quark used for NMSettingIP4Config errors.
+
 
-
-
-NM_SETTING_IP4_CONFIG_METHOD_LINK_LOCAL
-#define NM_SETTING_IP4_CONFIG_METHOD_LINK_LOCAL "link-local"
-
-
-IPv4 configuration should be automatically configured for link-local-only
-operation.
-
 
 
 
-NM_SETTING_IP4_CONFIG_METHOD_MANUAL
-#define NM_SETTING_IP4_CONFIG_METHOD_MANUAL     "manual"
-
-
-All necessary IPv4 configuration (addresses, prefix, DNS, etc) is specified
-in the setting's properties.
-
+nm_ip4_address_new ()
+NMIP4Address *
+nm_ip4_address_new (void);
+Creates and returns a new NMIP4Address object.
+
+Returns
+ the new empty NMIP4Address object. 
+[transfer full]
 
-
-
-NM_SETTING_IP4_CONFIG_METHOD_SHARED
-#define NM_SETTING_IP4_CONFIG_METHOD_SHARED     "shared"
-
-
-This connection specifies configuration that allows other computers to
-connect through it to the default network (usually the Internet).  The
-connection's interface will be assigned a private address, and a DHCP server,
-caching DNS server, and Network Address Translation (NAT) functionality will
-be started on this connection's interface to allow other devices to connect
-through that interface to the default network.
-
 
 
 
-NM_SETTING_IP4_CONFIG_METHOD_DISABLED
-#define NM_SETTING_IP4_CONFIG_METHOD_DISABLED   "disabled"
-
-
-This connection does not use or require IPv4 address and it should be disabled.
-
+nm_ip4_address_dup ()
+NMIP4Address *
+nm_ip4_address_dup (NMIP4Address *source);
+Copies a given NMIP4Address object and returns the copy.
+
+Parameters
+
+++++
+
+
+
+
+
+



source the NMIP4Address object to copy  
+
+
+Returns
+ the copy of the given NMIP4Address copy. 
+[transfer full]
+
 
 
 
-NMIP4Address
-typedef struct NMIP4Address NMIP4Address;
-
-
-
+nm_ip4_address_ref ()
+void
+nm_ip4_address_ref (NMIP4Address *address);
+Increases the reference count of the object.
+
+Parameters
+
+++++
+
+
+
+
+
+



address the NMIP4Address  
+
 
 
 
-nm_ip4_address_new ()
-NMIP4Address *      nm_ip4_address_new                  (void);
-
-Creates and returns a new NMIP4Address object.
-
-
+nm_ip4_address_unref ()
+void
+nm_ip4_address_unref (NMIP4Address *address);
+Decreases the reference count of the object.  If the reference count
+reaches zero, the object will be destroyed.
+
+Parameters
+
--+++
-
-
+
+
+
 





 
 Returns : the new empty NMIP4Address object. [transfer full]
- address the NMIP4Address  
 
 
 
+
 
 
-nm_ip4_address_dup ()
-NMIP4Address *      nm_ip4_address_dup                  (NMIP4Address *source);
-
-Copies a given NMIP4Address object and returns the copy.
-
-
+nm_ip4_address_compare ()
+gboolean
+nm_ip4_address_compare (NMIP4Address *address,
+                        NMIP4Address *other);
+Determines if two NMIP4Address objects contain the same values.
+
+Parameters
+
--+++
-
-
+
+
+
-
-
+
+
+
 





 
 
 source : the NMIP4Address object to copy address the NMIP4Address  
 
 Returns : the copy of the given NMIP4Address copy. [transfer full]
- other the NMIP4Address to compare address
+to.  
 
 
 
 
+
+Returns
+ TRUE if the objects contain the same values, FALSE if they do not.
+
+
+
 
 
-nm_ip4_address_ref ()
-void                nm_ip4_address_ref                  (NMIP4Address *address);
-
-Increases the reference count of the object.
-
-
+nm_ip4_address_get_address ()
+guint32
+nm_ip4_address_get_address (NMIP4Address *address);
+Gets the IPv4 address property of this address object.
+
+Parameters
+
--+++
-
-
+
+
+
 





 
 address : the NMIP4Address
- address the NMIP4Address  
 
 
 
+
+Returns
+ the IPv4 address in network byte order
+
+
+
 
 
-nm_ip4_address_unref ()
-void                nm_ip4_address_unref                (NMIP4Address *address);
-
-Decreases the reference count of the object.  If the reference count
-reaches zero, the object will be destroyed.
-
-
+nm_ip4_address_set_address ()
+void
+nm_ip4_address_set_address (NMIP4Address *address,
+                            guint32 addr);
+Sets the IPv4 address property of this object.
+
+Parameters
+

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



address the NMIP4Address  
addr the IPv4 address in network byte order  
+
+
+
+
+nm_ip4_address_get_prefix ()
+guint32
+nm_ip4_address_get_prefix (NMIP4Address *address);
+Gets the IPv4 address prefix (ie "24" or "30" etc) property of this address
+object.
+
+Parameters
+--+++
-
-
+
+
+
 





 
 address : the NMIP4Address
- address the NMIP4Address  
 
 
 
+
+Returns
+ the IPv4 address prefix
+
+
+
 
 
-nm_ip4_address_compare ()
-gboolean            nm_ip4_address_compare              (NMIP4Address *address,
-                                                         NMIP4Address *other);
-
-Determines if two NMIP4Address objects contain the same values.
-
-
+nm_ip4_address_set_prefix ()
+void
+nm_ip4_address_set_prefix (NMIP4Address *address,
+                           guint32 prefix);
+Sets the IPv4 address prefix.
+
+Parameters
+
--+++
-
-
-
-
-
-
+
+
+
-
-
+
+
+
 





 
 
 address : the NMIP4Address
-
other : the NMIP4Address to compare address to. address the NMIP4Address  
 
 Returns : 
-TRUE if the objects contain the same values, FALSE if they do not. prefix the address prefix, a number between 1 and 32 inclusive  
 
 
 
 
+
 
 
-nm_ip4_address_get_address ()
-guint32             nm_ip4_address_get_address          (NMIP4Address *address);
-
-Gets the IPv4 address property of this address object.
-
-
+nm_ip4_address_get_gateway ()
+guint32
+nm_ip4_address_get_gateway (NMIP4Address *address);
+Gets the IPv4 default gateway property of this address object.
+
+Parameters
+
--+++
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
 





 address : the NMIP4Address
-
Returns : the IPv4 address in network byte order
address the NMIP4Address  
 
 
+
+Returns
+ the IPv4 gateway address in network byte order
+
+
+

nm_ip4_address_set_address ()

void                nm_ip4_address_set_address          (NMIP4Address *address,
-                                                         guint32 addr);

-Sets the IPv4 address property of this object. -

nm_ip4_address_set_gateway ()

void
+nm_ip4_address_set_gateway (NMIP4Address *address,
+                            guint32 gateway);

Sets the IPv4 default gateway property of this address object.

Parameters

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

`address` :	the NMIP4Address -	address	the NMIP4Address
`addr` :	the IPv4 address in network byte order	gateway	the IPv4 default gateway in network byte order

nm_ip4_address_get_prefix ()

guint32             nm_ip4_address_get_prefix           (NMIP4Address *address);

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

nm_ip4_route_new ()

NMIP4Route *
+nm_ip4_route_new (void);

Creates and returns a new NMIP4Route object.

Returns

the new empty NMIP4Route object.

[transfer full]

+ +

nm_ip4_route_dup ()

NMIP4Route *
+nm_ip4_route_dup (NMIP4Route *source);

Copies a given NMIP4Route object and returns the copy.

Parameters

+++++ + + + + + +

source

the NMIP4Route object to copy

Returns

the copy of the given NMIP4Route copy.

[transfer full]

nm_ip4_route_ref ()

void
+nm_ip4_route_ref (NMIP4Route *route);

Increases the reference count of the object.

Parameters

+++++ + + + + + +

route

the NMIP4Route

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

+++++ + + + + + +

route

the NMIP4Route

nm_ip4_route_compare ()

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

Determines if two NMIP4Route objects contain the same values.

Parameters

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

`address` :	the NMIP4Address -	route	the NMIP4Route
Returns :	the IPv4 address prefix	other	the NMIP4Route to compare `route` +to.

Returns

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

nm_ip4_address_set_prefix ()

void                nm_ip4_address_set_prefix           (NMIP4Address *address,
-                                                         guint32 prefix);

-Sets the IPv4 address prefix. -

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

the NMIP4Route

Returns

the IPv4 address in network byte order

Property Details

The `“addresses”` property

  “addresses”                GPtrArray_GArray_guint__ *

Flags: Read / Write

The `“dhcp-client-id”` property

  “dhcp-client-id”           gchar *

Flags: Read / Write

Default value: NULL

The `"dhcp-hostname"` property

  "dhcp-hostname"            gchar*                : Read / Write

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

The `“dhcp-hostname”` property

  “dhcp-hostname”            gchar *

Flags: Read / Write

Default value: NULL

The `"dhcp-send-hostname"` property

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

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

The `“dhcp-send-hostname”` property

  “dhcp-send-hostname”       gboolean

Flags: Read / Write / Construct

Default value: TRUE

The `"dns"` property

  "dns"                      GArray_guint_*        : Read / Write

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

The `“dns”` property

  “dns”                      GArray_guint_ *

Flags: Read / Write

The `"dns-search"` property

  "dns-search"               GSList_gchararray_*   : Read / Write

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

The `“dns-search”` property

  “dns-search”               GSList_gchararray_ *

Flags: Read / Write

The `"ignore-auto-dns"` property

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

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

The `“ignore-auto-dns”` property

  “ignore-auto-dns”          gboolean

Flags: Read / Write / Construct

Default value: FALSE

The `"ignore-auto-routes"` property

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

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

The `“ignore-auto-routes”` property

  “ignore-auto-routes”       gboolean

Flags: Read / Write / Construct

Default value: FALSE

The `"may-fail"` property

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

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

The `“may-fail”` property

  “may-fail”                 gboolean

Flags: Read / Write / Construct

Default value: TRUE

The `"method"` property

  "method"                   gchar*                : Read / Write

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

The `“method”` property

  “method”                   gchar *

Flags: Read / Write

Default value: NULL

The `"never-default"` property

  "never-default"            gboolean              : Read / Write / Construct

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

The `“never-default”` property

  “never-default”            gboolean

Flags: Read / Write / Construct

Default value: FALSE

The `"route-metric"` property

  "route-metric"             gint64                : Read / Write / Construct

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

The `“route-metric”` property

  “route-metric”             gint64

Flags: Read / Write / Construct

Allowed values: [-1,4294967295]

Default value: -1

Since 1.0

The `"routes"` property

  "routes"                   GPtrArray_GArray_guint__*  : Read / Write

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

The `“routes”` property

  “routes”                   GPtrArray_GArray_guint__ *

Flags: Read / Write

`route` :	the NMIP4Route -
`other` :	the NMIP4Route to compare `route` to.
Returns :	-`TRUE` if the objects contain the same values, `FALSE` if they do not.
setting	the NMSettingIP4Config

`route` :	the NMIP4Route -	setting	the NMSettingIP4Config
Returns :	the IPv4 address in network byte order	i	index number of the DNS server to return

`route` :	the NMIP4Route -	setting	the NMSettingIP4Config
`dest` :	the destination address in network byte order	dns	the IPv4 address (network byte order) of the DNS server to add

`route` :	the NMIP4Route -	setting	the NMSettingIP4Config
Returns :	the IPv4 prefix	i	index number of the DNS server to remove

`route` :	the NMIP4Route -	setting	the NMSettingIP4Config
`prefix` :	the prefix, a number between 1 and 32 inclusive	dns	the DNS server to remove

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

`source` :	the NMIP4Address object to copy	address	the NMIP4Address
Returns :	the copy of the given NMIP4Address copy. [transfer full] -	other	the NMIP4Address to compare `address` +to.

address	the NMIP4Address
addr	the IPv4 address in network byte order

`setting` :	the NMSettingIP4Config -
Returns :	the "method" property of the setting
setting	the NMSettingIP4Config

`setting` :	the NMSettingIP4Config -
`i` :	index number of the DNS server to return	setting	the NMSettingIP4Config
Returns :	the IPv4 address (network byte order) of the DNS server at index -`i` -	address	the new address to add

`setting` :	the NMSettingIP4Config -
`dns` :	the IPv4 address (network byte order) of the DNS server to add	setting	the NMSettingIP4Config
Returns :	-`TRUE` if the DNS server was added; `FALSE` if the server was already -known	i	index number of the address to remove

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

`setting` :	the NMSettingIP4Config +	NM_SETTING_IP4_CONFIG_ERROR_UNKNOWN	+ unknown or unclassified error
Returns :	the number of configured routes

`setting` :	the NMSettingIP4Config +	NM_SETTING_IP4_CONFIG_ERROR_INVALID_PROPERTY	+ the property was invalid
`i` :	index number of the route to return	NM_SETTING_IP4_CONFIG_ERROR_MISSING_PROPERTY	+ the property was missing and is +required +
Returns :	the route at index `i` +	NM_SETTING_IP4_CONFIG_ERROR_NOT_ALLOWED_FOR_METHOD	+ the property's value is +not valid with the given IP4 method