NMSettingConnection

NMSettingConnection — Describes general connection properties

Functions

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_stable_id ()
const char * nm_setting_connection_get_interface_name ()
const char * nm_setting_connection_get_connection_type ()
gboolean nm_setting_connection_get_autoconnect ()
int nm_setting_connection_get_autoconnect_priority ()
int nm_setting_connection_get_autoconnect_retries ()
NMConnectionMultiConnect nm_setting_connection_get_multi_connect ()
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 ()
NMSettingConnectionAutoconnectSlaves nm_setting_connection_get_autoconnect_slaves ()
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 ()
guint32 nm_setting_connection_get_gateway_ping_timeout ()
NMMetered nm_setting_connection_get_metered ()
NMSettingConnectionLldp nm_setting_connection_get_lldp ()
int nm_setting_connection_get_auth_retries ()
NMSettingConnectionMdns nm_setting_connection_get_mdns ()
NMSettingConnectionLlmnr nm_setting_connection_get_llmnr ()
gint32 nm_setting_connection_get_wait_device_timeout ()
const char * nm_setting_connection_get_mud_url ()

Properties

int auth-retries Read / Write
gboolean autoconnect Read / Write
int autoconnect-priority Read / Write
int autoconnect-retries Read / Write
NMSettingConnectionAutoconnectSlaves autoconnect-slaves Read / Write
guint gateway-ping-timeout Read / Write
char * id Read / Write
char * interface-name Read / Write
int lldp Read / Write
int llmnr Read / Write
char * master Read / Write
int mdns Read / Write
NMMetered metered Read / Write
char * mud-url Read / Write
int multi-connect Read / Write
GStrv permissions Read / Write
gboolean read-only Read / Write
GStrv secondaries Read / Write
char * slave-type Read / Write
char * stable-id Read / Write
guint64 timestamp Read / Write
char * type Read / Write
char * uuid Read / Write
int wait-device-timeout Read / Write
char * zone Read / Write

Types and Values

#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_STABLE_ID
#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_AUTOCONNECT_RETRIES
#define NM_SETTING_CONNECTION_MULTI_CONNECT
#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_AUTOCONNECT_SLAVES
#define NM_SETTING_CONNECTION_SECONDARIES
#define NM_SETTING_CONNECTION_GATEWAY_PING_TIMEOUT
#define NM_SETTING_CONNECTION_METERED
#define NM_SETTING_CONNECTION_LLDP
#define NM_SETTING_CONNECTION_AUTH_RETRIES
#define NM_SETTING_CONNECTION_MDNS
#define NM_SETTING_CONNECTION_LLMNR
#define NM_SETTING_CONNECTION_WAIT_DEVICE_TIMEOUT
#define NM_SETTING_CONNECTION_MUD_URL
enum NMSettingConnectionAutoconnectSlaves
enum NMSettingConnectionLldp
enum NMSettingConnectionMdns
enum NMSettingConnectionLlmnr
  NMSettingConnection

Object Hierarchy

    GEnum
    ├── NMSettingConnectionAutoconnectSlaves
    ├── NMSettingConnectionLldp
    ├── NMSettingConnectionLlmnr
    ╰── NMSettingConnectionMdns
    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_id ()

const char *
nm_setting_connection_get_id (NMSettingConnection *setting);

Returns the “id” property of the connection.

Parameters

setting

the NMSettingConnection

  

Returns

the connection ID

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 UUID

nm_setting_connection_get_stable_id ()

const char *
nm_setting_connection_get_stable_id (NMSettingConnection *setting);

Returns the “stable_id” property of the connection.

Parameters

setting

the NMSettingConnection

  

Returns

the stable-id for the connection

Since: 1.4

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 interface name

nm_setting_connection_get_connection_type ()

const char *
nm_setting_connection_get_connection_type
                               (NMSettingConnection *setting);

Returns the “type” property of the connection.

Parameters

setting

the NMSettingConnection

  

Returns

the connection type

nm_setting_connection_get_autoconnect ()

gboolean
nm_setting_connection_get_autoconnect (NMSettingConnection *setting);

Returns the “autoconnect” property of the connection.

Parameters

setting

the NMSettingConnection

  

Returns

the connection's autoconnect behavior

nm_setting_connection_get_autoconnect_priority ()

int
nm_setting_connection_get_autoconnect_priority
                               (NMSettingConnection *setting);

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

Parameters

setting

the NMSettingConnection

  

Returns

the connection's autoconnect priority

nm_setting_connection_get_autoconnect_retries ()

int
nm_setting_connection_get_autoconnect_retries
                               (NMSettingConnection *setting);

Returns the “autoconnect-retries” property of the connection. Zero means infinite, -1 means the global default value.

Parameters

setting

the NMSettingConnection

  

Returns

the connection's autoconnect retries

Since: 1.6

nm_setting_connection_get_multi_connect ()

NMConnectionMultiConnect
nm_setting_connection_get_multi_connect
                               (NMSettingConnection *setting);

Parameters

setting

the NMSettingConnection

  

Returns

the “multi-connect” property of the connection.

Since: 1.14

nm_setting_connection_get_timestamp ()

guint64
nm_setting_connection_get_timestamp (NMSettingConnection *setting);

Returns the “timestamp” property of the connection.

Parameters

setting

the NMSettingConnection

  

Returns

the connection's timestamp

nm_setting_connection_get_read_only ()

gboolean
nm_setting_connection_get_read_only (NMSettingConnection *setting);

Returns the “read-only” property of the connection.

Parameters

setting

the NMSettingConnection

  

Returns

TRUE if the connection is read-only, FALSE if it is not

nm_setting_connection_get_num_permissions ()

guint32
nm_setting_connection_get_num_permissions
                               (NMSettingConnection *setting);

Returns the number of entries in the “permissions” property of this setting.

Parameters

setting

the NMSettingConnection

  

Returns

the number of permissions entries

nm_setting_connection_get_permission ()

gboolean
nm_setting_connection_get_permission (NMSettingConnection *setting,
                                      guint32 idx,
                                      const char **out_ptype,
                                      const char **out_pitem,
                                      const char **out_detail);

Retrieve one of the entries of the “permissions” property of this setting.