NMSettingConnection: libnm Reference Manual

## NMSettingConnection NMSettingConnection |

## 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 ()
NMSettingConnectionDnsOverTls | nm_setting_connection_get_dns_over_tls ()
NMMptcpFlags | nm_setting_connection_get_mptcp_flags ()
gint32 | nm_setting_connection_get_wait_device_timeout ()
gint32 | nm_setting_connection_get_wait_activation_delay ()
const char * | nm_setting_connection_get_mud_url ()

## 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_DNS_OVER_TLS
#define | NM_SETTING_CONNECTION_MPTCP_FLAGS
#define | NM_SETTING_CONNECTION_WAIT_DEVICE_TIMEOUT
#define | NM_SETTING_CONNECTION_MUD_URL
#define | NM_SETTING_CONNECTION_WAIT_ACTIVATION_DELAY
enum | NMSettingConnectionAutoconnectSlaves
enum | NMSettingConnectionLldp
enum | NMSettingConnectionMdns
enum | NMSettingConnectionLlmnr
enum | NMSettingConnectionDnsOverTls

## Object Hierarchy

        GEnum
        ├── NMSettingConnectionAutoconnectSlaves
        ├── NMSettingConnectionDnsOverTls
        ├── NMSettingConnectionLldp
        ├── NMSettingConnectionLlmnr
        ╰── NMSettingConnectionMdns

## Description

## Functions

### nm_setting_connection_new ()

    NMSetting *
    nm_setting_connection_new (void);

### nm_setting_connection_get_id ()

    const char *
    nm_setting_connection_get_id (NMSettingConnection *setting);

### nm_setting_connection_get_uuid ()

    const char *
    nm_setting_connection_get_uuid (NMSettingConnection *setting);

### nm_setting_connection_get_stable_id ()

    const char *
    nm_setting_connection_get_stable_id (NMSettingConnection *setting);

### nm_setting_connection_get_interface_name ()

    const char *
    nm_setting_connection_get_interface_name
                                   (NMSettingConnection *setting);

### nm_setting_connection_get_connection_type ()

    const char *
    nm_setting_connection_get_connection_type
                                   (NMSettingConnection *setting);

### nm_setting_connection_get_autoconnect ()

    gboolean
    nm_setting_connection_get_autoconnect (NMSettingConnection *setting);

### nm_setting_connection_get_autoconnect_priority ()

    int
    nm_setting_connection_get_autoconnect_priority
                                   (NMSettingConnection *setting);

### nm_setting_connection_get_autoconnect_retries ()

    int
    nm_setting_connection_get_autoconnect_retries
                                   (NMSettingConnection *setting);

### nm_setting_connection_get_multi_connect ()

    NMConnectionMultiConnect
    nm_setting_connection_get_multi_connect
                                   (NMSettingConnection *setting);

### nm_setting_connection_get_timestamp ()

    guint64
    nm_setting_connection_get_timestamp (NMSettingConnection *setting);

### nm_setting_connection_get_read_only ()

    gboolean
    nm_setting_connection_get_read_only (NMSettingConnection *setting);

### nm_setting_connection_get_num_permissions ()

    guint32
    nm_setting_connection_get_num_permissions
                                   (NMSettingConnection *setting);

### 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);

### nm_setting_connection_get_zone ()

    const char *
    nm_setting_connection_get_zone (NMSettingConnection *setting);

### nm_setting_connection_permissions_user_allowed ()

    gboolean
    nm_setting_connection_permissions_user_allowed
                                   (NMSettingConnection *setting,
                                    const char *uname);

### nm_setting_connection_add_permission ()

    gboolean
    nm_setting_connection_add_permission (NMSettingConnection *setting,
                                          const char *ptype,
                                          const char *pitem,
                                          const char *detail);

### nm_setting_connection_remove_permission ()

    void
    nm_setting_connection_remove_permission
                                   (NMSettingConnection *setting,
                                    guint32 idx);

### nm_setting_connection_remove_permission_by_value ()

    gboolean
    nm_setting_connection_remove_permission_by_value
                                   (NMSettingConnection *setting,
                                    const char *ptype,
                                    const char *pitem,
                                    const char *detail);

### nm_setting_connection_get_master ()

    const char *
    nm_setting_connection_get_master (NMSettingConnection *setting);

### nm_setting_connection_is_slave_type ()

    gboolean
    nm_setting_connection_is_slave_type (NMSettingConnection *setting,
                                         const char *type);

### nm_setting_connection_get_slave_type ()

    const char *
    nm_setting_connection_get_slave_type (NMSettingConnection *setting);

### nm_setting_connection_get_autoconnect_slaves ()

    NMSettingConnectionAutoconnectSlaves
    nm_setting_connection_get_autoconnect_slaves
                                   (NMSettingConnection *setting);

### nm_setting_connection_get_num_secondaries ()

    guint32
    nm_setting_connection_get_num_secondaries
                                   (NMSettingConnection *setting);

### nm_setting_connection_get_secondary ()

    const char *
    nm_setting_connection_get_secondary (NMSettingConnection *setting,
                                         guint32 idx);

### nm_setting_connection_add_secondary ()

    gboolean
    nm_setting_connection_add_secondary (NMSettingConnection *setting,
                                         const char *sec_uuid);

### nm_setting_connection_remove_secondary ()

    void
    nm_setting_connection_remove_secondary
                                   (NMSettingConnection *setting,
                                    guint32 idx);

### nm_setting_connection_remove_secondary_by_value ()

    gboolean
    nm_setting_connection_remove_secondary_by_value
                                   (NMSettingConnection *setting,
                                    const char *sec_uuid);

### nm_setting_connection_get_gateway_ping_timeout ()

    guint32
    nm_setting_connection_get_gateway_ping_timeout
                                   (NMSettingConnection *setting);

### nm_setting_connection_get_metered ()

    NMMetered
    nm_setting_connection_get_metered (NMSettingConnection *setting);

### nm_setting_connection_get_lldp ()

    NMSettingConnectionLldp
    nm_setting_connection_get_lldp (NMSettingConnection *setting);

### nm_setting_connection_get_auth_retries ()

    int
    nm_setting_connection_get_auth_retries
                                   (NMSettingConnection *setting);

### nm_setting_connection_get_mdns ()

    NMSettingConnectionMdns
    nm_setting_connection_get_mdns (NMSettingConnection *setting);

### nm_setting_connection_get_llmnr ()

    NMSettingConnectionLlmnr
    nm_setting_connection_get_llmnr (NMSettingConnection *setting);

### nm_setting_connection_get_dns_over_tls ()

    NMSettingConnectionDnsOverTls
    nm_setting_connection_get_dns_over_tls
                                   (NMSettingConnection *setting);

### nm_setting_connection_get_mptcp_flags ()

    NMMptcpFlags
    nm_setting_connection_get_mptcp_flags (NMSettingConnection *setting);

### nm_setting_connection_get_wait_device_timeout ()

    gint32
    nm_setting_connection_get_wait_device_timeout
                                   (NMSettingConnection *setting);

### nm_setting_connection_get_wait_activation_delay ()

    gint32
    nm_setting_connection_get_wait_activation_delay
                                   (NMSettingConnection *setting);

### nm_setting_connection_get_mud_url ()

    const char *
    nm_setting_connection_get_mud_url (NMSettingConnection *setting);

## Types and Values

### 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_STABLE_ID

    #define NM_SETTING_CONNECTION_STABLE_ID             "stable-id"

### 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_AUTOCONNECT_RETRIES

    #define NM_SETTING_CONNECTION_AUTOCONNECT_RETRIES   "autoconnect-retries"

### NM_SETTING_CONNECTION_MULTI_CONNECT

    #define NM_SETTING_CONNECTION_MULTI_CONNECT         "multi-connect"

### 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_AUTOCONNECT_SLAVES

    #define NM_SETTING_CONNECTION_AUTOCONNECT_SLAVES    "autoconnect-slaves"

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

### NM_SETTING_CONNECTION_METERED

    #define NM_SETTING_CONNECTION_METERED               "metered"

### NM_SETTING_CONNECTION_LLDP

    #define NM_SETTING_CONNECTION_LLDP                  "lldp"

### NM_SETTING_CONNECTION_AUTH_RETRIES

    #define NM_SETTING_CONNECTION_AUTH_RETRIES          "auth-retries"

### NM_SETTING_CONNECTION_MDNS

    #define NM_SETTING_CONNECTION_MDNS                  "mdns"

### NM_SETTING_CONNECTION_LLMNR

    #define NM_SETTING_CONNECTION_LLMNR                 "llmnr"

### NM_SETTING_CONNECTION_DNS_OVER_TLS

    #define NM_SETTING_CONNECTION_DNS_OVER_TLS          "dns-over-tls"

### NM_SETTING_CONNECTION_MPTCP_FLAGS

    #define NM_SETTING_CONNECTION_MPTCP_FLAGS           "mptcp-flags"

### NM_SETTING_CONNECTION_WAIT_DEVICE_TIMEOUT

    #define NM_SETTING_CONNECTION_WAIT_DEVICE_TIMEOUT   "wait-device-timeout"

### NM_SETTING_CONNECTION_MUD_URL

    #define NM_SETTING_CONNECTION_MUD_URL               "mud-url"

### NM_SETTING_CONNECTION_WAIT_ACTIVATION_DELAY

    #define NM_SETTING_CONNECTION_WAIT_ACTIVATION_DELAY "wait-activation-delay"

### enum NMSettingConnectionAutoconnectSlaves

NMSettingConnectionAutoconnectSlaves values indicate whether slave connections should be activated when master is activated.

#### Members

NM_SETTING_CONNECTION_AUTOCONNECT_SLAVES_DEFAULT | default value |
NM_SETTING_CONNECTION_AUTOCONNECT_SLAVES_NO | slaves are not brought up when master is activated |
NM_SETTING_CONNECTION_AUTOCONNECT_SLAVES_YES | slaves are brought up when master is activated |

Since: 1.2

### enum NMSettingConnectionLldp

NMSettingConnectionLldp values indicate whether LLDP should be enabled.

#### Members

NM_SETTING_CONNECTION_LLDP_DEFAULT | default value |
NM_SETTING_CONNECTION_LLDP_DISABLE | disable LLDP |
NM_SETTING_CONNECTION_LLDP_ENABLE_RX | enable reception of LLDP frames |

Since: 1.2

### enum NMSettingConnectionMdns

NMSettingConnectionMdns values indicate whether mDNS should be enabled.

#### Members

NM_SETTING_CONNECTION_MDNS_DEFAULT | default value |
NM_SETTING_CONNECTION_MDNS_NO | disable mDNS |
NM_SETTING_CONNECTION_MDNS_RESOLVE | support only resolving, do not register hostname |
NM_SETTING_CONNECTION_MDNS_YES | enable mDNS |

Since: 1.12

### enum NMSettingConnectionLlmnr

NMSettingConnectionLlmnr values indicate whether LLMNR should be enabled.

#### Members

NM_SETTING_CONNECTION_LLMNR_DEFAULT | default value |
NM_SETTING_CONNECTION_LLMNR_NO | disable LLMNR |
NM_SETTING_CONNECTION_LLMNR_RESOLVE | support only resolving, do not register hostname |
NM_SETTING_CONNECTION_LLMNR_YES | enable LLMNR |

Since: 1.14

### enum NMSettingConnectionDnsOverTls

NMSettingConnectionDnsOverTls values indicate whether DNSOverTls should be enabled.

#### Members

NM_SETTING_CONNECTION_DNS_OVER_TLS_DEFAULT | default value |
NM_SETTING_CONNECTION_DNS_OVER_TLS_NO | disable DNSOverTls |
NM_SETTING_CONNECTION_DNS_OVER_TLS_OPPORTUNISTIC | enable opportunistic mode |
NM_SETTING_CONNECTION_DNS_OVER_TLS_YES | enable strict mode |

Since: 1.34