libnm-glib Reference Manual: NMDevice

@@ -32,1710 +41,1703 @@

NMDevice

- +

Synopsis

enum                NMDeviceError;
+#define             NM_DEVICE_ERROR
+GQuark              nm_device_error_quark               (void);
+#define             NM_DEVICE_DEVICE_TYPE
+#define             NM_DEVICE_UDI
+#define             NM_DEVICE_INTERFACE
+#define             NM_DEVICE_IP_INTERFACE
+#define             NM_DEVICE_DRIVER
+#define             NM_DEVICE_DRIVER_VERSION
+#define             NM_DEVICE_FIRMWARE_VERSION
+#define             NM_DEVICE_CAPABILITIES
+#define             NM_DEVICE_MANAGED
+#define             NM_DEVICE_AUTOCONNECT
+#define             NM_DEVICE_FIRMWARE_MISSING
+#define             NM_DEVICE_IP4_CONFIG
+#define             NM_DEVICE_DHCP4_CONFIG
+#define             NM_DEVICE_IP6_CONFIG
+#define             NM_DEVICE_DHCP6_CONFIG
+#define             NM_DEVICE_STATE
+#define             NM_DEVICE_STATE_REASON
+#define             NM_DEVICE_ACTIVE_CONNECTION
+#define             NM_DEVICE_AVAILABLE_CONNECTIONS
+#define             NM_DEVICE_VENDOR
+#define             NM_DEVICE_PRODUCT
+#define             NM_DEVICE_PHYSICAL_PORT_ID
+#define             NM_DEVICE_MTU
+                    NMDevice;
+                    NMDeviceClass;
+GObject *           nm_device_new                       (DBusGConnection *connection,
+                                                         const char *path);
+const char *        nm_device_get_iface                 (NMDevice *device);
+const char *        nm_device_get_ip_iface              (NMDevice *device);
+NMDeviceType        nm_device_get_device_type           (NMDevice *device);
+const char *        nm_device_get_udi                   (NMDevice *device);
+const char *        nm_device_get_driver                (NMDevice *device);
+const char *        nm_device_get_driver_version        (NMDevice *device);
+const char *        nm_device_get_firmware_version      (NMDevice *device);
+const char *        nm_device_get_type_description      (NMDevice *device);
+const char *        nm_device_get_hw_address            (NMDevice *device);
+NMDeviceCapabilities nm_device_get_capabilities         (NMDevice *device);
+gboolean            nm_device_get_managed               (NMDevice *device);
+gboolean            nm_device_get_autoconnect           (NMDevice *device);
+void                nm_device_set_autoconnect           (NMDevice *device,
+                                                         gboolean autoconnect);
+gboolean            nm_device_get_firmware_missing      (NMDevice *device);
+NMIP4Config *       nm_device_get_ip4_config            (NMDevice *device);
+NMDHCP4Config *     nm_device_get_dhcp4_config          (NMDevice *device);
+NMIP6Config *       nm_device_get_ip6_config            (NMDevice *device);
+NMDHCP6Config *     nm_device_get_dhcp6_config          (NMDevice *device);
+NMDeviceState       nm_device_get_state                 (NMDevice *device);
+NMDeviceState       nm_device_get_state_reason          (NMDevice *device,
+                                                         NMDeviceStateReason *reason);
+NMActiveConnection * nm_device_get_active_connection    (NMDevice *device);
+const GPtrArray *   nm_device_get_available_connections (NMDevice *device);
+const char *        nm_device_get_physical_port_id      (NMDevice *device);
+guint32             nm_device_get_mtu                   (NMDevice *device);
+const char *        nm_device_get_product               (NMDevice *device);
+const char *        nm_device_get_vendor                (NMDevice *device);
+const char *        nm_device_get_description           (NMDevice *device);
+char **             nm_device_disambiguate_names        (NMDevice **devices,
+                                                         int num_devices);
+void                (*NMDeviceDeactivateFn)             (NMDevice *device,
+                                                         GError *error,
+                                                         gpointer user_data);
+void                nm_device_disconnect                (NMDevice *device,
+                                                         NMDeviceDeactivateFn callback,
+                                                         gpointer user_data);
+GSList *            nm_device_filter_connections        (NMDevice *device,
+                                                         const GSList *connections);
+gboolean            nm_device_connection_valid          (NMDevice *device,
+                                                         NMConnection *connection);
+gboolean            nm_device_connection_compatible     (NMDevice *device,
+                                                         NMConnection *connection,
+                                                         GError **error);
+GType               nm_device_get_setting_type          (NMDevice *device);
+

Object Hierarchy

+  GObject
+   +----NMObject
+         +----NMDevice
+               +----NMDeviceEthernet
+               +----NMDeviceWifi
+               +----NMDeviceModem
+               +----NMDeviceBt
+               +----NMDeviceWimax
+               +----NMDeviceOlpcMesh
+               +----NMDeviceAdsl
+               +----NMDeviceInfiniband
+               +----NMDeviceBond
+               +----NMDeviceBridge
+               +----NMDeviceTeam
+               +----NMDeviceGeneric
+               +----NMDeviceVlan
+

Implemented Interfaces

+NMDevice implements + GInitable and GAsyncInitable.

Properties

+  "active-connection"        NMActiveConnection*   : Read
+  "autoconnect"              gboolean              : Read / Write
+  "available-connections"    NMObjectArray*        : Read
+  "capabilities"             guint                 : Read
+  "device-type"              guint                 : Read
+  "dhcp4-config"             NMDHCP4Config*        : Read
+  "dhcp6-config"             NMDHCP6Config*        : Read
+  "driver"                   gchar*                : Read
+  "driver-version"           gchar*                : Read
+  "firmware-missing"         gboolean              : Read
+  "firmware-version"         gchar*                : Read
+  "interface"                gchar*                : Read
+  "ip-interface"             gchar*                : Read
+  "ip4-config"               NMIP4Config*          : Read
+  "ip6-config"               NMIP6Config*          : Read
+  "managed"                  gboolean              : Read
+  "mtu"                      guint                 : Read
+  "physical-port-id"         gchar*                : Read
+  "product"                  gchar*                : Read
+  "state"                    guint                 : Read
+  "state-reason"             GValueArray_guint+guint_*  : Read
+  "udi"                      gchar*                : Read
+  "vendor"                   gchar*                : Read
+

Signals

+  "state-changed"                                  : Run First
+

Description

Functions

Details

enum NMDeviceError

typedef enum {
+	NM_DEVICE_ERROR_UNKNOWN = 0,        /*< nick=UnknownError >*/
+	NM_DEVICE_ERROR_INTERFACE_MISMATCH, /*< nick=InterfaceMismatch >*/
+} NMDeviceError;
+

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

-GObject * -	-nm_device_new () -
const char * -	-nm_device_get_iface () -
const char * -	-nm_device_get_ip_iface () -
-NMDeviceType -	-nm_device_get_device_type () -
const char * -	-nm_device_get_udi () -
const char * -	-nm_device_get_driver () -
const char * -	-nm_device_get_driver_version () -
const char * -	-nm_device_get_firmware_version () -
-NMDeviceCapabilities -	-nm_device_get_capabilities () -
-gboolean -	-nm_device_get_managed () -
-gboolean -	-nm_device_get_autoconnect () -
-void -	-nm_device_set_autoconnect () -
-gboolean -	-nm_device_get_firmware_missing () -
-NMIP4Config * -	-nm_device_get_ip4_config () +	`NM_DEVICE_ERROR_UNKNOWN`	unknown or unclassified error
-NMDHCP4Config * -	-nm_device_get_dhcp4_config () +	`NM_DEVICE_ERROR_INTERFACE_MISMATCH`	the interface names of the connection and the + device mismatched

NM_DEVICE_ERROR

#define NM_DEVICE_ERROR nm_device_error_quark ()
+

nm_device_error_quark ()

GQuark              nm_device_error_quark               (void);

+Registers an error quark for NMDevice if necessary. +

++++ + + + + +

Returns :

the error quark used for NMDevice errors.

Since 0.9.10

NM_DEVICE_DEVICE_TYPE

#define NM_DEVICE_DEVICE_TYPE "device-type"
+

NM_DEVICE_UDI

#define NM_DEVICE_UDI "udi"
+

NM_DEVICE_INTERFACE

#define NM_DEVICE_INTERFACE "interface"
+

NM_DEVICE_IP_INTERFACE

#define NM_DEVICE_IP_INTERFACE "ip-interface"
+

NM_DEVICE_DRIVER

#define NM_DEVICE_DRIVER "driver"
+

NM_DEVICE_DRIVER_VERSION

#define NM_DEVICE_DRIVER_VERSION "driver-version"
+

NM_DEVICE_FIRMWARE_VERSION

#define NM_DEVICE_FIRMWARE_VERSION "firmware-version"
+

NM_DEVICE_CAPABILITIES

#define NM_DEVICE_CAPABILITIES "capabilities"
+

NM_DEVICE_MANAGED

#define NM_DEVICE_MANAGED "managed"
+

NM_DEVICE_AUTOCONNECT

#define NM_DEVICE_AUTOCONNECT "autoconnect"
+

NM_DEVICE_FIRMWARE_MISSING

#define NM_DEVICE_FIRMWARE_MISSING "firmware-missing"
+

NM_DEVICE_IP4_CONFIG

#define NM_DEVICE_IP4_CONFIG "ip4-config"
+

NM_DEVICE_DHCP4_CONFIG

#define NM_DEVICE_DHCP4_CONFIG "dhcp4-config"
+

NM_DEVICE_IP6_CONFIG

#define NM_DEVICE_IP6_CONFIG "ip6-config"
+

NM_DEVICE_DHCP6_CONFIG

#define NM_DEVICE_DHCP6_CONFIG "dhcp6-config"
+

NM_DEVICE_STATE

#define NM_DEVICE_STATE "state"
+

NM_DEVICE_STATE_REASON

#define NM_DEVICE_STATE_REASON "state-reason"
+

NM_DEVICE_ACTIVE_CONNECTION

#define NM_DEVICE_ACTIVE_CONNECTION "active-connection"
+

NM_DEVICE_AVAILABLE_CONNECTIONS

#define NM_DEVICE_AVAILABLE_CONNECTIONS "available-connections"
+

NM_DEVICE_VENDOR

#define NM_DEVICE_VENDOR "vendor"
+

NM_DEVICE_PRODUCT

#define NM_DEVICE_PRODUCT "product"
+

NM_DEVICE_PHYSICAL_PORT_ID

#define NM_DEVICE_PHYSICAL_PORT_ID "physical-port-id"
+

NM_DEVICE_MTU

#define NM_DEVICE_MTU "mtu"
+

NMDevice

typedef struct _NMDevice NMDevice;

NMDeviceClass

typedef struct {
+	NMObjectClass parent;
+
+	/* Signals */
+	void (*state_changed) (NMDevice *device,
+	                       NMDeviceState new_state,
+	                       NMDeviceState old_state,
+	                       NMDeviceStateReason reason);
+
+	gboolean (*connection_compatible) (NMDevice *device,
+	                                   NMConnection *connection,
+	                                   GError **error);
+
+	const char * (*get_type_description) (NMDevice *device);
+	const char * (*get_hw_address) (NMDevice *device);
+
+	GType (*get_setting_type) (NMDevice *device);
+
+	/* Padding for future expansion */
+	void (*_reserved1) (void);
+	void (*_reserved2) (void);
+	void (*_reserved3) (void);
+} NMDeviceClass;
+

nm_device_new ()

GObject *           nm_device_new                       (DBusGConnection *connection,
+                                                         const char *path);

+Creates a new NMDevice. +

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

-NMIP6Config * -	-nm_device_get_ip6_config () +	`connection` :	the DBusGConnection
-NMDHCP6Config * -	-nm_device_get_dhcp6_config () -	`path` :	the DBus object path of the device
-NMDeviceState -	-nm_device_get_state () +	Returns :	a new device. [transfer full]

nm_device_get_iface ()

const char *        nm_device_get_iface                 (NMDevice *device);

+Gets the interface name of the NMDevice. +

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

-NMDeviceState -	-nm_device_get_state_reason () +	`device` :	a NMDevice
-NMActiveConnection * -	-nm_device_get_active_connection () -	Returns :	the interface of the device. This is the internal string used by the +device, and must not be modified.

nm_device_get_ip_iface ()

const char *        nm_device_get_ip_iface              (NMDevice *device);

+Gets the IP interface name of the NMDevice over which IP traffic flows +when the device is in the ACTIVATED state. +

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

const GPtrArray * -	-nm_device_get_available_connections () +	`device` :	a NMDevice
const char * -	-nm_device_get_product () -	Returns :	the IP traffic interface of the device. This is the internal string +used by the device, and must not be modified.

nm_device_get_device_type ()

NMDeviceType        nm_device_get_device_type           (NMDevice *device);

+Returns the numeric type of the NMDevice, ie Ethernet, Wi-Fi, etc. +

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

const char * -	-nm_device_get_vendor () +	`device` :	a NMDevice
-void -	-(*NMDeviceDeactivateFn) () -	Returns :	the device type

nm_device_get_udi ()

const char *        nm_device_get_udi                   (NMDevice *device);

+Gets the Unique Device Identifier of the NMDevice. +

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

-void -	-nm_device_disconnect () +	`device` :	a NMDevice
-GSList * -	-nm_device_filter_connections () -	Returns :	the Unique Device Identifier of the device. This identifier may be +used to gather more information about the device from various operating +system services like udev or sysfs.

nm_device_get_driver ()

const char *        nm_device_get_driver                (NMDevice *device);

+Gets the driver of the NMDevice. +

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

-gboolean -	-nm_device_connection_valid () +	`device` :	a NMDevice
-gboolean -	-nm_device_connection_compatible () -	Returns :	the driver of the device. This is the internal string used by the +device, and must not be modified.

Properties

nm_device_get_driver_version ()

const char *        nm_device_get_driver_version        (NMDevice *device);

+Gets the driver version of the NMDevice. +

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

-NMActiveConnection *	active-connection	Read
gboolean	autoconnect	Read / Write
-NMObjectArray *	available-connections	Read
guint	capabilities	Read
guint	device-type	Read
-NMDHCP4Config *	dhcp4-config	Read
-NMDHCP6Config *	dhcp6-config	Read
-gchar *	driver	Read
-gchar *	driver-version	Read
gboolean	firmware-missing	Read
-gchar *	firmware-version	Read
-gchar *	interface	Read
-gchar *	ip-interface	Read
-NMIP4Config *	ip4-config	Read
-NMIP6Config *	ip6-config	Read
gboolean	managed	Read
-gchar *	product	Read
guint	state	Read
GValueArray_guint+guint_*	state-reason	Read
-gchar *	udi	Read	`device` :	a NMDevice +
-gchar *	vendor	Read	Returns :	the version of the device driver. This is the internal string used by the +device, and must not be modified.

Signals

----- - - - - - -

void

state-changed

Run First

Types and Values

nm_device_get_firmware_version ()

const char *        nm_device_get_firmware_version      (NMDevice *device);

+Gets the firmware version of the NMDevice. +

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

#define	NM_DEVICE_DEVICE_TYPE
#define	NM_DEVICE_UDI
#define	NM_DEVICE_INTERFACE
#define	NM_DEVICE_IP_INTERFACE
#define	NM_DEVICE_DRIVER
#define	NM_DEVICE_DRIVER_VERSION
#define	NM_DEVICE_FIRMWARE_VERSION
#define	NM_DEVICE_CAPABILITIES
#define	NM_DEVICE_MANAGED
#define	NM_DEVICE_AUTOCONNECT
#define	NM_DEVICE_FIRMWARE_MISSING
#define	NM_DEVICE_IP4_CONFIG
#define	NM_DEVICE_DHCP4_CONFIG
#define	NM_DEVICE_IP6_CONFIG
#define	NM_DEVICE_DHCP6_CONFIG
#define	NM_DEVICE_STATE
#define	NM_DEVICE_STATE_REASON
#define	NM_DEVICE_ACTIVE_CONNECTION
#define	NM_DEVICE_AVAILABLE_CONNECTIONS
#define	NM_DEVICE_VENDOR	`device` :	a NMDevice +
#define	NM_DEVICE_PRODUCT	Returns :	the firmware version of the device. This is the internal string used by the +device, and must not be modified.

Object Hierarchy

    GObject
-    ╰── NMObject
-        ╰── NMDevice
-            ├── NMDeviceEthernet
-            ├── NMDeviceWifi
-            ├── NMDeviceModem
-            ├── NMDeviceBt
-            ├── NMDeviceWimax
-            ├── NMDeviceOlpcMesh
-            ├── NMDeviceAdsl
-            ├── NMDeviceInfiniband
-            ├── NMDeviceBond
-            ├── NMDeviceBridge
-            ╰── NMDeviceVlan
-

Description

nm_device_get_type_description ()

const char *        nm_device_get_type_description      (NMDevice *device);

+Gets a (non-localized) description of the type of device that +device is.

Functions

nm_device_new ()

GObject *
-nm_device_new (DBusGConnection *connection,
-               const char *path);

Creates a new NMDevice.

Parameters

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

connection	the DBusGConnection		`device` :	a NMDevice +
path	the DBus object path of the device		Returns :	the type description of the device. This is the internal +string used by the device, and must not be modified.

Returns

a new device.

[transfer full]

nm_device_get_iface ()

const char *
-nm_device_get_iface (NMDevice *device);

Gets the interface name of the NMDevice.

Parameters

----- - - - - - -

device

a NMDevice

Returns

the interface of the device. This is the internal string used by the -device, and must not be modified.

nm_device_get_ip_iface ()

const char *
-nm_device_get_ip_iface (NMDevice *device);

Gets the IP interface name of the NMDevice over which IP traffic flows -when the device is in the ACTIVATED state.

Parameters

----- - - - - - -

device

a NMDevice

Returns

the IP traffic interface of the device. This is the internal string -used by the device, and must not be modified.

Since 0.9.10

nm_device_get_device_type ()

NMDeviceType
-nm_device_get_device_type (NMDevice *device);

Returns the numeric type of the NMDevice, ie ethernet, wifi, etc.

Parameters

nm_device_get_hw_address ()

const char *        nm_device_get_hw_address            (NMDevice *device);

+Gets the current a hardware address (MAC) for the device. +

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

device	a NMDevice
`device` :	a NMDevice +
Returns :	the current MAC of the device, or `NULL`. +This is the internal string used by the device, and must not be modified.

Returns

the device type

Since 0.9.10

nm_device_get_udi ()

const char *
-nm_device_get_udi (NMDevice *device);

Gets the Unique Device Identifier of the NMDevice.

Parameters

nm_device_get_capabilities ()

NMDeviceCapabilities nm_device_get_capabilities         (NMDevice *device);

+Gets the device' capabilities. +

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

device	a NMDevice
`device` :	a NMDevice +
Returns :	the capabilities

Returns

the Unique Device Identifier of the device. This identifier may be -used to gather more information about the device from various operating -system services like udev or sysfs.

nm_device_get_driver ()

const char *
-nm_device_get_driver (NMDevice *device);

Gets the driver of the NMDevice.

Parameters

nm_device_get_managed ()

gboolean            nm_device_get_managed               (NMDevice *device);

+Whether the NMDevice is managed by NetworkManager. +

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

device	a NMDevice
`device` :	a NMDevice +
Returns :	+`TRUE` if the device is managed by NetworkManager

Returns

the driver of the device. This is the internal string used by the -device, and must not be modified.

nm_device_get_driver_version ()

const char *
-nm_device_get_driver_version (NMDevice *device);

Gets the driver version of the NMDevice.

Parameters

nm_device_get_autoconnect ()

gboolean            nm_device_get_autoconnect           (NMDevice *device);

+Whether the NMDevice can be autoconnected. +

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

device	a NMDevice
`device` :	a NMDevice +
Returns :	+`TRUE` if the device is allowed to be autoconnected

Returns

the version of the device driver. This is the internal string used by the -device, and must not be modified.

nm_device_get_firmware_version ()

const char *
-nm_device_get_firmware_version (NMDevice *device);

Gets the firmware version of the NMDevice.

Parameters

nm_device_set_autoconnect ()

void                nm_device_set_autoconnect           (NMDevice *device,
+                                                         gboolean autoconnect);

+Enables or disables automatic activation of the NMDevice. +

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

device	a NMDevice
`device` :	a NMDevice +
`autoconnect` :	+`TRUE` to enable autoconnecting

Returns

the firmware version of the device. This is the internal string used by the -device, and must not be modified.

nm_device_get_capabilities ()

NMDeviceCapabilities
-nm_device_get_capabilities (NMDevice *device);

Gets the device' capabilities.

Parameters

nm_device_get_firmware_missing ()

gboolean            nm_device_get_firmware_missing      (NMDevice *device);

+Indicates that firmware required for the device's operation is likely +to be missing. +

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

device	a NMDevice
`device` :	a NMDevice +
Returns :	+`TRUE` if firmware required for the device's operation is likely +to be missing.

Returns

the capabilities

nm_device_get_managed ()

gboolean
-nm_device_get_managed (NMDevice *device);

Whether the NMDevice is managed by NetworkManager.

Parameters

nm_device_get_ip4_config ()

NMIP4Config *       nm_device_get_ip4_config            (NMDevice *device);

+Gets the current NMIP4Config associated with the NMDevice. +

+Note that as of NetworkManager 0.9.10, you can alternatively use +nm_active_connection_get_ip4_config(), which also works with VPN +connections. +

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

device	a NMDevice
`device` :	a NMDevice +
Returns :	the NMIP4Config or `NULL` if the device is not activated. [transfer none] +

Returns

TRUE if the device is managed by NetworkManager

nm_device_get_autoconnect ()

gboolean
-nm_device_get_autoconnect (NMDevice *device);

Whether the NMDevice can be autoconnected.

Parameters

nm_device_get_dhcp4_config ()

NMDHCP4Config *     nm_device_get_dhcp4_config          (NMDevice *device);

+Gets the current NMDHCP4Config associated with the NMDevice. +

+Note that as of NetworkManager 0.9.10, you can alternatively use +nm_active_connection_get_dhcp4_config(), which also works with VPN +connections. +

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

device	a NMDevice
`device` :	a NMDevice +
Returns :	the NMDHCP4Config or `NULL` if the device is not activated or not +using DHCP. [transfer none] +

Returns

TRUE if the device is allowed to be autoconnected

nm_device_set_autoconnect ()

void
-nm_device_set_autoconnect (NMDevice *device,
-                           gboolean autoconnect);

Enables or disables automatic activation of the NMDevice.

Parameters

nm_device_get_ip6_config ()

NMIP6Config *       nm_device_get_ip6_config            (NMDevice *device);

+Gets the current NMIP6Config associated with the NMDevice. +

+Note that as of NetworkManager 0.9.10, you can alternatively use +nm_active_connection_get_ip6_config(), which also works with VPN +connections. +

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

device	a NMDevice		`device` :	a NMDevice +
autoconnect	`TRUE` to enable autoconnecting		Returns :	the NMIP6Config or `NULL` if the device is not activated. [transfer none] +

nm_device_get_firmware_missing ()

gboolean
-nm_device_get_firmware_missing (NMDevice *device);

Indicates that firmware required for the device's operation is likely -to be missing.

Parameters

nm_device_get_dhcp6_config ()

NMDHCP6Config *     nm_device_get_dhcp6_config          (NMDevice *device);

+Gets the current NMDHCP6Config associated with the NMDevice. +

+Note that as of NetworkManager 0.9.10, you can alternatively use +nm_active_connection_get_dhcp6_config(), which also works with VPN +connections. +

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

device	a NMDevice
`device` :	a NMDevice +
Returns :	the NMDHCP6Config or `NULL` if the device is not activated or not +using DHCP. [transfer none] +

Returns

TRUE if firmware required for the device's operation is likely -to be missing.

nm_device_get_ip4_config ()

NMIP4Config *
-nm_device_get_ip4_config (NMDevice *device);

Gets the current NMIP4Config associated with the NMDevice.

Parameters

nm_device_get_state ()

NMDeviceState       nm_device_get_state                 (NMDevice *device);

+Gets the current NMDevice state. +

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

device	a NMDevice
`device` :	a NMDevice +
Returns :	the current device state

Returns

the NMIP4Config or NULL if the device is not activated.

[transfer none]

nm_device_get_dhcp4_config ()

NMDHCP4Config *
-nm_device_get_dhcp4_config (NMDevice *device);

Gets the current NMDHCP4Config associated with the NMDevice.

Parameters

nm_device_get_state_reason ()

NMDeviceState       nm_device_get_state_reason          (NMDevice *device,
+                                                         NMDeviceStateReason *reason);

+Gets the current NMDevice state (return value) and the reason for entering +the state (reason argument). +

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

device	a NMDevice
`device` :	a NMDevice +
`reason` :	location to store reason (NMDeviceStateReason), or `NULL`. [out][allow-none] +
Returns :	the current device state

Returns

the NMDHCP4Config or NULL if the device is not activated or not -using DHCP.

[transfer none]

nm_device_get_ip6_config ()

NMIP6Config *
-nm_device_get_ip6_config (NMDevice *device);

Gets the current NMIP6Config associated with the NMDevice.

Parameters

nm_device_get_active_connection ()

NMActiveConnection * nm_device_get_active_connection    (NMDevice *device);

+Gets the NMActiveConnection object which owns this device during activation. +

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

device	a NMDevice
`device` :	a NMDevice +
Returns :	the NMActiveConnection or `NULL` if the device is +not part of an active connection. [transfer none] +

Returns

the NMIP6Config or NULL if the device is not activated.

[transfer none]

nm_device_get_dhcp6_config ()

NMDHCP6Config *
-nm_device_get_dhcp6_config (NMDevice *device);

Gets the current NMDHCP6Config associated with the NMDevice.

Parameters

nm_device_get_available_connections ()

const GPtrArray *   nm_device_get_available_connections (NMDevice *device);

+Gets the NMRemoteConnections currently known to the daemon that could +be activated on device. +

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

device	a NMDevice
`device` :	a NMDevice +
Returns :	the GPtrArray +containing NMRemoteConnections. This is the internal copy used by +the connection, and must not be modified. [element-type NMClient.RemoteConnection] +

Returns

the NMDHCP6Config or NULL if the device is not activated or not -using DHCP.

[transfer none]

Since 0.9.8

nm_device_get_state ()

NMDeviceState
-nm_device_get_state (NMDevice *device);

Gets the current NMDevice state.

Parameters

nm_device_get_physical_port_id ()

const char *        nm_device_get_physical_port_id      (NMDevice *device);

+Gets the physical port ID of the NMDevice. If non-NULL, this is +an opaque string that can be used to recognize when +seemingly-unrelated NMDevices are actually just different virtual +ports on a single physical port. (Eg, NPAR / SR-IOV.) +

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

device	a NMDevice
`device` :	a NMDevice +
Returns :	the physical port ID of the device, or `NULL` if the port +ID is unknown. This is the internal string used by the device and +must not be modified.

Returns

the current device state

Since 0.9.10

nm_device_get_state_reason ()

NMDeviceState
-nm_device_get_state_reason (NMDevice *device,
-                            NMDeviceStateReason *reason);

Gets the current NMDevice state (return value) and the reason for entering -the state (reason - argument).

Parameters

nm_device_get_mtu ()

guint32             nm_device_get_mtu                   (NMDevice *device);

+Gets the MTU of the NMDevice. +

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

device	a NMDevice		`device` :	a NMDevice +
reason	location to store reason (NMDeviceStateReason), or `NULL`.	[out][allow-none]	Returns :	the MTU of the device.

Returns

the current device state

Since 0.9.10

nm_device_get_active_connection ()

NMActiveConnection *
-nm_device_get_active_connection (NMDevice *device);

Gets the NMActiveConnection object which owns this device during activation.

Parameters

nm_device_get_product ()

const char *        nm_device_get_product               (NMDevice *device);

+Gets the product string of the NMDevice. +

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

device	a NMDevice
`device` :	a NMDevice +
Returns :	the product name of the device. This is the internal string used by the +device, and must not be modified.

Returns

the NMActiveConnection or NULL if the device is -not part of an active connection.

[transfer none]

nm_device_get_available_connections ()

const GPtrArray *
-nm_device_get_available_connections (NMDevice *device);

Gets the NMRemoteConnections currently known to the daemon that could -be activated on device -.

Parameters

nm_device_get_vendor ()

const char *        nm_device_get_vendor                (NMDevice *device);

+Gets the vendor string of the NMDevice. +

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

device	a NMDevice
`device` :	a NMDevice +
Returns :	the vendor name of the device. This is the internal string used by the +device, and must not be modified.

Returns

the GPtrArray -containing NMRemoteConnections. This is the internal copy used by -the connection, and must not be modified.

[element-type NMClient.RemoteConnection]

Since 0.9.8

nm_device_get_product ()

const char *
-nm_device_get_product (NMDevice *device);

Gets the product string of the NMDevice.

Parameters

nm_device_get_description ()

const char *        nm_device_get_description           (NMDevice *device);

+Gets a description of device, incorporating the results of +nm_device_get_short_vendor() and nm_device_get_short_product(). +

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

device	a NMDevice
`device` :	an NMDevice +
Returns :	a description of `device`. If either the vendor or the +product name is unknown, this returns the interface name.

Returns

the product name of the device. This is the internal string used by the -device, and must not be modified.

Since 0.9.10

nm_device_get_vendor ()

const char *
-nm_device_get_vendor (NMDevice *device);

Gets the vendor string of the NMDevice.

Parameters

nm_device_disambiguate_names ()

char **             nm_device_disambiguate_names        (NMDevice **devices,
+                                                         int num_devices);

+Generates a list of short-ish unique presentation names for the +devices in devices. +

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

device	a NMDevice
`devices` :	an array of NMDevice. [array length=num_devices] +
`num_devices` :	length of `devices` +
Returns :	the device names. [transfer full][array zero-terminated=1] +

Returns

the vendor name of the device. This is the internal string used by the -device, and must not be modified.

Since 0.9.10

NMDeviceDeactivateFn ()

void
-(*NMDeviceDeactivateFn) (NMDevice *device,
-                         GError *error,
-                         gpointer user_data);

NMDeviceDeactivateFn ()

void                (*NMDeviceDeactivateFn)             (NMDevice *device,
+                                                         GError *error,
+                                                         gpointer user_data);

nm_device_disconnect ()

void
-nm_device_disconnect (NMDevice *device,
-                      NMDeviceDeactivateFn callback,
-                      gpointer user_data);

Disconnects the device if currently connected, and prevents the device from +

nm_device_disconnect ()

void                nm_device_disconnect                (NMDevice *device,
+                                                         NMDeviceDeactivateFn callback,
+                                                         gpointer user_data);

+Disconnects the device if currently connected, and prevents the device from automatically connecting to networks until the next manual network connection -request.

Parameters

+request. +

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

device	a NMDevice		`device` :	a NMDevice +
callback	callback to be called when disconnect -operation completes.	[scope async][allow-none]	`callback` :	callback to be called when disconnect +operation completes. [scope async][allow-none] +
user_data	caller-specific data passed to `callback` -.	[closure]	`user_data` :	caller-specific data passed to `callback`. [closure] +

nm_device_filter_connections ()

GSList *
-nm_device_filter_connections (NMDevice *device,
-                              const GSList *connections);

Filters a given list of connections for a given NMDevice object and return +

nm_device_filter_connections ()

GSList *            nm_device_filter_connections        (NMDevice *device,
+                                                         const GSList *connections);

+Filters a given list of connections for a given NMDevice object and return connections which may be activated with the device. For example if device - -is a WiFi device that supports only WEP encryption, the returned list will -contain any WiFi connections in connections - that allow connection to +is a Wi-Fi device that supports only WEP encryption, the returned list will +contain any Wi-Fi connections in connections that allow connection to unencrypted or WEP-enabled SSIDs. The returned list will not contain -Ethernet, Bluetooth, WiFi WPA connections, or any other connection that is +Ethernet, Bluetooth, Wi-Fi WPA connections, or any other connection that is incompatible with the device. To get the full list of connections see -nm_remote_settings_list_connections().

Parameters

+nm_remote_settings_list_connections(). +

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

device	an NMDevice to filter connections for		`device` :	an NMDevice to filter connections for
connections	a list of NMConnection objects to filter.	[element-type NetworkManager.Connection]	`connections` :	a list of NMConnection objects to filter. [element-type NetworkManager.Connection] +

Returns

a -list of NMConnection objects that could be activated with the given device -. + +

Returns :

+a +list of NMConnection objects that could be activated with the given device. The elements of the list are owned by their creator and should not be freed by the caller, but the returned list itself is owned by the caller and should -be freed with g_slist_free() when it is no longer required.

[transfer container][element-type NetworkManager.Connection]

+be freed with g_slist_free() when it is no longer required. [transfer container][element-type NetworkManager.Connection] + + + +

nm_device_connection_valid ()

gboolean
-nm_device_connection_valid (NMDevice *device,
-                            NMConnection *connection);

Validates a given connection for a given NMDevice object and returns +

nm_device_connection_valid ()

gboolean            nm_device_connection_valid          (NMDevice *device,
+                                                         NMConnection *connection);

+Validates a given connection for a given NMDevice object and returns whether the connection may be activated with the device. For example if -device - is a WiFi device that supports only WEP encryption, the connection -will only be valid if it is a WiFi connection which describes a WEP or open +device is a Wi-Fi device that supports only WEP encryption, the connection +will only be valid if it is a Wi-Fi connection which describes a WEP or open network, and will not be valid if it describes a WPA network, or if it is an Ethernet, Bluetooth, WWAN, etc connection that is incompatible with the -device.

Parameters

+device. +

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

device	an NMDevice to validate `connection` -against	`device` :	an NMDevice to validate `connection` against
`connection` :	an NMConnection to validate against `device` +
connection	an NMConnection to validate against `device` -	Returns :	+`TRUE` if the connection may be activated with this device, `FALSE` +if is incompatible with the device's capabilities and characteristics.

Returns

TRUE if the connection may be activated with this device, FALSE -if is incompatible with the device's capabilities and characteristics.

nm_device_connection_compatible ()

gboolean
-nm_device_connection_compatible (NMDevice *device,
-                                 NMConnection *connection,
-                                 GError **error);

Validates a given connection for a given NMDevice object and returns +

nm_device_connection_compatible ()

gboolean            nm_device_connection_compatible     (NMDevice *device,
+                                                         NMConnection *connection,
+                                                         GError **error);

This function does the same as nm_device_connection_valid(), i.e. checking +device. +

+This function does the same as nm_device_connection_valid(), i.e. checking compatibility of the given device and connection. But, in addition, it sets -GError when FALSE is returned.

Parameters

+GError when FALSE is returned. +

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

device	an NMDevice to validate `connection` -against	`device` :	an NMDevice to validate `connection` against
`connection` :	an NMConnection to validate against `device` +
connection	an NMConnection to validate against `device` -	`error` :	return location for a GError, or `NULL` +
error	return location for a GError, or `NULL`	Returns :	+`TRUE` if the connection may be activated with this device, `FALSE` +if is incompatible with the device's capabilities and characteristics.

Returns

TRUE if the connection may be activated with this device, FALSE -if is incompatible with the device's capabilities and characteristics.

Types and Values

NM_DEVICE_DEVICE_TYPE

#define NM_DEVICE_DEVICE_TYPE "device-type"
-

NM_DEVICE_UDI

#define NM_DEVICE_UDI "udi"
-

nm_device_get_setting_type ()

GType               nm_device_get_setting_type          (NMDevice *device);

+Gets the (primary) NMSetting subtype associated with connections +that can be used on device.

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

`device` :	an NMDevice +
Returns :	+`device`'s associated NMSetting type

Since 0.9.10

NM_DEVICE_INTERFACE

#define NM_DEVICE_INTERFACE "interface"
-

Property Details

NM_DEVICE_IP_INTERFACE

#define NM_DEVICE_IP_INTERFACE "ip-interface"
-

The `"active-connection"` property

  "active-connection"        NMActiveConnection*   : Read

+The NMActiveConnection object that "owns" this device during activation.

NM_DEVICE_DRIVER

#define NM_DEVICE_DRIVER "driver"
-

The `"autoconnect"` property

  "autoconnect"              gboolean              : Read / Write

+Whether the device can auto-activate a connection.

Default value: TRUE

NM_DEVICE_DRIVER_VERSION

#define NM_DEVICE_DRIVER_VERSION "driver-version"
-

The `"available-connections"` property

  "available-connections"    NMObjectArray*        : Read

+The available connections (NMRemoteConnection) of the device

Since 0.9.8

NM_DEVICE_FIRMWARE_VERSION

#define NM_DEVICE_FIRMWARE_VERSION "firmware-version"
-

The `"capabilities"` property

  "capabilities"             guint                 : Read

+The capabilities of the device.

Default value: 0

NM_DEVICE_CAPABILITIES

#define NM_DEVICE_CAPABILITIES "capabilities"
-

The `"device-type"` property

  "device-type"              guint                 : Read

+The numeric type of the device.

Default value: 0

NM_DEVICE_MANAGED

#define NM_DEVICE_MANAGED "managed"
-

The `"dhcp4-config"` property

  "dhcp4-config"             NMDHCP4Config*        : Read

+The NMDHCP4Config of the device.

NM_DEVICE_AUTOCONNECT

#define NM_DEVICE_AUTOCONNECT "autoconnect"
-

The `"dhcp6-config"` property

  "dhcp6-config"             NMDHCP6Config*        : Read

+The NMDHCP6Config of the device.

NM_DEVICE_FIRMWARE_MISSING

#define NM_DEVICE_FIRMWARE_MISSING "firmware-missing"
-

The `"driver"` property

  "driver"                   gchar*                : Read

+The driver of the device.

Default value: NULL

NM_DEVICE_IP4_CONFIG

#define NM_DEVICE_IP4_CONFIG "ip4-config"
-

The `"driver-version"` property

  "driver-version"           gchar*                : Read

+The version of the device driver.

Default value: NULL

NM_DEVICE_DHCP4_CONFIG

#define NM_DEVICE_DHCP4_CONFIG "dhcp4-config"
-

The `"firmware-missing"` property

  "firmware-missing"         gboolean              : Read

+When TRUE indicates the device is likely missing firmware required +for its operation.

Default value: FALSE

NM_DEVICE_IP6_CONFIG

#define NM_DEVICE_IP6_CONFIG "ip6-config"
-

The `"firmware-version"` property

  "firmware-version"         gchar*                : Read

+The firmware version of the device.

Default value: NULL

NM_DEVICE_DHCP6_CONFIG

#define NM_DEVICE_DHCP6_CONFIG "dhcp6-config"
-

The `"interface"` property

  "interface"                gchar*                : Read

+The interface of the device.

Default value: NULL

NM_DEVICE_STATE

#define NM_DEVICE_STATE "state"
-

The `"ip-interface"` property

  "ip-interface"             gchar*                : Read

+The IP interface of the device which should be used for all IP-related +operations like addressing and routing.

Default value: NULL

NM_DEVICE_STATE_REASON

#define NM_DEVICE_STATE_REASON "state-reason"
-

The `"ip4-config"` property

  "ip4-config"               NMIP4Config*          : Read

+The NMIP4Config of the device.

NM_DEVICE_ACTIVE_CONNECTION

#define NM_DEVICE_ACTIVE_CONNECTION "active-connection"
-

The `"ip6-config"` property

  "ip6-config"               NMIP6Config*          : Read

+The NMIP6Config of the device.

NM_DEVICE_AVAILABLE_CONNECTIONS

#define NM_DEVICE_AVAILABLE_CONNECTIONS "available-connections"
-

The `"managed"` property

  "managed"                  gboolean              : Read

+Whether the device is managed by NetworkManager.

Default value: FALSE

NM_DEVICE_VENDOR

#define NM_DEVICE_VENDOR "vendor"
-

The `"mtu"` property

  "mtu"                      guint                 : Read

+The MTU of the device.

Default value: 1500

Since 0.9.10

NM_DEVICE_PRODUCT

#define NM_DEVICE_PRODUCT "product"
-

The `"physical-port-id"` property

  "physical-port-id"         gchar*                : Read

+The physical port ID of the device. (See +nm_device_get_physical_port_id().)

Property Details

The `“active-connection”` property

  “active-connection”        NMActiveConnection *

Active Connection.

Flags: Read

The `“autoconnect”` property

  “autoconnect”              gboolean

Autoconnect.

Flags: Read / Write

Default value: TRUE

The `“available-connections”` property

  “available-connections”    NMObjectArray *

Available Connections.

Flags: Read

Since 0.9.8

The `“capabilities”` property

  “capabilities”             guint

Capabilities.

Flags: Read

Default value: 0

The `“device-type”` property

  “device-type”              guint

Numeric device type (ie ethernet, wifi, etc).

Flags: Read

Default value: 0

The `“dhcp4-config”` property

  “dhcp4-config”             NMDHCP4Config *

DHCP4 Config.

Flags: Read

The `“dhcp6-config”` property

  “dhcp6-config”             NMDHCP6Config *

DHCP6 Config.

Flags: Read

The `“driver”` property

  “driver”                   gchar *

Driver.

Flags: Read

Default value: NULL

The `“driver-version”` property

  “driver-version”           gchar *

Driver Version.

Flags: Read

Default value: NULL

The `“firmware-missing”` property

  “firmware-missing”         gboolean

Firmware missing.

Flags: Read

Default value: FALSE

The `“firmware-version”` property

  “firmware-version”         gchar *

Firmware Version.

Flags: Read

Default value: NULL

The `“interface”` property

  “interface”                gchar *

Interface name.

Flags: Read

Default value: NULL

The `“ip-interface”` property

  “ip-interface”             gchar *

IP Interface name.

Flags: Read

Default value: NULL

Since 0.9.10

The `“ip4-config”` property

  “ip4-config”               NMIP4Config *

IP4 Config.

Flags: Read

The `“ip6-config”` property

  “ip6-config”               NMIP6Config *

IP6 Config.

Flags: Read

The `“managed”` property

  “managed”                  gboolean

Managed.

Flags: Read

Default value: FALSE

The `“product”` property

  “product”                  gchar *

Product string.

Flags: Read

The `"product"` property

  "product"                  gchar*                : Read

+The product string of the device. +

Default value: NULL

The `“state”` property

  “state”                    guint

State.

Flags: Read

The `"state"` property

  "state"                    guint                 : Read

+The state of the device. +

Default value: 0

The `“state-reason”` property

  “state-reason”             GValueArray_guint+guint_*

StateReason.

Flags: Read

The `"state-reason"` property

  "state-reason"             GValueArray_guint+guint_*  : Read

+The state and reason of the device. +

The `“udi”` property

  “udi”                      gchar *

Unique Device Identifier.

Flags: Read

The `"udi"` property

  "udi"                      gchar*                : Read

+An operating-system specific device hardware identifier; this is not +unique to a specific hardware device across reboots or hotplugs. It +is an opaque string which for some device types (Bluetooth, Modem) +contains an identifier provided by the underlying hardware service daemon +such as Bluez or ModemManager, and clients can use this property to +request more information about the device from those services. +

Default value: NULL

The `“vendor”` property

  “vendor”                   gchar *

Vendor string.

Flags: Read

The `"vendor"` property

  "vendor"                   gchar*                : Read

+The vendor string of the device. +

Default value: NULL

Signal Details

The `“state-changed”` signal

void
-user_function (NMDevice *device,
-               guint     new_state,
-               guint     old_state,
-               guint     reason,
-               gpointer  user_data)

Flags: Run First

The `"state-changed"` signal

void                user_function                      (NMDevice *device,
+                                                        guint     new_state,
+                                                        guint     old_state,
+                                                        guint     reason,
+                                                        gpointer  user_data)      : Run First

+Notifies the state change of a NMDevice. +

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

`device` :	the device object that received the signal
`new_state` :	the new state of the device
`old_state` :	the previous state of the device
`reason` :	the reason describing the state change
`user_data` :	user data set when the signal handler was connected.

+ Generated by GTK-Doc V1.19

			libnm-glib Reference Manual
+Top + \| + Description + \| + Object Hierarchy + \| + Implemented Interfaces + \| + Properties + \| + Signals +