summaryrefslogtreecommitdiffstats
path: root/man/networkctl.xml
blob: 5e2126ff218c7ea773f938f7e59f35901559c71f (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
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
<?xml version='1.0'?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
  "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
<!-- SPDX-License-Identifier: LGPL-2.1-or-later -->

<refentry id="networkctl" conditional='ENABLE_NETWORKD'
          xmlns:xi="http://www.w3.org/2001/XInclude">

  <refentryinfo>
    <title>networkctl</title>
    <productname>systemd</productname>
  </refentryinfo>

  <refmeta>
    <refentrytitle>networkctl</refentrytitle>
    <manvolnum>1</manvolnum>
  </refmeta>

  <refnamediv>
    <refname>networkctl</refname>
    <refpurpose>Query or modify the status of network links</refpurpose>
  </refnamediv>

  <refsynopsisdiv>
    <cmdsynopsis>
      <command>networkctl</command>
      <arg choice="opt" rep="repeat">OPTIONS</arg>
      <arg choice="plain">COMMAND</arg>
      <arg choice="opt" rep="repeat">LINK</arg>
    </cmdsynopsis>
  </refsynopsisdiv>

  <refsect1>
    <title>Description</title>

    <para><command>networkctl</command> may be used to query or modify the
    state of the network links as seen by
    <command>systemd-networkd</command>.  Please refer to
    <citerefentry><refentrytitle>systemd-networkd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>
    for an introduction to the basic concepts, functionality, and
    configuration syntax.</para>
  </refsect1>

  <refsect1>
    <title>Commands</title>

    <para>The following commands are understood:</para>

    <variablelist>
      <varlistentry>
        <term>
          <command>list</command>
          <optional><replaceable>PATTERN…</replaceable></optional>
        </term>

        <listitem>
          <para>Show a list of existing links and their status. If one or more
          <replaceable>PATTERN</replaceable>s are specified, only links matching one of them are shown.
          If no further arguments are specified shows all links,
          otherwise just the specified links. Produces output similar to:

          <programlisting>IDX LINK         TYPE     OPERATIONAL SETUP
  1 lo           loopback carrier     unmanaged
  2 eth0         ether    routable    configured
  3 virbr0       ether    no-carrier  unmanaged
  4 virbr0-nic   ether    off         unmanaged

4 links listed.</programlisting></para>

        <para>The operational status is one of the following:
            <variablelist>
              <varlistentry>
                <term>missing</term>
                <listitem>
                    <para>The device is missing.</para>

                    <xi:include href="version-info.xml" xpointer="v245"/>
                </listitem>
              </varlistentry>
              <varlistentry>
                <term>off</term>
                <listitem>
                  <para>The device is powered down.</para>

                  <xi:include href="version-info.xml" xpointer="v240"/>
                </listitem>
              </varlistentry>
              <varlistentry>
                <term>no-carrier</term>
                <listitem>
                  <para>The device is powered up, but does not yet have a carrier.</para>

                  <xi:include href="version-info.xml" xpointer="v240"/>
                </listitem>
              </varlistentry>
              <varlistentry>
                <term>dormant</term>
                <listitem>
                  <para>The device has a carrier, but is not yet ready for normal traffic.</para>

                  <xi:include href="version-info.xml" xpointer="v240"/>
                </listitem>
              </varlistentry>
              <varlistentry>
                <term>degraded-carrier</term>
                <listitem>
                  <para>One of the bonding or bridge slave network interfaces is in off, no-carrier, or
                  dormant state, and the master interface has no address.</para>

                  <xi:include href="version-info.xml" xpointer="v242"/>
                </listitem>
              </varlistentry>
              <varlistentry>
                <term>carrier</term>
                <listitem>
                  <para>The link has carrier, or for bond or bridge master, all bonding or bridge slave
                  network interfaces are enslaved to the master.</para>

                  <xi:include href="version-info.xml" xpointer="v240"/>
                </listitem>
              </varlistentry>
              <varlistentry>
                <term>degraded</term>
                <listitem>
                  <para>The link has carrier and addresses valid on the local link configured. For bond or
                  bridge master this means that not all slave network interfaces have carrier but at least
                  one does.</para>

                  <xi:include href="version-info.xml" xpointer="v240"/>
                </listitem>
              </varlistentry>
              <varlistentry>
                <term>enslaved</term>
                <listitem>
                  <para>The link has carrier and is enslaved to bond or bridge master network interface.
                  </para>

                  <xi:include href="version-info.xml" xpointer="v242"/>
                </listitem>
              </varlistentry>
              <varlistentry>
                <term>routable</term>
                <listitem>
                  <para>The link has carrier and routable address configured. For bond or bridge master it is
                  not necessary for all slave network interfaces to have carrier, but at least one must.</para>

                  <xi:include href="version-info.xml" xpointer="v240"/>
                </listitem>
              </varlistentry>
            </variablelist>
        </para>

        <para>The setup status is one of the following:
            <variablelist>
              <varlistentry>
                <term>pending</term>
                <listitem>
                  <para><citerefentry><refentrytitle>systemd-udevd</refentrytitle><manvolnum>8</manvolnum></citerefentry>
                  is still processing the link, we don't yet know if we will manage it.</para>

                  <xi:include href="version-info.xml" xpointer="v240"/>
                </listitem>
              </varlistentry>
              <varlistentry>
                <term>initialized</term>
                <listitem>
                  <para><citerefentry><refentrytitle>systemd-udevd</refentrytitle><manvolnum>8</manvolnum></citerefentry>
                  has processed the link, but we don't yet know if we will manage it.</para>

                  <xi:include href="version-info.xml" xpointer="v251"/>
                </listitem>
              </varlistentry>
              <varlistentry>
                <term>configuring</term>
                <listitem>
                  <para>Configuration for the link is being retrieved or the link is being configured.</para>

                  <xi:include href="version-info.xml" xpointer="v240"/>
                </listitem>
              </varlistentry>
              <varlistentry>
                <term>configured</term>
                <listitem>
                  <para>Link has been configured successfully.</para>

                  <xi:include href="version-info.xml" xpointer="v240"/>
                </listitem>
              </varlistentry>
              <varlistentry>
                <term>unmanaged</term>
                <listitem>
                  <para><command>systemd-networkd</command> is not handling the link.</para>

                  <xi:include href="version-info.xml" xpointer="v240"/>
                </listitem>
              </varlistentry>
              <varlistentry>
                <term>failed</term>
                <listitem>
                  <para><command>systemd-networkd</command> failed to configure the link.</para>

                  <xi:include href="version-info.xml" xpointer="v240"/>
                </listitem>
              </varlistentry>
              <varlistentry>
                <term>linger</term>
                <listitem>
                  <para>The link is gone, but has not yet been dropped by <command>systemd-networkd</command>.</para>

                  <xi:include href="version-info.xml" xpointer="v240"/>
                </listitem>
              </varlistentry>
            </variablelist>
        </para>

        <xi:include href="version-info.xml" xpointer="v219"/>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>
          <command>status</command>
          <optional><replaceable>PATTERN…</replaceable></optional>
        </term>

        <listitem>
          <para>Show information about the specified links: type, state, kernel module driver, hardware and
          IP address, configured DNS servers, etc. If one or more <replaceable>PATTERN</replaceable>s are
          specified, only links matching one of them are shown.</para>

          <para>When no links are specified, an overall network status is shown. Also see the option
          <option>--all</option>.</para>

          <para>Produces output similar to:
          <programlisting>        State: routable
  Online state: online
       Address: 10.193.76.5 on eth0
                192.168.122.1 on virbr0
                169.254.190.105 on eth0
                fe80::5054:aa:bbbb:cccc on eth0
       Gateway: 10.193.11.1 (CISCO SYSTEMS, INC.) on eth0
           DNS: 8.8.8.8
                8.8.4.4</programlisting></para>

          <para>In the overall network status, the online state depends on the individual online state of all
          required links. Managed links are required for online by default. In this case, the online state is
          one of the following:
          <variablelist>
            <varlistentry>
              <term>unknown</term>
              <listitem>
                <para>All links have unknown online status (i.e. there are no required links).</para>

                <xi:include href="version-info.xml" xpointer="v249"/>
              </listitem>
            </varlistentry>
            <varlistentry>
              <term>offline</term>
              <listitem>
                <para>All required links are offline.</para>

                <xi:include href="version-info.xml" xpointer="v249"/>
              </listitem>
            </varlistentry>
            <varlistentry>
              <term>partial</term>
              <listitem>
                <para>Some, but not all, required links are online.</para>

                <xi:include href="version-info.xml" xpointer="v249"/>
              </listitem>
            </varlistentry>
            <varlistentry>
              <term>online</term>
              <listitem>
                <para>All required links are online.</para>

                <xi:include href="version-info.xml" xpointer="v249"/>
              </listitem>
            </varlistentry>
          </variablelist>
          </para>

          <xi:include href="version-info.xml" xpointer="v219"/>
        </listitem>

      </varlistentry>

      <varlistentry>
        <term>
          <command>lldp</command>
          <optional><replaceable>PATTERN…</replaceable></optional>
        </term>

        <listitem>
          <para>Show discovered LLDP (Link Layer Discovery Protocol) neighbors. If one or more
          <replaceable>PATTERN</replaceable>s are specified only neighbors on those interfaces are shown.
          Otherwise shows discovered neighbors on all interfaces. Note that for this feature to work,
          <varname>LLDP=</varname> must be turned on for the specific interface, see
          <citerefentry><refentrytitle>systemd.network</refentrytitle><manvolnum>5</manvolnum></citerefentry> for
          details.</para>

          <para>Produces output similar to:
          <programlisting>LINK    SYSTEM-NAME SYSTEM-DESCRIPTION CHASSIS-ID        PORT-ID PORT-DESCRIPTION CAPS
enp0s25 GS1900      -                  00:e0:4c:00:00:00 2       Port #2           ..b........

Capability Flags:
o - Other; p - Repeater;  b - Bridge; w - WLAN Access Point; r - Router;
t - Telephone; d - DOCSIS cable device; a - Station; c - Customer VLAN;
s - Service VLAN, m - Two-port MAC Relay (TPMR)

1 neighbor(s) listed.</programlisting></para>

          <xi:include href="version-info.xml" xpointer="v219"/>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>
          <command>label</command>
        </term>

        <listitem><para>Show numerical address labels that can be used for address selection.
        This is the same information that
        <citerefentry project='die-net'><refentrytitle>ip-addrlabel</refentrytitle><manvolnum>8</manvolnum></citerefentry>
        shows. See <ulink url="https://tools.ietf.org/html/rfc3484">RFC 3484</ulink>
        for a discussion of address labels.</para>

        <para>Produces output similar to:
        <programlisting>Prefix/Prefixlen                          Label
        ::/0                                  1
    fc00::/7                                  5
    fec0::/10                                11
    2002::/16                                 2
    3ffe::/16                                12
 2001:10::/28                                 7
    2001::/32                                 6
::ffff:0.0.0.0/96                             4
        ::/96                                 3
       ::1/128                                0</programlisting></para>

        <xi:include href="version-info.xml" xpointer="v234"/>
        </listitem>
      </varlistentry>

       <varlistentry>
        <term>
          <command>delete</command>
          <replaceable>DEVICE…</replaceable>
        </term>
        <listitem><para>Deletes virtual netdevs. Takes interface name or index number.</para>

        <xi:include href="version-info.xml" xpointer="v243"/></listitem>
      </varlistentry>

       <varlistentry>
        <term>
          <command>up</command>
          <replaceable>DEVICE…</replaceable>
        </term>
        <listitem><para>Bring devices up. Takes interface name or index number.</para>

        <xi:include href="version-info.xml" xpointer="v246"/></listitem>
      </varlistentry>

       <varlistentry>
        <term>
          <command>down</command>
          <replaceable>DEVICE…</replaceable>
        </term>
        <listitem><para>Bring devices down. Takes interface name or index number.</para>

        <xi:include href="version-info.xml" xpointer="v246"/></listitem>
      </varlistentry>

       <varlistentry>
        <term>
          <command>renew</command>
          <replaceable>DEVICE…</replaceable>
        </term>
        <listitem><para>Renew dynamic configurations e.g. addresses received from DHCP server.
        Takes interface name or index number.</para>

        <xi:include href="version-info.xml" xpointer="v244"/></listitem>
      </varlistentry>

      <varlistentry>
        <term>
          <command>forcerenew</command>
          <replaceable>DEVICE…</replaceable>
        </term>
        <listitem><para>Send a FORCERENEW message to all connected clients, triggering DHCP reconfiguration.
        Takes interface name or index number.</para>

        <xi:include href="version-info.xml" xpointer="v246"/></listitem>
      </varlistentry>

      <varlistentry>
        <term>
          <command>reconfigure</command>
          <replaceable>DEVICE…</replaceable>
        </term>
        <listitem><para>Reconfigure network interfaces. Takes interface name or index number. Note that
        this does not reload <filename>.netdev</filename> or <filename>.network</filename>
        corresponding to the specified interface. So, if you edit config files, it is necessary to call
        <command>networkctl reload</command> first to apply new settings.</para>

        <xi:include href="version-info.xml" xpointer="v244"/></listitem>
      </varlistentry>

      <varlistentry>
        <term>
          <command>reload</command>
        </term>
        <listitem><para>Reload <filename>.netdev</filename> and <filename>.network</filename> files.
        If a new <filename>.netdev</filename> file is found, then the corresponding netdev is created.
        Note that even if an existing <filename>.netdev</filename> is modified or removed,
        <command>systemd-networkd</command> does not update or remove the netdev.
        If a new, modified or removed <filename>.network</filename> file is found, then all interfaces
        which match the file are reconfigured.</para>

        <xi:include href="version-info.xml" xpointer="v244"/></listitem>
      </varlistentry>

      <varlistentry>
        <term>
          <command>edit</command>
          <replaceable>FILE</replaceable>|<replaceable>@DEVICE</replaceable>        </term>
        <listitem><para>Edit network configuration files, which include <filename>.network</filename>,
        <filename>.netdev</filename>, and <filename>.link</filename> files. If no network config file
        matching the given name is found, a new one will be created under <filename>/etc/</filename> or
        <filename>/run/</filename>, depending on whether <option>--runtime</option> is specified.
        Specially, if the name is prefixed by <literal>@</literal>, it will be treated as
        a network interface, and editing will be performed on the network config files associated
        with it. Additionally, the interface name can be suffixed with <literal>:network</literal> (default)
        or <literal>:link</literal>, in order to choose the type of network config to operate on.</para>

        <para>If <option>--drop-in=</option> is specified, edit the drop-in file instead of
        the main configuration file. Unless <option>--no-reload</option> is specified,
        <command>systemd-networkd</command> will be reloaded after the edit of the
        <filename>.network</filename> or <filename>.netdev</filename> files finishes.
        The same applies for <filename>.link</filename> files and
        <citerefentry><refentrytitle>systemd-udevd</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
        Note that the changed link settings are not automatically applied after reloading.
        To achieve that, trigger uevents for the corresponding interface. Refer to
        <citerefentry><refentrytitle>systemd.link</refentrytitle><manvolnum>5</manvolnum></citerefentry>
        for more information.</para>

        <xi:include href="version-info.xml" xpointer="v254"/></listitem>
      </varlistentry>

      <varlistentry>
        <term>
          <command>cat</command>
          <optional><replaceable>FILE</replaceable>|<replaceable>@DEVICE</replaceable></optional>
        </term>
        <listitem>
          <para>Show network configuration files. This command honors the <literal>@</literal> prefix in the
          same way as <command>edit</command>. When no argument is specified,
          <citerefentry><refentrytitle>networkd.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>
          and its drop-in files will be shown.</para>

          <xi:include href="version-info.xml" xpointer="v254"/>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>
          <command>mask</command>
          <replaceable>FILE</replaceable>        </term>
        <listitem><para>Mask network configuration files, which include <filename>.network</filename>,
        <filename>.netdev</filename>, and <filename>.link</filename> files. A symlink of the given name will
        be created under <filename>/etc/</filename> or <filename>/run/</filename>, depending on
        whether <option>--runtime</option> is specified, that points to <filename>/dev/null</filename>.
        If a non-empty config file with the specified name exists under the target directory or a directory
        with higher priority (e.g. <option>--runtime</option> is used while an existing config resides
        in <filename>/etc/</filename>), the operation is aborted.</para>

        <para>This command honors <option>--no-reload</option> in the same way as <command>edit</command>.
        </para>

        <xi:include href="version-info.xml" xpointer="v256"/></listitem>
      </varlistentry>

      <varlistentry>
        <term>
          <command>unmask</command>
          <replaceable>FILE</replaceable>        </term>
        <listitem><para>Unmask network configuration files, i.e. reverting the effect of <command>mask</command>.
        Note that this command operates regardless of the scope of the directory, i.e. <option>--runtime</option>
        is of no effect.</para>

        <para>This command honors <option>--no-reload</option> in the same way as <command>edit</command>
        and <command>mask</command>.</para>

        <xi:include href="version-info.xml" xpointer="v256"/></listitem>
      </varlistentry>

      <varlistentry>
        <term>
          <command>persistent-storage</command>
          <replaceable>BOOL</replaceable>
        </term>
        <listitem>
          <para>Notify <filename>systemd-networkd.service</filename> that the persistent storage for the
          service is ready. This is called by
          <filename>systemd-networkd-persistent-storage.service</filename>. Usually, this command should not
          be called manually by users or administrators.</para>

          <xi:include href="version-info.xml" xpointer="v256"/>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsect1>

  <refsect1>
    <title>Options</title>

    <para>The following options are understood:</para>

    <variablelist>
      <varlistentry>
        <term>
          <option>-a</option>
          <option>--all</option>
        </term>

        <listitem>
          <para>Show all links with <command>status</command>.</para>

          <xi:include href="version-info.xml" xpointer="v219"/>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>
          <option>-s</option>
          <option>--stats</option>
        </term>

        <listitem>
          <para>Show link statistics with <command>status</command>.</para>

          <xi:include href="version-info.xml" xpointer="v243"/>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><option>-l</option></term>
        <term><option>--full</option></term>

        <listitem>
          <para>Do not ellipsize the output.</para>

          <xi:include href="version-info.xml" xpointer="v245"/>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><option>-n</option></term>
        <term><option>--lines=</option></term>

        <listitem>
          <para>When used with <command>status</command>, controls the number of journal lines to show,
          counting from the most recent ones. Takes a positive integer argument. Defaults to 10.</para>

          <xi:include href="version-info.xml" xpointer="v245"/>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><option>--drop-in=<replaceable>NAME</replaceable></option></term>

        <listitem>
          <para>When used with <command>edit</command>, edit the drop-in file <replaceable>NAME</replaceable>
          instead of the main configuration file.</para>

          <xi:include href="version-info.xml" xpointer="v254"/>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><option>--no-reload</option></term>

        <listitem>
          <para>When used with <command>edit</command>, <command>mask</command>, or <command>unmask</command>,
          <citerefentry><refentrytitle>systemd-networkd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>
          or
          <citerefentry><refentrytitle>systemd-udevd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>
          will not be reloaded after the operation finishes.</para>

        <xi:include href="version-info.xml" xpointer="v254"/>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><option>--runtime</option></term>

        <listitem>
          <para>When used with <command>edit</command> or <command>mask</command>,
          operate on the file under <filename>/run/</filename> instead of <filename>/etc/</filename>.</para>

          <xi:include href="version-info.xml" xpointer="v256"/>
        </listitem>
      </varlistentry>

      <xi:include href="standard-options.xml" xpointer="json" />
      <xi:include href="standard-options.xml" xpointer="help" />
      <xi:include href="standard-options.xml" xpointer="version" />
      <xi:include href="standard-options.xml" xpointer="no-legend" />
      <xi:include href="standard-options.xml" xpointer="no-pager" />

    </variablelist>
  </refsect1>

  <refsect1>
    <title>Exit status</title>

    <para>On success, 0 is returned, a non-zero failure code otherwise.</para>
  </refsect1>

  <refsect1>
    <title>See Also</title>
    <para><simplelist type="inline">
      <member><citerefentry><refentrytitle>systemd-networkd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry></member>
      <member><citerefentry><refentrytitle>systemd.network</refentrytitle><manvolnum>5</manvolnum></citerefentry></member>
      <member><citerefentry><refentrytitle>systemd.netdev</refentrytitle><manvolnum>5</manvolnum></citerefentry></member>
      <member><citerefentry project='die-net'><refentrytitle>ip</refentrytitle><manvolnum>8</manvolnum></citerefentry></member>
    </simplelist></para>
  </refsect1>
</refentry>