diff options
Diffstat (limited to 'libnm-core/nm-setting-connection.c')
| -rw-r--r-- | libnm-core/nm-setting-connection.c | 900 |
1 files changed, 450 insertions, 450 deletions
diff --git a/libnm-core/nm-setting-connection.c b/libnm-core/nm-setting-connection.c index 936cd27a30..9a2ab4988e 100644 --- a/libnm-core/nm-setting-connection.c +++ b/libnm-core/nm-setting-connection.c @@ -1084,13 +1084,13 @@ verify(NMSetting *setting, NMConnection *connection, GError **error) NULL); if (!ovs_iface_type) { /* We cannot determine to OVS interface type. Consequently, we cannot - * fully validate the interface name. - * - * If we have a connection (and we do a full validation anyway), skip the - * check. The connection will fail validation when we validate the OVS setting. - * - * Otherwise, do the most basic validation. - */ + * fully validate the interface name. + * + * If we have a connection (and we do a full validation anyway), skip the + * check. The connection will fail validation when we validate the OVS setting. + * + * Otherwise, do the most basic validation. + */ if (connection) goto after_interface_name; iface_type = NMU_IFACE_ANY; @@ -1099,7 +1099,7 @@ verify(NMSetting *setting, NMConnection *connection, GError **error) iface_type = NMU_IFACE_OVS; } else { /* This interface type also requires a netdev. We need to validate - * for both OVS and KERNEL. */ + * for both OVS and KERNEL. */ nm_assert(NM_IN_STRSET(ovs_iface_type, "internal", "system", "dpdk")); iface_type = NMU_IFACE_OVS_AND_KERNEL; } @@ -1752,17 +1752,17 @@ nm_setting_connection_class_init(NMSettingConnectionClass *klass) setting_class->compare_property = compare_property; /** - * NMSettingConnection:id: - * - * A human readable unique identifier for the connection, like "Work Wi-Fi" - * or "T-Mobile 3G". - **/ + * NMSettingConnection:id: + * + * A human readable unique identifier for the connection, like "Work Wi-Fi" + * or "T-Mobile 3G". + **/ /* ---ifcfg-rh--- - * property: id - * variable: NAME(+) - * description: User friendly name for the connection profile. - * ---end--- - */ + * property: id + * variable: NAME(+) + * description: User friendly name for the connection profile. + * ---end--- + */ obj_properties[PROP_ID] = g_param_spec_string(NM_SETTING_CONNECTION_ID, "", "", @@ -1771,28 +1771,28 @@ nm_setting_connection_class_init(NMSettingConnectionClass *klass) | G_PARAM_STATIC_STRINGS); /** - * NMSettingConnection:uuid: - * - * 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 - * #NMSettingConnection:id property or #NMSettingIP4Config changes, but - * might need to be re-created when the Wi-Fi SSID, mobile broadband network - * provider, or #NMSettingConnection: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(). - **/ + * NMSettingConnection:uuid: + * + * 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 + * #NMSettingConnection:id property or #NMSettingIP4Config changes, but + * might need to be re-created when the Wi-Fi SSID, mobile broadband network + * provider, or #NMSettingConnection: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(). + **/ /* ---ifcfg-rh--- - * property: uuid - * variable: UUID(+) - * description: UUID for the connection profile. When missing, NetworkManager - * creates the UUID itself (by hashing the filename). - * ---end--- - */ + * property: uuid + * variable: UUID(+) + * description: UUID for the connection profile. When missing, NetworkManager + * creates the UUID itself (by hashing the filename). + * ---end--- + */ obj_properties[PROP_UUID] = g_param_spec_string( NM_SETTING_CONNECTION_UUID, "", @@ -1801,52 +1801,52 @@ nm_setting_connection_class_init(NMSettingConnectionClass *klass) G_PARAM_READWRITE | NM_SETTING_PARAM_FUZZY_IGNORE | G_PARAM_STATIC_STRINGS); /** - * NMSettingConnection:stable-id: - * - * This represents the identity of the connection used for various purposes. - * It allows to configure multiple profiles to share the identity. Also, - * the stable-id can contain placeholders that are substituted dynamically and - * deterministically depending on the context. - * - * The stable-id is used for generating IPv6 stable private addresses - * with ipv6.addr-gen-mode=stable-privacy. It is also used to seed the - * generated cloned MAC address for ethernet.cloned-mac-address=stable - * and wifi.cloned-mac-address=stable. It is also used as DHCP client - * identifier with ipv4.dhcp-client-id=stable and to derive the DHCP - * DUID with ipv6.dhcp-duid=stable-[llt,ll,uuid]. - * - * Note that depending on the context where it is used, other parameters are - * also seeded into the generation algorithm. For example, a per-host key - * is commonly also included, so that different systems end up generating - * different IDs. Or with ipv6.addr-gen-mode=stable-privacy, also the device's - * name is included, so that different interfaces yield different addresses. - * The per-host key is the identity of your machine and stored in /var/lib/NetworkManager/secret-key. - * - * The '$' character is treated special to perform dynamic substitutions - * at runtime. Currently, supported are "${CONNECTION}", "${DEVICE}", "${MAC}", - * "${BOOT}", "${RANDOM}". - * These effectively create unique IDs per-connection, per-device, per-boot, - * or every time. Note that "${DEVICE}" corresponds to the interface name of the - * device and "${MAC}" is the permanent MAC address of the device. - * Any unrecognized patterns following '$' are treated verbatim, however - * are reserved for future use. You are thus advised to avoid '$' or - * escape it as "$$". - * For example, set it to "${CONNECTION}-${BOOT}-${DEVICE}" to create a unique id for - * this connection that changes with every reboot and differs depending on the - * interface where the profile activates. - * - * If the value is unset, a global connection default is consulted. If the - * value is still unset, the default is similar to "${CONNECTION}" and uses - * a unique, fixed ID for the connection. - * - * Since: 1.4 - **/ + * NMSettingConnection:stable-id: + * + * This represents the identity of the connection used for various purposes. + * It allows to configure multiple profiles to share the identity. Also, + * the stable-id can contain placeholders that are substituted dynamically and + * deterministically depending on the context. + * + * The stable-id is used for generating IPv6 stable private addresses + * with ipv6.addr-gen-mode=stable-privacy. It is also used to seed the + * generated cloned MAC address for ethernet.cloned-mac-address=stable + * and wifi.cloned-mac-address=stable. It is also used as DHCP client + * identifier with ipv4.dhcp-client-id=stable and to derive the DHCP + * DUID with ipv6.dhcp-duid=stable-[llt,ll,uuid]. + * + * Note that depending on the context where it is used, other parameters are + * also seeded into the generation algorithm. For example, a per-host key + * is commonly also included, so that different systems end up generating + * different IDs. Or with ipv6.addr-gen-mode=stable-privacy, also the device's + * name is included, so that different interfaces yield different addresses. + * The per-host key is the identity of your machine and stored in /var/lib/NetworkManager/secret-key. + * + * The '$' character is treated special to perform dynamic substitutions + * at runtime. Currently, supported are "${CONNECTION}", "${DEVICE}", "${MAC}", + * "${BOOT}", "${RANDOM}". + * These effectively create unique IDs per-connection, per-device, per-boot, + * or every time. Note that "${DEVICE}" corresponds to the interface name of the + * device and "${MAC}" is the permanent MAC address of the device. + * Any unrecognized patterns following '$' are treated verbatim, however + * are reserved for future use. You are thus advised to avoid '$' or + * escape it as "$$". + * For example, set it to "${CONNECTION}-${BOOT}-${DEVICE}" to create a unique id for + * this connection that changes with every reboot and differs depending on the + * interface where the profile activates. + * + * If the value is unset, a global connection default is consulted. If the + * value is still unset, the default is similar to "${CONNECTION}" and uses + * a unique, fixed ID for the connection. + * + * Since: 1.4 + **/ /* ---ifcfg-rh--- - * property: stable-id - * variable: STABLE_ID(+) - * description: Token to generate stable IDs. - * ---end--- - */ + * property: stable-id + * variable: STABLE_ID(+) + * description: Token to generate stable IDs. + * ---end--- + */ obj_properties[PROP_STABLE_ID] = g_param_spec_string( NM_SETTING_CONNECTION_STABLE_ID, "", @@ -1855,28 +1855,28 @@ nm_setting_connection_class_init(NMSettingConnectionClass *klass) G_PARAM_READWRITE | NM_SETTING_PARAM_FUZZY_IGNORE | G_PARAM_STATIC_STRINGS); /** - * NMSettingConnection:interface-name: - * - * 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. - **/ + * NMSettingConnection:interface-name: + * + * 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. + **/ /* ---ifcfg-rh--- - * property: interface-name - * variable: DEVICE - * description: Interface name of the device this profile is bound to. The variable - * can be left out when the profile should apply for more devices. Note that DEVICE - * can be required for some connection types. - * ---end--- - */ + * property: interface-name + * variable: DEVICE + * description: Interface name of the device this profile is bound to. The variable + * can be left out when the profile should apply for more devices. Note that DEVICE + * can be required for some connection types. + * ---end--- + */ obj_properties[PROP_INTERFACE_NAME] = g_param_spec_string( NM_SETTING_CONNECTION_INTERFACE_NAME, "", @@ -1891,23 +1891,23 @@ nm_setting_connection_class_init(NMSettingConnectionClass *klass) nm_setting_connection_no_interface_name, )); /** - * NMSettingConnection:type: - * - * 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). - **/ + * NMSettingConnection:type: + * + * 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). + **/ /* ---ifcfg-rh--- - * property: type - * variable: TYPE (DEVICETYPE, DEVICE) - * values: Ethernet, Wireless, InfiniBand, Bridge, Bond, Vlan, Team, TeamPort - * description: Base type of the connection. DEVICETYPE is used for teaming - * connections. - * example: TYPE=Ethernet; TYPE=Bond; TYPE=Bridge; DEVICETYPE=TeamPort - * ---end--- - */ + * property: type + * variable: TYPE (DEVICETYPE, DEVICE) + * values: Ethernet, Wireless, InfiniBand, Bridge, Bond, Vlan, Team, TeamPort + * description: Base type of the connection. DEVICETYPE is used for teaming + * connections. + * example: TYPE=Ethernet; TYPE=Bond; TYPE=Bridge; DEVICETYPE=TeamPort + * ---end--- + */ obj_properties[PROP_TYPE] = g_param_spec_string(NM_SETTING_CONNECTION_TYPE, "", "", @@ -1916,30 +1916,30 @@ nm_setting_connection_class_init(NMSettingConnectionClass *klass) | G_PARAM_STATIC_STRINGS); /** - * NMSettingConnection:permissions: - * - * 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 users are allowed if and only if they are in - * this list. When this is not empty, the connection can be active only when - * one of the specified users is logged into an active session. 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. - */ + * NMSettingConnection:permissions: + * + * 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 users are allowed if and only if they are in + * this list. When this is not empty, the connection can be active only when + * one of the specified users is logged into an active session. 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. + */ /* ---ifcfg-rh--- - * property: permissions - * variable: USERS(+) - * description: Restrict to certain users the access to this connection, and - * allow the connection to be active only when at least one of the - * specified users is logged into an active session. - * example: USERS="joe bob" - * ---end--- - */ + * property: permissions + * variable: USERS(+) + * description: Restrict to certain users the access to this connection, and + * allow the connection to be active only when at least one of the + * specified users is logged into an active session. + * example: USERS="joe bob" + * ---end--- + */ obj_properties[PROP_PERMISSIONS] = g_param_spec_boxed(NM_SETTING_CONNECTION_PERMISSIONS, "", @@ -1948,24 +1948,24 @@ nm_setting_connection_class_init(NMSettingConnectionClass *klass) G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS); /** - * NMSettingConnection:autoconnect: - * - * 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. - * - * Note that autoconnect is not implemented for VPN profiles. See - * #NMSettingConnection:secondaries as an alternative to automatically - * connect VPN profiles. - **/ + * NMSettingConnection:autoconnect: + * + * 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. + * + * Note that autoconnect is not implemented for VPN profiles. See + * #NMSettingConnection:secondaries as an alternative to automatically + * connect VPN profiles. + **/ /* ---ifcfg-rh--- - * property: autoconnect - * variable: ONBOOT - * default: yes - * description: Whether the connection should be autoconnected (not only while booting). - * ---end--- - */ + * property: autoconnect + * variable: ONBOOT + * default: yes + * description: Whether the connection should be autoconnected (not only while booting). + * ---end--- + */ obj_properties[PROP_AUTOCONNECT] = g_param_spec_boolean( NM_SETTING_CONNECTION_AUTOCONNECT, "", @@ -1974,22 +1974,22 @@ nm_setting_connection_class_init(NMSettingConnectionClass *klass) G_PARAM_READWRITE | NM_SETTING_PARAM_FUZZY_IGNORE | G_PARAM_STATIC_STRINGS); /** - * NMSettingConnection:autoconnect-priority: - * - * 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. - **/ + * NMSettingConnection:autoconnect-priority: + * + * 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. + **/ /* ---ifcfg-rh--- - * property: autoconnect-priority - * variable: AUTOCONNECT_PRIORITY(+) - * values: -999 to 999 - * default: 0 - * description: Connection priority for automatic activation. Connections with - * higher numbers are preferred when selecting profiles for automatic activation. - * example: AUTOCONNECT_PRIORITY=20 - * ---end--- - */ + * property: autoconnect-priority + * variable: AUTOCONNECT_PRIORITY(+) + * values: -999 to 999 + * default: 0 + * description: Connection priority for automatic activation. Connections with + * higher numbers are preferred when selecting profiles for automatic activation. + * example: AUTOCONNECT_PRIORITY=20 + * ---end--- + */ obj_properties[PROP_AUTOCONNECT_PRIORITY] = g_param_spec_int( NM_SETTING_CONNECTION_AUTOCONNECT_PRIORITY, "", @@ -2000,23 +2000,23 @@ nm_setting_connection_class_init(NMSettingConnectionClass *klass) G_PARAM_READWRITE | NM_SETTING_PARAM_FUZZY_IGNORE | G_PARAM_STATIC_STRINGS); /** - * NMSettingConnection:autoconnect-retries: - * - * The number of times a connection should be tried when autoactivating before - * giving up. Zero means forever, -1 means the global default (4 times if not - * overridden). Setting this to 1 means to try activation only once before - * blocking autoconnect. Note that after a timeout, NetworkManager will try - * to autoconnect again. - */ + * NMSettingConnection:autoconnect-retries: + * + * The number of times a connection should be tried when autoactivating before + * giving up. Zero means forever, -1 means the global default (4 times if not + * overridden). Setting this to 1 means to try activation only once before + * blocking autoconnect. Note that after a timeout, NetworkManager will try + * to autoconnect again. + */ /* ---ifcfg-rh--- - * property: autoconnect-retries - * variable: AUTOCONNECT_RETRIES(+) - * description: The number of times a connection should be autoactivated - * before giving up and switching to the next one. - * values: -1 (use global default), 0 (forever) or a positive value - * example: AUTOCONNECT_RETRIES=1 - * ---end--- - */ + * property: autoconnect-retries + * variable: AUTOCONNECT_RETRIES(+) + * description: The number of times a connection should be autoactivated + * before giving up and switching to the next one. + * values: -1 (use global default), 0 (forever) or a positive value + * example: AUTOCONNECT_RETRIES=1 + * ---end--- + */ obj_properties[PROP_AUTOCONNECT_RETRIES] = g_param_spec_int( NM_SETTING_CONNECTION_AUTOCONNECT_RETRIES, "", @@ -2027,21 +2027,21 @@ nm_setting_connection_class_init(NMSettingConnectionClass *klass) G_PARAM_READWRITE | NM_SETTING_PARAM_FUZZY_IGNORE | G_PARAM_STATIC_STRINGS); /** - * NMSettingConnection:multi-connect: - * - * Specifies whether the profile can be active multiple times at a particular - * moment. The value is of type #NMConnectionMultiConnect. - * - * Since: 1.14 - */ + * NMSettingConnection:multi-connect: + * + * Specifies whether the profile can be active multiple times at a particular + * moment. The value is of type #NMConnectionMultiConnect. + * + * Since: 1.14 + */ /* ---ifcfg-rh--- - * property: multi-connect - * variable: MULTI_CONNECT(+) - * description: whether the profile can be active on multiple devices at a given - * moment. The values are numbers corresponding to #NMConnectionMultiConnect enum. - * example: MULTI_CONNECT=3 - * ---end--- - */ + * property: multi-connect + * variable: MULTI_CONNECT(+) + * description: whether the profile can be active on multiple devices at a given + * moment. The values are numbers corresponding to #NMConnectionMultiConnect enum. + * example: MULTI_CONNECT=3 + * ---end--- + */ obj_properties[PROP_MULTI_CONNECT] = g_param_spec_int( NM_SETTING_CONNECTION_MULTI_CONNECT, "", @@ -2052,16 +2052,16 @@ nm_setting_connection_class_init(NMSettingConnectionClass *klass) G_PARAM_READWRITE | NM_SETTING_PARAM_FUZZY_IGNORE | G_PARAM_STATIC_STRINGS); /** - * NMSettingConnection:timestamp: - * - * 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). - **/ + * NMSettingConnection:timestamp: + * + * 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). + **/ obj_properties[PROP_TIMESTAMP] = g_param_spec_uint64( NM_SETTING_CONNECTION_TIMESTAMP, "", @@ -2077,12 +2077,12 @@ nm_setting_connection_class_init(NMSettingConnectionClass *klass) .to_dbus_fcn = _to_dbus_fcn_timestamp, )); /** - * NMSettingConnection: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. - **/ + * NMSettingConnection: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. + **/ obj_properties[PROP_READ_ONLY] = g_param_spec_boolean( NM_SETTING_CONNECTION_READ_ONLY, "", @@ -2091,24 +2091,24 @@ nm_setting_connection_class_init(NMSettingConnectionClass *klass) G_PARAM_READWRITE | NM_SETTING_PARAM_FUZZY_IGNORE | G_PARAM_STATIC_STRINGS); /** - * NMSettingConnection:zone: - * - * 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. - * - * When updating this property on a currently activated connection, - * the change takes effect immediately. - **/ + * NMSettingConnection:zone: + * + * 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. + * + * When updating this property on a currently activated connection, + * the change takes effect immediately. + **/ /* ---ifcfg-rh--- - * property: zone - * variable: ZONE(+) - * description: Trust level of this connection. The string is usually used - * for a firewall. - * example: ZONE=Work - * ---end--- - */ + * property: zone + * variable: ZONE(+) + * description: Trust level of this connection. The string is usually used + * for a firewall. + * example: ZONE=Work + * ---end--- + */ obj_properties[PROP_ZONE] = g_param_spec_string(NM_SETTING_CONNECTION_ZONE, "", @@ -2118,19 +2118,19 @@ nm_setting_connection_class_init(NMSettingConnectionClass *klass) | NM_SETTING_PARAM_REAPPLY_IMMEDIATELY | G_PARAM_STATIC_STRINGS); /** - * NMSettingConnection:master: - * - * Interface name of the master device or UUID of the master connection. - **/ + * NMSettingConnection:master: + * + * Interface name of the master device or UUID of the master connection. + **/ /* ---ifcfg-rh--- - * property: master - * variable: MASTER, MASTER_UUID, TEAM_MASTER, TEAM_MASTER_UUID, BRIDGE, BRIDGE_UUID - * description: Reference to master connection. The variable used depends on - * the connection type and the value. In general, if the *_UUID variant is present, - * the variant without *_UUID is ignored. NetworkManager attempts to write both - * for compatibility with legacy tooling. - * ---end--- - */ + * property: master + * variable: MASTER, MASTER_UUID, TEAM_MASTER, TEAM_MASTER_UUID, BRIDGE, BRIDGE_UUID + * description: Reference to master connection. The variable used depends on + * the connection type and the value. In general, if the *_UUID variant is present, + * the variant without *_UUID is ignored. NetworkManager attempts to write both + * for compatibility with legacy tooling. + * ---end--- + */ obj_properties[PROP_MASTER] = g_param_spec_string(NM_SETTING_CONNECTION_MASTER, "", @@ -2140,22 +2140,22 @@ nm_setting_connection_class_init(NMSettingConnectionClass *klass) | NM_SETTING_PARAM_INFERRABLE | G_PARAM_STATIC_STRINGS); /** - * NMSettingConnection: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. - **/ + * NMSettingConnection: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. + **/ /* ---ifcfg-rh--- - * property: slave-type - * variable: MASTER, MASTER_UUID, TEAM_MASTER, TEAM_MASTER_UUID, DEVICETYPE, - * BRIDGE, BRIDGE_UUID - * description: Slave type doesn't map directly to a variable, but it is - * recognized using different variables. MASTER and MASTER_UUID for bonding, - * TEAM_MASTER, TEAM_MASTER_UUID and DEVICETYPE for teaming, BRIDGE - * and BRIDGE_UUID for bridging. - * ---end--- - */ + * property: slave-type + * variable: MASTER, MASTER_UUID, TEAM_MASTER, TEAM_MASTER_UUID, DEVICETYPE, + * BRIDGE, BRIDGE_UUID + * description: Slave type doesn't map directly to a variable, but it is + * recognized using different variables. MASTER and MASTER_UUID for bonding, + * TEAM_MASTER, TEAM_MASTER_UUID and DEVICETYPE for teaming, BRIDGE + * and BRIDGE_UUID for bridging. + * ---end--- + */ obj_properties[PROP_SLAVE_TYPE] = g_param_spec_string(NM_SETTING_CONNECTION_SLAVE_TYPE, "", @@ -2165,28 +2165,28 @@ nm_setting_connection_class_init(NMSettingConnectionClass *klass) | NM_SETTING_PARAM_INFERRABLE | G_PARAM_STATIC_STRINGS); /** - * NMSettingConnection:autoconnect-slaves: - * - * Whether or not slaves of this connection should be automatically brought up - * when NetworkManager activates this connection. This only has a real effect - * for master connections. The properties #NMSettingConnection:autoconnect, - * #NMSettingConnection:autoconnect-priority and #NMSettingConnection:autoconnect-retries - * are unrelated to this setting. - * The permitted values are: 0: leave slave connections untouched, - * 1: activate all the slave connections with this connection, -1: default. - * If -1 (default) is set, global connection.autoconnect-slaves is read to - * determine the real value. If it is default as well, this fallbacks to 0. - * - * Since: 1.2 - **/ + * NMSettingConnection:autoconnect-slaves: + * + * Whether or not slaves of this connection should be automatically brought up + * when NetworkManager activates this connection. This only has a real effect + * for master connections. The properties #NMSettingConnection:autoconnect, + * #NMSettingConnection:autoconnect-priority and #NMSettingConnection:autoconnect-retries + * are unrelated to this setting. + * The permitted values are: 0: leave slave connections untouched, + * 1: activate all the slave connections with this connection, -1: default. + * If -1 (default) is set, global connection.autoconnect-slaves is read to + * determine the real value. If it is default as well, this fallbacks to 0. + * + * Since: 1.2 + **/ /* ---ifcfg-rh--- - * property: autoconnect-slaves - * variable: AUTOCONNECT_SLAVES(+) - * default: missing variable means global default - * description: Whether slaves of this connection should be auto-connected - * when this connection is activated. - * ---end--- - */ + * property: autoconnect-slaves + * variable: AUTOCONNECT_SLAVES(+) + * default: missing variable means global default + * description: Whether slaves of this connection should be auto-connected + * when this connection is activated. + * ---end--- + */ obj_properties[PROP_AUTOCONNECT_SLAVES] = g_param_spec_enum( NM_SETTING_CONNECTION_AUTOCONNECT_SLAVES, "", @@ -2196,19 +2196,19 @@ nm_setting_connection_class_init(NMSettingConnectionClass *klass) G_PARAM_READWRITE | NM_SETTING_PARAM_FUZZY_IGNORE | G_PARAM_STATIC_STRINGS); /** - * NMSettingConnection:secondaries: - * - * List of connection UUIDs that should be activated when the base - * connection itself is activated. Currently, only VPN connections are - * supported. - **/ + * NMSettingConnection:secondaries: + * + * List of connection UUIDs that should be activated when the base + * connection itself is activated. Currently, only VPN connections are + * supported. + **/ /* ---ifcfg-rh--- - * property: secondaries - * variable: SECONDARY_UUIDS(+) - * description: UUID of VPN connections that should be activated - * together with this connection. - * ---end--- - */ + * property: secondaries + * variable: SECONDARY_UUIDS(+) + * description: UUID of VPN connections that should be activated + * together with this connection. + * ---end--- + */ obj_properties[PROP_SECONDARIES] = g_param_spec_boxed( NM_SETTING_CONNECTION_SECONDARIES, "", @@ -2217,20 +2217,20 @@ nm_setting_connection_class_init(NMSettingConnectionClass *klass) G_PARAM_READWRITE | NM_SETTING_PARAM_FUZZY_IGNORE | G_PARAM_STATIC_STRINGS); /** - * NMSettingConnection:gateway-ping-timeout: - * - * If greater than zero, delay success of IP addressing until either the - * timeout is reached, or an IP gateway replies to a ping. - **/ + * NMSettingConnection:gateway-ping-timeout: + * + * If greater than zero, delay success of IP addressing until either the + * timeout is reached, or an IP gateway replies to a ping. + **/ /* ---ifcfg-rh--- - * property: gateway-ping-timeout - * variable: GATEWAY_PING_TIMEOUT(+) - * default: 0 - * description: If greater than zero, the IP connectivity will be checked by - * pinging the gateway and waiting for the specified timeout (in seconds). - * example: GATEWAY_PING_TIMEOUT=5 - * ---end--- - */ + * property: gateway-ping-timeout + * variable: GATEWAY_PING_TIMEOUT(+) + * default: 0 + * description: If greater than zero, the IP connectivity will be checked by + * pinging the gateway and waiting for the specified timeout (in seconds). + * example: GATEWAY_PING_TIMEOUT=5 + * ---end--- + */ obj_properties[PROP_GATEWAY_PING_TIMEOUT] = g_param_spec_uint(NM_SETTING_CONNECTION_GATEWAY_PING_TIMEOUT, "", @@ -2241,23 +2241,23 @@ nm_setting_connection_class_init(NMSettingConnectionClass *klass) G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS); /** - * NMSettingConnection:metered: - * - * Whether the connection is metered. - * - * When updating this property on a currently activated connection, - * the change takes effect immediately. - * - * Since: 1.2 - **/ + * NMSettingConnection:metered: + * + * Whether the connection is metered. + * + * When updating this property on a currently activated connection, + * the change takes effect immediately. + * + * Since: 1.2 + **/ /* ---ifcfg-rh--- - * property: metered - * variable: CONNECTION_METERED(+) - * values: yes,no,unknown - * description: Whether the device is metered - * example: CONNECTION_METERED=yes - * ---end--- - */ + * property: metered + * variable: CONNECTION_METERED(+) + * values: yes,no,unknown + * description: Whether the device is metered + * example: CONNECTION_METERED=yes + * ---end--- + */ obj_properties[PROP_METERED] = g_param_spec_enum( NM_SETTING_CONNECTION_METERED, "", @@ -2267,21 +2267,21 @@ nm_setting_connection_class_init(NMSettingConnectionClass *klass) G_PARAM_READWRITE | NM_SETTING_PARAM_REAPPLY_IMMEDIATELY | G_PARAM_STATIC_STRINGS); /** - * NMSettingConnection:lldp: - * - * Whether LLDP is enabled for the connection. - * - * Since: 1.2 - **/ + * NMSettingConnection:lldp: + * + * Whether LLDP is enabled for the connection. + * + * Since: 1.2 + **/ /* ---ifcfg-rh--- - * property: lldp - * variable: LLDP(+) - * values: boolean value or 'rx' - * default: missing variable means global default - * description: whether LLDP is enabled for the connection - * example: LLDP=no - * ---end--- - */ + * property: lldp + * variable: LLDP(+) + * values: boolean value or 'rx' + * default: missing variable means global default + * description: whether LLDP is enabled for the connection + * example: LLDP=no + * ---end--- + */ obj_properties[PROP_LLDP] = g_param_spec_int(NM_SETTING_CONNECTION_LLDP, "", "", @@ -2292,23 +2292,23 @@ nm_setting_connection_class_init(NMSettingConnectionClass *klass) | G_PARAM_STATIC_STRINGS); /** - * NMSettingConnection:auth-retries: - * - * The number of retries for the authentication. Zero means to try indefinitely; -1 means - * to use a global default. If the global default is not set, the authentication - * retries for 3 times before failing the connection. - * - * Currently, this only applies to 802-1x authentication. - * - * Since: 1.10 - **/ + * NMSettingConnection:auth-retries: + * + * The number of retries for the authentication. Zero means to try indefinitely; -1 means + * to use a global default. If the global default is not set, the authentication + * retries for 3 times before failing the connection. + * + * Currently, this only applies to 802-1x authentication. + * + * Since: 1.10 + **/ /* ---ifcfg-rh--- - * property: auth-retries - * variable: AUTH_RETRIES(+) - * default: 0 - * description: Number of retries for authentication. - * ---end--- - */ + * property: auth-retries + * variable: AUTH_RETRIES(+) + * default: 0 + * description: Number of retries for authentication. + * ---end--- + */ obj_properties[PROP_AUTH_RETRIES] = g_param_spec_int( NM_SETTING_CONNECTION_AUTH_RETRIES, "", @@ -2319,31 +2319,31 @@ nm_setting_connection_class_init(NMSettingConnectionClass *klass) G_PARAM_READWRITE | NM_SETTING_PARAM_FUZZY_IGNORE | G_PARAM_STATIC_STRINGS); /** - * NMSettingConnection:mdns: - * - * Whether mDNS is enabled for the connection. - * - * The permitted values are: "yes" (2) register hostname and resolving - * for the connection, "no" (0) disable mDNS for the interface, "resolve" - * (1) do not register hostname but allow resolving of mDNS host names - * and "default" (-1) to allow lookup of a global default in NetworkManager.conf. - * If unspecified, "default" ultimately depends on the DNS plugin (which - * for systemd-resolved currently means "no"). - * - * This feature requires a plugin which supports mDNS. Otherwise, the - * setting has no effect. One such plugin is dns-systemd-resolved. + * NMSettingConnection:mdns: + * + * Whether mDNS is enabled for the connection. + * + * The permitted values are: "yes" (2) register hostname and resolving + * for the connection, "no" (0) disable mDNS for the interface, "resolve" + * (1) do not register hostname but allow resolving of mDNS host names + * and "default" (-1) to allow lookup of a global default in NetworkManager.conf. + * If unspecified, "default" ultimately depends on the DNS plugin (which + * for systemd-resolved currently means "no"). + * + * This feature requires a plugin which supports mDNS. Otherwise, the + * setting has no effect. One such plugin is dns-systemd-resolved. * - * Since: 1.12 - **/ + * Since: 1.12 + **/ /* ---ifcfg-rh--- - * property: mdns - * variable: MDNS(+) - * values: yes,no,resolve - * default: missing variable means global default - * description: Whether or not mDNS is enabled for the connection - * example: MDNS=yes - * ---end--- - */ + * property: mdns + * variable: MDNS(+) + * values: yes,no,resolve + * default: missing variable means global default + * description: Whether or not mDNS is enabled for the connection + * example: MDNS=yes + * ---end--- + */ obj_properties[PROP_MDNS] = g_param_spec_int(NM_SETTING_CONNECTION_MDNS, "", "", @@ -2353,33 +2353,33 @@ nm_setting_connection_class_init(NMSettingConnectionClass *klass) G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS); /** - * NMSettingConnection:llmnr: - * - * Whether Link-Local Multicast Name Resolution (LLMNR) is enabled - * for the connection. LLMNR is a protocol based on the Domain Name - * System (DNS) packet format that allows both IPv4 and IPv6 hosts - * to perform name resolution for hosts on the same local link. - * - * The permitted values are: "yes" (2) register hostname and resolving - * for the connection, "no" (0) disable LLMNR for the interface, "resolve" - * (1) do not register hostname but allow resolving of LLMNR host names - * If unspecified, "default" ultimately depends on the DNS plugin (which - * for systemd-resolved currently means "yes"). - * - * This feature requires a plugin which supports LLMNR. Otherwise, the - * setting has no effect. One such plugin is dns-systemd-resolved. - * - * Since: 1.14 - **/ + * NMSettingConnection:llmnr: + * + * Whether Link-Local Multicast Name Resolution (LLMNR) is enabled + * for the connection. LLMNR is a protocol based on the Domain Name + * System (DNS) packet format that allows both IPv4 and IPv6 hosts + * to perform name resolution for hosts on the same local link. + * + * The permitted values are: "yes" (2) register hostname and resolving + * for the connection, "no" (0) disable LLMNR for the interface, "resolve" + * (1) do not register hostname but allow resolving of LLMNR host names + * If unspecified, "default" ultimately depends on the DNS plugin (which + * for systemd-resolved currently means "yes"). + * + * This feature requires a plugin which supports LLMNR. Otherwise, the + * setting has no effect. One such plugin is dns-systemd-resolved. + * + * Since: 1.14 + **/ /* ---ifcfg-rh--- - * property: llmnr - * variable: LLMNR(+) - * values: yes,no,resolve - * default: missing variable means global default - * description: Whether or not LLMNR is enabled for the connection - * example: LLMNR=yes - * ---end--- - */ + * property: llmnr + * variable: LLMNR(+) + * values: yes,no,resolve + * default: missing variable means global default + * description: Whether or not LLMNR is enabled for the connection + * example: LLMNR=yes + * ---end--- + */ obj_properties[PROP_LLMNR] = g_param_spec_int(NM_SETTING_CONNECTION_LLMNR, "", "", @@ -2389,30 +2389,30 @@ nm_setting_connection_class_init(NMSettingConnectionClass *klass) G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS); /** - * NMSettingConnection:wait-device-timeout: - * - * Timeout in milliseconds to wait for device at startup. - * During boot, devices may take a while to be detected by the driver. - * This property will cause to delay NetworkManager-wait-online.service - * and nm-online to give the device a chance to appear. This works by - * waiting for the given timeout until a compatible device for the - * profile is available and managed. - * - * The value 0 means no wait time. The default value is -1, which - * currently has the same meaning as no wait time. - * - * Since: 1.20 - **/ + * NMSettingConnection:wait-device-timeout: + * + * Timeout in milliseconds to wait for device at startup. + * During boot, devices may take a while to be detected by the driver. + * This property will cause to delay NetworkManager-wait-online.service + * and nm-online to give the device a chance to appear. This works by + * waiting for the given timeout until a compatible device for the + * profile is available and managed. + * + * The value 0 means no wait time. The default value is -1, which + * currently has the same meaning as no wait time. + * + * Since: 1.20 + **/ /* ---ifcfg-rh--- - * property: wait-device-timeout - * variable: DEVTIMEOUT(+) - * values: timeout in seconds. - * description: for initscripts compatibility, this variable must be - * a whole integer. If necessary, NetworkManager stores also a fractional - * component for the milliseconds. - * example: DEVTIMEOUT=5 - * ---end--- - */ + * property: wait-device-timeout + * variable: DEVTIMEOUT(+) + * values: timeout in seconds. + * description: for initscripts compatibility, this variable must be + * a whole integer. If necessary, NetworkManager stores also a fractional + * component for the milliseconds. + * example: DEVTIMEOUT=5 + * ---end--- + */ obj_properties[PROP_WAIT_DEVICE_TIMEOUT] = g_param_spec_int(NM_SETTING_CONNECTION_WAIT_DEVICE_TIMEOUT, "", @@ -2423,27 +2423,27 @@ nm_setting_connection_class_init(NMSettingConnectionClass *klass) G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS); /** - * NMSettingConnection:mud-url: - * - * If configured, set to a Manufacturer Usage Description (MUD) URL that points - * to manufacturer-recommended network policies for IoT devices. It is transmitted - * as a DHCPv4 or DHCPv6 option. The value must be a valid URL starting with "https://". - * - * The special value "none" is allowed to indicate that no MUD URL is used. - * - * If the per-profile value is unspecified (the default), a global connection default gets - * consulted. If still unspecified, the ultimate default is "none". - * - * Since: 1.26 - **/ + * NMSettingConnection:mud-url: + * + * If configured, set to a Manufacturer Usage Description (MUD) URL that points + * to manufacturer-recommended network policies for IoT devices. It is transmitted + * as a DHCPv4 or DHCPv6 option. The value must be a valid URL starting with "https://". + * + * The special value "none" is allowed to indicate that no MUD URL is used. + * + * If the per-profile value is unspecified (the default), a global connection default gets + * consulted. If still unspecified, the ultimate default is "none". + * + * Since: 1.26 + **/ /* ---ifcfg-rh--- - * property: mud-url - * variable: MUD_URL - * values: a valid URL that points to recommended policy for this device - * description: MUD_URL to be sent by device (See RFC 8520). - * example: https://yourdevice.example.com/model.json - * ---end--- - */ + * property: mud-url + * variable: MUD_URL + * values: a valid URL that points to recommended policy for this device + * description: MUD_URL to be sent by device (See RFC 8520). + * example: https://yourdevice.example.com/model.json + * ---end--- + */ obj_properties[PROP_MUD_URL] = g_param_spec_string(NM_SETTING_CONNECTION_MUD_URL, "", "", |