Struct SettingConnection

Source

pub struct SettingConnection { /* private fields */ }

Expand description

General Connection Profile Settings

§Properties

§`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.

Readable | Writeable

§`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.

Autoconnect happens when the circumstances are suitable. That means for example that the device is currently managed and not active. Autoconnect thus never replaces or competes with an already active profile.

Note that autoconnect is not implemented for VPN profiles. See #NMSettingConnection:secondaries as an alternative to automatically connect VPN profiles.

If multiple profiles are ready to autoconnect on the same device, the one with the better “connection.autoconnect-priority” is chosen. If the priorities are equal, then the most recently connected profile is activated. If the profiles were not connected earlier or their “connection.timestamp” is identical, the choice is undefined.

Depending on “connection.multi-connect”, a profile can (auto)connect only once at a time or multiple times.

Readable | Writeable

§`autoconnect-ports`

Whether or not ports of this connection should be automatically brought up when NetworkManager activates this connection. This only has a real effect for controller connections. The properties #NMSettingConnection:autoconnect, #NMSettingConnection:autoconnect-priority and #NMSettingConnection:autoconnect-retries are unrelated to this setting. The permitted values are: 0: leave port connections untouched, 1: activate all the port connections with this connection, -1: default. If -1 (default) is set, global connection.autoconnect-ports is read to determine the real value. If it is default as well, this fallbacks to 0.

Readable | Writeable

§`autoconnect-priority`

The autoconnect priority in range -999 to 999. If the connection is set to autoconnect, connections with higher priority will be preferred. The higher number means higher priority. Defaults to 0. Note that this property only matters if there are more than one candidate profile to select for autoconnect. In case of equal priority, the profile used most recently is chosen.

Readable | Writeable

§`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.

Readable | Writeable

§`autoconnect-slaves`

Whether or not ports of this connection should be automatically brought up when NetworkManager activates this connection. This only has a real effect for controller connections. The properties #NMSettingConnection:autoconnect, #NMSettingConnection:autoconnect-priority and #NMSettingConnection:autoconnect-retries are unrelated to this setting. The permitted values are: 0: leave port connections untouched, 1: activate all the port 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.

Deprecated 1.46. Use #NMSettingConnection:autoconnect-ports instead, this is just an alias.

Readable | Writeable

§`controller`

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

Readable | Writeable

§`dns-over-tls`

Whether DNSOverTls (dns-over-tls) is enabled for the connection. DNSOverTls is a technology which uses TLS to encrypt dns traffic.

The permitted values are: “yes” (2) use DNSOverTls and disabled fallback, “opportunistic” (1) use DNSOverTls but allow fallback to unencrypted resolution, “no” (0) don’t ever use DNSOverTls. If unspecified “default” depends on the plugin used. Systemd-resolved uses global setting.

This feature requires a plugin which supports DNSOverTls. Otherwise, the setting has no effect. One such plugin is dns-systemd-resolved.

Readable | Writeable

§`down-on-poweroff`

Whether the connection will be brought down before the system is powered off. The default value is [SettingConnectionDownOnPoweroff::Default][crate::SettingConnectionDownOnPoweroff::Default]. When the default value is specified, then the global value from NetworkManager configuration is looked up, if not set, it is considered as [SettingConnectionDownOnPoweroff::No][crate::SettingConnectionDownOnPoweroff::No].

Readable | Writeable

§`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.

Readable | Writeable

§`id`

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

Readable | Writeable

§`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.

Readable | Writeable

§`ip-ping-addresses`

The property specifies a list of target IP addresses for pinging. When multiple targets are set, NetworkManager will start multiple ping processes in parallel. This property can only be set if connection.ip-ping-timeout is set. The ip-ping-timeout is used to delay the success of IP addressing until either the specified timeout (in seconds) is reached, or an target IP address replies to a ping. Configuring #NMSettingConnection:ip-ping-addresses may delay reaching the systemd’s network-online.target due to waiting for the ping operations to complete or timeout.

Readable | Writeable

§`ip-ping-addresses-require-all`

The property determines whether it is sufficient for any ping check to succeed among #NMSettingConnection:ip-ping-addresses, or if all ping checks must succeed for #NMSettingConnection:ip-ping-addresses.

Readable | Writeable

§`ip-ping-timeout`

If greater than zero, delay success of IP addressing until either the specified timeout (in seconds) is reached, or a target IP address replies to a ping. The property specifies the timeout for the #NMSettingConnection:ip-ping-addresses. This property is incompatible with #NMSettingConnection:gateway-ping-timeout, you cannot set these two properties at the same time.

Readable | Writeable

§`lldp`

Whether LLDP is enabled for the connection.

Readable | Writeable

§`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.

Readable | Writeable

§`master`

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

Deprecated 1.46. Use #NMSettingConnection:controller instead, this is just an alias.

Readable | Writeable

§`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.

This feature requires a plugin which supports mDNS. Otherwise, the setting has no effect. Currently the only supported DNS plugin is systemd-resolved. For systemd-resolved, the default is configurable via MulticastDNS= setting in resolved.conf.

Readable | Writeable

§`metered`

Whether the connection is metered.

When updating this property on a currently activated connection, the change takes effect immediately.

Readable | Writeable

§`mptcp-flags`

Whether to configure MPTCP endpoints and the address flags. If MPTCP is enabled in NetworkManager, it will configure the addresses of the interface as MPTCP endpoints. Note that IPv4 loopback addresses (127.0.0.0/8), IPv4 link local addresses (169.254.0.0/16), the IPv6 loopback address (::1), IPv6 link local addresses (fe80::/10), IPv6 unique local addresses (ULA, fc00::/7) and IPv6 privacy extension addresses (rfc3041, ipv6.ip6-privacy) will be excluded from being configured as endpoints.

If “disabled” (0x1), MPTCP handling for the interface is disabled and no endpoints are registered.

The “enabled” (0x2) flag means that MPTCP handling is enabled. This flag can also be implied from the presence of other flags.

Even when enabled, MPTCP handling will by default still be disabled unless “/proc/sys/net/mptcp/enabled” sysctl is on. NetworkManager does not change the sysctl and this is up to the administrator or distribution. To configure endpoints even if the sysctl is disabled, “also-without-sysctl” (0x4) flag can be used. In that case, NetworkManager doesn’t look at the sysctl and configures endpoints regardless.

Even when enabled, NetworkManager will only configure MPTCP endpoints for a certain address family, if there is a unicast default route (0.0.0.0/0 or ::/0) in the main routing table. The flag “also-without-default-route” (0x8) can override that.

When MPTCP handling is enabled then endpoints are configured with the specified address flags “signal” (0x10), “subflow” (0x20), “backup” (0x40), “fullmesh” (0x80). See ip-mptcp(8) manual for additional information about the flags.

If the flags are zero (0x0), the global connection default from NetworkManager.conf is honored. If still unspecified, the fallback is “enabled,subflow”. Note that this means that MPTCP is by default done depending on the “/proc/sys/net/mptcp/enabled” sysctl.

NetworkManager does not change the MPTCP limits nor enable MPTCP via “/proc/sys/net/mptcp/enabled”. That is a host configuration which the admin can change via sysctl and ip-mptcp.

Strict reverse path filtering (rp_filter) breaks many MPTCP use cases, so when MPTCP handling for IPv4 addresses on the interface is enabled, NetworkManager would loosen the strict reverse path filtering (1) to the loose setting (2).

Readable | Writeable

§`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”.

Readable | Writeable

§`multi-connect`

Specifies whether the profile can be active multiple times at a particular moment. The value is of type #NMConnectionMultiConnect.

Readable | Writeable

§`permissions`

An array of strings defining what access a given user has to this connection. If this is None 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.

Readable | Writeable

§`port-type`

Setting name of the device type of this port’s controller connection (eg, SETTING_BOND_SETTING_NAME), or None if this connection is not a port.

Readable | Writeable

§`read-only`

This property is deprecated and has no meaning.

Readable | Writeable

§`secondaries`

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

Readable | Writeable

§`slave-type`

Setting name of the device type of this port’s controller connection (eg, SETTING_BOND_SETTING_NAME), or None if this connection is not a port.

Deprecated 1.46. Use #NMSettingConnection:port-type instead, this is just an alias.

Readable | Writeable

§`stable-id`

This represents the identity of the connection used for various purposes. It allows configuring 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 to derive the DHCP client identifier with ipv4.dhcp-client-id=stable, the DHCPv6 DUID with ipv6.dhcp-duid=stable-[llt,ll,uuid] and the DHCP IAID with ipv4.iaid=stable and ipv6.iaid=stable.

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. See NetworkManager(8) manual about the secret-key and the host identity.

The ‘$’ character is treated special to perform dynamic substitutions at activation time. Currently, supported are “${CONNECTION}”, “${DEVICE}”, “${MAC}”, “${NETWORK_SSID}”, “${BOOT}”, “${RANDOM}”. These effectively create unique IDs per-connection, per-device, per-SSID, per-boot, or every time. The “${CONNECTION}” uses the profile’s connection.uuid, the “${DEVICE}” uses the interface name of the device and “${MAC}” the permanent MAC address of the device. “${NETWORK_SSID}” uses the SSID for Wi-Fi networks and falls back to “${CONNECTION}” on other networks. 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 “default${CONNECTION}” go generate an ID unique per connection profile.

Readable | Writeable

§`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).

Readable | Writeable

§`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).

Readable | Writeable

§`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_uuid_generate_from_string_str().

Readable | Writeable

§`wait-activation-delay`

Time in milliseconds to wait for connection to be considered activated. The wait will start after the pre-up dispatcher event.

The value 0 means no wait time. The default value is -1, which currently has the same meaning as no wait time.

Readable | Writeable

§`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.

Readable | Writeable

§`zone`

The trust level of a the connection. Free form case-insensitive string (for example “Home”, “Work”, “Public”). None 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.

Readable | Writeable

Setting

§`name`

The setting’s name, which uniquely identifies the setting within the connection. Each setting type has a name unique to that type, for example “ppp” or “802-11-wireless” or “802-3-ethernet”.

Readable

§Implements

SettingExt

GLib type: GObject with reference counted clone semantics.

Struct SettingConnection Copy item path

§Properties

§auth-retries

§autoconnect

§autoconnect-ports

§autoconnect-priority

§autoconnect-retries

§autoconnect-slaves

§controller

§dns-over-tls

§down-on-poweroff

§gateway-ping-timeout

§id

§interface-name

§ip-ping-addresses

§ip-ping-addresses-require-all

§ip-ping-timeout

§lldp

§llmnr

§master

§mdns

§metered

§mptcp-flags

§mud-url

§multi-connect

§permissions

§port-type

§read-only

§secondaries

§slave-type

§stable-id

§timestamp

§type

§uuid

§wait-activation-delay

§wait-device-timeout

§zone

Setting

§name

§Implements

Implementations§

impl SettingConnection

pub fn new() -> SettingConnection

§Returns

pub fn builder() -> SettingConnectionBuilder

pub fn add_permission( &self, ptype: &str, pitem: &str, detail: Option<&str>, ) -> bool

§ptype

§pitem

§detail

§Returns

pub fn add_secondary(&self, sec_uuid: &str) -> bool

§sec_uuid

§Returns

pub fn auth_retries(&self) -> i32

§Returns

pub fn is_autoconnect(&self) -> bool

§Returns

pub fn autoconnect_priority(&self) -> i32

§Returns

pub fn autoconnect_retries(&self) -> i32

§Returns

pub fn autoconnect_slaves(&self) -> SettingConnectionAutoconnectSlaves

§Deprecated since 1.46

§Returns

pub fn connection_type(&self) -> GString

§Returns

pub fn gateway_ping_timeout(&self) -> u32

§Returns

pub fn id(&self) -> GString

§Returns

pub fn interface_name(&self) -> GString

§Returns

pub fn lldp(&self) -> SettingConnectionLldp

§Returns

pub fn llmnr(&self) -> SettingConnectionLlmnr

§Returns

pub fn master(&self) -> GString

§Deprecated since 1.46

§Returns

pub fn mdns(&self) -> SettingConnectionMdns

Struct SettingConnection

§`auth-retries`

§`autoconnect`

§`autoconnect-ports`

§`autoconnect-priority`

§`autoconnect-retries`

§`autoconnect-slaves`

§`controller`

§`dns-over-tls`

§`down-on-poweroff`

§`gateway-ping-timeout`

§`id`

§`interface-name`

§`ip-ping-addresses`

§`ip-ping-addresses-require-all`

§`ip-ping-timeout`

§`lldp`

§`llmnr`

§`master`

§`mdns`

§`metered`

§`mptcp-flags`

§`mud-url`

§`multi-connect`

§`permissions`

§`port-type`

§`read-only`

§`secondaries`

§`slave-type`

§`stable-id`

§`timestamp`

§`type`

§`uuid`

§`wait-activation-delay`

§`wait-device-timeout`

§`zone`

§`name`

§`ptype`

§`pitem`

§`detail`

§`sec_uuid`

§`idx`

§`out_ptype`

§`out_pitem`

§`out_detail`

§`idx`

§`type_`

§`uname`

§`idx`

§`ptype`

§`pitem`

§`detail`

§`idx`

§`sec_uuid`