NMSettingIP6Config

@@ -37,2170 +31,2694 @@

NMSettingIP6Config

NMSettingIP6Config — Describes IPv6 addressing, routing, and name service properties

- +

Synopsis

-#include <nm-setting-ip6-config.h>
-
-#define             NM_SETTING_IP6_CONFIG_SETTING_NAME
-enum                NMSettingIP6ConfigError;
-#define             NM_SETTING_IP6_CONFIG_ERROR
-GQuark              nm_setting_ip6_config_error_quark   (void);
-#define             NM_SETTING_IP6_CONFIG_METHOD
-#define             NM_SETTING_IP6_CONFIG_DNS
-#define             NM_SETTING_IP6_CONFIG_DNS_SEARCH
-#define             NM_SETTING_IP6_CONFIG_ADDRESSES
-#define             NM_SETTING_IP6_CONFIG_ROUTES
-#define             NM_SETTING_IP6_CONFIG_ROUTE_METRIC
-#define             NM_SETTING_IP6_CONFIG_IGNORE_AUTO_ROUTES
-#define             NM_SETTING_IP6_CONFIG_IGNORE_AUTO_DNS
-#define             NM_SETTING_IP6_CONFIG_NEVER_DEFAULT
-#define             NM_SETTING_IP6_CONFIG_MAY_FAIL
-#define             NM_SETTING_IP6_CONFIG_IP6_PRIVACY
-#define             NM_SETTING_IP6_CONFIG_DHCP_HOSTNAME
-#define             NM_SETTING_IP6_CONFIG_METHOD_IGNORE
-#define             NM_SETTING_IP6_CONFIG_METHOD_AUTO
-#define             NM_SETTING_IP6_CONFIG_METHOD_DHCP
-#define             NM_SETTING_IP6_CONFIG_METHOD_LINK_LOCAL
-#define             NM_SETTING_IP6_CONFIG_METHOD_MANUAL
-#define             NM_SETTING_IP6_CONFIG_METHOD_SHARED
-enum                NMSettingIP6ConfigPrivacy;
-typedef             NMIP6Address;
-NMIP6Address *      nm_ip6_address_new                  (void);
-NMIP6Address *      nm_ip6_address_dup                  (NMIP6Address *source);
-void                nm_ip6_address_ref                  (NMIP6Address *address);
-void                nm_ip6_address_unref                (NMIP6Address *address);
-gboolean            nm_ip6_address_compare              (NMIP6Address *address,
-                                                         NMIP6Address *other);
-const struct in6_addr * nm_ip6_address_get_address      (NMIP6Address *address);
-void                nm_ip6_address_set_address          (NMIP6Address *address,
-                                                         const struct in6_addr *addr);
-guint32             nm_ip6_address_get_prefix           (NMIP6Address *address);
-void                nm_ip6_address_set_prefix           (NMIP6Address *address,
-                                                         guint32 prefix);
-const struct in6_addr * nm_ip6_address_get_gateway      (NMIP6Address *address);
-void                nm_ip6_address_set_gateway          (NMIP6Address *address,
-                                                         const struct in6_addr *gateway);
-typedef             NMIP6Route;
-NMIP6Route *        nm_ip6_route_new                    (void);
-NMIP6Route *        nm_ip6_route_dup                    (NMIP6Route *source);
-void                nm_ip6_route_ref                    (NMIP6Route *route);
-void                nm_ip6_route_unref                  (NMIP6Route *route);
-gboolean            nm_ip6_route_compare                (NMIP6Route *route,
-                                                         NMIP6Route *other);
-const struct in6_addr * nm_ip6_route_get_dest           (NMIP6Route *route);
-void                nm_ip6_route_set_dest               (NMIP6Route *route,
-                                                         const struct in6_addr *dest);
-guint32             nm_ip6_route_get_prefix             (NMIP6Route *route);
-void                nm_ip6_route_set_prefix             (NMIP6Route *route,
-                                                         guint32 prefix);
-const struct in6_addr * nm_ip6_route_get_next_hop       (NMIP6Route *route);
-void                nm_ip6_route_set_next_hop           (NMIP6Route *route,
-                                                         const struct in6_addr *next_hop);
-guint32             nm_ip6_route_get_metric             (NMIP6Route *route);
-void                nm_ip6_route_set_metric             (NMIP6Route *route,
-                                                         guint32 metric);
-                    NMSettingIP6Config;
-                    NMSettingIP6ConfigClass;
-NMSetting *         nm_setting_ip6_config_new           (void);
-const char *        nm_setting_ip6_config_get_method    (NMSettingIP6Config *setting);
-guint32             nm_setting_ip6_config_get_num_dns   (NMSettingIP6Config *setting);
-const struct in6_addr * nm_setting_ip6_config_get_dns   (NMSettingIP6Config *setting,
-                                                         guint32 i);
-gboolean            nm_setting_ip6_config_add_dns       (NMSettingIP6Config *setting,
-                                                         const struct in6_addr *dns);
-void                nm_setting_ip6_config_remove_dns    (NMSettingIP6Config *setting,
-                                                         guint32 i);
-gboolean            nm_setting_ip6_config_remove_dns_by_value
-                                                        (NMSettingIP6Config *setting,
-                                                         const struct in6_addr *dns);
-void                nm_setting_ip6_config_clear_dns     (NMSettingIP6Config *setting);
-guint32             nm_setting_ip6_config_get_num_dns_searches
-                                                        (NMSettingIP6Config *setting);
-const char *        nm_setting_ip6_config_get_dns_search
-                                                        (NMSettingIP6Config *setting,
-                                                         guint32 i);
-gboolean            nm_setting_ip6_config_add_dns_search
-                                                        (NMSettingIP6Config *setting,
-                                                         const char *dns_search);
-void                nm_setting_ip6_config_remove_dns_search
-                                                        (NMSettingIP6Config *setting,
-                                                         guint32 i);
-gboolean            nm_setting_ip6_config_remove_dns_search_by_value
-                                                        (NMSettingIP6Config *setting,
-                                                         const char *dns_search);
-void                nm_setting_ip6_config_clear_dns_searches
-                                                        (NMSettingIP6Config *setting);
-guint32             nm_setting_ip6_config_get_num_addresses
-                                                        (NMSettingIP6Config *setting);
-NMIP6Address *      nm_setting_ip6_config_get_address   (NMSettingIP6Config *setting,
-                                                         guint32 i);
-gboolean            nm_setting_ip6_config_add_address   (NMSettingIP6Config *setting,
-                                                         NMIP6Address *address);
-void                nm_setting_ip6_config_remove_address
-                                                        (NMSettingIP6Config *setting,
-                                                         guint32 i);
-gboolean            nm_setting_ip6_config_remove_address_by_value
-                                                        (NMSettingIP6Config *setting,
-                                                         NMIP6Address *address);
-void                nm_setting_ip6_config_clear_addresses
-                                                        (NMSettingIP6Config *setting);
-guint32             nm_setting_ip6_config_get_num_routes
-                                                        (NMSettingIP6Config *setting);
-NMIP6Route *        nm_setting_ip6_config_get_route     (NMSettingIP6Config *setting,
-                                                         guint32 i);
-gboolean            nm_setting_ip6_config_add_route     (NMSettingIP6Config *setting,
-                                                         NMIP6Route *route);
-void                nm_setting_ip6_config_remove_route  (NMSettingIP6Config *setting,
-                                                         guint32 i);
-gboolean            nm_setting_ip6_config_remove_route_by_value
-                                                        (NMSettingIP6Config *setting,
-                                                         NMIP6Route *route);
-void                nm_setting_ip6_config_clear_routes  (NMSettingIP6Config *setting);
-gboolean            nm_setting_ip6_config_get_ignore_auto_routes
-                                                        (NMSettingIP6Config *setting);
-gint64              nm_setting_ip6_config_get_route_metric
-                                                        (NMSettingIP6Config *setting);
-gboolean            nm_setting_ip6_config_get_ignore_auto_dns
-                                                        (NMSettingIP6Config *setting);
-const char *        nm_setting_ip6_config_get_dhcp_hostname
-                                                        (NMSettingIP6Config *setting);
-gboolean            nm_setting_ip6_config_get_never_default
-                                                        (NMSettingIP6Config *setting);
-gboolean            nm_setting_ip6_config_get_may_fail  (NMSettingIP6Config *setting);
-NMSettingIP6ConfigPrivacy nm_setting_ip6_config_get_ip6_privacy
-                                                        (NMSettingIP6Config *setting);
-

Object Hierarchy

-  GEnum
-   +----NMSettingIP6ConfigError
-

-  GEnum
-   +----NMSettingIP6ConfigPrivacy
-

-  GBoxed
-   +----NMIP6Address
-

-  GBoxed
-   +----NMIP6Route
-

-  GObject
-   +----NMSetting
-         +----NMSettingIP6Config
-

Properties

-  "addresses"                GPtrArray_GValueArray_GArray_guchar_+guint+GArray_guchar___*  : Read / Write
-  "dhcp-hostname"            gchar*                : Read / Write
-  "dns"                      GPtrArray_GArray_guchar__*  : Read / Write
-  "dns-search"               GSList_gchararray_*   : Read / Write
-  "ignore-auto-dns"          gboolean              : Read / Write / Construct
-  "ignore-auto-routes"       gboolean              : Read / Write / Construct
-  "ip6-privacy"              gint                  : 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_GValueArray_GArray_guchar_+guint+GArray_guchar_+guint__*  : Read / Write
-

Description

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

Details

NM_SETTING_IP6_CONFIG_SETTING_NAME

#define NM_SETTING_IP6_CONFIG_SETTING_NAME "ipv6"
-

enum NMSettingIP6ConfigError

typedef enum {
-	NM_SETTING_IP6_CONFIG_ERROR_UNKNOWN = 0,           /*< nick=UnknownError >*/
-	NM_SETTING_IP6_CONFIG_ERROR_INVALID_PROPERTY,      /*< nick=InvalidProperty >*/
-	NM_SETTING_IP6_CONFIG_ERROR_MISSING_PROPERTY,      /*< nick=MissingProperty >*/
-	NM_SETTING_IP6_CONFIG_ERROR_NOT_ALLOWED_FOR_METHOD /*< nick=NotAllowedForMethod >*/
-} NMSettingIP6ConfigError;
-

Functions

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

`NM_SETTING_IP6_CONFIG_ERROR_UNKNOWN`	unknown or unclassified error +	+GQuark +	+nm_setting_ip6_config_error_quark () +
+NMIP6Address * +	+nm_ip6_address_new () +
+NMIP6Address * +	+nm_ip6_address_dup () +
+void +	+nm_ip6_address_ref () +
+void +	+nm_ip6_address_unref () +
+gboolean +	+nm_ip6_address_compare () +
const struct in6_addr * +	+nm_ip6_address_get_address () +
+void +	+nm_ip6_address_set_address () +
+guint32 +	+nm_ip6_address_get_prefix () +
+void +	+nm_ip6_address_set_prefix () +
const struct in6_addr * +	+nm_ip6_address_get_gateway () +
+void +	+nm_ip6_address_set_gateway () +
+NMIP6Route * +	+nm_ip6_route_new () +
+NMIP6Route * +	+nm_ip6_route_dup () +
+void +	+nm_ip6_route_ref () +
+void +	+nm_ip6_route_unref () +
+gboolean +	+nm_ip6_route_compare () +
const struct in6_addr * +	+nm_ip6_route_get_dest () +
+void +	+nm_ip6_route_set_dest () +
+guint32 +	+nm_ip6_route_get_prefix () +
+void +	+nm_ip6_route_set_prefix () +
const struct in6_addr * +	+nm_ip6_route_get_next_hop () +
+void +	+nm_ip6_route_set_next_hop () +
+guint32 +	+nm_ip6_route_get_metric () +
+void +	+nm_ip6_route_set_metric () +
+NMSetting * +	+nm_setting_ip6_config_new () +
const char * +	+nm_setting_ip6_config_get_method () +
+guint32 +	+nm_setting_ip6_config_get_num_dns () +
const struct in6_addr * +	+nm_setting_ip6_config_get_dns () +
+gboolean +	+nm_setting_ip6_config_add_dns () +
+void +	+nm_setting_ip6_config_remove_dns () +
+gboolean +	+nm_setting_ip6_config_remove_dns_by_value () +
+void +	+nm_setting_ip6_config_clear_dns () +
+guint32 +	+nm_setting_ip6_config_get_num_dns_searches () +
const char * +	+nm_setting_ip6_config_get_dns_search () +
+gboolean +	+nm_setting_ip6_config_add_dns_search () +
+void +	+nm_setting_ip6_config_remove_dns_search () +
+gboolean +	+nm_setting_ip6_config_remove_dns_search_by_value () +
+void +	+nm_setting_ip6_config_clear_dns_searches () +
+guint32 +	+nm_setting_ip6_config_get_num_addresses ()
`NM_SETTING_IP6_CONFIG_ERROR_INVALID_PROPERTY`	the property was invalid +	+NMIP6Address * +	+nm_setting_ip6_config_get_address ()
`NM_SETTING_IP6_CONFIG_ERROR_MISSING_PROPERTY`	the property was missing and is -required +	+gboolean +	+nm_setting_ip6_config_add_address ()
`NM_SETTING_IP6_CONFIG_ERROR_NOT_ALLOWED_FOR_METHOD`	the property's value is -not valid with the given IPv6 method +	+void +	+nm_setting_ip6_config_remove_address () +
+gboolean +	+nm_setting_ip6_config_remove_address_by_value () +
+void +	+nm_setting_ip6_config_clear_addresses () +
+guint32 +	+nm_setting_ip6_config_get_num_routes () +
+NMIP6Route * +	+nm_setting_ip6_config_get_route () +
+gboolean +	+nm_setting_ip6_config_add_route () +
+void +	+nm_setting_ip6_config_remove_route () +
+gboolean +	+nm_setting_ip6_config_remove_route_by_value () +
+void +	+nm_setting_ip6_config_clear_routes () +
+gboolean +	+nm_setting_ip6_config_get_ignore_auto_routes () +
+gint64 +	+nm_setting_ip6_config_get_route_metric () +
+gboolean +	+nm_setting_ip6_config_get_ignore_auto_dns () +
const char * +	+nm_setting_ip6_config_get_dhcp_hostname () +
+gboolean +	+nm_setting_ip6_config_get_never_default () +
+gboolean +	+nm_setting_ip6_config_get_may_fail () +
+NMSettingIP6ConfigPrivacy +	+nm_setting_ip6_config_get_ip6_privacy ()

NM_SETTING_IP6_CONFIG_ERROR

#define NM_SETTING_IP6_CONFIG_ERROR nm_setting_ip6_config_error_quark ()
-

nm_setting_ip6_config_error_quark ()

GQuark              nm_setting_ip6_config_error_quark   (void);

-Registers an error quark for NMSettingIP6Config if necessary. -

Properties

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

Returns :	the error quark used for NMSettingIP6Config errors.
GPtrArray_GValueArray_GArray_guchar_+guint+GArray_guchar___*	addresses	Read / Write
+gchar *	dhcp-hostname	Read / Write
+GPtrArray_GArray_guchar__ *	dns	Read / Write
+GSList_gchararray_ *	dns-search	Read / Write
gboolean	ignore-auto-dns	Read / Write / Construct
gboolean	ignore-auto-routes	Read / Write / Construct
gint	ip6-privacy	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_GValueArray_GArray_guchar_+guint+GArray_guchar_+guint__*	routes	Read / Write

NM_SETTING_IP6_CONFIG_METHOD

#define NM_SETTING_IP6_CONFIG_METHOD             "method"
-

NM_SETTING_IP6_CONFIG_DNS

#define NM_SETTING_IP6_CONFIG_DNS                "dns"
-

NM_SETTING_IP6_CONFIG_DNS_SEARCH

#define NM_SETTING_IP6_CONFIG_DNS_SEARCH         "dns-search"
-

NM_SETTING_IP6_CONFIG_ADDRESSES

#define NM_SETTING_IP6_CONFIG_ADDRESSES          "addresses"
-

NM_SETTING_IP6_CONFIG_ROUTES

#define NM_SETTING_IP6_CONFIG_ROUTES             "routes"
-

NM_SETTING_IP6_CONFIG_ROUTE_METRIC

#define NM_SETTING_IP6_CONFIG_ROUTE_METRIC       "route-metric"
-

Types and Values

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

#define	NM_SETTING_IP6_CONFIG_SETTING_NAME
enum	NMSettingIP6ConfigError
#define	NM_SETTING_IP6_CONFIG_ERROR
#define	NM_SETTING_IP6_CONFIG_METHOD
#define	NM_SETTING_IP6_CONFIG_DNS
#define	NM_SETTING_IP6_CONFIG_DNS_SEARCH
#define	NM_SETTING_IP6_CONFIG_ADDRESSES
#define	NM_SETTING_IP6_CONFIG_ROUTES
#define	NM_SETTING_IP6_CONFIG_ROUTE_METRIC
#define	NM_SETTING_IP6_CONFIG_IGNORE_AUTO_ROUTES
#define	NM_SETTING_IP6_CONFIG_IGNORE_AUTO_DNS
#define	NM_SETTING_IP6_CONFIG_NEVER_DEFAULT
#define	NM_SETTING_IP6_CONFIG_MAY_FAIL
#define	NM_SETTING_IP6_CONFIG_IP6_PRIVACY
#define	NM_SETTING_IP6_CONFIG_DHCP_HOSTNAME
#define	NM_SETTING_IP6_CONFIG_METHOD_IGNORE
#define	NM_SETTING_IP6_CONFIG_METHOD_AUTO
#define	NM_SETTING_IP6_CONFIG_METHOD_DHCP
#define	NM_SETTING_IP6_CONFIG_METHOD_LINK_LOCAL
#define	NM_SETTING_IP6_CONFIG_METHOD_MANUAL
#define	NM_SETTING_IP6_CONFIG_METHOD_SHARED
enum	NMSettingIP6ConfigPrivacy

NM_SETTING_IP6_CONFIG_IGNORE_AUTO_ROUTES

#define NM_SETTING_IP6_CONFIG_IGNORE_AUTO_ROUTES "ignore-auto-routes"
+
+Object Hierarchy
+    GBoxed
+    ├── NMIP6Address
+    ╰── NMIP6Route
+    GEnum
+    ├── NMSettingIP6ConfigError
+    ╰── NMSettingIP6ConfigPrivacy
+    GObject
+    ╰── NMSetting
+        ╰── NMSettingIP6Config
 
-
-
 
-
-
-NM_SETTING_IP6_CONFIG_IGNORE_AUTO_DNS
-#define NM_SETTING_IP6_CONFIG_IGNORE_AUTO_DNS    "ignore-auto-dns"
+
+Includes
+#include <nm-setting-ip6-config.h>
 
-
-
 
-
-
-NM_SETTING_IP6_CONFIG_NEVER_DEFAULT
-#define NM_SETTING_IP6_CONFIG_NEVER_DEFAULT      "never-default"
-
-
-
+
+Description
+The NMSettingIP6Config object is a NMSetting subclass that describes
+properties related to IPv6 addressing, routing, and Domain Name Service
 
-
+
+Functions
 
-NM_SETTING_IP6_CONFIG_MAY_FAIL
-#define NM_SETTING_IP6_CONFIG_MAY_FAIL           "may-fail"
-
-
-
+nm_setting_ip6_config_error_quark ()
+GQuark
+nm_setting_ip6_config_error_quark (void);
+Registers an error quark for NMSettingIP6Config if necessary.
+
+Returns
+ the error quark used for NMSettingIP6Config errors.
+
 
-
-
-NM_SETTING_IP6_CONFIG_IP6_PRIVACY
-#define NM_SETTING_IP6_CONFIG_IP6_PRIVACY        "ip6-privacy"
-
-
-
 
 
 
-NM_SETTING_IP6_CONFIG_DHCP_HOSTNAME
-#define NM_SETTING_IP6_CONFIG_DHCP_HOSTNAME      "dhcp-hostname"
-
-
-
+nm_ip6_address_new ()
+NMIP6Address *
+nm_ip6_address_new (void);
+Creates and returns a new NMIP6Address object.
+
+Returns
+ the new empty NMIP6Address object. 
+[transfer full]
 
-
-
-NM_SETTING_IP6_CONFIG_METHOD_IGNORE
-#define NM_SETTING_IP6_CONFIG_METHOD_IGNORE     "ignore"
-
-
-IPv6 is not required or is handled by some other mechanism, and NetworkManager
-should not configure IPv6 for this connection.
-
 
 
 
-NM_SETTING_IP6_CONFIG_METHOD_AUTO
-#define NM_SETTING_IP6_CONFIG_METHOD_AUTO       "auto"
-
-
-IPv6 configuration should be automatically determined via a method appropriate
-for the hardware interface, ie router advertisements, DHCP, or PPP or some
-other device-specific manner.
-
+nm_ip6_address_dup ()
+NMIP6Address *
+nm_ip6_address_dup (NMIP6Address *source);
+Copies a given NMIP6Address object and returns the copy.
+
+Parameters
+
+++++
+
+
+
+
+
+



source the NMIP6Address object to copy  
+
+
+Returns
+ the copy of the given NMIP6Address copy. 
+[transfer full]
+
 
 
 
-NM_SETTING_IP6_CONFIG_METHOD_DHCP
-#define NM_SETTING_IP6_CONFIG_METHOD_DHCP       "dhcp"
-
-
-IPv6 configuration should be automatically determined via DHCPv6 only and
-router advertisements should be ignored.
-
+nm_ip6_address_ref ()
+void
+nm_ip6_address_ref (NMIP6Address *address);
+Increases the reference count of the object.
+
+Parameters
+
+++++
+
+
+
+
+
+



address the NMIP6Address  
+
 
 
 
-NM_SETTING_IP6_CONFIG_METHOD_LINK_LOCAL
-#define NM_SETTING_IP6_CONFIG_METHOD_LINK_LOCAL "link-local"
-
-
-IPv6 configuration should be automatically configured for link-local-only
-operation.
-
+nm_ip6_address_unref ()
+void
+nm_ip6_address_unref (NMIP6Address *address);
+Decreases the reference count of the object.  If the reference count
+reaches zero, the object will be destroyed.
+
+Parameters
+
+++++
+
+
+
+
+
+



address the NMIP6Address  
+
 
 
 
-NM_SETTING_IP6_CONFIG_METHOD_MANUAL
-#define NM_SETTING_IP6_CONFIG_METHOD_MANUAL     "manual"
-
-
-All necessary IPv6 configuration (addresses, prefix, DNS, etc) is specified
-in the setting's properties.
-
+nm_ip6_address_compare ()
+gboolean
+nm_ip6_address_compare (NMIP6Address *address,
+                        NMIP6Address *other);
+Determines if two NMIP6Address objects contain the same values.
+
+Parameters
+
+++++
+
+
+
+
+
+
+
+
+
+
+
+
+



address the NMIP6Address  
other the NMIP6Address to compare address
+to.  
+
+
+Returns
+ TRUE if the objects contain the same values, FALSE if they do not.
+
+
 
 
 
-NM_SETTING_IP6_CONFIG_METHOD_SHARED
-#define NM_SETTING_IP6_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 router
-advertisements, a 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. (not yet
-supported for IPv6)
-
+nm_ip6_address_get_address ()
+const struct in6_addr *
+nm_ip6_address_get_address (NMIP6Address *address);
+Gets the IPv6 address property of this address object.
+
+Parameters
+
+++++
+
+
+
+
+
+



address the NMIP6Address  
+
+
+Returns
+         the IPv6 address. 
+[array fixed-size=16][element-type guint8][transfer none]
+
 
 
 
-enum NMSettingIP6ConfigPrivacy
-typedef enum {
-	NM_SETTING_IP6_CONFIG_PRIVACY_UNKNOWN = -1,
-	NM_SETTING_IP6_CONFIG_PRIVACY_DISABLED = 0,
-	NM_SETTING_IP6_CONFIG_PRIVACY_PREFER_PUBLIC_ADDR = 1,
-	NM_SETTING_IP6_CONFIG_PRIVACY_PREFER_TEMP_ADDR = 2
-} NMSettingIP6ConfigPrivacy;
-
-
-NMSettingIP6ConfigPrivacy values indicate if and how IPv6 Privacy
-Extensions are used (RFC4941).
-
-
+nm_ip6_address_set_address ()
+void
+nm_ip6_address_set_address (NMIP6Address *address,
+                            const struct in6_addr *addr);
+Sets the IPv6 address property of this object.
+
+Parameters
+
--+++
-
-
+
+
+
-
-
+
+
+
+
+
 





 
 
 NM_SETTING_IP6_CONFIG_PRIVACY_UNKNOWN unknown or no value specified
- address the NMIP6Address  
 
 NM_SETTING_IP6_CONFIG_PRIVACY_DISABLED IPv6 Privacy Extensions are disabled
- addr the IPv6 address  
 
+
+
+
+
+nm_ip6_address_get_prefix ()
+guint32
+nm_ip6_address_get_prefix (NMIP6Address *address);
+Gets the IPv6 address prefix property of this address object.
+
+Parameters
+
+++++
+
+
+
+
+
+



address the NMIP6Address  
+
+
+Returns
+ the IPv6 address prefix
+
+
+
+
+
+nm_ip6_address_set_prefix ()
+void
+nm_ip6_address_set_prefix (NMIP6Address *address,
+                           guint32 prefix);
+Sets the IPv6 address prefix.
+
+Parameters
+
+++++
+
-
-
+
+
+
-
-
+
+
+




 NM_SETTING_IP6_CONFIG_PRIVACY_PREFER_PUBLIC_ADDR IPv6 Privacy Extensions
-are enabled, but public addresses are preferred over temporary addresses
- address the NMIP6Address  
 
 NM_SETTING_IP6_CONFIG_PRIVACY_PREFER_TEMP_ADDR IPv6 Privacy Extensions
-are enabled and temporary addresses are preferred over public addresses
- prefix the address prefix, a number between 0 and 128 inclusive  
 
 
 
 
-
-
-NMIP6Address
-typedef struct NMIP6Address NMIP6Address;
-
-
-
 
 
 
-nm_ip6_address_new ()
-NMIP6Address *      nm_ip6_address_new                  (void);
-
-Creates and returns a new NMIP6Address object.
-
-
+nm_ip6_address_get_gateway ()
+const struct in6_addr *
+nm_ip6_address_get_gateway (NMIP6Address *address);
+Gets the IPv6 default gateway property of this address object.
+
+Parameters
+
--+++
-
-
+
+
+
 





 
 Returns : the new empty NMIP6Address object. [transfer full]
- address the NMIP6Address  
 
 
 
+
+Returns
+         the IPv6 gateway address. 
+[array fixed-size=16][element-type guint8][transfer none]
+
+
 
 
-nm_ip6_address_dup ()
-NMIP6Address *      nm_ip6_address_dup                  (NMIP6Address *source);
-
-Copies a given NMIP6Address object and returns the copy.
-
-
+nm_ip6_address_set_gateway ()
+void
+nm_ip6_address_set_gateway (NMIP6Address *address,
+                            const struct in6_addr *gateway);
+Sets the IPv6 default gateway property of this address object.
+
+Parameters
+
--+++
-
-
+
+
+
-
-
+
+
+
 





 
 
 source : the NMIP6Address object to copy address the NMIP6Address  
 
 Returns : the copy of the given NMIP6Address copy. [transfer full]
- gateway the IPv6 default gateway  
 
 
 
 
+
 
 
-nm_ip6_address_ref ()
-void                nm_ip6_address_ref                  (NMIP6Address *address);
-
-Increases the reference count of the object.
-
-
+nm_ip6_route_new ()
+NMIP6Route *
+nm_ip6_route_new (void);
+Creates and returns a new NMIP6Route object.
+
+Returns
+ the new empty NMIP6Route object. 
+[transfer full]
+
+
+
+
+nm_ip6_route_dup ()
+NMIP6Route *
+nm_ip6_route_dup (NMIP6Route *source);
+Copies a given NMIP6Route object and returns the copy.
+
+Parameters
+
--+++
-
-
+
+
+
 





 
 address : the NMIP6Address
- source the NMIP6Route object to copy  
 
 
 
+
+Returns
+ the copy of the given NMIP6Route copy. 
+[transfer full]
+
+
 
 
-nm_ip6_address_unref ()
-void                nm_ip6_address_unref                (NMIP6Address *address);
-
-Decreases the reference count of the object.  If the reference count
-reaches zero, the object will be destroyed.
-
-
+nm_ip6_route_ref ()
+void
+nm_ip6_route_ref (NMIP6Route *route);
+Increases the reference count of the object.
+
+Parameters
+
--+++
-
-
+
+
+
 





 
 address : the NMIP6Address
- route the NMIP6Route  
 
 
 
+
 
 
-nm_ip6_address_compare ()
-gboolean            nm_ip6_address_compare              (NMIP6Address *address,
-                                                         NMIP6Address *other);
-
-Determines if two NMIP6Address objects contain the same values.
-
-
+nm_ip6_route_unref ()
+void
+nm_ip6_route_unref (NMIP6Route *route);
+Decreases the reference count of the object.  If the reference count
+reaches zero, the object will be destroyed.
+
+Parameters
+
--+++
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
 





 address : the NMIP6Address
-
other : the NMIP6Address to compare address to.
Returns : 
-TRUE if the objects contain the same values, FALSE if they do not.
route the NMIP6Route  
 
 
+
 
 
-nm_ip6_address_get_address ()
-const struct in6_addr * nm_ip6_address_get_address      (NMIP6Address *address);
-
-Gets the IPv6 address property of this address object.
-
-
+nm_ip6_route_compare ()
+gboolean
+nm_ip6_route_compare (NMIP6Route *route,
+                      NMIP6Route *other);
+Determines if two NMIP6Route objects contain the same values.
+
+Parameters
+
--+++
-
-
+
+
+
-
-
+
+
+
 





 
 
 address : the NMIP6Address
- route the NMIP6Route  
 
 Returns : the IPv6 address. [array fixed-size=16][element-type guint8][transfer none]
- other the NMIP6Route to compare route
+to.  
 
 
 
 
+
+Returns
+ TRUE if the objects contain the same values, FALSE if they do not.
+
+
+

nm_ip6_address_set_address ()

void                nm_ip6_address_set_address          (NMIP6Address *address,
-                                                         const struct in6_addr *addr);

-Sets the IPv6 address property of this object. -

nm_ip6_route_get_dest ()

const struct in6_addr *
+nm_ip6_route_get_dest (NMIP6Route *route);

Gets the IPv6 destination address property of this route object.

Parameters

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

`address` :	the NMIP6Address -
`addr` :	the IPv6 address
route	the NMIP6Route

Returns

the IPv6 address of destination.

[array fixed-size=16][element-type guint8][transfer none]

nm_ip6_address_get_prefix ()

guint32             nm_ip6_address_get_prefix           (NMIP6Address *address);

-Gets the IPv6 address prefix property of this address object. -

nm_ip6_route_set_dest ()

void
+nm_ip6_route_set_dest (NMIP6Route *route,
+                       const struct in6_addr *dest);

Sets the IPv6 destination address property of this route object.

Parameters

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

`address` :	the NMIP6Address -	route	the NMIP6Route
Returns :	the IPv6 address prefix	dest	the destination address

nm_ip6_address_set_prefix ()

void                nm_ip6_address_set_prefix           (NMIP6Address *address,
-                                                         guint32 prefix);

-Sets the IPv6 address prefix. -

nm_ip6_route_get_prefix ()

guint32
+nm_ip6_route_get_prefix (NMIP6Route *route);

Gets the IPv6 prefix (ie "32" or "64" etc) of this route.

Parameters

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

`address` :	the NMIP6Address -
`prefix` :	the address prefix, a number between 0 and 128 inclusive
route	the NMIP6Route

Returns

the IPv6 prefix

Property Details

The `"addresses"` property

  "addresses"                GPtrArray_GValueArray_GArray_guchar_+guint+GArray_guchar___*  : Read / Write

-Array of IPv6 address structures. Each IPv6 address structure is -composed of 3 members, the first being a byte array containing the IPv6 -address (network byte order), the second a 32-bit integer containing the -IPv6 address prefix, and the third a byte array containing the IPv6 -address (network byte order) of the gateway associated with this address, -if any. If no gateway is given, the third element should be given as all -zeros. For the "auto" method, given IP addresses are appended to those -returned by automatic configuration. Addresses cannot be used with the -"shared" or "link-local" methods as the interface is automatically -assigned an address with these methods. -

The `“addresses”` property

  “addresses”                GPtrArray_GValueArray_GArray_guchar_+guint+GArray_guchar___*

Flags: Read / Write

The `"dhcp-hostname"` property

  "dhcp-hostname"            gchar*                : Read / Write

-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

Since 0.9.8

The `"dns"` property

  "dns"                      GPtrArray_GArray_guchar__*  : Read / Write

-Array of DNS servers, where each member of the array is a byte array -containing the IPv6 address of the DNS server (in 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" or "link-local" methods as there is no usptream network. In all -other methods, these DNS servers are used as the only DNS servers for -this connection. -

The `“dns”` property

  “dns”                      GPtrArray_GArray_guchar__ *

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" or "link-local" 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" or "dhcp" and this property is set 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" or "dhcp" and this property is set 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 `"ip6-privacy"` property

  "ip6-privacy"              gint                  : Read / Write / Construct

-Configure IPv6 Privacy Extensions for SLAAC, described in RFC4941. If -enabled, it makes the kernel generate a temporary IPv6 address in -addition to the public one generated from MAC address via modified -EUI-64. This enhances privacy, but could cause problems in some -applications, on the other hand. The permitted values are: 0: disabled, -1: enabled (prefer public address), 2: enabled (prefer temporary -addresses). -

The `“ip6-privacy”` property

  “ip6-privacy”              gint

Flags: Read / Write / Construct

Allowed values: [-1,2]

Default value: -1

The `"may-fail"` property

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

-If TRUE, allow overall network configuration to proceed even if IPv6 -configuration times out. Note that at least one IP configuration must -succeed or overall network configuration will still fail. For example, -in IPv4-only networks, setting this property to TRUE allows the overall -network configuration to succeed if IPv6 configuration fails but IPv4 -configuration completes successfully. -

The `“may-fail”` property

  “may-fail”                 gboolean

Flags: Read / Write / Construct

Default value: TRUE

The `"method"` property

  "method"                   gchar*                : Read / Write

-IPv6 configuration method. If "auto" is specified then the appropriate -automatic method (PPP, router advertisement, etc) is used for the device -and most other properties can be left unset. To force the use of DHCP -only, specify "dhcp"; this method is only valid for Ethernet- based -hardware. If "link-local" is specified, then an IPv6 link-local address -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 "ignore" is specified, IPv6 configuration is -not done. This property must be set. Note: the "shared" method is not -yet supported. -

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 IPv6 connection, -meaning it will never be assigned the default IPv6 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 replaces zero (0) by 1024 (user-default), setting -this property to 0 means effectively setting it to 1024. -

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_GValueArray_GArray_guchar_+guint+GArray_guchar_+guint__*  : Read / Write

-Array of IPv6 route structures. Each IPv6 route structure is composed of -4 members; the first being the destination IPv6 network or address -(network byte order) as a byte array, the second the destination network -or address IPv6 prefix, the third being the next-hop IPv6 address -(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" or -"link-local" methods because there is no upstream network. -

The `“routes”` property

  “routes”                   GPtrArray_GValueArray_GArray_guchar_+guint+GArray_guchar_+guint__*

Flags: Read / Write

`route` :	the NMIP6Route -
`other` :	the NMIP6Route to compare `route` to.	setting	the NMSettingIP6Config
Returns :	-`TRUE` if the objects contain the same values, `FALSE` if they do not.	i	index number of the DNS server to return

`route` :	the NMIP6Route -	setting	the NMSettingIP6Config
Returns :	the IPv6 address of destination. [array fixed-size=16][element-type guint8][transfer none] -	dns	the IPv6 address of the DNS server to add

`route` :	the NMIP6Route -	setting	the NMSettingIP6Config
`dest` :	the destination address	i	index number of the DNS server to remove

`route` :	the NMIP6Route -
`prefix` :	the prefix, a number between 1 and 128 inclusive
setting	the NMSettingIP6Config

`route` :	the NMIP6Route -	setting	the NMSettingIP6Config
Returns :	the IPv6 address of next hop. [array fixed-size=16][element-type guint8][transfer none] -	i	index number of the DNS search domain to return

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

address	the NMIP6Address
other	the NMIP6Address to compare `address` +to.

`NM_SETTING_IP6_CONFIG_PRIVACY_UNKNOWN`	unknown or no value specified -	address	the NMIP6Address
`NM_SETTING_IP6_CONFIG_PRIVACY_DISABLED`	IPv6 Privacy Extensions are disabled -	addr	the IPv6 address

`NM_SETTING_IP6_CONFIG_PRIVACY_PREFER_PUBLIC_ADDR`	IPv6 Privacy Extensions -are enabled, but public addresses are preferred over temporary addresses -	address	the NMIP6Address
`NM_SETTING_IP6_CONFIG_PRIVACY_PREFER_TEMP_ADDR`	IPv6 Privacy Extensions -are enabled and temporary addresses are preferred over public addresses -	prefix	the address prefix, a number between 0 and 128 inclusive

`source` :	the NMIP6Address object to copy	address	the NMIP6Address
Returns :	the copy of the given NMIP6Address copy. [transfer full] -	gateway	the IPv6 default gateway

`source` :	the NMIP6Route object to copy	route	the NMIP6Route
Returns :	the copy of the given NMIP6Route copy. [transfer full] -	metric	the route metric

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

`setting` :	the NMSettingIP6Config -
`i` :	index number of the DNS server to return	setting	the NMSettingIP6Config
Returns :	the IPv6 address of the DNS server at index `i`. [transfer none] -	address	the new address to add

`setting` :	the NMSettingIP6Config -
`dns` :	the IPv6 address of the DNS server to add	setting	the NMSettingIP6Config
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 NMSettingIP6Config -
`dns_search` :	the search domain to add	setting	the NMSettingIP6Config
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 NMSettingIP6Config +	NM_SETTING_IP6_CONFIG_ERROR_UNKNOWN	+ unknown or unclassified error
Returns :	the number of configured routes

`setting` :	the NMSettingIP6Config +	NM_SETTING_IP6_CONFIG_ERROR_INVALID_PROPERTY	+ the property was invalid
`i` :	index number of the route to return	NM_SETTING_IP6_CONFIG_ERROR_MISSING_PROPERTY	+ the property was missing and is +required +
Returns :	the route at index `i` +	NM_SETTING_IP6_CONFIG_ERROR_NOT_ALLOWED_FOR_METHOD	+ the property's value is +not valid with the given IPv6 method

`setting` :	the NMSettingIP6Config +	NM_SETTING_IP6_CONFIG_PRIVACY_UNKNOWN	+ unknown or no value specified
Returns :	IPv6 Privacy Extensions configuration value (NMSettingIP6ConfigPrivacy).	NM_SETTING_IP6_CONFIG_PRIVACY_DISABLED	+ IPv6 Privacy Extensions are disabled +
NM_SETTING_IP6_CONFIG_PRIVACY_PREFER_PUBLIC_ADDR	+ IPv6 Privacy Extensions +are enabled, but public addresses are preferred over temporary addresses +
NM_SETTING_IP6_CONFIG_PRIVACY_PREFER_TEMP_ADDR	+ IPv6 Privacy Extensions +are enabled and temporary addresses are preferred over public addresses +