summaryrefslogtreecommitdiff
path: root/man/NetworkManager.8
blob: 127c72bf37392bf73d9cc5e568207e57d35a9271 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
.\" NetworkManager(8) manual page
.\"
.\" Copyright (C) 2005 - 2011 Red Hat, Inc.
.\" Copyright (C) 2005 - 2009 Novell, Inc.
.\" Copyright (C) 2005 Robert Love
.\"
.TH NETWORKMANAGER "8" "2 August 2011"
.SH NAME
NetworkManager \- network management daemon
.SH SYNOPSIS
.B NetworkManager [\-\-version] | [\-\-help]
.PP
.B NetworkManager [\-\-no\-daemon] [\-\-pid\-file=<filename>] [\-\-state\-file=<filename>] [\-\-config=<filename>] [\-\-plugins=<plugin1>,plugin2>,...] [\-\-log\-level=<level>] [\-\-log\-domains=<domain1>,<domain2>,...]
.SH DESCRIPTION
The \fINetworkManager\fP daemon attempts to make  networking configuration and
operation as painless and automatic as possible by managing the primary network
connection and other network interfaces, like Ethernet, WiFi, and Mobile
Broadband devices.  NetworkManager will connect any network device when a
connection for that device becomes available, unless that behavior is disabled.
Information about networking is exported via a D-Bus interface to any interested
application, providing a rich API with which to inspect and control network
settings and operation.
.P
NetworkManager will execute scripts in the /etc/NetworkManager/dispatcher.d
directory in alphabetical order in response to network events.  Each script
should be:
.IP "(a)" 4
a regular file
.IP "(b)" 4
owned by root
.IP "(c)" 4
not writable by group or other
.IP "(d)" 4
not set-uid
.IP "(e)" 4
and executable by the owner
.PP
Each script receives two arguments, the first being the interface name of the
device just activated, and second an action.
.PP
Actions:
.TP
.I "up"
The interface has been activated.  The environment contains more information
about the interface; CONNECTION_UUID contains the UUID of the connection.  Other
variables are IP4_ADDRESS_N where N is a number from 0 to (# IPv4 addresses \- 1),
in the format "address/prefix gateway".  IP4_NUM_ADDRESSES contains the number
addresses the script may expect.  IP4_NAMESERVERS contains a space-separated
list of the DNS servers, and IP4_DOMAINS contains a space-separated list of the
search domains.  Routes use the format IP4_ROUTE_N where N is a number from 0
to (# IPv4 routes \- 1), in the format "address/prefix next-hop metric", and
IP4_NUM_ROUTES contains the number of routes to expect.  If the connection used
DHCP for address configuration, the received DHCP configuration is passed in the
environment using standard DHCP option names, prefixed with "DHCP4_", like
"DHCP4_HOST_NAME=foobar".
.TP
.I "down"
The interface has been deactivated.
.TP
.I "vpn\-up"
A VPN connection has been activated.  The environment contains the connection
UUID in the variable CONNECTION_UUID.
.TP
.I "vpn\-down"
A VPN connection has been deactivated.
.TP
.I "hostname"
The system hostname has been updated.  Use gethostname(2) to retrieve it.
.TP
.I "dhcp4\-change"
The DHCPv4 lease has changed (renewed, rebound, etc).
.TP
.I "dhcp6\-change"
The DHCPv6 lease has changed (renewed, rebound, etc).
.SH OPTIONS
The following options are supported:
.TP
.I "\-\-version"
Print the NetworkManager software version and exit.
.TP
.I "\-\-help"
Print NetworkManager's available options and exit.
.TP
.I "\-\-no\-daemon"
Do not daemonize.  This is useful for debugging, and directs log output to the
controlling terminal in addition to syslog.
.TP
.I "\-\-pid\-file=<filename>"
Specify location of a PID file.  The PID file is used for storing PID of the
running proccess and prevents running multiple instances.
.TP
.I "\-\-state\-file=<filename>"
Specify file for storing state of the NetworkManager persistently.  If not specified,
the default value of '<LOCALSTATEDIR>/lib/NetworkManager/NetworkManager.state' is
used; where <LOCALSTATEDIR> is dependent on your distribution (usually it's /var).
.TP
.I "\-\-config=<filename>"
Specify configuration file to set up various settings for NetworkManager.  If not
specified, the default value of '<SYSCONFDIR>/NetworkManager/NetworkManager.conf'
is used with a fallback to the older 'nm\-system\-settings.conf' if located in
the same directory; where <SYSCONFDIR> is dependent on your distribution (usually
it's /etc).  See \fBNetworkManager.conf\fP(5) for more information on configuration
file.
.TP
.I "\-\-plugins=<plugin1>,<plugin2>, ...
List plugins used to manage system-wide connection settings.   This list has
preference over plugins specified in the configuration file.  Currently supported
plugins are: keyfile, ifcfg\-rh, ifcfg\-suse, ifupdown.
See \fBNetworkManager.conf\fP(5) for more information on the plugins.
.TP
.I "\-\-log\-level=<level>
Sets how much information NetworkManager sends to the log destination (usually
syslog's "daemon" facility).  By default, only informational, warning, and error
messages are logged.  See \fBNetworkManager.conf\fP(5) for more information on
log levels and domains.
.TP
.I "\-\-log\-domains=<domain1>,<domain2>, ...
Sets which operations are logged to the log destination (usually syslog).  By
default, most domains are logging-enabled.  See \fBNetworkManager.conf\fP(5) for
more information on log levels and domains.
.SH DEBUGGING
The following environment variables are supported to help debugging.  When used
in conjunction with the "\-\-no\-daemon" option (thus echoing PPP and DHCP helper
output to stdout) these can quickly help pinpoint the source of connection
issues.  Also see the \-\-log\-level and \-\-log\-domains to enable debug logging inside
NetworkManager itself.
.TP
.I "NM_PPP_DEBUG"
When set to anything, causes NetworkManager to turn on PPP debugging in pppd,
which logs all PPP and PPTP frames and client/server exchanges.
.SH SEE ALSO
.BR nm\-tool (1),
.BR nm\-online (1),
.BR nmcli (1),
.BR NetworkManager.conf (5).