cli: make the *-slave type option parsing out of the common path
[NetworkManager.git] / man / nmcli.1.in
1 .\" nmcli (1) manual page
2 .\"
3 .\" This is free documentation; you can redistribute it and/or
4 .\" modify it under the terms of the GNU General Public License as
5 .\" published by the Free Software Foundation; either version 2 of
6 .\" the License, or (at your option) any later version.
7 .\"
8 .\" The GNU General Public License's references to "object code"
9 .\" and "executables" are to be interpreted as the output of any
10 .\" document formatting or typesetting system, including
11 .\" intermediate and printed output.
12 .\"
13 .\" This manual is distributed in the hope that it will be useful,
14 .\" but WITHOUT ANY WARRANTY; without even the implied warranty of
15 .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16 .\" GNU General Public License for more details.
17 .\"
18 .\" You should have received a copy of the GNU General Public Licence along
19 .\" with this manual; if not, write to the Free Software Foundation, Inc.,
20 .\" 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
21 .\"
22 .\" Copyright 2010 - 2015 Red Hat, Inc.
23 .\"
24 .TH NMCLI "1" "2016-03-09" "NetworkManager 1.2"
25
26 .SH NAME
27 nmcli \- command\(hyline tool for controlling NetworkManager
28 .SH SYNOPSIS
29 .ad l
30 .B nmcli
31 .RI " [ " OPTIONS " ] " OBJECT " { " COMMAND " | "
32 .BR help " } "
33 .sp
34
35 .IR OBJECT " := { "
36 .BR general " | " networking " | " radio " | " connection " | " device " | " agent " | " monitor
37 .RI " }"
38 .sp
39
40 .IR OPTIONS " := { "
41 .br
42 \fB\-t\fR[\fIerse\fR]
43 .br
44 \fB\-p\fR[\fIretty\fR]
45 .br
46 \fB\-m\fR[\fImode\fR] tabular | multiline
47 .br
48 \fB\-c\fR[\fIcolors\fR] auto | yes | no
49 .br
50 \fB\-f\fR[\fIields\fR] <field1,field2,...> | all | common
51 .br
52 \fB\-e\fR[\fIscape\fR] yes | no
53 .br
54 \fB\-n\fR[\fIocheck\fR]
55 .br
56 \fB\-a\fR[\fIsk\fR]
57 .br
58 \fB\-s\fR[\fIhow-secrets\fR]
59 .br
60 \fB\-w\fR[\fIait\fR] <seconds>
61 .br
62 \fB\-v\fR[\fIersion\fR]
63 .br
64 \fB\-h\fR[\fIelp\fR]
65 .br
66 .RI "}"
67
68 .SH DESCRIPTION
69 .B nmcli
70 is a command\(hyline tool for controlling NetworkManager and reporting network
71 status. It can be utilized as a replacement for \fInm\(hyapplet\fP or other
72 graphical clients. \fInmcli\fP is used to create, display, edit, delete, activate,
73 and deactivate network connections, as well as control and display network device
74 status.
75 .P
76 Typical uses include:
77 .IP \(em 4
78 Scripts: utilize NetworkManager via \fInmcli\fP instead of managing network
79 connections manually.  \fInmcli\fP supports a terse output format which is better
80 suited for script processing. Note that NetworkManager can also execute scripts,
81 called "dispatcher scripts", in response to network events. See
82 \fBNetworkManager\fP for details about these dispatcher scripts.
83 .IP \(em 4
84 Servers, headless machines, and terminals:  \fInmcli\fP can be used to control
85 NetworkManager without a GUI, including creating, editing, starting and stopping
86 network connections and viewing network status.
87 .SS \fIOPTIONS\fP
88 .TP
89 .B \-t, \-\-terse
90 Output is terse.  This mode is designed and suitable for computer (script)
91 processing.
92 .TP
93 .B \-p, \-\-pretty
94 Output is pretty. This causes \fInmcli\fP to produce easily readable outputs
95 for humans, i.e. values are aligned, headers are printed, etc.
96 .TP
97 .B \-m, \-\-mode tabular | multiline
98 Switch between \fItabular\fP and \fImultiline\fP output.
99 If omitted, default is \fItabular\fP for most commands. For the commands
100 producing more structured information, that cannot be displayed on a single
101 line, default is \fImultiline\fP. Currently, they are:
102 .br
103 .nf
104   'nmcli connection show <ID>'
105   'nmcli device show'
106 .fi
107 \fItabular\fP   \(en Output is a table where each line describes a single entry.
108 Columns define particular properties of the entry.
109 .br
110 \fImultiline\fP \(en Each entry comprises multiple lines, each property on its own
111 line. The values are prefixed with the property name.
112 .TP
113 .B \-c, \-\-colors auto|yes|no
114 This option controls color output (using terminal escape sequences). \fIyes\fP
115 enables colors, \fIno\fP disables them, \fIauto\fP only produces colors when
116 standard output is directed to a terminal. The default value is \fIauto\fP.
117 .TP
118 .B \-f, \-\-fields <field1,field2,...> | all | common
119 This option is used to specify what fields (column names) should be printed.
120 Valid field names differ for specific commands. List available fields by
121 providing an invalid value to the \fI\-\-fields\fP option.
122 .br
123 \fIall\fP is used to print all valid field values of the command.
124 \fIcommon\fP is used to print common field values of the command.
125 If omitted, default is \fIcommon\fP.
126 The option is mandatory when \fI\-\-terse\fP is used.  In this case, generic
127 values \fIall\fP and \fIcommon\fP cannot be used.  (This is to maintain
128 compatibility when new fields are added in the future).
129 .TP
130 .B \-e, \-\-escape yes | no
131 Whether to escape ':' and '\\' characters in terse tabular mode.  The escape
132 character is '\\'.
133 If omitted, default is \fIyes\fP.
134 .TP
135 .B \-n, \-\-nocheck
136 This option can be used to force \fInmcli\fP to skip checking \fInmcli\fP and
137 \fINetworkManager\fP version compatibility. Use it with care, because using
138 incompatible versions may produce incorrect results.
139 .TP
140 .B \-a, \-\-ask
141 When using this option \fInmcli\fP will stop and ask for any missing required
142 arguments, so do not use this option for non-interactive purposes like scripts.
143 This option controls, for example, whether you will be prompted for a password
144 if it is required for connecting to a network.
145 .TP
146 .B \-s, \-\-show-secrets
147 When using this option \fInmcli\fP will display passwords and secrets that might
148 be present in an output of an operation. This option also influences echoing
149 passwords typed by user as an input.
150 .TP
151 .B \-w, \-\-wait <seconds>
152 This option sets a timeout period for which \fInmcli\fP will wait for \fINetworkManager\fP
153 to finish operations. It is especially useful for commands that may take a longer time to
154 complete, e.g. connection activation.
155 Specifying a value of \fB0\fP instructs \fInmcli\fP not to wait but to exit immediately
156 with a status of success. The default value depends on the executed command.
157 .TP
158 .B \-v, \-\-version
159 Show \fInmcli\fP version.
160 .TP
161 .B \-h, \-\-help
162 Print help information.
163 .SS \fIOBJECT\fP
164 .TP
165 .B general \- general \fINetworkManager\fP status and operations
166 .br
167 Use this object to show NetworkManager status and permissions. You can also get
168 and change system hostname, as well as NetworkManager logging level and domains.
169 .TP
170 .SS \fICOMMAND\fP := { status | hostname | permissions | logging }
171 .sp
172 .RS
173 .TP
174 .B status
175 .br
176 Show overall status of NetworkManager. This is the default action, when no additional
177 command is provided for \fIgeneral\fP object.
178 .TP
179 .B hostname [<hostname>]
180 .br
181 Get and change system hostname. With no arguments, this prints currently configured hostname.
182 When you pass a hostname, it will be handed over to NetworkManager to be set as a new system
183 hostname.
184 .br
185 Note that the term \fBsystem\fP hostname may also be referred to as \fBpersistent\fP or
186 \fBstatic\fP by other programs or tools. The hostname is stored in /etc/hostname
187 file in most distributions. For example, systemd-hostnamed service uses the term
188 \fBstatic\fP hostname and it only reads the /etc/hostname file when it starts.
189 .TP
190 .B permissions
191 .br
192 Show the permissions a caller has for various authenticated operations that
193 NetworkManager provides, like enable and disable networking, changing Wi\(hyFi
194 and WWAN state, modifying connections, etc.
195 .TP
196 .B logging [level <log level>] [domains <log domains>]
197 .br
198 Get and change \fINetworkManager\fP logging level and domains. Without any argument
199 current logging level and domains are shown. In order to change logging state, provide
200 \fIlevel\fP and, or, \fIdomain\fP parameters. See \fBNetworkManager.conf\fP for available
201 level and domain values.
202 .RE
203
204 .TP
205 .B networking \- get or set general networking state of NetworkManager
206 .br
207 Use this object to show NetworkManager networking status, or to enable and disable
208 networking. Disabling networking removes the configuration from all devices and
209 changes them to the 'unmanaged' state.
210 .TP
211 .SS \fICOMMAND\fP := { [ on | off | connectivity ] }
212 .sp
213 .RS
214 .TP
215 .B [ on | off ]
216 .br
217 Get networking\(hyenabled status or enable and disable networking by NetworkManager.
218 All interfaces managed by NetworkManager are deactivated when networking has
219 been disabled.
220 .TP
221 .B connectivity [check]
222 .br
223 Get network connectivity state.
224 The optional \fIcheck\fP argument tells NetworkManager to re-check the connectivity,
225 else the most recent known connectivity state is displayed without re-checking.
226 .br
227 Possible states are:
228 .RS
229 .PP
230 .IP \fInone\fP 9
231 \(en the host is not connected to any network
232 .IP \fIportal\fP 9
233 \(en the host is behind a captive portal and cannot reach the full Internet
234 .IP \fIlimited\fP 9
235 \(en the host is connected to a network, but it has no access to the Internet
236 .IP \fIfull\fP 9
237 \(en the host is connected to a network and has full access to the Internet
238 .IP \fIunknown\fP 9
239 \(en the connectivity status cannot be found out
240 .RE
241 .RE
242
243 .TP
244 .B radio \- get or set radio switch states
245 .br
246 Use this object to show radio switches status, or enable and disable
247 the switches.
248 .TP
249 .SS \fICOMMAND\fP := { all | wifi | wwan }
250 .sp
251 .RS
252 .TP
253 .B wifi [ on | off ]
254 .br
255 Show or set status of Wi\(hyFi in NetworkManager. If no arguments are supplied,
256 Wi\(hyFi status is printed; \fIon\fP enables Wi\(hyFi; \fIoff\fP disables Wi\(hyFi.
257 .TP
258 .B wwan [ on | off ]
259 .br
260 Show or set status of WWAN (mobile broadband) in NetworkManager. If no arguments
261 are supplied, mobile broadband status is printed; \fIon\fP enables mobile broadband,
262 \fIoff\fP disables it.
263 .TP
264 .B all [ on | off ]
265 .br
266 Show or set all previously mentioned radio switches at the same time.
267 .RE
268
269 .TP
270 .B monitor \- monitor NetworkManager
271 .br
272 Use this object to observe NetworkManager activity. Watches for changes
273 in connectivity state, devices or connection profiles.
274 .br
275 See also \fImonitor\fP command of \fIconnection\fP or \fIdevice\fP object
276 to watch for changes in certain objects or object classes.
277 .RE
278
279 .TP
280 .B connection \- start, stop, and manage network connections
281 .sp
282 NetworkManager stores all network configuration as \fIconnections\fP, which are
283 collections of data (Layer2 details, IP addressing, etc.) that describe
284 how to create or connect to a network.  A connection is \fIactive\fP when
285 a device uses that connection's configuration to create or connect to a network.
286 There may be multiple connections that apply to a device, but only one of them
287 can be active on that device at any given time. The additional connections can
288 be used to allow quick switching between different networks and configurations.
289 .sp
290 Consider a machine which is usually connected to a DHCP-enabled network, but
291 sometimes connected to a testing network which uses static IP addressing.  Instead
292 of manually reconfiguring eth0 each time the network is changed, the settings can
293 be saved as two connections which both apply to eth0, one for DHCP (called
294 "default") and one with the static addressing details (called "testing").  When
295 connected to the DHCP-enabled network the user would run "nmcli con up default"
296 , and when connected to the static network the user would run "nmcli con up testing".
297 .TP
298 .SS \fICOMMAND\fP := { show | up | down | add | edit | modify | delete | monitor | reload | load }
299 .sp
300 .RS
301 .TP
302 .B show [--active]
303 .br
304 List in-memory and on-disk connection profiles, some of which may also be
305 active if a device is using that connection profile. Without a parameter, all
306 profiles are listed. When --active option is specified, only the active profiles
307 are shown.
308 .TP
309 .B show [--active] [--order <order spec>] [ id | uuid | path | apath ] <ID> ...
310 .br
311 Show details for specified connections. By default, both static configuration
312 and active connection data are displayed.  When --active option is specified,
313 only the active profiles are taken into account. Use global --show-secrets option
314 to display secrets associated with the profile.
315 .sp
316 Ordering:
317 .br
318 The --order option can be used to get custom ordering of connections. The
319 connections can be ordered by active status, name, type or D-Bus path. If
320 connections are equal according to a sort order category, an additional
321 category can be specified.
322 The default sorting order is equivalent to "--order active:name:path".
323 .sp
324 <order spec> := category:category:...
325 .br
326 category := [+-]active | [+-]name | [+-]type | [+-]path
327 .br
328 \fI+\fP or no prefix means sorting in ascending order (alphabetically or in numbers).
329 .br
330 \fI-\fP means reverse (descending) order.
331 .br
332 The category names can be abbreviated (e.g. --order -a:na)
333 .sp
334 \fIid\fP, \fIuuid\fP, \fIpath\fP and \fIapath\fP keywords can be used if
335 \fI<ID>\fP is ambiguous.
336 .RS
337 .PP
338 Optional <ID>-specifying keywords are:
339 .IP \fIid\fP 13
340 \(en the <ID> denotes a connection name
341 .IP \fIuuid\fP 13
342 \(en the <ID> denotes a connection UUID
343 .IP \fIpath\fP 13
344 \(en the <ID> denotes a D-Bus static connection path
345 in the format of /org/freedesktop/NetworkManager/Settings/<num> or just <num>
346 .IP \fIapath\fP 13
347 \(en the <ID> denotes a D-Bus active connection path
348 in the format of /org/freedesktop/NetworkManager/ActiveConnection/<num> or just <num>
349 .PP
350 It is possible to filter the output using the global \fI--fields\fP option. Use the following
351 values:
352 .RE
353 .RS
354 .PP
355 .IP \fIprofile\fP 13
356 \(en only shows static profile configuration
357 .IP \fIactive\fP 13
358 \(en only shows active connection data (when the profile is active)
359 .PP
360 You can also specify particular fields. For static configuration, use setting and property names
361 as described in \fInm-settings\fP(5) manual page. For active data use GENERAL, IP4, DHCP4, IP6,
362 DHCP6, VPN.
363 .PP
364 When no command is given to the \fIconnection\fP object, the default action
365 is 'nmcli connection show'.
366 .RE
367 .TP
368 .B up [ id | uuid | path ] <ID> [ifname <ifname>] [ap <BSSID>] [passwd-file <file with passwords>]
369 .RE
370 .RS
371 .B up ifname <ifname> [ap <BSSID>] [passwd-file <file with passwords>]
372 .RS
373 .br
374 Activate a connection.  The connection is identified by its name, UUID or D-Bus
375 path. If <ID> is ambiguous, a keyword \fIid\fP, \fIuuid\fP or \fIpath\fP can be
376 used.  When requiring a particular device to activate the connection on, the
377 \fIifname\fP option with interface name should be given.  If the <ID> is not
378 given an \fIifname\fP is required, and NetworkManager will activate the best
379 available connection for the given \fIifname\fP.  In case of a VPN connection,
380 the \fIifname\fP option specifies the device of the base connection. The
381 \fIap\fP option specify what particular AP should be used in case of a Wi\(hyFi
382 connection.
383 .br
384 If '--wait' option is not specified, the default timeout will be 90 seconds.
385 .br
386 See \fBconnection show\fP above for the description of the <ID>-specifying keywords.
387 .RS
388 .PP
389 Available options are:
390 .IP \fIifname\fP 13
391 \(en interface that will be used for activation
392 .IP \fIap\fP 13
393 \(en BSSID of the AP which the command should connect to (for Wi\(hyFi connections)
394 .IP \fIpasswd-file\fP 13
395 \(en some networks may require credentials during activation. You can give these
396 credentials using this option.
397 Each line of the file should contain one password in the form of
398 .br
399 \fBsetting_name.property_name:the password\fP
400 .br
401 For example, for WPA Wi-Fi with PSK, the line would be
402 .br
403 \fI802-11-wireless-security.psk:secret12345\fP
404 .br
405 For 802.1X password, the line would be
406 .br
407 \fI802-1x.password:my 1X password\fP
408 .br
409 nmcli also accepts "wifi-sec" and "wifi" strings instead of "802-11-wireless-security".
410 When NetworkManager requires a password and it is not given, nmcli will ask for it
411 when run with --ask. If --ask was not passed, NetworkManager can ask another secret
412 agent that may be running (typically a GUI secret agent, such as nm-applet or
413 gnome-shell).
414 .RE
415 .RE
416 .TP
417 .B down [ id | uuid | path | apath ] <ID> ...
418 .br
419 Deactivate a connection from a device without preventing the device from
420 further auto-activation. Multiple connections can be passed to the command. 
421 .sp
422 Be aware that this command deactivates the specified active connection, but the device
423 on which the connection was active, is still ready to connect and will perform
424 auto-activation by looking for a suitable connection that has the 'autoconnect'
425 flag set. This includes the just deactivated connection. So if the connection is set
426 to auto-connect, it will be automatically started on the disconnected device again.
427 .br
428 In most cases you may want to use \fIdevice disconnect\fP command instead.
429 .sp
430 The connection is identified by its name, UUID or D-Bus path.
431 If <ID> is ambiguous, a keyword \fIid\fP, \fIuuid\fP, \fIpath\fP or
432 \fIapath\fP can be used.
433 .br
434 See \fBconnection show\fP above for the description of the <ID>-specifying keywords.
435 .br
436 If '--wait' option is not specified, the default timeout will be 10 seconds.
437 .TP
438 .B add COMMON_OPTIONS TYPE_SPECIFIC_OPTIONS IP_OPTIONS [-- [+|-]<setting>.<property> <value> ...]
439 .br
440 Add a connection for NetworkManager. Arguments differ according to connection types, see below.
441 .RS
442 .TP
443 .B COMMON_OPTIONS:
444 .IP "\fItype <type>\fP" 42
445 \(en connection type; see below \fBTYPE_SPECIFIC_OPTIONS\fP for allowed values; (mandatory)
446 Note that types \fIbond-slave\fP, \fIteam-slave\fP and \fIbridge-slave\fP create \fIethernet\fP
447 connection profiles. Their use is discouraged in favor of using a specific type with \fImaster\fP
448 option.
449 .IP "\fIifname <ifname> | \(dq\&*\(dq\&\fP" 42
450 \(en interface to bind the connection to. The connection will only be applicable to this
451 interface name. A special value of "\fB*\fP" can be used for interface-independent connections.
452 The \fIifname\fP argument is mandatory for all connection types except bond, team, bridge and vlan.
453 Note: use quotes around \fB*\fP to suppress shell expansion.
454 .IP "\fI[con-name <connection name>]\fP" 42
455 \(en connection name (when not provided a default name is generated: <type>[-<ifname>][-<num>])
456 .IP "\fI[autoconnect yes|no]\fP" 42
457 \(en whether the connection profile can be automatically activated (default: yes)
458 .IP "\fI[save yes|no]\fP" 42
459 \(en whether the connection should be persistent, i.e. NetworkManager should store it on disk (default: yes)
460 .IP "\fI[master <master (ifname, or connection UUID or name)>]\fP" 42
461 \(en master interface name, or connection UUID or ID of master connection profile.
462 The value can be prefixed with \fBifname/\fP, \fBuuid/\fP or \fBid/\fP to disambiguate it.
463 .IP "\fI[slave-type <master connection type>]\fP" 42
464 \(en type of master connection. Only required when it can not be inferred (i.e. the master connection does
465 not exist yet).
466 .RE
467 .RS
468 .TP
469 .B TYPE_SPECIFIC_OPTIONS:
470 .TP
471 .B ethernet:
472 .IP "\fI[mac <MAC address>]\fP" 42
473 \(en MAC address of the device this connection is locked to
474 .IP "\fI[cloned-mac <cloned MAC address>]\fP" 42
475 \(en cloned MAC
476 .IP "\fI[mtu <MTU>]\fP" 42
477 \(en MTU
478 .RE
479 .RS
480 .TP
481 .B wifi:
482 .IP "\fIssid <SSID>\fP" 42
483 \(en SSID
484 .IP "\fI[mac <MAC address>]\fP" 42
485 \(en MAC address of the device this connection is locked to
486 .IP "\fI[cloned-mac <cloned MAC address>]\fP" 42
487 \(en cloned MAC
488 .IP "\fI[mode infrastructure|ap|adhoc]\fP" 42
489 \(en Wi-Fi network mode. If blank, \fIinfrastructure\fP is assumed.
490 .IP "\fI[mtu <MTU>]\fP" 42
491 \(en MTU
492 .RE
493 .RS
494 .TP
495 .B wimax:
496 .IP "\fI[mac <MAC address>]\fP" 42
497 \(en MAC address of the device this connection is locked to
498 .IP "\fI[nsp <NSP>]\fP" 42
499 \(en Network Service Provider name
500 .RE
501 .RS
502 .TP
503 .B pppoe:
504 .IP "\fIusername <PPPoE username>\fP" 42
505 \(en PPPoE username
506 .IP "\fI[password <PPPoE password>]\fP" 42
507 \(en Password for the PPPoE username
508 .IP "\fI[service <PPPoE service name>]\fP" 42
509 \(en PPPoE service name (if required by concentrator)
510 .IP "\fI[mtu <MTU>]\fP" 42
511 \(en MTU
512 .IP "\fI[mac <MAC address>]\fP" 42
513 \(en MAC address of the device this connection is locked to
514 .RE
515 .RS
516 .TP
517 .B gsm:
518 .IP "\fIapn <APN>\fP" 42
519 \(en APN - GSM Access Point Name
520 .IP "\fI[user <username>]\fP" 42
521 \(en user name
522 .IP "\fI[password <password>]\fP" 42
523 \(en password
524 .RE
525 .RS
526 .TP
527 .B cdma:
528 .IP "\fI[user <username>]\fP" 42
529 \(en user name
530 .IP "\fI[password <password>]\fP" 42
531 \(en password
532 .RE
533 .RS
534 .TP
535 .B infiniband:
536 .IP "\fI[mac <MAC address>]\fP" 42
537 \(en MAC address of the device this connection is locked to (InfiniBand MAC is 20 bytes)
538 .IP "\fI[mtu <MTU>]\fP" 42
539 \(en MTU
540 .IP "\fI[transport-mode datagram | connected]\fP" 42
541 \(en InfiniBand transport mode
542 .IP "\fI[parent <interface name>]\fP" 42
543 \(en the interface name of the parent device (if any)
544 .IP "\fI[p-key <IPoIB P_Key>]\fP" 42
545 \(en the InfiniBand P_Key (16-bit unsigned integer)
546 .RE
547 .RS
548 .TP
549 .B bluetooth:
550 .IP "\fI[addr <bluetooth address>]\fP" 42
551 \(en Bluetooth device address (MAC)
552 .IP "\fI[bt-type panu|dun-gsm|dun-cdma]\fP" 42
553 \(en Bluetooth connection type
554 .RE
555 .RS
556 .TP
557 .B vlan:
558 .IP "\fIdev <parent device (connection UUID, ifname, or MAC)>\fP" 42
559 \(en parent device this VLAN is on
560 .IP "\fIid <VLAN ID>\fP" 42
561 \(en VLAN ID in range <0-4095>
562 .IP "\fI[flags <VLAN flags>]\fP" 42
563 \(en flags
564 .IP "\fI[ingress <ingress priority mapping>]\fP" 42
565 \(en VLAN ingress priority mapping
566 .IP "\fI[egress <egress priority mapping>]\fP" 42
567 \(en VLAN egress priority mapping
568 .IP "\fI[mtu <MTU>]\fP" 42
569 \(en MTU
570 .RE
571 .RS
572 .TP
573 .B bond:
574 .IP "\fI[mode balance-rr (0) | active-backup (1) | balance-xor (2) | broadcast (3) |\fP"
575 .IP "\fI      802.3ad    (4) | balance-tlb   (5) | balance-alb (6)]\fP" 42
576 \(en bonding mode (default: balance-rr)
577 .IP "\fI[primary <ifname>]\fP" 42
578 \(en primary interface name (for "active-backup" mode)
579 .IP "\fI[miimon <num>]\fP" 42
580 \(en miimon (default: 100)
581 .IP "\fI[downdelay <num>]\fP" 42
582 \(en downdelay (default: 0)
583 .IP "\fI[updelay <num>]\fP" 42
584 \(en updelay (default: 0)
585 .IP "\fI[arp-interval <num>]\fP" 42
586 \(en ARP interval (default: 0)
587 .IP "\fI[arp-ip-target <num>]\fP" 42
588 \(en ARP IP target
589 .RE
590 .RS
591 .TP
592 .B bond-slave:
593 .IP "\fImaster <master (ifname, or connection UUID or name)>\fP" 42
594 \(en master bond interface name, or connection UUID or ID of bond master connection profile.
595 The value can be prefixed with \fBifname/\fP, \fBuuid/\fP or \fBid/\fP to disambiguate it.
596 .RE
597 .RS
598 .TP
599 .B team:
600 .IP "\fI[config <file>|<raw JSON data>]\fP" 42
601 \(en JSON configuration for team
602 .RE
603 .RS
604 .TP
605 .B team-slave:
606 .IP "\fImaster <master (ifname, or connection UUID or name)>\fP" 42
607 \(en master team interface name, or connection UUID or ID of team master connection profile.
608 The value can be prefixed with \fBifname/\fP, \fBuuid/\fP or \fBid/\fP to disambiguate it.
609 .RE
610 .RS
611 .TP
612 .IP "\fI[config <file>|<raw JSON data>]\fP" 42
613 \(en JSON configuration for team
614 .RE
615 .RS
616 .TP
617 .B bridge:
618 .IP "\fI[stp yes|no]\fP" 42
619 \(en controls whether Spanning Tree Protocol (STP) is enabled for this bridge (default: yes)
620 .IP "\fI[priority <num>]\fP" 42
621 \(en sets STP priority (default: 128)
622 .IP "\fI[forward-delay <2-30>]\fP" 42
623 \(en STP forwarding delay, in seconds (default: 15)
624 .IP "\fI[hello-time <1-10>]\fP" 42
625 \(en STP hello time, in seconds (default: 2)
626 .IP "\fI[max-age <6-42>]\fP" 42
627 \(en STP maximum message age, in seconds (default: 20)
628 .IP "\fI[ageing-time <0-1000000>]\fP" 42
629 \(en the Ethernet MAC address aging time, in seconds (default: 300)
630 .IP "\fI[multicast-snooping yes|no]\fP" 42
631 \(en controls whether IGMP snooping is enabled (default: yes)
632 .IP "\fI[mac <MAC address>]\fP" 42
633 \(en MAC address of the bridge (note: this requires a recent kernel feature,
634 originally introduced in 3.15 upstream kernel)
635 .RE
636 .RS
637 .TP
638 .B bridge-slave:
639 .IP "\fImaster <master (ifname, or connection UUID or name)>\fP" 42
640 \(en master bridge interface name, or connection UUID or ID of bridge master connection profile.
641 The value can be prefixed with \fBifname/\fP, \fBuuid/\fP or \fBid/\fP to disambiguate it.
642 .RE
643 .RS
644 .TP
645 .IP "\fI[priority <0-63>]\fP" 42
646 \(en STP priority of this slave (default: 32)
647 .IP "\fI[path-cost <1-65535>]\fP" 42
648 \(en STP port cost for destinations via this slave (default: 100)
649 .IP "\fI[hairpin yes|no]\fP" 42
650 \(en 'hairpin mode' for the slave, which allows frames
651 to be sent back out through the slave the frame was received on (default: yes)
652 .RE
653 .RS
654 .TP
655 .B vpn:
656 .IP "\fIvpn-type vpnc|openvpn|pptp|openconnect|openswan|libreswan|strongswan|ssh|l2tp|iodine|fortisslvpn|...\fP" 42
657 \(en VPN type
658 .IP "\fI[user <username>]\fP" 42
659 \(en VPN username
660 .RE
661 .RS
662 .TP
663 .B olpc-mesh:
664 .IP "\fIssid <SSID>\fP" 42
665 \(en SSID
666 .IP "\fI[channel <1-13>]\fP" 42
667 \(en channel to use for the network
668 .IP "\fI[dhcp-anycast <MAC address>]\fP" 42
669 \(en anycast DHCP MAC address used when requesting an IP address via DHCP
670 .RE
671 .RS
672 .TP
673 .B adsl:
674 .IP "\fIusername <username>\fP" 42
675 \(en ADSL user name
676 .IP "\fIprotocol pppoa|pppoe|ipoatm\fP" 42
677 \(en ADSL protocol
678 .IP "\fI[password <password>]\fP" 42
679 \(en ADSL password
680 .IP "\fI[encapsulation vcmux|llc]\fP" 42
681 \(en ADSL encapsulation
682 .RE
683 .RS
684 .TP
685 .B tun:
686 .IP "\fImode tun|tap\fP" 42
687 \(en Mode for the device
688 .IP "\fI[owner <UID>]\fP" 42
689 \(en UID of the owner
690 .IP "\fI[group <GID>]\fP" 42
691 \(en GID of the group
692 .IP "\fI[pi yes|no>]\fP" 42
693 \(en include packet information (~IFF_NO_PI flag)
694 .IP "\fI[vnet-hdr yes|no>]\fP" 42
695 \(en send and receive large (i.e. GSO) packets and packets with partial checksums (IFF_VNET_HDR flag)
696 .IP "\fI[multi-queue yes|no>]\fP" 42
697 \(en multi-queue support for tun/tap device (IFF_MULTI_QUEUE flag)
698 .RE
699 .RS
700 .TP
701 .B ip-tunnel:
702 .IP "\fImode ipip|gre|sit|isatap|vti|ip6ip6|ipip6|ip6gre|vti6\fP" 42
703 \(en tunnel mode
704 .IP "\fIremote <remote endpoint IP>\fP" 42
705 \(en IPv4 or IPv6 address of the remote tunnel endpoint
706 .IP "\fI[local <local endpoint IP>]\fP" 42
707 \(en IPv4 or IPv6 address of the local tunnel endpoint
708 .IP "\fI[dev <parent device (ifname or connection UUID)>]\fP" 42
709 \(en device to use for tunnel endpoint communication
710 .RE
711 .RS
712 .TP
713 .B macvlan:
714 .IP "\fIdev <parent device (connection  UUID, ifname, or MAC)>\fP" 42
715 \(en parent device this MACVLAN is on
716 .IP "\fImode vepa|bridge|private|passthru|source\fP" 42
717 \(en MACVLAN mode, which specifies the communication mechanism between multiple MACVLANs on the same lower device
718 .IP "\fI[tap yes|no]\fP" 42
719 \(en controls the device type. If set to 'yes' a MACVTAP will be created (default: no)
720 .RE
721 .RS
722 .TP
723 .B vxlan:
724 .IP "\fIid <VXLAN ID>\fP" 42
725 \(en VXLAN Network Identifer to use
726 .IP "\fIremote <IP>\fP" 42
727 \(en unicast destination IP address or multicast IP address to join
728 .IP "\fI[dev <parent device (ifname or connection UUID)>]\fP" 42
729 \(en device to use for tunnel endpoint communication
730 .IP "\fI[local <IP>]\fP" 42
731 \(en source IP address
732 .IP "\fI[source-port-min <0-65535>]\fP" 42
733 \(en minimum UDP source port to communicate to the remote VXLAN tunnel endpoint
734 .IP "\fI[source-port-max <0-65535>]\fP" 42
735 \(en maximum UDP source port to communicate to the remote VXLAN tunnel endpoint
736 .IP "\fI[destination-port <0-65535>]\fP" 42
737 \(en UDP destination port to communicate to the remote VXLAN tunnel endpoint
738 .RE
739 .RS
740 .TP
741 .B IP_OPTIONS:
742 .IP "\fI[ip4 <IPv4 address>] [gw4 <IPv4 gateway>]\fP" 42
743 \(en IPv4 addresses
744 .IP "\fI[ip6 <IPv6 address>] [gw6 <IPv6 gateway>]\fP" 42
745 \(en IPv6 addresses
746 .RE
747 .RS
748 If a \fI--\fP argument is encountered, the rest of command line is interpreted
749 as property list in the same format as \fIconnection modify\fP command accepts.
750 This makes it possible to adjust the connection properties before it's added.
751 .RE
752 .TP
753 .B edit [id | uuid | path ] <ID>  - edit an existing connection
754 .RE
755 .RS
756 .B edit [type <new connection type>] [con-name <new connection name>]  - add a new connection
757 .RS
758 Edit an existing connection or add a new one, using an interactive editor.
759 .br
760 The existing connection is identified by its name, UUID or D-Bus path.
761 If <ID> is ambiguous, a keyword \fIid\fP, \fIuuid\fP, or \fIpath\fP can be used.
762 See \fBconnection show\fP above for the description of the <ID>-specifying keywords.
763 Not providing an <ID> means that a new connection will be added.
764 .sp
765 The interactive editor will guide you through the connection editing and
766 allow you to change connection parameters according to your needs by means of
767 a simple menu-driven interface. The editor indicates what settings and
768 properties can be modified and provides in-line help.
769 .sp
770 .PP
771 Available options:
772 .IP \fItype\fP 13
773 \(en type of the new connection; valid types are the same as for \fIconnection add\fP command
774 .IP \fIcon-name\fP 13
775 \(en name for the new connection. It can be changed later in the editor.
776 .RE
777 .RS
778 .sp
779 See also \fInm-settings\fP(5) for all NetworkManager settings and property names, and their
780 descriptions; and \fInmcli-examples\fP(5) for sample editor sessions.
781 .RE
782 .TP
783 .B modify [--temporary] [ id | uuid | path ] <ID> [+|-]<setting>.<property> <value>
784 .B [+|-]<setting>.<property> <value> ...
785 .br
786 Modify one or more properties in the connection profile.
787 .br
788 The connection is identified by its name, UUID or D-Bus path. If <ID> is
789 ambiguous, a keyword \fIid\fP, \fIuuid\fP or \fIpath\fP can be used.  See
790 \fInm-settings\fP(5) for setting and property names, their descriptions and
791 default values. This command supports abbreviations for \fIsetting name\fP and
792 \fIproperty name\fP provided they are unique. Empty \fIvalue\fP ("") removes
793 the property value (sets the property to the default value).  The provided
794 value overwrites the existing property value.
795 .br
796 If you want to append an item to the existing value, use \fI+\fP prefix for the
797 property name. If you want to remove just one item from container-type
798 property, use \fI-\fP prefix for the property name and specify a value or an
799 zero-based index of the item to remove (or option name for properties with
800 named options) as \fIvalue\fP. Of course, \fI+|-\fP only have a real effect for
801 multi-value (container) properties like ipv4.dns, ipv4.addresses, bond.options,
802 etc.
803 .br
804 The changes to the connection profile will be saved persistently by
805 NetworkManager, unless \fI--temporary\fP option is provided, in which case the
806 changes won't persist over NetworkManager restart.
807 .TP
808 .B clone [--temporary] [ id | uuid | path ] <ID> <new name>
809 .br
810 Clone a connection. The connection to be cloned is identified by its
811 name, UUID or D-Bus path. If <ID> is ambiguous, a keyword \fIid\fP,
812 \fIuuid\fP or \fIpath\fP can be used. See \fBconnection show\fP above for
813 the description of the <ID>-specifying keywords. \fI<new name>\fP is the name
814 of the new cloned connection. The new connection will be the exact copy except
815 the connection.id (\fI<new name>\fP) and connection.uuid (generated)
816 properties.
817 .br
818 The new connection profile will be saved as persistent unless \fI--temporary\fP
819 option is specified, in which case the new profile won't exist after NetworkManager
820 restart.
821 .TP
822 .B delete [ id | uuid | path ] <ID> ...
823 .br
824 Delete a configured connection. The connection to be deleted is identified by
825 its name, UUID or D-Bus path. If <ID> is ambiguous, a keyword \fIid\fP,
826 \fIuuid\fP or \fIpath\fP can be used.
827 .br
828 See \fBconnection show\fP above for the description of the <ID>-specifying keywords.
829 .br
830 If '--wait' option is not specified, the default timeout will be 10 seconds.
831 .TP
832 .B monitor [ id | uuid | path ] <ID> ...
833 .br
834 Monitor connection profile activity. This command prints a line whenever the
835 specified connection changes. The connection to be monitored is identified by
836 its name, UUID or D-Bus path. If <ID> is ambiguous, a keyword \fIid\fP,
837 \fIuuid\fP or \fIpath\fP can be used.
838 .br
839 See \fBconnection show\fP above for the description of the <ID>-specifying keywords.
840 .br
841 Monitors all connection profiles in case none is specified. The command terminates
842 when all monitored connections disappear. If you want to monitor connection creation
843 consider using the global monitor with \fInmcli monitor\fP command.
844 .TP
845 .B reload
846 .br
847 Reload all connection files from disk. \fINetworkManager\fP does not monitor
848 changes to connection files by default. So you need to use this command in order
849 to tell \fINetworkManager\fP to re-read the connection profiles from disk when
850 a change was made to them. However, the auto-loading feature can be enabled and
851 then \fINetworkManager\fP will reload connection files any time they change
852 (monitor-connection-files=true in \fINetworkManager.conf\fP(5)).
853 .TP
854 .B load <filename> [<filename>...]
855 .br
856 Load/reload one or more connection files from disk. Use this after manually
857 editing a connection file to ensure that \fBNetworkManager\fP is aware
858 of its latest state.
859 .TP
860 .B import [--temporary] type <type> file <file to import>
861 .br
862 Import an external/foreign configuration as a NetworkManager connection profile.
863 The type of the input file is specified by \fItype\fP option.
864 .br
865 Only VPN configurations are supported at the moment. The configuration
866 is imported by NetworkManager VPN plugins. \fItype\fP values are the same as for
867 \fIvpn-type\fP option in \fBnmcli connection add\fP. VPN configurations are
868 imported by VPN plugins. Therefore the proper VPN plugin has to be installed
869 so that nmcli could import the data.
870 .br
871 The imported connection profile will be saved as persistent unless \fI--temporary\fP
872 option is specified, in which case the new profile won't exist after NetworkManager
873 restart.
874 .TP
875 .B export [ id | uuid | path ] <ID> [<output file>]
876 .br
877 Export a connection.
878 .br
879 Only VPN connections are supported at the moment. A proper VPN plugin has to be
880 installed so that nmcli could export a connection. If no \fI<output file>\fP is
881 provided, the VPN configuration data will be printed to standard output.
882 .RE
883
884 .TP
885 .B device - show and manage network interfaces
886 .br
887 .TP
888 .SS \fICOMMAND\fP := { status | show | set | connect | reapply | disconnect | delete | monitor | wifi | lldp }
889 .sp
890 .RS
891 .TP
892 .B status
893 .br
894 Print status of devices.
895 .br
896 This is the default action if no command is specified to \fIdevice\fP object.
897 .TP
898 .B show [<ifname>]
899 .br
900 Show detailed information about devices.  Without an argument, all devices are
901 examined. To get information for a specific device, the interface name has
902 to be provided.
903 .TP
904 .TP
905 .B set [ifname] <ifname> [autoconnect yes|no] [managed yes|no]
906 .br
907 Set device properties.
908 .TP
909 .B connect <ifname>
910 .br
911 Connect the device. NetworkManager will try to find a suitable connection that
912 will be activated. It will also consider connections that are not set to auto connect.
913 .br
914 If '--wait' option is not specified, the default timeout will be 90 seconds.
915 .TP
916 .B reapply <ifname>
917 .br
918 Attempt to update device with changes to the currently active connection
919 made since it was last applied.
920 .TP
921 .B disconnect <ifname> ...
922 .br
923 Disconnect a device and prevent the device from automatically activating further
924 connections without user/manual intervention. Note that disconnecting software
925 devices may mean that the devices will disappear.
926 .br
927 If '--wait' option is not specified, the default timeout will be 10 seconds.
928 .TP
929 .B delete <ifname> ...
930 .br
931 Delete a device. The command removes the interface from the system. Note that
932 this only works for software devices like bonds, bridges, teams, etc.
933 Hardware devices (like Ethernet) cannot be deleted by the command.
934 .br
935 If '--wait' option is not specified, the default timeout will be 10 seconds.
936 .TP
937 .B monitor [<ifname>] ...
938 .br
939 Monitor device activity. This command prints a line whenever the specified devices
940 change state.
941 .br
942 Monitors all devices in case no interface is specified. The monitor terminates when
943 all specified devices disappear. If you want to monitor device addition consider
944 using the global monitor with \fInmcli monitor\fP command.
945 .TP
946 .B wifi [list [ifname <ifname>] [bssid <BSSID>]]
947 .br
948 List available Wi\(hyFi access points. The \fIifname\fP and \fIbssid\fP options
949 can be used to list APs for a particular interface or with a specific BSSID,
950 respectively.
951 .TP
952 .B wifi connect <(B)SSID> [password <password>] [wep\-key\-type key|phrase] [ifname <ifname>] [bssid <BSSID>] [name <name>]
953 .B [private yes|no] [hidden yes|no]
954 .br
955 Connect to a Wi\(hyFi network specified by SSID or BSSID. The command creates a new
956 connection and then activates it on a device. This is a command\(hyline counterpart
957 of clicking an SSID in a GUI client. The command always creates a new connection
958 and thus it is mainly useful for connecting to new Wi\(hyFi networks. If a connection
959 for the network already exists, it is better to bring up (activate) the existing connection
960 as follows: \fInmcli con up id <name>\fP. Note that only open, WEP and WPA\(hyPSK networks
961 are supported at the moment. It is also supposed that IP configuration is obtained via
962 DHCP.
963 .br
964 If '--wait' option is not specified, the default timeout will be 90 seconds.
965 .RS
966 .PP
967 Available options are:
968 .IP \fIpassword\fP 13
969 \(en password for secured networks (WEP or WPA)
970 .IP \fIwep\-key\-type\fP 13
971 \(en type of WEP secret, either \fIkey\fP for ASCII/HEX key or \fIphrase\fP for passphrase
972 .IP \fIifname\fP 13
973 \(en interface that will be used for activation
974 .IP \fIbssid\fP 13
975 \(en if specified, the created connection will be restricted just for the BSSID
976 .IP \fIname\fP 13
977 \(en if specified, the connection will use the name (else NM creates a name itself)
978 .IP \fIprivate\fP 13
979 \(en if set to \fByes\fP, the connection will only be visible to the user who created it.
980 Otherwise the connection is system\(hywide, which is the default.
981 .IP \fIhidden\fP 13
982 \(en set to \fByes\fP when connecting for the first time to an AP not broadcasting its SSID.
983 Otherwise the SSID would not be found and the connection attempt would fail.
984 .RE
985 .TP
986 .B wifi hotspot [ifname <ifname>] [con-name <name>] [ssid <SSID>] [band a|bg] [channel <channel>] [password <password>]
987 .br
988 Create a Wi-Fi hotspot. The command creates a hotspot connection profile according to
989 Wi-Fi device capabilities and activates it on the device. The hotspot is secured with WPA
990 if device/driver supports that, otherwise WEP is used.
991 Use \fIconnection down\fP or \fIdevice disconnect\fP to stop the hotspot.
992 .br
993 .RS
994 .PP
995 Parameters of the hotspot can be influenced by the optional parameters:
996 .IP \fIifname\fP 17
997 \(en what Wi-Fi device is used
998 .IP \fIcon-name\fP 17
999 \(en name of the created hotspot connection profile
1000 .IP \fIssid\fP 17
1001 \(en SSID of the hotspot
1002 .IP \fIband\fP 17
1003 \(en Wi-Fi band to use
1004 .IP \fIchannel\fP 17
1005 \(en Wi-Fi channel to use
1006 .IP \fIpassword\fP 17
1007 \(en password to use for the created hotspot. If not provided,
1008 nmcli will generate a password. The password is either WPA
1009 pre-shared key or WEP key.
1010 .PP
1011 Note that \fI--show-secrets\fP global option can be used to print the hotspot
1012 password. It is useful especially when the password was generated.
1013 .RE
1014 .TP
1015 .B wifi rescan [ifname <ifname>] [[ssid <SSID>] ...]
1016 .br
1017 Request that \fINetworkManager\fP immediately re-scan for available access points.
1018 NetworkManager scans Wi\(hyFi networks periodically, but in some cases it can be
1019 useful to start scanning manually (e.g. after resuming the computer). By using
1020 \fIssid\fP, it is possible to scan for a specific SSID, which is useful for APs
1021 with hidden SSIDs. You can provide multiple \fIssid\fP parameters in order to
1022 scan more SSIDs.
1023 .br
1024 This command does not show the APs, use 'nmcli device wifi list' for that.
1025 .TP
1026 .B lldp [list [ifname <ifname>]]
1027 .br
1028 Display information about neighboring devices learned through the Link
1029 Layer Discovery Protocol (LLDP). The \fIifname\fP option can be used to
1030 list neighbors only for a given interface. The protocol must be
1031 enabled in the connection settings.
1032 .RE
1033
1034 .TP
1035 .B agent \- run nmcli as a NetworkManager secret agent, or polkit agent
1036 .br
1037 .TP
1038 .SS \fICOMMAND\fP := { secret | polkit  | all }
1039 .sp
1040 .RS
1041 .TP
1042 .B secret
1043 .br
1044 Register nmcli as a NetworkManager secret agent and listen for secret requests.
1045 You do usually not need this command, because nmcli can handle secrets when
1046 connecting to networks. However, you may find the command useful when you use
1047 another tool for activating connections and you do not have a secret agent
1048 available (like nm-applet).
1049 .TP
1050 .B polkit
1051 .br
1052 Register nmcli as a polkit agent for the user session and listen for
1053 authorization requests. You do not usually need this command, because nmcli can
1054 handle polkit actions related to NetworkManager operations (when run with
1055 --ask).  However, you may find the command useful when you want to run a simple
1056 text based polkit agent and you do not have an agent of a desktop environment.
1057 Note that running this command makes nmcli handle all polkit requests, not only
1058 NetworkManager related ones, because only one polkit agent can run for the
1059 session.
1060 .TP
1061 .B all
1062 .br
1063 Runs nmcli as both NetworkManager secret and a polkit agent.
1064 .RE
1065
1066 .SH ENVIRONMENT VARIABLES
1067 \fInmcli\fP's behavior is affected by the following environment variables.
1068 .IP "LC_ALL" 13
1069 If set to a non\(hyempty string value, it overrides the values of all the other
1070 internationalization variables.
1071 .IP "LC_MESSAGES" 13
1072 Determines the locale to be used for internationalized messages.
1073 .IP "LANG" 13
1074 Provides a default value for the internationalization variables that are unset
1075 or null.
1076
1077 .RE
1078 Internationalization notes:
1079 .br
1080 Be aware that \fInmcli\fP is localized and that is why the output depends on
1081 your environment. This is important to realize especially when you parse the
1082 output.
1083 .br
1084 Call \fInmcli\fP as \fBLC_ALL=C nmcli\fP to be sure the locale is
1085 set to "C" while executing in a script.
1086
1087 \fBLC_ALL\fP, \fBLC_MESSAGES\fP, \fBLANG\fP variables specify the LC_MESSAGES
1088 locale category (in that order), which determines the language that \fInmcli\fP
1089 uses for messages.  The "C" locale is used if none of these variables are set,
1090 and this locale uses English messages.
1091
1092 .SH EXIT STATUS
1093 \fInmcli\fP exits with status 0 if it succeeds, a value greater than 0 is
1094 returned if an error occurs.
1095 .IP "0" 4
1096 Success \(en indicates the operation succeeded
1097 .IP "1" 4
1098 Unknown or unspecified error
1099 .IP "2" 4
1100 Invalid user input, wrong \fInmcli\fP invocation
1101 .IP "3" 4
1102 Timeout expired (see \fI\-\-wait\fP option)
1103 .IP "4" 4
1104 Connection activation failed
1105 .IP "5" 4
1106 Connection deactivation failed
1107 .IP "6" 4
1108 Disconnecting device failed
1109 .IP "7" 4
1110 Connection deletion failed
1111 .IP "8" 4
1112 NetworkManager is not running
1113 .IP "9" 4
1114 \fInmcli\fP and \fINetworkManager\fP versions mismatch
1115 .IP "10" 4
1116 Connection, device, or access point does not exist.
1117
1118 .SH EXAMPLES
1119 .PP
1120 This section presents various examples of nmcli usage. If you want even more,
1121 please refer to \fInmcli-examples\fP(5) manual page.
1122 .sp
1123 .IP "\fB\f(CWnmcli \-t \-f RUNNING general\fP\fP"
1124 .IP
1125 tells you whether NetworkManager is running or not.
1126
1127 .IP "\fB\f(CWnmcli \-t \-f STATE general\fP\fP"
1128 .IP
1129 shows the overall status of NetworkManager.
1130
1131 .IP "\fB\f(CWnmcli radio wifi off\fP\fP"
1132 .IP
1133 switches Wi\(hyFi off.
1134
1135 .IP "\fB\f(CWnmcli connection show\fP\fP"
1136 .IP
1137 lists all connections NetworkManager has.
1138
1139 .IP "\fB\f(CWnmcli \-p \-m multiline \-f all con show\fP\fP"
1140 .IP
1141 shows all configured connections in multi-line mode.
1142
1143 .IP "\fB\f(CWnmcli connection show --active\fP\fP"
1144 .IP
1145 lists all currently active connections.
1146
1147 .IP "\fB\f(CWnmcli \-f name,autoconnect c s\fP\fP"
1148 .IP
1149 shows all connection profile names and their auto-connect property.
1150
1151 .IP "\fB\f(CWnmcli \-p connection show \(dq\&My default em1\(dq\&\fP\fP"
1152 .IP
1153 shows details for "My default em1" connection profile.
1154
1155 .IP "\fB\f(CWnmcli --show-secrets connection show \(dq\&My Home WiFi\(dq\&\fP\fP"
1156 .IP
1157 shows details for "My Home WiFi" connection profile with all passwords.
1158 Without \fI--show-secrets\fP option, secrets would not be displayed.
1159
1160 .IP "\fB\f(CWnmcli \-f active connection show \(dq\&My default em1\(dq\&\fP\fP"
1161 .IP
1162 shows details for "My default em1" active connection, like IP, DHCP
1163 information, etc.
1164
1165 .IP "\fB\f(CWnmcli -f profile con s \(dq\&My wired connection\(dq\&\fP\fP"
1166 .IP
1167 shows static configuration details of the connection profile with "My wired connection" name.
1168
1169 .IP "\fB\f(CWnmcli \-p con up \(dq\&My wired connection\(dq\& ifname eth0\fP\fP"
1170 .IP
1171 activates the connection profile with name "My wired connection" on interface eth0.
1172 The \-p option makes nmcli show progress of the activation.
1173
1174 .IP "\fB\f(CWnmcli con up 6b028a27\-6dc9\-4411\-9886\-e9ad1dd43761 ap 00:3A:98:7C:42:D3\fP\fP"
1175 .IP
1176 connects the Wi\(hyFi connection with UUID 6b028a27\-6dc9\-4411\-9886\-e9ad1dd43761 to the AP
1177 with BSSID 00:3A:98:7C:42:D3.
1178
1179 .IP "\fB\f(CWnmcli device status\fP\fP"
1180 .IP
1181 shows the status for all devices.
1182
1183 .IP "\fB\f(CWnmcli dev disconnect em2\fP\fP"
1184 .IP
1185 disconnects a connection on interface em2 and marks the device as unavailable for
1186 auto\(hyconnecting. As a result, no connection will automatically be activated on the
1187 device until the device's 'autoconnect' is set to TRUE or the user manually activates
1188 a connection.
1189
1190 .IP "\fB\f(CWnmcli \-f GENERAL,WIFI\-PROPERTIES dev show wlan0\fP\fP"
1191 .IP
1192 shows details for wlan0 interface; only GENERAL and WIFI\-PROPERTIES sections will be shown.
1193
1194 .IP "\fB\f(CWnmcli \-f CONNECTIONS device show wlp3s0\fP\fP"
1195 .IP
1196 shows all available connection profiles for your Wi-Fi interface wlp3s0.
1197
1198 .IP "\fB\f(CWnmcli dev wifi\fP\fP"
1199 .IP
1200 lists available Wi\(hyFi access points known to NetworkManager.
1201
1202 .IP "\fB\f(CWnmcli dev wifi con \(dq\&Cafe Hotspot 1\(dq\& password caffeine name \(dq\&My cafe\(dq\&\fP\fP"
1203 .IP
1204 creates a new connection named "My cafe" and then connects it to "Cafe Hotspot 1" SSID
1205 using password "caffeine". This is mainly useful when connecting to "Cafe Hotspot 1" for
1206 the first time. Next time, it is better to use 'nmcli con up id "My cafe"' so that the
1207 existing connection profile can be used and no additional is created.
1208
1209 .IP "\fB\f(CWnmcli -s dev wifi hotspot con-name QuickHotspot\fP\fP"
1210 .IP
1211 creates a hotspot profile and connects it. Prints the hotspot password the user should use
1212 to connect to the hotspot from other devices.
1213
1214 .IP "\fB\f(CWnmcli connection add type ethernet autoconnect no ifname eth0\fP\fP"
1215 .IP
1216 non-interactively adds an Ethernet connection tied to eth0 interface with automatic IP configuration (DHCP),
1217 and disables the connection's "autoconnect" flag.
1218
1219 .IP "\fB\f(CWnmcli c a ifname Maxipes\(hyfik type vlan dev eth0 id 55\fP\fP"
1220 .IP
1221 non-interactively adds a VLAN connection with ID 55. The connection will use eth0 and the VLAN interface
1222 will be named Maxipes\(hyfik.
1223
1224 .IP "\fB\f(CWnmcli c a ifname eth0 type ethernet -- ipv4.method disabled ipv6.method link-local\fP\fP"
1225 .IP
1226 non-interactively adds a connection that will use eth0 Ethernet interface and only have an IPv6 link-local
1227 address configured.
1228
1229 .IP "\fB\f(CWnmcli connection edit ethernet\-em1\-2\fP\fP"
1230 .IP
1231 edits existing "ethernet\(hyem1\(hy2" connection in the interactive editor.
1232
1233 .IP "\fB\f(CWnmcli connection edit type ethernet con-name \(dq\&yet another Ethernet connection\(dq\&\fP\fP"
1234 .IP
1235 adds a new Ethernet connection in the interactive editor.
1236
1237 .IP "\fB\f(CWnmcli con mod ethernet\-2 connection.autoconnect no\fP\fP"
1238 .IP
1239 modifies 'autoconnect' property in the 'connection' setting of 'ethernet\(hy2' connection.
1240
1241 .IP "\fB\f(CWnmcli con mod \(dq\&Home Wi\-Fi\(dq\& wifi.mtu 1350\fP\fP"
1242 .IP
1243 modifies 'mtu' property in the 'wifi' setting of 'Home Wi\(hyFi' connection.
1244
1245 .IP "\fB\f(CWnmcli con mod em1-1 ipv4.method manual ipv4.addr \(dq\&192.168.1.23/24 192.168.1.1, 10.10.1.5/8, 10.0.0.11\(dq\&\fP\fP"
1246 .IP
1247 sets manual addressing and the addresses in em1-1 profile.
1248
1249 .IP "\fB\f(CWnmcli con modify ABC +ipv4.dns 8.8.8.8\fP\fP"
1250 .IP
1251 appends a Google public DNS server to DNS servers in ABC profile.
1252
1253 .IP "\fB\f(CWnmcli con modify ABC -ipv4.addresses \(dq\&192.168.100.25/24 192.168.1.1\(dq\&\fP\fP"
1254 .IP
1255 removes the specified IP address from (static) profile ABC.
1256
1257 .IP "\fB\f(CWnmcli con import type openvpn file ~/Downloads/frootvpn.ovpn\fP\fP"
1258 .IP
1259 imports an OpenVPN configuration to NetworkManager.
1260
1261 .IP "\fB\f(CWnmcli con export corp-vpnc /home/joe/corpvpn.conf\fP\fP"
1262 .IP
1263 exports NetworkManager VPN profile corp-vpnc as standard Cisco (vpnc) configuration.
1264
1265 .SH NOTES
1266 \fInmcli\fP accepts abbreviations, as long as they are a unique prefix in the set
1267 of possible options. As new options get added, these abbreviations are not guaranteed
1268 to stay unique. For scripting and long term compatibility it is therefore strongly
1269 advised to spell out the full option names.
1270
1271 .SH BUGS
1272 There are probably some bugs.  If you find a bug, please report it to
1273 https://bugzilla.gnome.org/ \(em product \fINetworkManager\fP.
1274
1275 .SH SEE ALSO
1276 .BR nmcli\-examples (5),
1277 .BR nm\-online (1),
1278 .BR NetworkManager (8),
1279 .BR NetworkManager.conf (5),
1280 .BR nm\-settings (5),
1281 .BR nm\-applet (1),
1282 .BR nm\-connection\-editor (1).