Tree - source-git/NetworkManager

<head>

Packit

<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">

Packit

<title>NMSetting: libnm Reference Manual</title>

Packit

<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">

Packit

<link rel="home" href="index.html" title="libnm Reference Manual">

Packit

<link rel="up" href="ch03.html" title="Connection and Setting API Reference">

Packit

<link rel="prev" href="NMRemoteConnection.html" title="NMRemoteConnection">

Packit

<link rel="next" href="NMSettingConnection.html" title="NMSettingConnection">

Packit Service

<meta name="generator" content="GTK-Doc V1.33.0 (XML mode)">

Packit

<link rel="stylesheet" href="style.css" type="text/css">

Packit

</head>

Packit

<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">

Packit

Packit

Packit

Top  |

Packit

                  Description  |

Packit

                  Object Hierarchy  |

Packit

                  Properties

Packit

Packit

Packit

Packit

Packit

Packit

Packit

Packit

Packit

Packit

Packit

NMSetting

Packit

NMSetting — Describes related configuration information

Packit

Packit

Packit

Packit

Packit

Functions

Packit

Packit

Packit

Packit

Packit

Packit

Packit

Packit

Packit

gboolean

Packit

Packit

Packit

(*NMSettingClearSecretsWithFlagsFn) ()

Packit

Packit

Packit

Packit

Packit

void

Packit

Packit

Packit

(*NMSettingValueIterFn) ()

Packit

Packit

Packit

Packit

Packit

gboolean

Packit

Packit

Packit

(*_NMConnectionForEachSecretFunc) ()

Packit

Packit

Packit

Packit

Packit

GType

Packit

Packit

Packit

nm_setting_lookup_type ()

Packit

Packit

Packit

Packit

Packit

NMSetting *

Packit

Packit

Packit

nm_setting_duplicate ()

Packit

Packit

Packit

Packit

const char *

Packit

Packit

Packit

nm_setting_get_name ()

Packit

Packit

Packit

Packit

Packit

gboolean

Packit

Packit

Packit

nm_setting_verify ()

Packit

Packit

Packit

Packit

Packit

gboolean

Packit

Packit

Packit

nm_setting_verify_secrets ()

Packit

Packit

Packit

Packit

Packit

gboolean

Packit

Packit

Packit

nm_setting_compare ()

Packit

Packit

Packit

Packit

Packit

gboolean

Packit

Packit

Packit

nm_setting_diff ()

Packit

Packit

Packit

Packit

Packit

void

Packit

Packit

Packit

nm_setting_enumerate_values ()

Packit

Packit

Packit

Packit

Packit

char *

Packit

Packit

Packit

nm_setting_to_string ()

Packit

Packit

Packit

Packit

Packit

gboolean

Packit

Packit

Packit

nm_setting_get_secret_flags ()

Packit

Packit

Packit

Packit

Packit

gboolean

Packit

Packit

Packit

nm_setting_set_secret_flags ()

Packit

Packit

Packit

Packit

Packit

GVariant *

Packit

Packit

Packit

nm_setting_option_get ()

Packit

Packit

Packit

Packit

Packit

gboolean

Packit

Packit

Packit

nm_setting_option_get_boolean ()

Packit

Packit

Packit

Packit

Packit

gboolean

Packit

Packit

Packit

nm_setting_option_get_uint32 ()

Packit

Packit

Packit

Packit

Packit

void

Packit

Packit

Packit

nm_setting_option_set ()

Packit

Packit

Packit

Packit

Packit

void

Packit

Packit

Packit

nm_setting_option_set_uint32 ()

Packit

Packit

Packit

Packit

Packit

void

Packit

Packit

Packit

nm_setting_option_set_boolean ()

Packit

Packit

Packit

Packit Service

const char *const *

Packit

Packit

Packit

nm_setting_option_get_all_names ()

Packit

Packit

Packit

Packit

Packit

void

Packit

Packit

Packit

nm_setting_option_clear_by_name ()

Packit

Packit

Packit

Packit

const GVariantType *

Packit

Packit

Packit

nm_setting_get_dbus_property_type ()

Packit

Packit

Packit

Packit

Packit

Packit

Packit

Properties

Packit

Packit

Packit

Packit

Packit

Packit

Packit

Packit

Packit Service

char *

Packit

name

Packit

Read

Packit

Packit

Packit

Packit

Packit

Types and Values

Packit

Packit

Packit

Packit

Packit

Packit

Packit

Packit

#define

Packit

NM_SETTING_PARAM_REQUIRED

Packit

Packit

Packit

#define

Packit

NM_SETTING_PARAM_SECRET

Packit

Packit

Packit

#define

Packit

NM_SETTING_PARAM_FUZZY_IGNORE

Packit

Packit

Packit

#define

Packit

NM_SETTING_NAME

Packit

Packit

Packit

enum

Packit

NMSettingSecretFlags

Packit

Packit

Packit

enum

Packit

NMSettingCompareFlags

Packit

Packit

Packit

enum

Packit

NMSettingMacRandomization

Packit

Packit

Packit

Packit

NMSetting

Packit

Packit

Packit

enum

Packit

NMSettingDiffResult

Packit

Packit

Packit

Packit

Packit

Packit

Object Hierarchy

Packit

    GEnum

Packit

    ├── NMSettingCompareFlags

Packit

    ├── NMSettingDiffResult

Packit

    ╰── NMSettingMacRandomization

Packit

    GFlags

Packit

    ╰── NMSettingSecretFlags

Packit

    GObject

Packit

    ╰── NMSetting

Packit

        ├── NMSetting6Lowpan

Packit

        ├── NMSetting8021x

Packit

        ├── NMSettingAdsl

Packit

        ├── NMSettingBluetooth

Packit

        ├── NMSettingBond

Packit

        ├── NMSettingBridge

Packit

        ├── NMSettingBridgePort

Packit

        ├── NMSettingCdma

Packit

        ├── NMSettingConnection

Packit

        ├── NMSettingDcb

Packit

        ├── NMSettingDummy

Packit

        ├── NMSettingEthtool

Packit

        ├── NMSettingGeneric

Packit

        ├── NMSettingGsm

Packit Service

        ├── NMSettingHostname

Packit

        ├── NMSettingInfiniband

Packit

        ├── NMSettingIPConfig

Packit

        ├── NMSettingIPTunnel

Packit

        ├── NMSettingMacsec

Packit

        ├── NMSettingMacvlan

Packit

        ├── NMSettingMatch

Packit

        ├── NMSettingOlpcMesh

Packit

        ├── NMSettingOvsBridge

Packit

        ├── NMSettingOvsDpdk

Packit Service

        ├── NMSettingOvsExternalIDs

Packit

        ├── NMSettingOvsInterface

Packit

        ├── NMSettingOvsPatch

Packit

        ├── NMSettingOvsPort

Packit

        ├── NMSettingPpp

Packit

        ├── NMSettingPppoe

Packit

        ├── NMSettingProxy

Packit

        ├── NMSettingSerial

Packit

        ├── NMSettingSriov

Packit

        ├── NMSettingTCConfig

Packit

        ├── NMSettingTeam

Packit

        ├── NMSettingTeamPort

Packit

        ├── NMSettingTun

Packit

        ├── NMSettingUser

Packit Service

        ├── NMSettingVeth

Packit

        ├── NMSettingVlan

Packit

        ├── NMSettingVpn

Packit

        ├── NMSettingVrf

Packit

        ├── NMSettingVxlan

Packit

        ├── NMSettingWifiP2P

Packit

        ├── NMSettingWimax

Packit

        ├── NMSettingWired

Packit

        ├── NMSettingWireGuard

Packit

        ├── NMSettingWireless

Packit

        ├── NMSettingWirelessSecurity

Packit

        ╰── NMSettingWpan

Packit

Packit

Packit

Packit

Description

Packit

Each NMSetting contains properties that describe configuration that applies

Packit

to a specific network layer (like IPv4 or IPv6 configuration) or device type

Packit

(like Ethernet, or Wi-Fi).  A collection of individual settings together

Packit

make up an NMConnection. Each property is strongly typed and usually has

Packit

a number of allowed values.  See each NMSetting subclass for a description

Packit

of properties and allowed values.

Packit

Packit

Packit

Functions

Packit

Packit

NMSettingClearSecretsWithFlagsFn ()

Packit

gboolean

Packit

(*NMSettingClearSecretsWithFlagsFn) (NMSetting *setting,

Packit

                                     const char *secret,

Packit

                                     NMSettingSecretFlags flags,

Packit

                                     gpointer user_data);

Packit

Packit

Parameters

Packit

Packit

Packit

Packit

Packit

Packit

Packit

Packit

Packit

setting

Packit

The setting for which secrets are being iterated

Packit

Packit

Packit

Packit

secret

Packit

The secret's name

Packit

Packit

Packit

Packit

flags

Packit

The secret's flags, eg NM_SETTING_SECRET_FLAG_AGENT_OWNED

Packit

Packit

Packit

Packit

user_data

Packit

User data passed to nm_connection_clear_secrets_with_flags()

Packit

Packit

Packit

Packit

Packit

Packit

Packit

Returns

Packit

 TRUE to clear the secret, FALSE to not clear the secret

Packit

Packit

Packit

Packit

Packit

NMSettingValueIterFn ()

Packit

void

Packit

(*NMSettingValueIterFn) (NMSetting *setting,

Packit

                         const char *key,

Packit

                         const GValue *value,

Packit

                         GParamFlags flags,

Packit

                         gpointer user_data);

Packit

Packit

Parameters

Packit

Packit

Packit

Packit

Packit

Packit

Packit

Packit

Packit

setting

Packit

The setting for which properties are being iterated, given to

Packit

nm_setting_enumerate_values()

Packit

Packit

Packit

Packit

key

Packit

The value/property name

Packit

Packit

Packit

Packit

value

Packit

The property's value

Packit

Packit

Packit

Packit

flags

Packit

The property's flags, like NM_SETTING_PARAM_SECRET

Packit

Packit

Packit

Packit

user_data

Packit

User data passed to nm_setting_enumerate_values()

Packit

Packit

Packit

Packit

Packit

Packit

Packit

Packit

Packit

_NMConnectionForEachSecretFunc ()

Packit

gboolean

Packit

(*_NMConnectionForEachSecretFunc) (NMSettingSecretFlags flags,

Packit

                                   gpointer user_data);

Packit

Packit

Packit

Packit

nm_setting_lookup_type ()

Packit

GType

Packit

nm_setting_lookup_type (const char *name);

Packit

Returns the GType of the setting's class for a given setting name.

Packit

Packit

Parameters

Packit

Packit

Packit

Packit

Packit

Packit

Packit

Packit

name

Packit

a setting name

Packit

Packit

Packit

Packit

Packit

Packit

Returns

Packit

 the GType of the setting's class, or G_TYPE_INVALID if

Packit

name

Packit

is not recognized.

Packit

Packit

Packit

Packit

Packit

nm_setting_duplicate ()

Packit

NMSetting *

Packit

nm_setting_duplicate (NMSetting *setting);

Packit

Duplicates a NMSetting.

Packit

Packit

Parameters

Packit

Packit

Packit

Packit

Packit

Packit

Packit

Packit

setting

Packit

the NMSetting to duplicate

Packit

Packit

Packit

Packit

Packit

Packit

Returns

Packit

a new NMSetting containing the same properties and values as the

Packit

source NMSetting.

Packit Service

[transfer full]

Packit

Packit

Packit

Packit

Packit

nm_setting_get_name ()

Packit

const char *

Packit

nm_setting_get_name (NMSetting *setting);

Packit

Returns the type name of the NMSetting object

Packit

Packit

Parameters

Packit

Packit

Packit

Packit

Packit

Packit

Packit

Packit

setting

Packit

the NMSetting

Packit

Packit

Packit

Packit

Packit

Packit

Returns

Packit

 a string containing the type name of the NMSetting object,

Packit

like 'ppp' or 'wireless' or 'wired'.

Packit

Packit

Packit

Packit

Packit

nm_setting_verify ()

Packit

gboolean

Packit

nm_setting_verify (NMSetting *setting,

Packit

                   NMConnection *connection,

Packit

                   GError **error);

Packit

Validates the setting.  Each setting's properties have allowed values, and

Packit

some are dependent on other values (hence the need for connection

Packit

).  The

Packit

returned GError contains information about which property of the setting

Packit

failed validation, and in what way that property failed validation.

Packit

Packit

Parameters

Packit

Packit

Packit

Packit

Packit

Packit

Packit

Packit

Packit

setting

Packit

the NMSetting to verify

Packit

Packit

Packit

Packit

connection

Packit

the NMConnection that setting

Packit

came from, or

Packit

NULL if setting

Packit

is being verified in isolation.

Packit

[allow-none]

Packit

Packit

Packit

error

Packit

location to store error, or NULL

Packit

Packit

Packit

Packit

Packit

Packit

Packit

Returns

Packit

 TRUE if the setting is valid, FALSE if it is not

Packit

Packit

Packit

Packit

Packit

nm_setting_verify_secrets ()

Packit

gboolean

Packit

nm_setting_verify_secrets (NMSetting *setting,

Packit

                           NMConnection *connection,

Packit

                           GError **error);

Packit

Verifies the secrets in the setting.

Packit

The returned GError contains information about which secret of the setting

Packit

failed validation, and in what way that secret failed validation.

Packit

The secret validation is done separately from main setting validation, because

Packit

in some cases connection failure is not desired just for the secrets.

Packit

Packit

Parameters

Packit

Packit

Packit

Packit

Packit

Packit

Packit

Packit

Packit

setting

Packit

the NMSetting to verify secrets in

Packit

Packit

Packit

Packit

connection

Packit

the NMConnection that setting

Packit

came from, or

Packit

NULL if setting

Packit

is being verified in isolation.

Packit

[allow-none]

Packit

Packit

Packit

error

Packit

location to store error, or NULL

Packit

Packit

Packit

Packit

Packit

Packit

Packit

Returns

Packit

 TRUE if the setting secrets are valid, FALSE if they are not

Packit

Packit

Since: 1.2

Packit

Packit

Packit

Packit

nm_setting_compare ()

Packit

gboolean

Packit

nm_setting_compare (NMSetting *a,

Packit

                    NMSetting *b,

Packit

                    NMSettingCompareFlags flags);

Packit

Compares two NMSetting objects for similarity, with comparison behavior

Packit

modified by a set of flags.  See the documentation for NMSettingCompareFlags

Packit

for a description of each flag's behavior.

Packit

Packit

Parameters

Packit

Packit

Packit

Packit

Packit

Packit

Packit

Packit

Packit

Packit

a NMSetting

Packit

Packit

Packit

Packit

Packit

a second NMSetting to compare with the first

Packit

Packit

Packit

Packit

flags

Packit

compare flags, e.g. NM_SETTING_COMPARE_FLAG_EXACT

Packit

Packit

Packit

Packit

Packit

Packit

Packit

Returns

Packit

 TRUE if the comparison succeeds, FALSE if it does not

Packit

Packit

Packit

Packit

Packit

nm_setting_diff ()

Packit

gboolean

Packit

nm_setting_diff (NMSetting *a,

Packit

                 NMSetting *b,

Packit

                 NMSettingCompareFlags flags,

Packit

                 gboolean invert_results,

Packit

                 GHashTable **results);

Packit

Compares two NMSetting objects for similarity, with comparison behavior

Packit

modified by a set of flags.  See the documentation for NMSettingCompareFlags

Packit

for a description of each flag's behavior.  If the settings differ, the keys

Packit

of each setting that differ from the other are added to results

Packit

, mapped to

Packit

one or more NMSettingDiffResult values.

Packit

Packit

Parameters

Packit

Packit

Packit

Packit

Packit

Packit

Packit

Packit

Packit

Packit

a NMSetting

Packit

Packit

Packit

Packit

Packit

a second NMSetting to compare with the first

Packit

Packit

Packit

Packit

flags

Packit

compare flags, e.g. NM_SETTING_COMPARE_FLAG_EXACT

Packit

Packit

Packit

Packit

invert_results

Packit

this parameter is used internally by libnm and should

Packit

be set to FALSE.  If TRUE inverts the meaning of the NMSettingDiffResult.

Packit

Packit

Packit

Packit

results

Packit

if the

Packit

settings differ, on return a hash table mapping the differing keys to one or

Packit

more NMSettingDiffResult values OR-ed together.  If the settings do not

Packit

differ, any hash table passed in is unmodified.  If no hash table is passed

Packit

in and the settings differ, a new one is created and returned.

Packit Service

[inout][transfer full][element-type utf8 guint32]

Packit

Packit

Packit

Packit

Packit

Packit

Returns

Packit

 TRUE if the settings contain the same values, FALSE if they do not

Packit

Packit

Packit

Packit

Packit

nm_setting_enumerate_values ()

Packit

void

Packit

nm_setting_enumerate_values (NMSetting *setting,

Packit

                             NMSettingValueIterFn func,

Packit

                             gpointer user_data);

Packit

Iterates over each property of the NMSetting object, calling the supplied

Packit

user function for each property.

Packit

Packit

Parameters

Packit

Packit

Packit

Packit

Packit

Packit

Packit

Packit

Packit

setting

Packit

the NMSetting

Packit

Packit

Packit

Packit

func

Packit

user-supplied function called for each property of the setting.

Packit

[scope call]

Packit

Packit

Packit

user_data

Packit

user data passed to func

Packit

at each invocation

Packit

Packit

Packit

Packit

Packit

Packit

Packit

Packit

Packit

nm_setting_to_string ()

Packit

char *

Packit

nm_setting_to_string (NMSetting *setting);

Packit

Convert the setting (including secrets!) into a string. For debugging

Packit

purposes ONLY, should NOT be used for serialization of the setting,

Packit

or machine-parsed in any way. The output format is not guaranteed to

Packit

be stable and may change at any time.

Packit

Packit

Parameters

Packit

Packit

Packit

Packit

Packit

Packit

Packit

Packit

setting

Packit

the NMSetting

Packit

Packit

Packit

Packit

Packit

Packit

Returns

Packit

 an allocated string containing a textual representation of the

Packit

setting's properties and values, which the caller should

Packit

free with g_free()

Packit

Packit

Packit

Packit

Packit

nm_setting_get_secret_flags ()

Packit

gboolean

Packit

nm_setting_get_secret_flags (NMSetting *setting,

Packit

                             const char *secret_name,

Packit

                             NMSettingSecretFlags *out_flags,

Packit

                             GError **error);

Packit

For a given secret, retrieves the NMSettingSecretFlags describing how to

Packit

handle that secret.

Packit

Packit

Parameters

Packit

Packit

Packit

Packit

Packit

Packit

Packit

Packit

Packit

setting

Packit

the NMSetting

Packit

Packit

Packit

Packit

secret_name

Packit

the secret key name to get flags for

Packit

Packit

Packit

Packit

out_flags

Packit

on success, the NMSettingSecretFlags for the secret

Packit

Packit

Packit

Packit

error

Packit

location to store error, or NULL

Packit

Packit

Packit

Packit

Packit

Packit

Packit

Returns

Packit

 TRUE on success (if the given secret name was a valid property of

Packit

this setting, and if that property is secret), FALSE if not

Packit

Packit

Packit

Packit

Packit

nm_setting_set_secret_flags ()

Packit

gboolean

Packit

nm_setting_set_secret_flags (NMSetting *setting,

Packit

                             const char *secret_name,

Packit

                             NMSettingSecretFlags flags,

Packit

                             GError **error);

Packit

For a given secret, stores the NMSettingSecretFlags describing how to

Packit

handle that secret.

Packit

Packit

Parameters

Packit

Packit

Packit

Packit

Packit

Packit

Packit

Packit

Packit

setting

Packit

the NMSetting

Packit

Packit

Packit

Packit

secret_name

Packit

the secret key name to set flags for

Packit

Packit

Packit

Packit

flags

Packit

the NMSettingSecretFlags for the secret

Packit

Packit

Packit

Packit

error

Packit

location to store error, or NULL

Packit

Packit

Packit

Packit

Packit

Packit

Packit

Returns

Packit

 TRUE on success (if the given secret name was a valid property of

Packit

this setting, and if that property is secret), FALSE if not

Packit

Packit

Packit

Packit

Packit

nm_setting_option_get ()

Packit

GVariant *

Packit

nm_setting_option_get (NMSetting *setting,

Packit

                       const char *opt_name);

Packit

Packit

Parameters

Packit

Packit

Packit

Packit

Packit

Packit

Packit

Packit

Packit

setting

Packit

the NMSetting

Packit

Packit

Packit

Packit

opt_name

Packit

the option name to request.

Packit

Packit

Packit

Packit

Packit

Packit

Packit

Returns

Packit

the GVariant or NULL if the option

Packit

is not set.

Packit Service

[transfer none]

Packit

Packit

Since: 1.26.

Packit

Packit

Packit

Packit

nm_setting_option_get_boolean ()

Packit

gboolean

Packit

nm_setting_option_get_boolean (NMSetting *setting,

Packit

                               const char *opt_name,

Packit

                               gboolean *out_value);

Packit

Packit

Parameters

Packit

Packit

Packit

Packit

Packit

Packit

Packit

Packit

Packit

setting

Packit

the NMSetting

Packit

Packit

Packit

Packit

opt_name

Packit

the option to get

Packit

Packit

Packit

Packit

out_value

Packit

the optional output value.

Packit

If the option is unset, FALSE will be returned.

Packit

[allow-none][out]

Packit

Packit

Packit

Packit

Packit

Packit

Returns

Packit

 TRUE if opt_name

Packit

is set to a boolean variant.

Packit

Packit

Since: 1.26

Packit

Packit

Packit

Packit

nm_setting_option_get_uint32 ()

Packit

gboolean

Packit

nm_setting_option_get_uint32 (NMSetting *setting,

Packit

                              const char *opt_name,

Packit

                              guint32 *out_value);

Packit

Packit

Parameters

Packit

Packit

Packit

Packit

Packit

Packit

Packit

Packit

Packit

setting

Packit

the NMSetting

Packit

Packit

Packit

Packit

opt_name

Packit

the option to get

Packit

Packit

Packit

Packit

out_value

Packit

the optional output value.

Packit

If the option is unset, 0 will be returned.

Packit

[allow-none][out]

Packit

Packit

Packit

Packit

Packit

Packit

Returns

Packit

 TRUE if opt_name

Packit

is set to a uint32 variant.

Packit

Packit

Since: 1.26

Packit

Packit

Packit

Packit

nm_setting_option_set ()

Packit

void

Packit

nm_setting_option_set (NMSetting *setting,

Packit

                       const char *opt_name,

Packit

                       GVariant *variant);

Packit

If variant

Packit

 is NULL, this clears the option if it is set.

Packit

Otherwise, variant

Packit

 is set as the option. If variant

Packit

is

Packit

a floating reference, it will be consumed.

Packit

Note that not all setting types support options. It is a bug

Packit

setting a variant to a setting that doesn't support it.

Packit

Currently, only NMSettingEthtool supports it.

Packit

Packit

Parameters

Packit

Packit

Packit

Packit

Packit

Packit

Packit

Packit

Packit

setting

Packit

the NMSetting

Packit

Packit

Packit

Packit

opt_name

Packit

the option name to set

Packit

Packit

Packit

Packit

variant

Packit

the variant to set.

Packit

[allow-none]

Packit

Packit

Packit

Packit

Packit

Since: 1.26

Packit

Packit

Packit

Packit

nm_setting_option_set_uint32 ()

Packit

void

Packit

nm_setting_option_set_uint32 (NMSetting *setting,

Packit

                              const char *opt_name,

Packit

                              guint32 value);

Packit

Like nm_setting_option_set() to set a uint32 GVariant.

Packit

Packit

Parameters

Packit

Packit

Packit

Packit

Packit

Packit

Packit

Packit

Packit

setting

Packit

the NMSetting

Packit

Packit

Packit

Packit

value

Packit

the value to set.

Packit

Packit

Packit

Packit

Packit

Packit

Since: 1.26

Packit

Packit

Packit

Packit

nm_setting_option_set_boolean ()

Packit

void

Packit

nm_setting_option_set_boolean (NMSetting *setting,

Packit

                               const char *opt_name,

Packit

                               gboolean value);

Packit

Like nm_setting_option_set() to set a boolean GVariant.

Packit

Packit

Parameters

Packit

Packit

Packit

Packit

Packit

Packit

Packit

Packit

Packit

setting

Packit

the NMSetting

Packit

Packit

Packit

Packit

value

Packit

the value to set.

Packit

Packit

Packit

Packit

Packit

Packit

Since: 1.26

Packit

Packit

Packit

Packit

nm_setting_option_get_all_names ()

Packit Service

const char *const *

Packit

nm_setting_option_get_all_names (NMSetting *setting,

Packit

                                 guint *out_len);

Packit

Gives the name of all set options.

Packit

Packit

Parameters

Packit

Packit

Packit

Packit

Packit

Packit

Packit

Packit

Packit

setting

Packit

the NMSetting

Packit

Packit

Packit

Packit

out_len

Packit

Packit

[allow-none][out]

Packit

Packit

Packit

Packit

Packit

Packit

Returns

Packit

A NULL terminated array of key names. If no names are present, this returns

Packit

NULL. The returned array and the names are owned by NMSetting and might be invalidated

Packit

by the next operation.

Packit Service

[array length=out_len zero-terminated=1][transfer none]

Packit

Packit

Since: 1.26

Packit

Packit

Packit

Packit

nm_setting_option_clear_by_name ()

Packit

void

Packit

nm_setting_option_clear_by_name (NMSetting *setting,

Packit

                                 NMUtilsPredicateStr predicate);

Packit

Packit

Parameters

Packit

Packit

Packit

Packit

Packit

Packit

Packit

Packit

Packit

setting

Packit

the NMSetting

Packit

Packit

Packit

Packit

predicate

Packit

the predicate for which names

Packit

should be clear.

Packit

If the predicate returns TRUE for an option name, the option

Packit

gets removed. If NULL, all options will be removed.

Packit

[allow-none][scope call]

Packit

Packit

Packit

Packit

Packit

Since: 1.26

Packit

Packit

Packit

Packit

nm_setting_get_dbus_property_type ()

Packit

const GVariantType *

Packit

nm_setting_get_dbus_property_type (NMSetting *setting,

Packit

                                   const char *property_name);

Packit

Gets the D-Bus marshalling type of a property. property_name

Packit

 is a D-Bus

Packit

property name, which may not necessarily be a GObject property.

Packit

Packit

Parameters

Packit

Packit

Packit

Packit

Packit

Packit

Packit

Packit

Packit

setting

Packit

an NMSetting

Packit

Packit

Packit

Packit

property_name

Packit

the property of setting

Packit

to get the type of

Packit

Packit

Packit

Packit

Packit

Packit

Packit

Returns

Packit

 the D-Bus marshalling type of property

Packit

on setting

Packit

Packit

Packit

Packit

Packit

Packit

Types and Values

Packit

Packit

NM_SETTING_PARAM_REQUIRED

Packit Service

#define NM_SETTING_PARAM_REQUIRED (1 << (1 + G_PARAM_USER_SHIFT))

Packit

Packit

Packit

Packit

Packit

NM_SETTING_PARAM_SECRET

Packit Service

#define NM_SETTING_PARAM_SECRET (1 << (2 + G_PARAM_USER_SHIFT))

Packit

Packit

Packit

Packit

Packit

NM_SETTING_PARAM_FUZZY_IGNORE

Packit

#define NM_SETTING_PARAM_FUZZY_IGNORE (1 << (3 + G_PARAM_USER_SHIFT))

Packit

Packit

Packit

Packit

Packit

NM_SETTING_NAME

Packit

#define NM_SETTING_NAME "name"

Packit

Packit

Packit

Packit

Packit

enum NMSettingSecretFlags

Packit

These flags indicate specific behavior related to handling of a secret.  Each

Packit

secret has a corresponding set of these flags which indicate how the secret

Packit

is to be stored and/or requested when it is needed.

Packit

Packit

Members

Packit

Packit

Packit

Packit

Packit

Packit

Packit

Packit

Packit

NM_SETTING_SECRET_FLAG_NONE

Packit

Packit

the system is responsible for providing and

Packit

storing this secret (default)

Packit

Packit

Packit

Packit

Packit

NM_SETTING_SECRET_FLAG_AGENT_OWNED

Packit

Packit

a user secret agent is responsible

Packit

for providing and storing this secret; when it is required agents will be

Packit

asked to retrieve it

Packit

Packit

Packit

Packit

Packit

NM_SETTING_SECRET_FLAG_NOT_SAVED

Packit

Packit

this secret should not be saved, but

Packit

should be requested from the user each time it is needed

Packit

Packit

Packit

Packit

Packit

NM_SETTING_SECRET_FLAG_NOT_REQUIRED

Packit

Packit

in situations where it cannot be

Packit

automatically determined that the secret is required (some VPNs and PPP

Packit

providers don't require all secrets) this flag indicates that the specific

Packit

secret is not required

Packit

Packit

Packit

Packit

Packit

Packit

Packit

Packit

Packit

Packit

enum NMSettingCompareFlags

Packit

These flags modify the comparison behavior when comparing two settings or

Packit

two connections.

Packit

Packit

Members

Packit

Packit

Packit

Packit

Packit

Packit

Packit

Packit

Packit

NM_SETTING_COMPARE_FLAG_EXACT

Packit

Packit

match all properties exactly

Packit

Packit

Packit

Packit

Packit

NM_SETTING_COMPARE_FLAG_FUZZY

Packit

Packit

match only important attributes, like SSID,

Packit

type, security settings, etc.  Does not match, for example, connection ID

Packit

or UUID.

Packit

Packit

Packit

Packit

Packit

NM_SETTING_COMPARE_FLAG_IGNORE_ID

Packit

Packit

ignore the connection's ID

Packit

Packit

Packit

Packit

Packit

NM_SETTING_COMPARE_FLAG_IGNORE_SECRETS

Packit

Packit

ignore all secrets

Packit

Packit

Packit

Packit

Packit

NM_SETTING_COMPARE_FLAG_IGNORE_AGENT_OWNED_SECRETS

Packit

Packit

ignore secrets for which

Packit

the secret's flags indicate the secret is owned by a user secret agent

Packit

(ie, the secret's flag includes NM_SETTING_SECRET_FLAG_AGENT_OWNED

Packit

Packit

Packit

Packit

Packit

Packit

NM_SETTING_COMPARE_FLAG_IGNORE_NOT_SAVED_SECRETS

Packit

Packit

ignore secrets for which

Packit

the secret's flags indicate the secret should not be saved to persistent

Packit

storage (ie, the secret's flag includes NM_SETTING_SECRET_FLAG_NOT_SAVED

Packit

Packit

Packit

Packit

Packit

Packit

NM_SETTING_COMPARE_FLAG_DIFF_RESULT_WITH_DEFAULT

Packit

Packit

if this flag is set,

Packit

nm_setting_diff() and nm_connection_diff() will also include properties that

Packit

are set to their default value. See also NM_SETTING_COMPARE_FLAG_DIFF_RESULT_NO_DEFAULT

Packit

Packit

Packit

Packit

Packit

Packit

NM_SETTING_COMPARE_FLAG_DIFF_RESULT_NO_DEFAULT

Packit

Packit

if this flag is set,

Packit

nm_setting_diff() and nm_connection_diff() will not include properties that

Packit

are set to their default value. This is the opposite of

Packit

NM_SETTING_COMPARE_FLAG_DIFF_RESULT_WITH_DEFAULT

Packit

. If both flags are set together,

Packit

NM_SETTING_COMPARE_FLAG_DIFF_RESULT_WITH_DEFAULT

Packit

 wins. If both flags are unset,

Packit

this means to exclude default properties if there is a setting to compare,

Packit

but include all properties, if the setting 'b' is missing. This is the legacy

Packit

behaviour of libnm-util, where nm_setting_diff() behaved differently depending

Packit

on whether the setting 'b' was available. If NM_SETTING_COMPARE_FLAG_DIFF_RESULT_WITH_DEFAULT

Packit

Packit

is set, nm_setting_diff() will also set the flags NM_SETTING_DIFF_RESULT_IN_A_DEFAULT

Packit

Packit

and NM_SETTING_DIFF_RESULT_IN_B_DEFAULT

Packit

, if the values are default values.

Packit

Packit

Packit

Packit

Packit

NM_SETTING_COMPARE_FLAG_IGNORE_TIMESTAMP

Packit

Packit

ignore the connection's timestamp

Packit

Packit

Packit

Packit

Packit

Packit

Packit

Packit

Packit

Packit

enum NMSettingMacRandomization

Packit

Controls if and how the MAC address of a device is randomzied.

Packit

Packit

Members

Packit

Packit

Packit

Packit

Packit

Packit

Packit

Packit

Packit

NM_SETTING_MAC_RANDOMIZATION_DEFAULT

Packit

Packit

the default value, which unless

Packit

overridden by user-controlled defaults configuration, is "never".

Packit

Packit

Packit

Packit

Packit

NM_SETTING_MAC_RANDOMIZATION_NEVER

Packit

Packit

the device's MAC address is always used.

Packit

Packit

Packit

Packit

Packit

NM_SETTING_MAC_RANDOMIZATION_ALWAYS

Packit

Packit

a random MAC address is used.

Packit

Packit

Packit

Packit

Packit

Packit

Packit

Packit

Packit

Packit

NMSetting

Packit

typedef struct _NMSetting NMSetting;

Packit

The NMSetting struct contains only private data.

Packit

It should only be accessed through the functions described below.

Packit

Packit

Packit

Packit

enum NMSettingDiffResult

Packit

These values indicate the result of a setting difference operation.

Packit

Packit

Members

Packit

Packit

Packit

Packit

Packit

Packit

Packit

Packit

Packit

NM_SETTING_DIFF_RESULT_UNKNOWN

Packit

Packit

unknown result

Packit

Packit

Packit

Packit

Packit

NM_SETTING_DIFF_RESULT_IN_A

Packit

Packit

the property is present in setting A

Packit

Packit

Packit

Packit

Packit

NM_SETTING_DIFF_RESULT_IN_B

Packit

Packit

the property is present in setting B

Packit

Packit

Packit

Packit

Packit

NM_SETTING_DIFF_RESULT_IN_A_DEFAULT

Packit

Packit

the property is present in

Packit

setting A but is set to the default value. This flag is only set,

Packit

if you specify NM_SETTING_COMPARE_FLAG_DIFF_RESULT_WITH_DEFAULT

Packit

Packit

Packit

Packit

Packit

Packit

NM_SETTING_DIFF_RESULT_IN_B_DEFAULT

Packit

Packit

analog to NM_SETTING_DIFF_RESULT_IN_A_DEFAULT

Packit

Packit

Packit

Packit

Packit

Packit

Packit

Packit

Packit

Packit

Packit

Property Details

Packit

Packit

The “name” property

Packit Service

  “name”                     char *

Packit

The setting's name, which uniquely identifies the setting within the

Packit

connection.  Each setting type has a name unique to that type, for

Packit

example "ppp" or "802-11-wireless" or "802-3-ethernet".

Packit

Owner: NMSetting

Packit

Flags: Read

Packit

Default value: NULL

Packit

Packit

Packit

Packit

Packit Service


Generated by GTK-Doc V1.33.0

Packit

</body>

Packit