1NETWORKMANAGER.CONF(5) Configuration NETWORKMANAGER.CONF(5)
2
6 NetworkManager.conf - NetworkManager configuration file
7
9 /etc/NetworkManager/NetworkManager.conf,
10 /etc/NetworkManager/conf.d/name.conf,
11 /run/NetworkManager/conf.d/name.conf,
12 /usr/lib/NetworkManager/conf.d/name.conf,
13 /var/lib/NetworkManager/NetworkManager-intern.conf
14
16 NetworkManager.conf is the configuration file for NetworkManager. It is
17 used to set up various aspects of NetworkManager's behavior. The
18 location of the main file and configuration directories may be changed
19 through use of the --config, --config-dir, --system-config-dir, and
20 --intern-config argument for NetworkManager, respectively.
21 If a default NetworkManager.conf is provided by your distribution's
23 packages, you should not modify it, since your changes may get
24 overwritten by package updates. Instead, you can add additional .conf
25 files to the /etc/NetworkManager/conf.d directory. These will be read
26 in order, with later files overriding earlier ones. Packages might
27 install further configuration snippets to
28 /usr/lib/NetworkManager/conf.d. This directory is parsed first, even
29 before NetworkManager.conf. Scripts can also put per-boot configuration
30 into /run/NetworkManager/conf.d. This directory is parsed second, also
31 before NetworkManager.conf. The loading of a file
32 /run/NetworkManager/conf.d/name.conf can be prevented by adding a file
33 /etc/NetworkManager/conf.d/name.conf. Likewise, a file
34 /usr/lib/NetworkManager/conf.d/name.conf can be shadowed by putting a
35 file of the same name to either /etc/NetworkManager/conf.d or
36 /run/NetworkManager/conf.d.
37 NetworkManager can overwrite certain user configuration options via
39 D-Bus or other internal operations. In this case it writes those
40 changes to /var/lib/NetworkManager/NetworkManager-intern.conf. This
41 file is not intended to be modified by the user, but it is read last
42 and can shadow user configuration from NetworkManager.conf.
43 Certain settings from the configuration can be reloaded at runtime
45 either by sending SIGHUP signal or via D-Bus' Reload call.
46 NetworkManager does not require any configuration in
48 NetworkManager.conf. Depending on your use case, you may remove all
49 files to restore the default configuration (factory reset). But note
50 that your distribution or other packages may drop configuration
51 snippets for NetworkManager, such that they are part of the factory
52 default.
53
55 The configuration file format is so-called key file (sort of ini-style
56 format). It consists of sections (groups) of key-value pairs. Lines
57 beginning with a '#' and blank lines are considered comments. Sections
58 are started by a header line containing the section enclosed in '[' and
59 ']', and ended implicitly by the start of the next section or the end
60 of the file. Each key-value pair must be contained in a section.
61 For keys that take a list of devices as their value, you can specify
63 devices by their MAC addresses or interface names, or "*" to specify
64 all devices. See the section called “Device List Format” below.
65 A simple configuration file looks like this:
67 [main]
69 plugins=keyfile
70 As an extension to the normal keyfile format, you can also append a
72 value to a previously-set list-valued key by doing:
73 plugins+=another-plugin
75 plugins-=remove-me
76
79 plugins
80 Lists system settings plugin names separated by ','. These plugins
81 are used to read and write system-wide connection profiles. When
82 multiple plugins are specified, the connections are read from all
83 listed plugins. When writing connections, the plugins will be asked
84 to save the connection in the order listed here; if the first
85 plugin cannot write out that connection type (or can't write out
86 any connections) the next plugin is tried, etc. If none of the
87 plugins can save the connection, an error is returned to the user.
88 The default value and the number of available plugins is
90 distro-specific. See the section called “PLUGINS” below for the
91 available plugins. Note that NetworkManager's native keyfile plugin
92 is always appended to the end of this list (if it doesn't already
93 appear earlier in the list).
94 monitor-connection-files
96 This setting is deprecated and has no effect. Profiles from disk
97 are never automatically reloaded. Use for example nmcli connection
98 (re)load for that.
99 auth-polkit
101 Whether the system uses PolicyKit for authorization. If true,
102 non-root requests are authorized using PolicyKit. Requests from
103 root (user ID zero) are always granted without asking PolicyKit. If
104 false, all requests will be allowed and PolicyKit is not used. If
105 set to root-only PolicyKit is not used and all requests except root
106 are denied. The default value is true.
107 dhcp
109 This key sets up what DHCP client NetworkManager will use. Allowed
110 values are dhclient, dhcpcd, and internal. The dhclient and dhcpcd
111 options require the indicated clients to be installed. The internal
112 option uses a built-in DHCP client which is not currently as
113 featureful as the external clients.
114 If this key is missing, it defaults to internal. If the chosen
116 plugin is not available, clients are looked for in this order:
117 dhclient, dhcpcd, internal.
118 no-auto-default
120 Specify devices for which NetworkManager shouldn't create default
121 wired connection (Auto eth0). By default, NetworkManager creates a
122 temporary wired connection for any Ethernet device that is managed
123 and doesn't have a connection configured. List a device in this
124 option to inhibit creating the default connection for the device.
125 May have the special value * to apply to all devices.
126 When the default wired connection is deleted or saved to a new
128 persistent connection by a plugin, the device is added to a list in
129 the file /var/lib/NetworkManager/no-auto-default.state to prevent
130 creating the default connection for that device again.
131 See the section called “Device List Format” for the syntax how to
133 specify a device.
134 Example:
136 no-auto-default=00:22:68:5c:5d:c4,00:1e:65:ff:aa:ee
138 no-auto-default=eth0,eth1
139 no-auto-default=*
140 ignore-carrier
143 This setting is deprecated for the per-device setting
144 ignore-carrier which overwrites this setting if specified (See
145 ignore-carrier). Otherwise, it is a list of matches to specify for
146 which device carrier should be ignored. See the section called
147 “Device List Format” for the syntax how to specify a device. Note
148 that master types like bond, bridge, and team ignore carrier by
149 default. You can however revert that default using the "except:"
150 specifier (or better, use the per-device setting instead of the
151 deprecated setting).
152 assume-ipv6ll-only
154 Specify devices for which NetworkManager will try to generate a
155 connection based on initial configuration when the device only has
156 an IPv6 link-local address.
157 See the section called “Device List Format” for the syntax how to
159 specify a device.
160 configure-and-quit
162 This option is no longer useful to configure in NetworkManager.conf
163 file. It can however also be configured on the command line with
164 the same values, where it has some use.
165 When set to 'initrd', NetworkManager does not connect to D-Bus and
167 quits after configuring the network. This is an implementation
168 detail how the NetworkManager module of dracut can run
169 NetworkManager. An alternative to this is having NetworkManager as
170 a systemd service with D-Bus in initrd.
171 The value 'true' is unsupported since version 1.36. Previously this
173 was a mode where NetworkManager would quit after configuring the
174 network and run helper processes for DHCP and SLAAC.
175 Otherwise, NetworkManager runs a system service with D-Bus and does
177 not quit during normal operation.
178 hostname-mode
180 Set the management mode of the hostname. This parameter will affect
181 only the transient hostname. If a valid static hostname is set,
182 NetworkManager will skip the update of the hostname despite the
183 value of this option. An hostname empty or equal to 'localhost',
184 'localhost6', 'localhost.localdomain' or 'localhost6.localdomain'
185 is considered invalid.
186 default: NetworkManager will update the hostname with the one
188 provided via DHCP or reverse DNS lookup of the IP address on the
189 connection with the default route or on any connection with the
190 property hostname.only-from-default set to 'false'. Connections are
191 considered in order of increasing value of the hostname.priority
192 property. In case multiple connections have the same priority,
193 connections activated earlier are considered first. If no hostname
194 can be determined in such way, the hostname will be updated to the
195 last one set outside NetworkManager or to 'localhost.localdomain'.
196 dhcp: this is similar to 'default', with the difference that after
198 trying to get the DHCP hostname, reverse DNS lookup is not done.
199 Note that selecting this option is equivalent to setting the
200 property 'hostname.from-dns-lookup' to 'false' globally for all
201 connections in NetworkManager.conf.
202 none: NetworkManager will not manage the transient hostname and
204 will never set it.
205 dns
207 Set the DNS processing mode.
208 If the key is unspecified, default is used, unless /etc/resolv.conf
210 is a symlink to /run/systemd/resolve/stub-resolv.conf,
211 /run/systemd/resolve/resolv.conf, /lib/systemd/resolv.conf or
212 /usr/lib/systemd/resolv.conf. In that case, systemd-resolved is
213 chosen automatically.
214 default: NetworkManager will update /etc/resolv.conf to reflect the
216 nameservers provided by currently active connections. The
217 rc-manager setting (below) controls how this is done.
218 dnsmasq: NetworkManager will run dnsmasq as a local caching
220 nameserver, using "Conditional Forwarding" if you are connected to
221 a VPN, and then update resolv.conf to point to the local
222 nameserver. It is possible to pass custom options to the dnsmasq
223 instance by adding them to files in the
224 "/etc/NetworkManager/dnsmasq.d/" directory. Note that when multiple
225 upstream servers are available, dnsmasq will initially contact them
226 in parallel and then use the fastest to respond, probing again
227 other servers after some time. This behavior can be modified
228 passing the 'all-servers' or 'strict-order' options to dnsmasq (see
229 the manual page for more details).
230 systemd-resolved: NetworkManager will push the DNS configuration to
232 systemd-resolved
233 none: NetworkManager will not modify resolv.conf. This implies
235 rc-manager unmanaged
236 Note that the plugins dnsmasq and systemd-resolved are caching
238 local nameservers. Hence, when NetworkManager writes
239 /run/NetworkManager/resolv.conf and /etc/resolv.conf (according to
240 rc-manager setting below), the name server there will be localhost
241 only. NetworkManager also writes a file
242 /run/NetworkManager/no-stub-resolv.conf that contains the original
243 name servers pushed to the DNS plugin.
244 When using dnsmasq and systemd-resolved, per-connection added dns
246 servers will always be queried using the device the connection has
247 been activated on.
248 rc-manager
250 Set the resolv.conf management mode. This option is about how
251 NetworkManager writes to /etc/resolv.conf, if at all. The default
252 value depends on NetworkManager build options, and this version of
253 NetworkManager was build with a default of "auto". Regardless of
254 this setting, NetworkManager will always write its version of
255 resolv.conf to its runtime state directory as
256 /run/NetworkManager/resolv.conf.
257 If you configure dns=none or make /etc/resolv.conf immutable with
259 chattr +i, NetworkManager will ignore this setting and always
260 choose unmanaged (below).
261 auto: if systemd-resolved plugin is configured via the dns setting
263 or if it gets detected as main DNS plugin, NetworkManager will
264 update systemd-resolved without touching /etc/resolv.conf.
265 Alternatively, if resolvconf or netconfig are enabled at compile
266 time and the respective binary is found, NetworkManager will
267 automatically use it. Note that if you install or uninstall these
268 binaries, you need to reload the rc-manager setting with SIGHUP or
269 systemctl reload NetworkManager. As last fallback it uses the
270 symlink option (see next).
271 symlink: If /etc/resolv.conf is a regular file or does not exist,
273 NetworkManager will write the file directly. If /etc/resolv.conf is
274 instead a symlink, NetworkManager will leave it alone. Unless the
275 symlink points to the internal file
276 /run/NetworkManager/resolv.conf, in which case the symlink will be
277 updated to emit an inotify notification. This allows the user to
278 conveniently instruct NetworkManager not to manage /etc/resolv.conf
279 by replacing it with a symlink.
280 file: NetworkManager will write /etc/resolv.conf as regular file.
282 If it finds a symlink to an existing target, it will follow the
283 symlink and update the target instead. In no case will an existing
284 symlink be replaced by a file. Note that older versions of
285 NetworkManager behaved differently and would replace dangling
286 symlinks with a plain file.
287 resolvconf: NetworkManager will run resolvconf to update the DNS
289 configuration.
290 netconfig: NetworkManager will run netconfig to update the DNS
292 configuration.
293 unmanaged: don't touch /etc/resolv.conf.
295 none: deprecated alias for symlink.
297 systemd-resolved
299 Additionally, send the connection DNS configuration to
300 systemd-resolved. Defaults to "true".
301 Note that this setting has no effect if the main dns plugin is
303 already systemd-resolved. It is complementary to the dns setting to
304 configure systemd-resolved alongside the main plugin.
305 If systemd-resolved is enabled, either via this setting or the main
307 DNS plugin, the connectivity check resolves the hostname
308 per-device.
309 debug
311 Comma separated list of options to aid debugging. This value will
312 be combined with the environment variable NM_DEBUG. Currently, the
313 following values are supported:
314 RLIMIT_CORE: set ulimit -c unlimited to write out core dumps.
316 Beware, that a core dump can contain sensitive information such as
317 passwords or configuration settings.
318 fatal-warnings: set g_log_set_always_fatal() to core dump on
320 warning messages from glib. This is equivalent to the
321 --g-fatal-warnings command line option.
322 autoconnect-retries-default
324 The number of times a connection activation should be automatically
325 tried before switching to another one. This value applies only to
326 connections that can auto-connect and have a
327 connection.autoconnect-retries property set to -1. If not
328 specified, connections will be tried 4 times. Setting this value to
329 1 means to try activation once, without retry.
330 slaves-order
332 This key specifies in which order slave connections are
333 auto-activated on boot or when the master activates them. Allowed
334 values are name (order connection by interface name, the default),
335 or index (order slaves by their kernel index).
336 firewall-backend
338 The firewall backend for configuring masquerading with shared mode.
339 Set to either iptables, nftables or none. iptables and nftables
340 require iptables and nft application, respectively. none means to
341 skip firewall configuration if the users wish to manage firewall
342 themselves. If unspecified, it will be auto detected.
343 iwd-config-path
345 If the value is "auto" (the default), IWD is queried for its
346 current state directory when it appears on D-Bus -- the directory
347 where IWD keeps its network configuration files -- usually
348 /var/lib/iwd. NetworkManager will then attempt to write copies of
349 new or modified Wi-Fi connection profiles, converted into the IWD
350 format, into this directory thus making IWD connection properties
351 editable. NM will overwrite existing files without preserving their
352 contents.
353 The path can also be overriden by pointing to a specific existing
355 and writable directory. On the other hand setting this to an empty
356 string or any other value disables the profile conversion
357 mechanism.
358 This mechanism allows editing connection profile settings such as
360 the 802.1x configuration using NetworkManager clients. Without it
361 such changes have no effect in IWD.
362 migrate-ifcfg-rh
364 Whether NetworkManager tries to automatically convert any
365 connection profile stored in ifcfg-rh format to the keyfile format.
366 Support for ifcfg-rh is deprecated and will be eventually removed.
367 If enabled, the migration is performed at every startup of the
368 daemon. The default value is true.
369
371 This section contains keyfile-plugin-specific options, and is normally
372 only used when you are not using any other distro-specific plugin.
373 hostname
375 This key is deprecated and has no effect since the hostname is now
376 stored in /etc/hostname or other system configuration files
377 according to build options.
378 path
380 The location where keyfiles are read and stored. This defaults to
381 "/etc/NetworkManager/system-connections".
382 rename
384 NetworkManager automatically chooses a filename when storing a new
385 profile to disk. That name depends on the profile's name
386 (connection.id). When updating a profile's name, the file is not
387 renamed to not break scripts that rely on the filename for the
388 profile. By setting this option to "true", NetworkManager renames
389 the keyfile on update of the profile, to follow the profile's name.
390 This defaults to "false".
391 unmanaged-devices
393 Set devices that should be ignored by NetworkManager.
394 A device unmanaged due to this option is strictly unmanaged and
396 cannot be overruled by using the API like nmcli device set $IFNAME
397 managed yes. Also, a device that is unmanaged for other reasons,
398 like an udev rule, cannot be made managed with this option (e.g. by
399 using an except: specifier). These two points make it different
400 from the device*.managed option which for that reason may be a
401 better choice.
402 See the section called “Device List Format” for the syntax on how
404 to specify a device.
405 Example:
407 unmanaged-devices=interface-name:em4
409 unmanaged-devices=mac:00:22:68:1c:59:b1;mac:00:1E:65:30:D1:C4;interface-name:eth2
410
413 This section contains ifupdown-specific options and thus only has
414 effect when using the ifupdown plugin.
415 managed
417 If set to true, then interfaces listed in /etc/network/interfaces
418 are managed by NetworkManager. If set to false, then any interface
419 listed in /etc/network/interfaces will be ignored by
420 NetworkManager. Remember that NetworkManager controls the default
421 route, so because the interface is ignored, NetworkManager may
422 assign the default route to some other interface.
423 The default value is false.
425
427 This section controls NetworkManager's logging. Logging is very
428 important to understand what NetworkManager is doing. When you report a
429 bug, do not unnecessarily filter or limit the log file. Just enable
430 level=TRACE and domains=ALL to collect everything.
431 The recommended way for enabling logging is with a file
433 /etc/NetworkManager/conf.d/95-logging.conf that contains
434 [logging]
436 level=TRACE
437 domains=ALL
438 and restart the daemon with systemctl restart NetworkManager. Then
440 reproduce the problem. You can find the logs in syslog (for example
441 journalctl).
442 Any settings here are overridden by the --log-level and --log-domains
444 command-line options. Logging can also be reconfigured at runtime with
445 nmcli general logging level "$LEVEL" domains "$DOMAINS". However, often
446 it is interesting to get a complete log from the start. Especially,
447 when debugging an issue, enable debug logging in NetworkManager.conf
448 and restart the service to enable verbose logging early on.
449 By setting nm.debug on the kernel command line (either from
451 /run/NetworkManager/proc-cmdline or /proc/cmdline), debug logging is
452 enabled. This overrides both the command-line options and the settings
453 from NetworkManager.conf.
454 NetworkManager's logging aims not to contain private sensitive data and
456 you should be fine sharing the debug logs. Still, there will be IP
457 addresses and your network setup, if you consider that private then
458 review the log before sharing. However, try not to mangle the logfile
459 in a way that distorts the meaning too much.
460 NetworkManager uses syslog or systemd-journald, depending on
462 configuration. In any case, debug logs are verbose and might be rate
463 limited or filtered by the logging daemon. For systemd-journald, see
464 RateLimitIntervalSec and RateLimitBurst in journald.conf manual for how
465 to disable that.
466 level
468 The default logging verbosity level. One of OFF, ERR, WARN, INFO,
469 DEBUG, TRACE, in order of verbosity.
470 OFF disables all logging. INFO is the default verbosity for
472 regular operation. TRACE is for debugging.
473 The other levels are in most cases not useful. For example, DEBUG
475 is between TRACE and INFO, but it's too verbose for regular
476 operation and lacks possibly interesting messages for debugging.
477 Almost always, when debugging an issue or reporting a bug, collect
478 full level TRACE logs to get the full picture.
479 domains
481 Filter the messages by their topic. When debugging an issue, it's
482 better to collect all logs (ALL domain) upfront. The unnecessary
483 parts can always be ignored later.
484 In the uncommon case to tune out certain topics, the following log
486 domains are available: PLATFORM, RFKILL, ETHER, WIFI, BT, MB,
487 DHCP4, DHCP6, PPP, WIFI_SCAN, IP4, IP6, AUTOIP4, DNS, VPN, SHARING,
488 SUPPLICANT, AGENTS, SETTINGS, SUSPEND, CORE, DEVICE, OLPC, WIMAX,
489 INFINIBAND, FIREWALL, ADSL, BOND, VLAN, BRIDGE, DBUS_PROPS, TEAM,
490 CONCHECK, DCB, DISPATCH, AUDIT, SYSTEMD, VPN_PLUGIN, PROXY.
491 In addition, these special domains can be used: NONE, ALL, DEFAULT,
493 DHCP, IP.
494 You can specify per-domain log level overrides by adding a colon
496 and a log level to any domain. E.g., "WIFI:DEBUG,WIFI_SCAN:OFF".
497 Another example is ALL,VPN_PLUGIN:TRACE to enable all the logging
498 there is (see about VPN_PLUGIN below).
499 Domain descriptions:
501 PLATFORM : OS (platform) operations
502 RFKILL : RFKill subsystem operations
503 ETHER : Ethernet device operations
504 WIFI : Wi-Fi device operations
505 BT : Bluetooth operations
506 MB : Mobile broadband operations
507 DHCP4 : DHCP for IPv4
508 DHCP6 : DHCP for IPv6
509 PPP : Point-to-point protocol operations
510 WIFI_SCAN : Wi-Fi scanning operations
511 IP4 : IPv4-related operations
512 IP6 : IPv6-related operations
513 AUTOIP4 : AutoIP operations
514 DNS : Domain Name System related operations
515 VPN : Virtual Private Network connections and
516 operations
517 SHARING : Connection sharing. With TRACE level log queries
518 for dnsmasq instance
519 SUPPLICANT : WPA supplicant related operations
520 AGENTS : Secret agents operations and communication
521 SETTINGS : Settings/config service operations
522 SUSPEND : Suspend/resume
523 CORE : Core daemon and policy operations
524 DEVICE : Activation and general interface operations
525 OLPC : OLPC Mesh device operations
526 WIMAX : WiMAX device operations
527 INFINIBAND : InfiniBand device operations
528 FIREWALL : FirewallD related operations
529 ADSL : ADSL device operations
530 BOND : Bonding operations
531 VLAN : VLAN operations
532 BRIDGE : Bridging operations
533 DBUS_PROPS : D-Bus property changes
534 TEAM : Teaming operations
535 CONCHECK : Connectivity check
536 DCB : Data Center Bridging (DCB) operations
537 DISPATCH : Dispatcher scripts
538 AUDIT : Audit records
539 SYSTEMD : Messages from internal libsystemd
540 VPN_PLUGIN : logging messages from VPN plugins
541 PROXY : logging messages for proxy handling
542 NONE : when given by itself logging is disabled
544 ALL : all log domains
545 DEFAULT : default log domains
546 DHCP : shortcut for "DHCP4,DHCP6"
547 IP : shortcut for "IP4,IP6"
548 HW : deprecated alias for "PLATFORM"
550 In general, the logfile should not contain passwords or private
552 data. However, you are always advised to check the file before
553 posting it online or attaching to a bug report. VPN_PLUGIN is
554 special as it might reveal private information of the VPN plugins
555 with verbose levels. Therefore this domain will be excluded when
556 setting ALL or DEFAULT to more verbose levels then INFO.
557 backend
559 The logging backend. Supported values are "syslog" and "journal".
560 When NetworkManager is started with "--debug" in addition all
561 messages will be printed to stderr. If unspecified, the default is
562 "journal".
563 audit
565 Whether the audit records are delivered to auditd, the audit
566 daemon. If false, audit records will be sent only to the
567 NetworkManager logging system. If set to true, they will be also
568 sent to auditd. The default value is false.
569
571 Specify default values for connections.
572 Such default values are only consulted if the corresponding
574 per-connection property explicitly allows for that. That means, all
575 these properties correspond to a property of the connection profile
576 (for example connection.mud-url). Only if the per-profile property is
577 set to a special value that indicates to use the default, the default
578 value from NetworkManager.conf is consulted. It depends on the
579 property, which is the special value that indicates fallback to the
580 default, but it usually is something like empty, unset values or
581 special numeric values like 0 or -1. That means the effectively used
582 value can first always be configured for each profile, and these
583 default values only matter if the per-profile values explicitly
584 indicates to use the default from NetworkManager.conf.
585 Example:
587 [connection]
589 ipv6.ip6-privacy=0
590 Supported Properties
593 Not all properties can be overwritten, only the following properties
594 are supported to have their default values configured (see nm-
595 settings(5) for details).
596 802-1x.auth-timeout
598 cdma.mtu
600 connection.auth-retries
602 If left unspecified, the default value is 3 tries before failing
603 the connection.
604 connection.autoconnect-slaves
606 connection.mud-url
608 If unspecified, MUD URL defaults to "none".
609 connection.lldp
611 connection.llmnr
613 If unspecified, the ultimate default values depends on the DNS
614 plugin. With systemd-resolved the default currently is "yes" (2)
615 and for all other plugins "no" (0).
616 connection.mdns
618 If unspecified, the ultimate default values depends on the DNS
619 plugin. With systemd-resolved the default currently is "no" (0) and
620 for all other plugins also "no" (0).
621 connection.mptcp-flags
623 If unspecified, the fallback is 0x22 ("enabled,subflow"). Note that
624 if sysctl /proc/sys/net/mptcp/enabled is disabled, NetworkManager
625 will still not configure endpoints.
626 connection.dns-over-tls
628 If unspecified, the ultimate default values depends on the DNS
629 plugin. With systemd-resolved the default currently is global
630 setting and for all other plugins "no" (0).
631 connection.stable-id
633 ethernet.cloned-mac-address
635 If left unspecified, it defaults to "preserve".
636 ethernet.generate-mac-address-mask
638 ethernet.mtu
640 If configured explicitly to 0, the MTU is not reconfigured during
641 device activation unless it is required due to IPv6 constraints. If
642 left unspecified, a DHCP/IPv6 SLAAC provided value is used or the
643 MTU is not reconfigured during activation.
644 ethernet.wake-on-lan
646 gsm.mtu
648 hostname.from-dhcp
650 hostname.from-dns-lookup
652 hostname.only-from-default
654 hostname.priority
656 infiniband.mtu
658 If configured explicitly to 0, the MTU is not reconfigured during
659 device activation unless it is required due to IPv6 constraints. If
660 left unspecified, a DHCP/IPv6 SLAAC provided value is used or the
661 MTU is left unspecified on activation.
662 ip-tunnel.mtu
664 If configured explicitly to 0, the MTU is not reconfigured during
665 device activation unless it is required due to IPv6 constraints. If
666 left unspecified, a DHCP/IPv6 SLAAC provided value is used or a
667 default of 1500.
668 ipv4.dad-timeout
670 ipv4.dhcp-client-id
672 ipv4.dhcp-iaid
674 If left unspecified, it defaults to "ifname".
675 ipv4.dhcp-hostname-flags
677 If left unspecified, the value 3 (fqdn-encoded,fqdn-serv-update) is
678 used.
679 ipv4.dhcp-timeout
681 If left unspecified, the default value for the interface type is
682 used.
683 ipv4.dhcp-vendor-class-identifier
685 If left unspecified, the default is to not send the DHCP option to
686 the server.
687 ipv4.dns-priority
689 If unspecified or zero, use 50 for VPN profiles and 100 for other
690 profiles.
691 ipv4.required-timeout
693 ipv4.link-local
695 If left unspecified, fallback to "auto" which makes it dependent on
696 "ipv4.method" setting.
697 ipv4.route-metric
699 ipv4.route-table
701 If left unspecified, routes are only added to the main table. Note
702 that this is different from explicitly selecting the main table
703 254, because of how NetworkManager removes extraneous routes from
704 the tables.
705 ipv6.addr-gen-mode
707 If the per-profile setting is either "default" or
708 "default-or-eui64", the global default is used. If the default is
709 unspecified, the fallback value is either "stable-privacy" or
710 "eui64", depending on whether the per-profile setting is "default"
711 or "default-or-eui64, respectively.
712 ipv6.ra-timeout
714 If left unspecified, the default value depends on the sysctl
715 solicitation settings.
716 ipv6.dhcp-duid
718 If left unspecified, it defaults to "lease".
719 ipv6.dhcp-iaid
721 If left unspecified, it defaults to "ifname".
722 ipv6.dhcp-hostname-flags
724 If left unspecified, the value 1 (fqdn-serv-update) is used.
725 ipv6.dhcp-timeout
727 If left unspecified, the default value for the interface type is
728 used.
729 ipv6.dns-priority
731 If unspecified or zero, use 50 for VPN profiles and 100 for other
732 profiles.
733 ipv6.ip6-privacy
735 If ipv6.ip6-privacy is unset, use the content of
736 "/proc/sys/net/ipv6/conf/default/use_tempaddr" as last fallback.
737 ipv6.required-timeout
739 ipv6.route-metric
741 ipv6.route-table
743 If left unspecified, routes are only added to the main table. Note
744 that this is different from explicitly selecting the main table
745 254, because of how NetworkManager removes extraneous routes from
746 the tables.
747 loopback.mtu
749 If configured explicitly to 0, the MTU is not reconfigured during
750 device activation unless it is required due to IPv6 constraints. If
751 left unspecified, a DHCP/IPv6 SLAAC provided value is used or the
752 MTU is left unspecified on activation.
753 sriov.autoprobe-drivers
755 If left unspecified, drivers are autoprobed when the SR-IOV VF gets
756 created.
757 vpn.timeout
759 If left unspecified, default value of 60 seconds is used.
760 wifi.ap-isolation
762 If left unspecified, AP isolation is disabled.
763 wifi.cloned-mac-address
765 If left unspecified, it defaults to "preserve".
766 wifi.generate-mac-address-mask
768 wifi.mac-address-randomization
770 If left unspecified, MAC address randomization is disabled. This
771 setting is deprecated for wifi.cloned-mac-address.
772 wifi.mtu
774 If configured explicitly to 0, the MTU is not reconfigured during
775 device activation unless it is required due to IPv6 constraints. If
776 left unspecified, a DHCP/IPv6 SLAAC provided value is used or a
777 default of 1500.
778 wifi.powersave
780 If left unspecified, the default value "ignore" will be used.
781 wifi-sec.pmf
783 If left unspecified, the default value "optional" will be used.
784 wifi-sec.fils
786 If left unspecified, the default value "optional" will be used.
787 wifi.wake-on-wlan
789 wireguard.mtu
791 Sections
794 You can configure multiple connection sections, by having different
795 sections with a name that all start with "connection". Example:
796 [connection]
798 ipv6.ip6-privacy=0
799 connection.autoconnect-slaves=1
800 vpn.timeout=120
801 [connection-wifi-wlan0]
803 match-device=interface-name:wlan0
804 ipv4.route-metric=50
805 [connection-wifi-other]
807 match-device=type:wifi
808 ipv4.route-metric=55
809 ipv6.ip6-privacy=1
810 The sections within one file are considered in order of appearance,
812 with the exception that the [connection] section is always considered
813 last. In the example above, this order is [connection-wifi-wlan0],
814 [connection-wlan-other], and [connection]. When checking for a default
815 configuration value, the sections are searched until the requested
816 value is found. In the example above, "ipv4.route-metric" for wlan0
817 interface is set to 50, and for all other Wi-Fi typed interfaces to 55.
818 Also, Wi-Fi devices would have IPv6 private addresses enabled by
819 default, but other devices would have it disabled. Note that also
820 "wlan0" gets "ipv6.ip6-privacy=1", because although the section
821 "[connection-wifi-wlan0]" matches the device, it does not contain that
822 property and the search continues.
823 When having different sections in multiple files, sections from files
825 that are read later have higher priority. So within one file the
826 priority of the sections is top-to-bottom. Across multiple files later
827 definitions take precedence.
828 The following properties further control how a connection section
830 applies.
831 match-device
833 An optional device spec that restricts when the section applies.
834 See the section called “Device List Format” for the possible
835 values.
836 stop-match
838 An optional boolean value which defaults to no. If the section
839 matches (based on match-device), further sections will not be
840 considered even if the property in question is not present. In the
841 example above, if [connection-wifi-wlan0] would have stop-match set
842 to yes, the device wlan0 would have ipv6.ip6-privacy property
843 unspecified. That is, the search for the property would not
844 continue in the connection sections [connection-wifi-other] or
845 [connection].
846
848 Contains per-device persistent configuration.
849 Example:
851 [device]
853 match-device=interface-name:eth3
854 managed=1
855 Supported Properties
858 The following properties can be configured per-device.
859 managed
861 Whether the device is managed or not. A device can be marked as
862 managed via udev rules (ENV{NM_UNMANAGED}), or via setting plugins
863 (keyfile.unmanaged-devices). This is yet another way. Note that
864 this configuration can be overruled at runtime via D-Bus. Also, it
865 has higher priority then udev rules.
866 carrier-wait-timeout
868 Specify the timeout for waiting for carrier in milliseconds. The
869 default is 6000 milliseconds. This setting exists because certain
870 drivers/hardware can take a long time to detect whether the cable
871 is plugged in.
872 When the device loses carrier, NetworkManager does not react
874 immediately. Instead, it waits for this timeout before considering
875 the link lost.
876 Also, on startup, NetworkManager considers the device as busy for
878 this time, as long as the device has no carrier. This delays
879 startup-complete signal and NetworkManager-wait-online. Configuring
880 this too high means to block NetworkManager-wait-online longer than
881 necessary when booting with cable unplugged. Configuring it too
882 low, means that NetworkManager will declare startup-complete too
883 soon, although carrier is about to come and auto-activation to kick
884 in. Note that if a profile only has static IP configuration or
885 Layer 3 configuration disabled, then it can already autoconnect
886 without carrier on the device. Once such a profile reaches full
887 activated state, startup-complete is considered as reached even if
888 the device has no carrier yet.
889 ignore-carrier
891 Specify devices for which NetworkManager will (partially) ignore
892 the carrier state. Normally, for device types that support
893 carrier-detect, such as Ethernet and InfiniBand, NetworkManager
894 will only allow a connection to be activated on the device if
895 carrier is present (ie, a cable is plugged in), and it will
896 deactivate the device if carrier drops for more than a few seconds.
897 A device with carrier ignored will allow activating connections on
899 that device even when it does not have carrier, provided that the
900 connection uses only statically-configured IP addresses.
901 Additionally, it will allow any active connection (whether static
902 or dynamic) to remain active on the device when carrier is lost.
903 Note that the "carrier" property of NMDevices and device D-Bus
905 interfaces will still reflect the actual device state; it's just
906 that NetworkManager will not make use of that information.
907 Master types like bond, bridge and team ignore carrier by default,
909 while other device types react on carrier changes by default.
910 This setting overwrites the deprecated main.ignore-carrier setting
912 above.
913 keep-configuration
915 On startup, NetworkManager tries to not interfere with interfaces
916 that are already configured. It does so by generating a in-memory
917 connection based on the interface current configuration.
918 If this generated connection matches one of the existing persistent
920 connections, the persistent connection gets activated. If there is
921 no match, the generated connection gets activated as "external",
922 which means that the connection is considered as active, but
923 NetworkManager doesn't actually touch the interface.
924 It is possible to disable this behavior by setting
926 keep-configuration to no. In this way, on startup NetworkManager
927 always tries to activate the most suitable persistent connection
928 (the one with highest autoconnect-priority or, in case of a tie,
929 the one activated most recently).
930 Note that when NetworkManager gets restarted, it stores the
932 previous state in /run/NetworkManager; in particular it saves the
933 UUID of the connection that was previously active so that it can be
934 activated again after the restart. Therefore, keep-configuration
935 does not have any effect on service restart.
936 allowed-connections
938 A list of connections that can be activated on the device. See the
939 section called “Connection List Format” for the syntax to specify a
940 connection. If this option is not specified, all connections can be
941 potentially activated on the device, provided that the connection
942 type and other settings match.
943 A notable use case for this is to filter which connections can be
945 activated based on how they were created; see the origin keyword in
946 the section called “Connection List Format”.
947 wifi.scan-rand-mac-address
949 Configures MAC address randomization of a Wi-Fi device during
950 scanning. This defaults to yes in which case a random,
951 locally-administered MAC address will be used. The setting
952 wifi.scan-generate-mac-address-mask allows to influence the
953 generated MAC address to use certain vendor OUIs. If disabled, the
954 MAC address during scanning is left unchanged to whatever is
955 configured. For the configured MAC address while the device is
956 associated, see instead the per-connection setting
957 wifi.cloned-mac-address.
958 wifi.backend
960 Specify the Wi-Fi backend used for the device. Currently, supported
961 are wpa_supplicant and iwd (experimental). If unspecified, the
962 default is "wpa_supplicant".
963 wifi.scan-generate-mac-address-mask
965 Like the per-connection settings ethernet.generate-mac-address-mask
966 and wifi.generate-mac-address-mask, this allows to configure the
967 generated MAC addresses during scanning. See nm-settings(5) for
968 details.
969 wifi.iwd.autoconnect
971 If wifi.backend is iwd, setting this to false forces IWD's
972 autoconnect mechanism to be disabled for this device and
973 connections will only be initiated by NetworkManager whether
974 commanded by a client or automatically. Leaving it true (default)
975 stops NetworkManager from automatically initiating connections and
976 allows IWD to use its network ranking and scanning logic to decide
977 the best networks to autoconnect to next. Connections'
978 autoconnect-priority, autoconnect-retries settings will be ignored.
979 Other settings like permissions or multi-connect may interfere with
980 IWD connection attempts.
981 sriov-num-vfs
983 Specify the number of virtual functions (VF) to enable for a PCI
984 physical device that supports single-root I/O virtualization
985 (SR-IOV).
986 Sections
988 The [device] section works the same as the [connection] section. That
989 is, multiple sections that all start with the prefix "device" can be
990 specified. The settings "match-device" and "stop-match" are available
991 to match a device section on a device. The order of multiple sections
992 is also top-down within the file and later files overwrite previous
993 settings. See “Sections” under the section called “CONNECTION SECTION”
994 for details.
995
997 This section controls NetworkManager's optional connectivity checking
998 functionality. This allows NetworkManager to detect whether or not the
999 system can actually access the internet or whether it is behind a
1000 captive portal.
1001 Connectivity checking serves two purposes. For one, it exposes a
1003 connectivity state on D-Bus, which other applications may use. For
1004 example, Gnome's portal helper uses this as signal to show a captive
1005 portal login page. The other use is that default-route of devices
1006 without global connectivity get a penalty of +20000 to the
1007 route-metric. This has the purpose to give a better default-route to
1008 devices that have global connectivity. For example, when being
1009 connected to WWAN and to a Wi-Fi network which is behind a captive
1010 portal, WWAN still gets preferred until login.
1011 Note that your distribution might set
1013 /proc/sys/net/ipv4/conf/*/rp_filter to strict filtering. That works
1014 badly with per-device connectivity checking, which uses SO_BINDDEVICE
1015 to send requests on all devices. A strict rp_filter setting will reject
1016 any response and the connectivity check on all but the best route will
1017 fail.
1018 enabled
1020 Whether connectivity check is enabled. Note that to enable
1021 connectivity check, a valid uri must also be configured. The value
1022 defaults to true, but since the uri is unset by default,
1023 connectivity check may be disabled. The main purpose of this option
1024 is to have a single flag to disable connectivity check. Note that
1025 this setting can also be set via D-Bus API at runtime. In that
1026 case, the value gets stored in
1027 /var/lib/NetworkManager/NetworkManager-intern.conf file.
1028 uri
1030 The URI of a web page to periodically request when connectivity is
1031 being checked. This page should return the header
1032 "X-NetworkManager-Status" with a value of "online". Alternatively,
1033 its body content should be set to "NetworkManager is online". The
1034 body content check can be controlled by the response option. If
1035 this option is blank or missing, connectivity checking is disabled.
1036 interval
1038 Specified in seconds; controls how often connectivity is checked
1039 when a network connection exists. If set to 0 connectivity checking
1040 is disabled. If missing, the default is 300 seconds.
1041 response
1043 If set, controls what body content NetworkManager checks for when
1044 requesting the URI for connectivity checking. Note that this only
1045 compares that the HTTP response starts with the specifid text, it
1046 does not compare the exact string. This behavior might change in
1047 the future, so avoid relying on it. If missing, the response
1048 defaults to "NetworkManager is online". If set to empty, the HTTP
1049 server is expected to answer with status code 204 or send no data.
1050
1052 This section specifies DNS settings that are applied globally, in
1053 addition to connection-specific ones.
1054 searches
1056 A list of search domains to be used during hostname lookup.
1057 options
1059 A list of options to be passed to the hostname resolver.
1060
1062 Sections with a name starting with the "global-dns-domain-" prefix
1063 allow to define global DNS configuration for specific domains. The part
1064 of section name after "global-dns-domain-" specifies the domain name a
1065 section applies to (for example, a section could be named
1066 "global-dns-domain-foobar.com"). More specific domains have the
1067 precedence over less specific ones and the default domain is
1068 represented by the wildcard "*". To be valid, global DNS domains must
1069 include a section for the default domain "*". When the global DNS
1070 domains are valid, the name servers and domains defined globally
1071 override the ones from active connections.
1072 servers
1074 A list of addresses of DNS servers to be used for the given domain.
1075 options
1077 A list of domain-specific DNS options. Not used at the moment.
1078
1080 This is a special section that contains options which apply to the
1081 configuration file that contains the option.
1082 enable
1084 Defaults to "true". If "false", the configuration file will be
1085 skipped during loading. Note that the main configuration file
1086 NetworkManager.conf cannot be disabled.
1087 # always skip loading the config file
1089 [.config]
1090 enable=false
1091 You can also match against the version of NetworkManager. For
1093 example the following are valid configurations:
1094 # only load on version 1.0.6
1096 [.config]
1097 enable=nm-version:1.0.6
1098 # load on all versions 1.0.x, but not 1.2.x
1100 [.config]
1101 enable=nm-version:1.0
1102 # only load on versions >= 1.1.6. This does not match
1104 # with version 1.2.0 or 1.4.4. Only the last digit is considered.
1105 [.config]
1106 enable=nm-version-min:1.1.6
1107 # only load on versions >= 1.2. Contrary to the previous
1109 # example, this also matches with 1.2.0, 1.2.10, 1.4.4, etc.
1110 [.config]
1111 enable=nm-version-min:1.2
1112 # Match against the maximum allowed version. The example matches
1114 # versions 1.2.0, 1.2.2, 1.2.4. Again, only the last version digit
1115 # is allowed to be smaller. So this would not match on 1.1.10.
1116 [.config]
1117 enable=nm-version-max:1.2.6
1118 You can also match against the value of the environment variable
1120 NM_CONFIG_ENABLE_TAG, like:
1121 # only load the file when running NetworkManager with
1123 # environment variable "NM_CONFIG_ENABLE_TAG=TAG1"
1124 [.config]
1125 enable=env:TAG1
1126 More then one match can be specified. The configuration will be
1128 enabled if one of the predicates matches ("or"). The special prefix
1129 "except:" can be used to negate the match. Note that if one
1130 except-predicate matches, the entire configuration will be
1131 disabled. In other words, a except predicate always wins over other
1132 predicates. If the setting only consists of "except:" matches and
1133 none of the negative conditions are satisfied, the configuration is
1134 still enabled.
1135 # enable the configuration either when the environment variable
1137 # is present or the version is at least 1.2.0.
1138 [.config]
1139 enable=env:TAG2,nm-version-min:1.2
1140 # enable the configuration for version >= 1.2.0, but disable
1142 # it when the environment variable is set to "TAG3"
1143 [.config]
1144 enable=except:env:TAG3,nm-version-min:1.2
1145 # enable the configuration on >= 1.3, >= 1.2.6, and >= 1.0.16.
1147 # Useful if a certain feature is only present since those releases.
1148 [.config]
1149 enable=nm-version-min:1.3,nm-version-min:1.2.6,nm-version-min:1.0.16
1150
1153 Settings plugins for reading and writing connection profiles. The
1154 number of available plugins is distribution specific.
1155 keyfile
1157 The keyfile plugin is the generic plugin that supports all the
1158 connection types and capabilities that NetworkManager has. It
1159 writes files out in an .ini-style format in
1160 /etc/NetworkManager/system-connections. See nm-settings-keyfile(5)
1161 for details about the file format.
1162 The stored connection file may contain passwords, secrets and
1164 private keys in plain text, so it will be made readable only to
1165 root, and the plugin will ignore files that are readable or
1166 writable by any user or group other than root. See "Secret flag
1167 types" in nm-settings(5) for how to avoid storing passwords in
1168 plain text.
1169 This plugin is always active, and will automatically be used to
1171 store any connections that aren't supported by any other active
1172 plugin.
1173 ifcfg-rh
1175 This plugin is now deprecated; it can be used on the Fedora and Red
1176 Hat Enterprise Linux distributions to read and write configuration
1177 from the standard /etc/sysconfig/network-scripts/ifcfg-* files. It
1178 currently supports reading Ethernet, Wi-Fi, InfiniBand, VLAN, Bond,
1179 Bridge, and Team connections. Enabling ifcfg-rh implicitly enables
1180 ibft plugin, if it is available. This can be disabled by adding
1181 no-ibft. See /usr/share/doc/initscripts/sysconfig.txt and nm-
1182 settings-ifcfg-rh(5) for more information about the ifcfg file
1183 format.
1184 ifupdown
1186 This plugin is used on the Debian and Ubuntu distributions, and
1187 reads Ethernet and Wi-Fi connections from /etc/network/interfaces.
1188 This plugin is read-only; any connections (of any type) added from
1190 within NetworkManager when you are using this plugin will be saved
1191 using the keyfile plugin instead.
1192 ibft, no-ibft
1194 These plugins are deprecated and their selection has no effect.
1195 This is now handled by nm-initrd-generator.
1196 ifcfg-suse, ifnet
1198 These plugins are deprecated and their selection has no effect. The
1199 keyfile plugin should be used instead.
1200
1202 Device List Format
1203 The configuration options main.no-auto-default, main.ignore-carrier,
1204 keyfile.unmanaged-devices, connection*.match-device and
1205 device*.match-device select devices based on a list of matchings.
1206 Devices can be specified using the following format:
1207 *
1209 Matches every device.
1210 IFNAME
1212 Case sensitive match of interface name of the device. Globbing is
1213 not supported.
1214 HWADDR
1216 Match the permanent MAC address of the device. Globbing is not
1217 supported
1218 interface-name:IFNAME, interface-name:~IFNAME
1220 Case sensitive match of interface name of the device. Simple
1221 globbing is supported with * and ?. Ranges and escaping is not
1222 supported.
1223 interface-name:=IFNAME
1225 Case sensitive match of interface name of the device. Globbing is
1226 disabled and IFNAME is taken literally.
1227 mac:HWADDR
1229 Match the permanent MAC address of the device. Globbing is not
1230 supported
1231 s390-subchannels:HWADDR
1233 Match the device based on the subchannel address. Globbing is not
1234 supported
1235 type:TYPE
1237 Match the device type. Valid type names are as reported by "nmcli
1238 -f GENERAL.TYPE device show". Globbing is not supported.
1239 driver:DRIVER
1241 Match the device driver as reported by "nmcli -f
1242 GENERAL.DRIVER,GENERAL.DRIVER-VERSION device show". "DRIVER" must
1243 match the driver name exactly and does not support globbing.
1244 Optionally, a driver version may be specified separated by '/'.
1245 Globbing is supported for the version.
1246 dhcp-plugin:DHCP
1248 Match the configured DHCP plugin "main.dhcp".
1249 except:SPEC
1251 Negative match of a device. SPEC must be explicitly qualified with
1252 a prefix such as interface-name:. A negative match has higher
1253 priority then the positive matches above.
1254 If there is a list consisting only of negative matches, the
1256 behavior is the same as if there is also match-all. That means, if
1257 none of all the negative matches is satisfied, the overall result
1258 is still a positive match. That means, "except:interface-name:eth0"
1259 is the same as "*,except:interface-name:eth0".
1260 SPEC[,;]SPEC
1262 Multiple specs can be concatenated with commas or semicolons. The
1263 order does not matter as matches are either inclusive or negative
1264 (except:), with negative matches having higher priority.
1265 Backslash is supported to escape the separators ';' and ',', and to
1267 express special characters such as newline ('\n'), tabulator
1268 ('\t'), whitespace ('\s') and backslash ('\\'). The globbing of
1269 interface names cannot be escaped. Whitespace is not a separator
1270 but will be trimmed between two specs (unless escaped as '\s').
1271 Example:
1273 interface-name:em4
1275 mac:00:22:68:1c:59:b1;mac:00:1E:65:30:D1:C4;interface-name:eth2
1276 interface-name:vboxnet*,except:interface-name:vboxnet2
1277 *,except:mac:00:22:68:1c:59:b1
1278 Connection List Format
1281 Connections can be specified using the following format:
1282 *
1284 Matches every connection.
1285 uuid:UUID
1287 Match the connection by UUID, for example
1288 "uuid:83037490-1d17-4986-a397-01f1db3a7fc2"
1289 id=ID
1291 Match the connection by name.
1292 origin:ORIGIN
1294 Match the connection by origin, stored in the
1295 org.freedesktop.NetworkManager.origin tag of the user setting. For
1296 example, use "except:origin:nm-initrd-generator" to forbid
1297 activation of connections created by the initrd generator.
1298 except:SPEC
1300 Negative match of a connection. A negative match has higher
1301 priority then the positive matches above.
1302 If there is a list consisting only of negative matches, the
1304 behavior is the same as if there is also match-all. That means, if
1305 none of all the negative matches is satisfied, the overall result
1306 is still a positive match.
1307 SPEC[,;]SPEC
1309 Multiple specs can be concatenated with commas or semicolons. The
1310 order does not matter as matches are either inclusive or negative
1311 (except:), with negative matches having higher priority.
1312 Backslash is supported to escape the separators ';' and ',', and to
1314 express special characters such as newline ('\n'), tabulator
1315 ('\t'), whitespace ('\s') and backslash ('\\'). Whitespace is not a
1316 separator but will be trimmed between two specs (unless escaped as
1317 '\s').
1318
1320 NetworkManager(8), nmcli(1), nmcli-examples(7), nm-online(1), nm-
1321 settings(5), nm-applet(1), nm-connection-editor(1)
1322NetworkManager 1.44.2 NETWORKMANAGER.CONF(5)