1NETWORKMANAGER(8)         Network management daemons         NETWORKMANAGER(8)
2
3
4

NAME

6       NetworkManager - network management daemon
7

SYNOPSIS

9       NetworkManager [OPTIONS...]
10

DESCRIPTION

12       The NetworkManager daemon attempts to make networking configuration and
13       operation as painless and automatic as possible by managing the primary
14       network connection and other network interfaces, like Ethernet, WiFi,
15       and Mobile Broadband devices. NetworkManager will connect any network
16       device when a connection for that device becomes available, unless that
17       behavior is disabled. Information about networking is exported via a
18       D-Bus interface to any interested application, providing a rich API
19       with which to inspect and control network settings and operation.
20

DISPATCHER SCRIPTS

22       NetworkManager will execute scripts in the
23       /etc/NetworkManager/dispatcher.d directory or subdirectories in
24       alphabetical order in response to network events. Each script should be
25       a regular executable file owned by root. Furthermore, it must not be
26       writable by group or other, and not setuid.
27
28       Each script receives two arguments, the first being the interface name
29       of the device an operation just happened on, and second the action. For
30       device actions, the interface is the name of the kernel interface
31       suitable for IP configuration. Thus it is either VPN_IP_IFACE,
32       DEVICE_IP_IFACE, or DEVICE_IFACE, as applicable. For the hostname and
33       connectivity-change actions it is always "none".
34
35       The actions are:
36
37       pre-up
38           The interface is connected to the network but is not yet fully
39           activated. Scripts acting on this event must be placed or symlinked
40           into the /etc/NetworkManager/dispatcher.d/pre-up.d directory, and
41           NetworkManager will wait for script execution to complete before
42           indicating to applications that the interface is fully activated.
43
44       up
45           The interface has been activated.
46
47       pre-down
48           The interface will be deactivated but has not yet been disconnected
49           from the network. Scripts acting on this event must be placed or
50           symlinked into the /etc/NetworkManager/dispatcher.d/pre-down.d
51           directory, and NetworkManager will wait for script execution to
52           complete before disconnecting the interface from its network. Note
53           that this event is not emitted for forced disconnections, like when
54           carrier is lost or a wireless signal fades. It is only emitted when
55           there is an opportunity to cleanly handle a network disconnection
56           event.
57
58       down
59           The interface has been deactivated.
60
61       vpn-pre-up
62           The VPN is connected to the network but is not yet fully activated.
63           Scripts acting on this event must be placed or symlinked into the
64           /etc/NetworkManager/dispatcher.d/pre-up.d directory, and
65           NetworkManager will wait for script execution to complete before
66           indicating to applications that the VPN is fully activated.
67
68       vpn-up
69           A VPN connection has been activated.
70
71       vpn-pre-down
72           The VPN will be deactivated but has not yet been disconnected from
73           the network. Scripts acting on this event must be placed or
74           symlinked into the /etc/NetworkManager/dispatcher.d/pre-down.d
75           directory, and NetworkManager will wait for script execution to
76           complete before disconnecting the VPN from its network. Note that
77           this event is not emitted for forced disconnections, like when the
78           VPN terminates unexpectedly or general connectivity is lost. It is
79           only emitted when there is an opportunity to cleanly handle a VPN
80           disconnection event.
81
82       vpn-down
83           A VPN connection has been deactivated.
84
85       hostname
86           The system hostname has been updated. Use gethostname(2) to
87           retrieve it. The interface name (first argument) is empty and no
88           environment variable is set for this action.
89
90       dhcp4-change
91           The DHCPv4 lease has changed (renewed, rebound, etc).
92
93       dhcp6-change
94           The DHCPv6 lease has changed (renewed, rebound, etc).
95
96       connectivity-change
97           The network connectivity state has changed (no connectivity, went
98           online, etc).
99
100       The environment contains more information about the interface and the
101       connection. The following variables are available for the use in the
102       dispatcher scripts:
103
104       NM_DISPATCHER_ACTION
105           The dispatcher action like "up" or "dhcp4-change", identical to the
106           first command line argument. Since NetworkManager 1.12.0.
107
108       CONNECTION_UUID
109           The UUID of the connection profile.
110
111       CONNECTION_ID
112           The name (ID) of the connection profile.
113
114       CONNECTION_DBUS_PATH
115           The NetworkManager D-Bus path of the connection.
116
117       CONNECTION_FILENAME
118           The backing file name of the connection profile (if any).
119
120       CONNECTION_EXTERNAL
121           If "1", this indicates that the connection describes a network
122           configuration created outside of NetworkManager.
123
124       DEVICE_IFACE
125           The interface name of the control interface of the device.
126           Depending on the device type, this differs from DEVICE_IP_IFACE.
127           For example for ADSL devices, this could be 'atm0' or for WWAN
128           devices it might be 'ttyUSB0'.
129
130       DEVICE_IP_IFACE
131           The IP interface name of the device. This is the network interface
132           on which IP addresses and routes will be configured.
133
134       IP4_ADDRESS_N
135           The IPv4 address in the format "address/prefix gateway", where N is
136           a number from 0 to (# IPv4 addresses - 1). gateway item in this
137           variable is deprecated, use IP4_GATEWAY instead.
138
139       IP4_NUM_ADDRESSES
140           The variable contains the number of IPv4 addresses the script may
141           expect.
142
143       IP4_GATEWAY
144           The gateway IPv4 address in traditional numbers-and-dots notation.
145
146       IP4_ROUTE_N
147           The IPv4 route in the format "address/prefix next-hop metric",
148           where N is a number from 0 to (# IPv4 routes - 1).
149
150       IP4_NUM_ROUTES
151           The variable contains the number of IPv4 routes the script may
152           expect.
153
154       IP4_NAMESERVERS
155           The variable contains a space-separated list of the DNS servers.
156
157       IP4_DOMAINS
158           The variable contains a space-separated list of the search domains.
159
160       DHCP4_<dhcp-option-name>
161           If the connection used DHCP for address configuration, the received
162           DHCP configuration is passed in the environment using standard DHCP
163           option names, prefixed with "DHCP4_", like
164           "DHCP4_HOST_NAME=foobar".
165
166       IP6_<name> and DHCP6_<name>
167           The same variables as for IPv4 are available for IPv6, but the
168           prefixes are IP6_ and DHCP6_ instead.
169
170       CONNECTIVITY_STATE
171           The network connectivity state, which can take the values defined
172           by the NMConnectivityState type, from the
173           org.freedesktop.NetworkManager D-Bus API: unknown, none, portal,
174           limited or full. Note: this variable will only be set for
175           connectivity-change actions.
176
177       In case of VPN, VPN_IP_IFACE is set, and IP4_*, IP6_* variables with
178       VPN prefix are exported too, like VPN_IP4_ADDRESS_0,
179       VPN_IP4_NUM_ADDRESSES.
180
181       Dispatcher scripts are run one at a time, but asynchronously from the
182       main NetworkManager process, and will be killed if they run for too
183       long. If your script might take arbitrarily long to complete, you
184       should spawn a child process and have the parent return immediately.
185       Scripts that are symbolic links pointing inside the
186       /etc/NetworkManager/dispatcher.d/no-wait.d/ directory are run
187       immediately, without waiting for the termination of previous scripts,
188       and in parallel. Also beware that once a script is queued, it will
189       always be run, even if a later event renders it obsolete. (Eg, if an
190       interface goes up, and then back down again quickly, it is possible
191       that one or more "up" scripts will be run after the interface has gone
192       down.)
193

OPTIONS

195       The following options are understood:
196
197       --version | -V
198           Print the NetworkManager software version and exit.
199
200       --help | -h
201           Print NetworkManager's available options and exit.
202
203       --no-daemon | -n
204           Do not daemonize.
205
206       --debug | -d
207           Do not daemonize, and direct log output to the controlling terminal
208           in addition to syslog.
209
210       --pid-file | -p
211           Specify location of a PID file. The PID file is used for storing
212           PID of the running process and prevents running multiple instances.
213
214       --state-file
215           Specify file for storing state of the NetworkManager persistently.
216           If not specified, the default value of
217           /var/lib/NetworkManager/NetworkManager.state is used.
218
219       --config
220           Specify configuration file to set up various settings for
221           NetworkManager. If not specified, the default value of
222           /etc/NetworkManager/NetworkManager.conf is used with a fallback to
223           the older 'nm-system-settings.conf' if located in the same
224           directory. See NetworkManager.conf(5) for more information on
225           configuration file.
226
227       --plugins
228           List plugins used to manage system-wide connection settings. This
229           list has preference over plugins specified in the configuration
230           file. See main.plugins setting in NetworkManager.conf(5) for
231           supported options.
232
233       --log-level
234           Sets how much information NetworkManager sends to the log
235           destination (usually syslog's "daemon" facility). By default, only
236           informational, warning, and error messages are logged. See the
237           section on logging in NetworkManager.conf(5) for more information.
238
239       --log-domains
240           A comma-separated list specifying which operations are logged to
241           the log destination (usually syslog). By default, most domains are
242           logging-enabled. See the section on logging in
243           NetworkManager.conf(5) for more information.
244
245       --print-config
246           Print the NetworkManager configuration to stdout and exit.
247

UDEV PROPERTIES

249       udev(7) device manager is used for the network device discovery. The
250       following property influences how NetworkManager manages the devices:
251
252       NM_UNMANAGED
253           No default connection will be created and automatic activation will
254           not be attempted when this property of a device is set to a true
255           value ("1" or "true"). You will still be able to attach a
256           connection to the device manually or observe externally added
257           configuration such as addresses or routes.
258
259           Create an udev rule that sets this property to prevent
260           NetworkManager from interfering with virtual Ethernet device
261           interfaces that are managed by virtualization tools.
262

SIGNALS

264       NetworkManager process handles the following signals:
265
266       SIGHUP
267           The signal causes a reload of NetworkManager's configuration. Note
268           that not all configuration parameters can be changed at runtime and
269           therefore some changes may be applied only after the next restart
270           of the daemon. A SIGHUP also involves further reloading actions,
271           like doing a DNS update and restarting the DNS plugin. The latter
272           can be useful for example when using the dnsmasq plugin and
273           changing its configuration in /etc/NetworkManager/dnsmasq.d.
274           However, it also means this will shortly interrupt name resolution.
275           In the future, there may be further actions added. A SIGHUP means
276           to update NetworkManager configuration and reload everything that
277           is supported. Note that this does not reload connections from disk.
278           For that there is a D-Bus API and nmcli's reload action
279
280       SIGUSR1
281           The signal forces a rewrite of DNS configuration. Contrary to
282           SIGHUP, this does not restart the DNS plugin and will not interrupt
283           name resolution. In the future, further actions may be added. A
284           SIGUSR1 means to write out data like resolv.conf, or refresh a
285           cache. It is a subset of what is done for SIGHUP without reloading
286           configuration from disk.
287
288       SIGUSR2
289           The signal has no effect at the moment but is reserved for future
290           use.
291
292       An alternative to a signal to reload configuration is the Reload D-Bus
293       call. It allows for more fine-grained selection of what to reload, it
294       only returns after the reload is complete, and it is guarded by
295       PolicyKit.
296

DEBUGGING

298       The following environment variables are supported to help debugging.
299       When used in conjunction with the --no-daemon option (thus echoing PPP
300       and DHCP helper output to stdout) these can quickly help pinpoint the
301       source of connection issues. Also see the --log-level and --log-domains
302       to enable debug logging inside NetworkManager itself.
303
304       NM_PPP_DEBUG: When set to anything, causes NetworkManager to turn on
305       PPP debugging in pppd, which logs all PPP and PPTP frames and
306       client/server exchanges.
307

BUGS

309       Please report any bugs you find in NetworkManager at the NetworkManager
310       bug tracker[1].
311

SEE ALSO

313       NetworkManager home page[2], NetworkManager.conf(5), nmcli(1), nmcli-
314       examples(7), nm-online(1), nm-settings(5), nm-applet(1), nm-connection-
315       editor(1), udev(7)
316

NOTES

318        1. NetworkManager bug tracker
319           https://bugzilla.gnome.org/enter_bug.cgi?product=NetworkManager
320
321        2. NetworkManager home page
322           https://wiki.gnome.org/Projects/NetworkManager
323
324
325
326NetworkManager 1.12.0                                        NETWORKMANAGER(8)
Impressum