NMSettingConnection

@@ -37,1210 +31,1533 @@

NMSettingConnection

NMSettingConnection — Describes general connection properties

- +

Synopsis

#define             NM_SETTING_CONNECTION_SETTING_NAME
-#define             NM_SETTING_CONNECTION_AUTOCONNECT_PRIORITY_MIN
-#define             NM_SETTING_CONNECTION_AUTOCONNECT_PRIORITY_MAX
-#define             NM_SETTING_CONNECTION_AUTOCONNECT_PRIORITY_DEFAULT
-#define             NM_SETTING_CONNECTION_ID
-#define             NM_SETTING_CONNECTION_UUID
-#define             NM_SETTING_CONNECTION_INTERFACE_NAME
-#define             NM_SETTING_CONNECTION_TYPE
-#define             NM_SETTING_CONNECTION_AUTOCONNECT
-#define             NM_SETTING_CONNECTION_AUTOCONNECT_PRIORITY
-#define             NM_SETTING_CONNECTION_TIMESTAMP
-#define             NM_SETTING_CONNECTION_READ_ONLY
-#define             NM_SETTING_CONNECTION_PERMISSIONS
-#define             NM_SETTING_CONNECTION_ZONE
-#define             NM_SETTING_CONNECTION_MASTER
-#define             NM_SETTING_CONNECTION_SLAVE_TYPE
-#define             NM_SETTING_CONNECTION_SECONDARIES
-#define             NM_SETTING_CONNECTION_GATEWAY_PING_TIMEOUT
-struct              NMSettingConnection;
-                    NMSettingConnectionClass;
-NMSetting *         nm_setting_connection_new           (void);
-const char *        nm_setting_connection_get_id        (NMSettingConnection *setting);
-const char *        nm_setting_connection_get_uuid      (NMSettingConnection *setting);
-const char *        nm_setting_connection_get_interface_name
-                                                        (NMSettingConnection *setting);
-const char *        nm_setting_connection_get_connection_type
-                                                        (NMSettingConnection *setting);
-gboolean            nm_setting_connection_get_autoconnect
-                                                        (NMSettingConnection *setting);
-gint                nm_setting_connection_get_autoconnect_priority
-                                                        (NMSettingConnection *setting);
-guint64             nm_setting_connection_get_timestamp (NMSettingConnection *setting);
-gboolean            nm_setting_connection_get_read_only (NMSettingConnection *setting);
-guint32             nm_setting_connection_get_num_permissions
-                                                        (NMSettingConnection *setting);
-gboolean            nm_setting_connection_get_permission
-                                                        (NMSettingConnection *setting,
-                                                         guint32 idx,
-                                                         const char **out_ptype,
-                                                         const char **out_pitem,
-                                                         const char **out_detail);
-const char *        nm_setting_connection_get_zone      (NMSettingConnection *setting);
-gboolean            nm_setting_connection_permissions_user_allowed
-                                                        (NMSettingConnection *setting,
-                                                         const char *uname);
-gboolean            nm_setting_connection_add_permission
-                                                        (NMSettingConnection *setting,
-                                                         const char *ptype,
-                                                         const char *pitem,
-                                                         const char *detail);
-void                nm_setting_connection_remove_permission
-                                                        (NMSettingConnection *setting,
-                                                         guint32 idx);
-gboolean            nm_setting_connection_remove_permission_by_value
-                                                        (NMSettingConnection *setting,
-                                                         const char *ptype,
-                                                         const char *pitem,
-                                                         const char *detail);
-const char *        nm_setting_connection_get_master    (NMSettingConnection *setting);
-gboolean            nm_setting_connection_is_slave_type (NMSettingConnection *setting,
-                                                         const char *type);
-const char *        nm_setting_connection_get_slave_type
-                                                        (NMSettingConnection *setting);
-guint32             nm_setting_connection_get_num_secondaries
-                                                        (NMSettingConnection *setting);
-const char *        nm_setting_connection_get_secondary (NMSettingConnection *setting,
-                                                         guint32 idx);
-gboolean            nm_setting_connection_add_secondary (NMSettingConnection *setting,
-                                                         const char *sec_uuid);
-void                nm_setting_connection_remove_secondary
-                                                        (NMSettingConnection *setting,
-                                                         guint32 idx);
-gboolean            nm_setting_connection_remove_secondary_by_value
-                                                        (NMSettingConnection *setting,
-                                                         const char *sec_uuid);
-guint32             nm_setting_connection_get_gateway_ping_timeout
-                                                        (NMSettingConnection *setting);
-

Object Hierarchy

-  GObject
-   +----NMSetting
-         +----NMSettingConnection
-

Properties

-  "autoconnect"              gboolean              : Read / Write / Construct
-  "autoconnect-priority"     gint                  : Read / Write / Construct
-  "gateway-ping-timeout"     guint                 : Read / Write / Construct
-  "id"                       gchar*                : Read / Write
-  "interface-name"           gchar*                : Read / Write
-  "master"                   gchar*                : Read / Write
-  "permissions"              GStrv                 : Read / Write
-  "read-only"                gboolean              : Read / Write / Construct
-  "secondaries"              GStrv                 : Read / Write
-  "slave-type"               gchar*                : Read / Write
-  "timestamp"                guint64               : Read / Write / Construct
-  "type"                     gchar*                : Read / Write
-  "uuid"                     gchar*                : Read / Write
-  "zone"                     gchar*                : Read / Write / Construct
-

Description

-The NMSettingConnection object is a NMSetting subclass that describes -properties that apply to all NMConnection objects, regardless of what type -of network connection they describe. Each NMConnection object must contain -a NMSettingConnection setting. -

Details

NM_SETTING_CONNECTION_SETTING_NAME

#define NM_SETTING_CONNECTION_SETTING_NAME "connection"
-

NM_SETTING_CONNECTION_AUTOCONNECT_PRIORITY_MIN

#define NM_SETTING_CONNECTION_AUTOCONNECT_PRIORITY_MIN -999
-

NM_SETTING_CONNECTION_AUTOCONNECT_PRIORITY_MAX

#define NM_SETTING_CONNECTION_AUTOCONNECT_PRIORITY_MAX 999
-

NM_SETTING_CONNECTION_AUTOCONNECT_PRIORITY_DEFAULT

#define NM_SETTING_CONNECTION_AUTOCONNECT_PRIORITY_DEFAULT 0
-

NM_SETTING_CONNECTION_ID

#define NM_SETTING_CONNECTION_ID             "id"
-

NM_SETTING_CONNECTION_UUID

#define NM_SETTING_CONNECTION_UUID           "uuid"
-

NM_SETTING_CONNECTION_INTERFACE_NAME

#define NM_SETTING_CONNECTION_INTERFACE_NAME "interface-name"
-

NM_SETTING_CONNECTION_TYPE

#define NM_SETTING_CONNECTION_TYPE           "type"
-

NM_SETTING_CONNECTION_AUTOCONNECT

#define NM_SETTING_CONNECTION_AUTOCONNECT    "autoconnect"
-

NM_SETTING_CONNECTION_AUTOCONNECT_PRIORITY

#define NM_SETTING_CONNECTION_AUTOCONNECT_PRIORITY "autoconnect-priority"
-

NM_SETTING_CONNECTION_TIMESTAMP

#define NM_SETTING_CONNECTION_TIMESTAMP      "timestamp"
-

NM_SETTING_CONNECTION_READ_ONLY

#define NM_SETTING_CONNECTION_READ_ONLY      "read-only"
-

NM_SETTING_CONNECTION_PERMISSIONS

#define NM_SETTING_CONNECTION_PERMISSIONS    "permissions"
-

NM_SETTING_CONNECTION_ZONE

#define NM_SETTING_CONNECTION_ZONE           "zone"
-

NM_SETTING_CONNECTION_MASTER

#define NM_SETTING_CONNECTION_MASTER         "master"
-

NM_SETTING_CONNECTION_SLAVE_TYPE

#define NM_SETTING_CONNECTION_SLAVE_TYPE     "slave-type"
-

NM_SETTING_CONNECTION_SECONDARIES

#define NM_SETTING_CONNECTION_SECONDARIES    "secondaries"
-

NM_SETTING_CONNECTION_GATEWAY_PING_TIMEOUT

#define NM_SETTING_CONNECTION_GATEWAY_PING_TIMEOUT "gateway-ping-timeout"
-

struct NMSettingConnection

struct NMSettingConnection;

-The NMSettingConnection struct contains only private data. -It should only be accessed through the functions described below. -

NMSettingConnectionClass

typedef struct {
-	NMSettingClass parent;
-} NMSettingConnectionClass;
-

nm_setting_connection_new ()

NMSetting *         nm_setting_connection_new           (void);

-Creates a new NMSettingConnection object with default values. -

---- - - - - -

Returns :

the new empty NMSettingConnection object

nm_setting_connection_get_id ()

const char *        nm_setting_connection_get_id        (NMSettingConnection *setting);

-Returns the "id" property of the connection. -

Functions

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

`setting` :	the NMSettingConnection +	+NMSetting * +	+nm_setting_connection_new () +
const char * +	+nm_setting_connection_get_id () +
const char * +	+nm_setting_connection_get_uuid () +
const char * +	+nm_setting_connection_get_interface_name () +
const char * +	+nm_setting_connection_get_connection_type () +
+gboolean +	+nm_setting_connection_get_autoconnect () +
+gint +	+nm_setting_connection_get_autoconnect_priority () +
+guint64 +	+nm_setting_connection_get_timestamp () +
+gboolean +	+nm_setting_connection_get_read_only () +
+guint32 +	+nm_setting_connection_get_num_permissions () +
+gboolean +	+nm_setting_connection_get_permission () +
const char * +	+nm_setting_connection_get_zone () +
+gboolean +	+nm_setting_connection_permissions_user_allowed () +
+gboolean +	+nm_setting_connection_add_permission () +
+void +	+nm_setting_connection_remove_permission () +
+gboolean +	+nm_setting_connection_remove_permission_by_value () +
const char * +	+nm_setting_connection_get_master () +
+gboolean +	+nm_setting_connection_is_slave_type () +
const char * +	+nm_setting_connection_get_slave_type () +
+guint32 +	+nm_setting_connection_get_num_secondaries () +
const char * +	+nm_setting_connection_get_secondary () +
+gboolean +	+nm_setting_connection_add_secondary () +
+void +	+nm_setting_connection_remove_secondary () +
+gboolean +	+nm_setting_connection_remove_secondary_by_value ()
Returns :	the connection ID	+guint32 +	+nm_setting_connection_get_gateway_ping_timeout () +

nm_setting_connection_get_uuid ()

const char *        nm_setting_connection_get_uuid      (NMSettingConnection *setting);

-Returns the "uuid" property of the connection. -

Properties

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

`setting` :	the NMSettingConnection -	gboolean	autoconnect	Read / Write / Construct
gint	autoconnect-priority	Read / Write / Construct
guint	gateway-ping-timeout	Read / Write / Construct
+gchar *	id	Read / Write
+gchar *	interface-name	Read / Write
+gchar *	master	Read / Write
GStrv	permissions	Read / Write
gboolean	read-only	Read / Write / Construct
Returns :	the connection UUID	GStrv	secondaries	Read / Write
+gchar *	slave-type	Read / Write
guint64	timestamp	Read / Write / Construct
+gchar *	type	Read / Write
+gchar *	uuid	Read / Write
+gchar *	zone	Read / Write / Construct

nm_setting_connection_get_interface_name ()

const char *        nm_setting_connection_get_interface_name
-                                                        (NMSettingConnection *setting);

-Returns the "interface-name" property of the connection. -

Types and Values

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

`setting` :	the NMSettingConnection -	#define	NM_SETTING_CONNECTION_SETTING_NAME
#define	NM_SETTING_CONNECTION_AUTOCONNECT_PRIORITY_MIN
#define	NM_SETTING_CONNECTION_AUTOCONNECT_PRIORITY_MAX
#define	NM_SETTING_CONNECTION_AUTOCONNECT_PRIORITY_DEFAULT
#define	NM_SETTING_CONNECTION_ID
#define	NM_SETTING_CONNECTION_UUID
#define	NM_SETTING_CONNECTION_INTERFACE_NAME
#define	NM_SETTING_CONNECTION_TYPE
#define	NM_SETTING_CONNECTION_AUTOCONNECT
Returns :	the connection's interface name	#define	NM_SETTING_CONNECTION_AUTOCONNECT_PRIORITY
#define	NM_SETTING_CONNECTION_TIMESTAMP
#define	NM_SETTING_CONNECTION_READ_ONLY
#define	NM_SETTING_CONNECTION_PERMISSIONS
#define	NM_SETTING_CONNECTION_ZONE
#define	NM_SETTING_CONNECTION_MASTER
#define	NM_SETTING_CONNECTION_SLAVE_TYPE
#define	NM_SETTING_CONNECTION_SECONDARIES
#define	NM_SETTING_CONNECTION_GATEWAY_PING_TIMEOUT
struct	NMSettingConnection

Object Hierarchy

    GObject
+    ╰── NMSetting
+        ╰── NMSettingConnection
+

Description

The NMSettingConnection object is a NMSetting subclass that describes +properties that apply to all NMConnection objects, regardless of what type +of network connection they describe. Each NMConnection object must contain +a NMSettingConnection setting.

Functions

nm_setting_connection_new ()

NMSetting *
+nm_setting_connection_new (void);

Creates a new NMSettingConnection object with default values.

Returns

the new empty NMSettingConnection object

nm_setting_connection_get_connection_type ()

const char *        nm_setting_connection_get_connection_type
-                                                        (NMSettingConnection *setting);

-Returns the "type" property of the connection. -

nm_setting_connection_get_id ()

const char *
+nm_setting_connection_get_id (NMSettingConnection *setting);

Returns the “id” property of the connection.

Parameters

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

`setting` :	the NMSettingConnection -
Returns :	the connection type
setting	the NMSettingConnection

Returns

the connection ID

nm_setting_connection_get_autoconnect ()

gboolean            nm_setting_connection_get_autoconnect
-                                                        (NMSettingConnection *setting);

-Returns the "autoconnect" property of the connection. -

nm_setting_connection_get_uuid ()

const char *
+nm_setting_connection_get_uuid (NMSettingConnection *setting);

Returns the “uuid” property of the connection.

Parameters

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

`setting` :	the NMSettingConnection -
Returns :	the connection's autoconnect behavior
setting	the NMSettingConnection

Returns

the connection UUID

nm_setting_connection_get_autoconnect_priority ()

gint                nm_setting_connection_get_autoconnect_priority
-                                                        (NMSettingConnection *setting);

-Returns the "autoconnect-priority" property of the connection. -The higher number, the higher priority. -

nm_setting_connection_get_interface_name ()

const char *
+nm_setting_connection_get_interface_name
+                               (NMSettingConnection *setting);

Returns the “interface-name” property of the connection.

Parameters

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

`setting` :	the NMSettingConnection -
Returns :	the connection's autoconnect priority
setting	the NMSettingConnection

Returns

the connection's interface name

Property Details

Types and Values

The `"autoconnect"` property

  "autoconnect"              gboolean              : Read / Write / Construct

NM_SETTING_CONNECTION_SETTING_NAME

#define NM_SETTING_CONNECTION_SETTING_NAME "connection"
+

-Whether or not the connection should be automatically connected by -NetworkManager when the resources for the connection are available. -TRUE to automatically activate the connection, FALSE to require manual -intervention to activate the connection.

Default value: TRUE

The `"autoconnect-priority"` property

  "autoconnect-priority"     gint                  : Read / Write / Construct

NM_SETTING_CONNECTION_AUTOCONNECT_PRIORITY_MIN

#define NM_SETTING_CONNECTION_AUTOCONNECT_PRIORITY_MIN -999
+

-The autoconnect priority. If the connection is set to autoconnect, -connections with higher priority will be preferred. Defaults to 0. -The higher number means higher priority.

Allowed values: [-999,999]

Default value: 0

The `"gateway-ping-timeout"` property

  "gateway-ping-timeout"     guint                 : Read / Write / Construct

NM_SETTING_CONNECTION_AUTOCONNECT_PRIORITY_MAX

#define NM_SETTING_CONNECTION_AUTOCONNECT_PRIORITY_MAX 999
+

-If greater than zero, delay success of IP addressing until either the -timeout is reached, or an IP gateway replies to a ping.

Allowed values: <= 30

Default value: 0

The `"id"` property

  "id"                       gchar*                : Read / Write

NM_SETTING_CONNECTION_AUTOCONNECT_PRIORITY_DEFAULT

#define NM_SETTING_CONNECTION_AUTOCONNECT_PRIORITY_DEFAULT 0
+

-A human readable unique identifier for the connection, like "Work Wi-Fi" -or "T-Mobile 3G".

Default value: NULL

The `"interface-name"` property

  "interface-name"           gchar*                : Read / Write

NM_SETTING_CONNECTION_ID

#define NM_SETTING_CONNECTION_ID             "id"
+

-The name of the network interface this connection is bound to. If not -set, then the connection can be attached to any interface of the -appropriate type (subject to restrictions imposed by other settings).

NM_SETTING_CONNECTION_UUID

#define NM_SETTING_CONNECTION_UUID           "uuid"
+

-For software devices this specifies the name of the created device.

NM_SETTING_CONNECTION_INTERFACE_NAME

#define NM_SETTING_CONNECTION_INTERFACE_NAME "interface-name"
+

-For connection types where interface names cannot easily be made -persistent (e.g. mobile broadband or USB Ethernet), this property should -not be used. Setting this property restricts the interfaces a connection -can be used with, and if interface names change or are reordered the -connection may be applied to the wrong interface.

Default value: NULL

The `"master"` property

  "master"                   gchar*                : Read / Write

NM_SETTING_CONNECTION_TYPE

#define NM_SETTING_CONNECTION_TYPE           "type"
+

NM_SETTING_CONNECTION_AUTOCONNECT

#define NM_SETTING_CONNECTION_AUTOCONNECT    "autoconnect"
+

-Interface name of the master device or UUID of the master connection.

Default value: NULL

The `"permissions"` property

  "permissions"              GStrv                 : Read / Write

NM_SETTING_CONNECTION_AUTOCONNECT_PRIORITY

#define NM_SETTING_CONNECTION_AUTOCONNECT_PRIORITY "autoconnect-priority"
+

-An array of strings defining what access a given user has to this -connection. If this is NULL or empty, all users are allowed to access -this connection. Otherwise a user is allowed to access this connection -if and only if they are in this list. Each entry is of the form -"[type]:[id]:[reserved]"; for example, "user:dcbw:blah".

NM_SETTING_CONNECTION_TIMESTAMP

#define NM_SETTING_CONNECTION_TIMESTAMP      "timestamp"
+

-At this time only the "user" [type] is allowed. Any other values are -ignored and reserved for future use. [id] is the username that this -permission refers to, which may not contain the ":" character. Any -[reserved] information present must be ignored and is reserved for future -use. All of [type], [id], and [reserved] must be valid UTF-8.

The `"read-only"` property

  "read-only"                gboolean              : Read / Write / Construct

NM_SETTING_CONNECTION_READ_ONLY

#define NM_SETTING_CONNECTION_READ_ONLY      "read-only"
+

-FALSE if the connection can be modified using the provided settings -service's D-Bus interface with the right privileges, or TRUE if the -connection is read-only and cannot be modified.

Default value: FALSE

The `"secondaries"` property

  "secondaries"              GStrv                 : Read / Write

NM_SETTING_CONNECTION_PERMISSIONS

#define NM_SETTING_CONNECTION_PERMISSIONS    "permissions"
+

-List of connection UUIDs that should be activated when the base -connection itself is activated. Currently only VPN connections are -supported.

The `"slave-type"` property

  "slave-type"               gchar*                : Read / Write

NM_SETTING_CONNECTION_ZONE

#define NM_SETTING_CONNECTION_ZONE           "zone"
+

NM_SETTING_CONNECTION_MASTER

#define NM_SETTING_CONNECTION_MASTER         "master"
+

NM_SETTING_CONNECTION_SLAVE_TYPE

#define NM_SETTING_CONNECTION_SLAVE_TYPE     "slave-type"
+

-Setting name of the device type of this slave's master connection (eg, -NM_SETTING_BOND_SETTING_NAME), or NULL if this connection is not a -slave.

Default value: NULL

The `"timestamp"` property

  "timestamp"                guint64               : Read / Write / Construct

NM_SETTING_CONNECTION_SECONDARIES

#define NM_SETTING_CONNECTION_SECONDARIES    "secondaries"
+

-The time, in seconds since the Unix Epoch, that the connection was last -_successfully_ fully activated.

NM_SETTING_CONNECTION_GATEWAY_PING_TIMEOUT

#define NM_SETTING_CONNECTION_GATEWAY_PING_TIMEOUT "gateway-ping-timeout"
+

-NetworkManager updates the connection timestamp periodically when the +

struct NMSettingConnection

struct NMSettingConnection;

The NMSettingConnection struct contains only private data. +It should only be accessed through the functions described below.

Property Details

The `“autoconnect”` property

  “autoconnect”              gboolean

Whether or not the connection should be automatically connected by +NetworkManager when the resources for the connection are available. +TRUE to automatically activate the connection, FALSE to require manual +intervention to activate the connection.

Flags: Read / Write / Construct

Default value: TRUE

The `“autoconnect-priority”` property

  “autoconnect-priority”     gint

The autoconnect priority. If the connection is set to autoconnect, +connections with higher priority will be preferred. Defaults to 0. +The higher number means higher priority.

Flags: Read / Write / Construct

Allowed values: [-999,999]

Default value: 0

The `“gateway-ping-timeout”` property

  “gateway-ping-timeout”     guint

If greater than zero, delay success of IP addressing until either the +timeout is reached, or an IP gateway replies to a ping.

Flags: Read / Write / Construct

Allowed values: <= 30

Default value: 0

The `“id”` property

  “id”                       gchar *

A human readable unique identifier for the connection, like "Work Wi-Fi" +or "T-Mobile 3G".

Flags: Read / Write

Default value: NULL

The `“interface-name”` property

  “interface-name”           gchar *

The name of the network interface this connection is bound to. If not +set, then the connection can be attached to any interface of the +appropriate type (subject to restrictions imposed by other settings).

For software devices this specifies the name of the created device.

For connection types where interface names cannot easily be made +persistent (e.g. mobile broadband or USB Ethernet), this property should +not be used. Setting this property restricts the interfaces a connection +can be used with, and if interface names change or are reordered the +connection may be applied to the wrong interface.

Flags: Read / Write

Default value: NULL

The `“master”` property

  “master”                   gchar *

Interface name of the master device or UUID of the master connection.

Flags: Read / Write

Default value: NULL

The `“permissions”` property

  “permissions”              GStrv

An array of strings defining what access a given user has to this +connection. If this is NULL or empty, all users are allowed to access +this connection. Otherwise a user is allowed to access this connection +if and only if they are in this list. Each entry is of the form +"[type]:[id]:[reserved]"; for example, "user:dcbw:blah".

At this time only the "user" [type] is allowed. Any other values are +ignored and reserved for future use. [id] is the username that this +permission refers to, which may not contain the ":" character. Any +[reserved] information present must be ignored and is reserved for future +use. All of [type], [id], and [reserved] must be valid UTF-8.

Flags: Read / Write

The `“read-only”` property

  “read-only”                gboolean

FALSE if the connection can be modified using the provided settings +service's D-Bus interface with the right privileges, or TRUE if the +connection is read-only and cannot be modified.

Flags: Read / Write / Construct

Default value: FALSE

The `“secondaries”` property

  “secondaries”              GStrv

List of connection UUIDs that should be activated when the base +connection itself is activated. Currently only VPN connections are +supported.

Flags: Read / Write

The `“slave-type”` property

  “slave-type”               gchar *

Setting name of the device type of this slave's master connection (eg, +NM_SETTING_BOND_SETTING_NAME), or NULL if this connection is not a +slave.

Flags: Read / Write

Default value: NULL

The `“timestamp”` property

  “timestamp”                guint64

The time, in seconds since the Unix Epoch, that the connection was last +_successfully_ fully activated.

NetworkManager updates the connection timestamp periodically when the connection is active to ensure that an active connection has the latest timestamp. The property is only meant for reading (changes to this -property will not be preserved). -

+property will not be preserved).

Flags: Read / Write / Construct

Default value: 0

The `"type"` property

  "type"                     gchar*                : Read / Write

-Base type of the connection. For hardware-dependent connections, should +

The `“type”` property

  “type”                     gchar *

Base type of the connection. For hardware-dependent connections, should contain the setting name of the hardware-type specific setting (ie, "802-3-ethernet" or "802-11-wireless" or "bluetooth", etc), and for non-hardware dependent connections like VPN or otherwise, should contain -the setting name of that setting type (ie, "vpn" or "bridge", etc). -

+the setting name of that setting type (ie, "vpn" or "bridge", etc).

Flags: Read / Write

Default value: NULL

The `"uuid"` property

  "uuid"                     gchar*                : Read / Write

-A universally unique identifier for the connection, for example generated +

The `“uuid”` property

  “uuid”                     gchar *

A universally unique identifier for the connection, for example generated with libuuid. It should be assigned when the connection is created, and never changed as long as the connection still applies to the same network. For example, it should not be changed when the -"id" property or NMSettingIP4Config changes, but +“id” property or NMSettingIP4Config changes, but might need to be re-created when the Wi-Fi SSID, mobile broadband network -provider, or "type" property changes. -

-The UUID must be in the format "2815492f-7e56-435e-b2e9-246bd7cdc664" +provider, or “type” property changes.

The UUID must be in the format "2815492f-7e56-435e-b2e9-246bd7cdc664" (ie, contains only hexadecimal characters and "-"). A suitable UUID may -be generated by nm_utils_uuid_generate() or -nm_utils_uuid_generate_from_string(). -

+be generated by nm_utils_uuid_generate() or +nm_utils_uuid_generate_from_string().

Flags: Read / Write

Default value: NULL

The `"zone"` property

  "zone"                     gchar*                : Read / Write / Construct

-The trust level of a the connection. Free form case-insensitive string -(for example "Home", "Work", "Public"). NULL or unspecified zone means +

The `“zone”` property

  “zone”                     gchar *

The trust level of a the connection. Free form case-insensitive string +(for example "Home", "Work", "Public"). NULL or unspecified zone means the connection will be placed in the default zone as defined by the -firewall. -

+firewall.

Flags: Read / Write / Construct

Default value: NULL

`setting` :	the NMSettingConnection -
`idx` :	the zero-based index of the permissions entry
`out_ptype` :	on return, the permission type (at this time, always "user")
`out_pitem` :	on return, the permission item (formatted accoring to `ptype`, see -"permissions" for more detail
`out_detail` :	on return, the permission detail (at this time, always `NULL`)
Returns :	-`TRUE` if a permission was returned, `FALSE` if `idx` was invalid
setting	the NMSettingConnection

`setting` :	the NMSettingConnection -	setting	the NMSettingConnection
`ptype` :	the permission type; at this time only "user" is supported	idx	the zero-based index of the permissions entry
`pitem` :	the permission item formatted as required for `ptype` -	out_ptype	on return, the permission type (at this time, always "user")
`detail` :	unused at this time; must be `NULL`. [allow-none] -	out_pitem	on return, the permission item (formatted accoring to `ptype` +, see +“permissions” for more detail
Returns :	-`TRUE` if the permission was unique and was successfully added to the -list, `FALSE` if `ptype` or `pitem` was invalid or it the permission was already -present in the list	out_detail	on return, the permission detail (at this time, always `NULL`)

`setting` :	the NMSettingConnection -
`ptype` :	the permission type; at this time only "user" is supported	setting	the NMSettingConnection
`pitem` :	the permission item formatted as required for `ptype` -	ptype	the permission type; at this time only "user" is supported
`detail` :	unused at this time; must be `NULL`. [allow-none] -	pitem	the permission item formatted as required for `ptype` +
Returns :	-`TRUE` if the permission was found and removed; `FALSE` if it was not.	detail	unused at this time; must be `NULL`.	[allow-none]

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

`setting` :	the NMSettingConnection -
`uname` :	the user name to check permissions for
Returns :	-`TRUE` if the requested user is allowed to view this connection, -`FALSE` if the given user is not allowed to view this connection
setting	the NMSettingConnection

`setting` :	the NMSettingConnection -
`sec_uuid` :	the secondary connection UUID to add	setting	the NMSettingConnection
Returns :	-`TRUE` if the secondary connection UUID was added; `FALSE` if the UUID -was already present	idx	the zero-based index of the secondary connection UUID entry

NMSettingConnection

Synopsis

Object Hierarchy

Properties

Description

Details

NM_SETTING_CONNECTION_SETTING_NAME

NM_SETTING_CONNECTION_AUTOCONNECT_PRIORITY_MIN

NM_SETTING_CONNECTION_AUTOCONNECT_PRIORITY_MAX

NM_SETTING_CONNECTION_AUTOCONNECT_PRIORITY_DEFAULT

NM_SETTING_CONNECTION_ID

NM_SETTING_CONNECTION_UUID

NM_SETTING_CONNECTION_INTERFACE_NAME

NM_SETTING_CONNECTION_TYPE

NM_SETTING_CONNECTION_AUTOCONNECT

NM_SETTING_CONNECTION_AUTOCONNECT_PRIORITY

NM_SETTING_CONNECTION_TIMESTAMP

NM_SETTING_CONNECTION_READ_ONLY

NM_SETTING_CONNECTION_PERMISSIONS

NM_SETTING_CONNECTION_ZONE

NM_SETTING_CONNECTION_MASTER

NM_SETTING_CONNECTION_SLAVE_TYPE

NM_SETTING_CONNECTION_SECONDARIES

NM_SETTING_CONNECTION_GATEWAY_PING_TIMEOUT

struct NMSettingConnection

NMSettingConnectionClass

nm_setting_connection_new ()

nm_setting_connection_get_id ()

Functions

nm_setting_connection_get_uuid ()

Properties

nm_setting_connection_get_interface_name ()

Types and Values

Object Hierarchy

Description

Functions

nm_setting_connection_new ()

Returns

nm_setting_connection_get_connection_type ()

nm_setting_connection_get_id ()

Parameters

Returns

nm_setting_connection_get_autoconnect ()

nm_setting_connection_get_uuid ()

Parameters

Returns

nm_setting_connection_get_autoconnect_priority ()

nm_setting_connection_get_interface_name ()

Parameters

Returns

nm_setting_connection_get_timestamp ()

nm_setting_connection_get_connection_type ()

Parameters

Returns

nm_setting_connection_get_read_only ()

nm_setting_connection_get_autoconnect ()

Parameters

Returns

nm_setting_connection_get_num_permissions ()

nm_setting_connection_get_autoconnect_priority ()

Parameters

Returns

nm_setting_connection_get_permission ()

nm_setting_connection_get_timestamp ()

Parameters

Returns

nm_setting_connection_get_zone ()

nm_setting_connection_get_read_only ()

Parameters

Returns

nm_setting_connection_permissions_user_allowed ()

nm_setting_connection_get_num_permissions ()

Parameters

Returns

nm_setting_connection_add_permission ()

nm_setting_connection_get_permission ()

Parameters

Returns

nm_setting_connection_remove_permission ()

nm_setting_connection_get_zone ()

The `"autoconnect"` property

The `"autoconnect-priority"` property

The `"gateway-ping-timeout"` property

The `"id"` property

The `"interface-name"` property

The `"master"` property

The `"permissions"` property

The `"read-only"` property