man/networkctl.xml

   1 <?xml version='1.0'?>
   2 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
   3 "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
   4
   5 <!--
   6   SPDX-License-Identifier: LGPL-2.1+
   7 -->
   8
   9 <refentry id="networkctl" conditional='ENABLE_NETWORKD'
  10           xmlns:xi="http://www.w3.org/2001/XInclude">
  11
  12   <refentryinfo>
  13     <title>networkctl</title>
  14     <productname>systemd</productname>
  15   </refentryinfo>
  16
  17   <refmeta>
  18     <refentrytitle>networkctl</refentrytitle>
  19     <manvolnum>1</manvolnum>
  20   </refmeta>
  21
  22   <refnamediv>
  23     <refname>networkctl</refname>
  24     <refpurpose>Query the status of network links</refpurpose>
  25   </refnamediv>
  26
  27   <refsynopsisdiv>
  28     <cmdsynopsis>
  29       <command>networkctl</command>
  30       <arg choice="opt" rep="repeat">OPTIONS</arg>
  31       <arg choice="plain">COMMAND</arg>
  32       <arg choice="opt" rep="repeat">LINK</arg>
  33     </cmdsynopsis>
  34   </refsynopsisdiv>
  35
  36   <refsect1>
  37     <title>Description</title>
  38
  39     <para><command>networkctl</command> may be used to introspect the
  40     state of the network links as seen by
  41     <command>systemd-networkd</command>.  Please refer to
  42     <citerefentry><refentrytitle>systemd-networkd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>
  43     for an introduction to the basic concepts, functionality, and
  44     configuration syntax.</para>
  45   </refsect1>
  46
  47   <refsect1>
  48     <title>Options</title>
  49
  50     <para>The following options are understood:</para>
  51
  52     <variablelist>
  53       <varlistentry>
  54         <term>
  55           <option>-a</option>
  56           <option>--all</option>
  57         </term>
  58
  59         <listitem>
  60           <para>Show all links with <command>status</command>.</para>
  61         </listitem>
  62       </varlistentry>
  63
  64       <xi:include href="standard-options.xml" xpointer="help" />
  65       <xi:include href="standard-options.xml" xpointer="version" />
  66       <xi:include href="standard-options.xml" xpointer="no-legend" />
  67       <xi:include href="standard-options.xml" xpointer="no-pager" />
  68
  69     </variablelist>
  70   </refsect1>
  71
  72   <refsect1>
  73     <title>Commands</title>
  74
  75     <para>The following commands are understood:</para>
  76
  77     <variablelist>
  78       <varlistentry>
  79         <term>
  80           <command>list</command>
  81           <optional><replaceable>PATTERN…</replaceable></optional>
  82         </term>
  83
  84         <listitem>
  85           <para>Show a list of existing links and their status. If one ore more
  86           <replaceable>PATTERN</replaceable>s are specified, only links matching one of them are shown.
  87           If no further arguments are specified shows all links,
  88           otherwise just the specified links. Produces output similar to:
  89
  90           <programlisting>IDX LINK         TYPE     OPERATIONAL SETUP
  91   1 lo           loopback carrier     unmanaged
  92   2 eth0         ether    routable    configured
  93   3 virbr0       ether    no-carrier  unmanaged
  94   4 virbr0-nic   ether    off         unmanaged
  95
  96 4 links listed.</programlisting></para>
  97
  98         <para>The operational status is one of the following:
  99             <variablelist>
 100               <varlistentry>
 101                 <term>off</term>
 102                 <listitem>
 103                   <para>the device is powered down</para>
 104                 </listitem>
 105               </varlistentry>
 106               <varlistentry>
 107                 <term>no-carrier</term>
 108                 <listitem>
 109                   <para>the device is powered up, but it does not yet have a carrier</para>
 110                 </listitem>
 111               </varlistentry>
 112               <varlistentry>
 113                 <term>dormant</term>
 114                 <listitem>
 115                   <para>the device has a carrier, but is not yet ready for normal traffic</para>
 116                 </listitem>
 117               </varlistentry>
 118               <varlistentry>
 119                 <term>carrier</term>
 120                 <listitem>
 121                   <para>the link has a carrier, or for bond or bridge master, all bonding or bridge slave
 122                   network interfaces are enslaved to the master.</para>
 123                 </listitem>
 124               </varlistentry>
 125               <varlistentry>
 126                 <term>degraded</term>
 127                 <listitem>
 128                   <para>the link has carrier and addresses valid on the local link configured, or for bond
 129                   or bridge master, one of the bonding or bridge slave network interfaces is in off,
 130                   no-carrier, or dormant</para>
 131                 </listitem>
 132               </varlistentry>
 133               <varlistentry>
 134                 <term>enslaved</term>
 135                 <listitem>
 136                   <para>the link has carrier and is enslaved to bond or bridge master network interface</para>
 137                 </listitem>
 138               </varlistentry>
 139               <varlistentry>
 140                 <term>routable</term>
 141                 <listitem>
 142                   <para>the link has carrier and routable address configured</para>
 143                 </listitem>
 144               </varlistentry>
 145             </variablelist>
 146         </para>
 147
 148         <para>The setup status is one of the following:
 149             <variablelist>
 150               <varlistentry>
 151                 <term>pending</term>
 152                 <listitem>
 153                   <para>udev is still processing the link, we don't yet know if we will manage it</para>
 154                 </listitem>
 155               </varlistentry>
 156               <varlistentry>
 157                 <term>failed</term>
 158                 <listitem>
 159                   <para>networkd failed to manage the link</para>
 160                 </listitem>
 161               </varlistentry>
 162               <varlistentry>
 163                 <term>configuring</term>
 164                 <listitem>
 165                   <para>in the process of retrieving configuration or configuring the link</para>
 166                 </listitem>
 167               </varlistentry>
 168               <varlistentry>
 169                 <term>configured</term>
 170                 <listitem>
 171                   <para>link configured successfully</para>
 172                 </listitem>
 173               </varlistentry>
 174               <varlistentry>
 175                 <term>unmanaged</term>
 176                 <listitem>
 177                   <para>networkd is not handling the link</para>
 178                 </listitem>
 179               </varlistentry>
 180               <varlistentry>
 181                 <term>linger</term>
 182                 <listitem>
 183                   <para>the link is gone, but has not yet been dropped by networkd</para>
 184                 </listitem>
 185               </varlistentry>
 186             </variablelist>
 187         </para>
 188         </listitem>
 189       </varlistentry>
 190
 191       <varlistentry>
 192         <term>
 193           <command>status</command>
 194           <optional><replaceable>PATTERN…</replaceable></optional>
 195         </term>
 196
 197         <listitem>
 198           <para>Show information about the specified links: type, state, kernel module driver, hardware and
 199           IP address, configured DNS servers, etc. If one ore more <replaceable>PATTERN</replaceable>s are
 200           specified, only links matching one of them are shown.</para>
 201
 202           <para>When no links are specified, an overall network status is shown. Also see the option
 203           <option>--all</option>.</para>
 204
 205           <para>Produces output similar to:
 206           <programlisting>
 207 ●      State: routable
 208      Address: 10.193.76.5 on eth0
 209               192.168.122.1 on virbr0
 210               169.254.190.105 on eth0
 211               fe80::5054:aa:bbbb:cccc on eth0
 212      Gateway: 10.193.11.1 (CISCO SYSTEMS, INC.) on eth0
 213          DNS: 8.8.8.8
 214               8.8.4.4</programlisting></para>
 215         </listitem>
 216
 217       </varlistentry>
 218
 219       <varlistentry>
 220         <term>
 221           <command>lldp</command>
 222           <optional><replaceable>PATTERN…</replaceable></optional>
 223         </term>
 224
 225         <listitem>
 226           <para>Show discovered LLDP (Link Layer Discovery Protocol) neighbors. If one or more
 227           <replaceable>PATTERN</replaceable>s are specified only neighbors on those interfaces are shown.
 228           Otherwise shows discovered neighbors on all interfaces. Note that for this feature to work,
 229           <varname>LLDP=</varname> must be turned on for the specific interface, see
 230           <citerefentry><refentrytitle>systemd.network</refentrytitle><manvolnum>5</manvolnum></citerefentry> for
 231           details.</para>
 232
 233           <para>Produces output similar to:
 234           <programlisting>LINK             CHASSIS ID        SYSTEM NAME      CAPS        PORT ID           PORT DESCRIPTION
 235 enp0s25          00:e0:4c:00:00:00 GS1900           ..b........ 2                 Port #2
 236
 237 Capability Flags:
 238 o - Other; p - Repeater;  b - Bridge; w - WLAN Access Point; r - Router;
 239 t - Telephone; d - DOCSIS cable device; a - Station; c - Customer VLAN;
 240 s - Service VLAN, m - Two-port MAC Relay (TPMR)
 241
 242 1 neighbors listed.</programlisting></para>
 243         </listitem>
 244       </varlistentry>
 245
 246       <varlistentry>
 247         <term>
 248           <command>label</command>
 249         </term>
 250
 251         <listitem><para>Show numerical address labels that can be used for address selection.
 252         This is the same information that
 253         <citerefentry><refentrytitle>ip-addrlabel</refentrytitle><manvolnum>8</manvolnum></citerefentry>
 254         shows. See <ulink url="https://tools.ietf.org/html/rfc3484">RFC 3484</ulink>
 255         for a discussion of address labels.</para>
 256
 257         <para>Produces output similar to:
 258         <programlisting>Prefix/Prefixlen                          Label
 259         ::/0                                  1
 260     fc00::/7                                  5
 261     fec0::/10                                11
 262     2002::/16                                 2
 263     3ffe::/16                                12
 264  2001:10::/28                                 7
 265     2001::/32                                 6
 266 ::ffff:0.0.0.0/96                             4
 267         ::/96                                 3
 268        ::1/128                                0</programlisting></para>
 269         </listitem>
 270       </varlistentry>
 271
 272     </variablelist>
 273   </refsect1>
 274
 275   <refsect1>
 276     <title>Exit status</title>
 277
 278     <para>On success, 0 is returned, a non-zero failure code otherwise.</para>
 279   </refsect1>
 280
 281   <refsect1>
 282     <title>See Also</title>
 283     <para>
 284       <citerefentry><refentrytitle>systemd-networkd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
 285       <citerefentry><refentrytitle>systemd.network</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
 286       <citerefentry><refentrytitle>systemd.netdev</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
 287       <citerefentry project='die-net'><refentrytitle>ip</refentrytitle><manvolnum>8</manvolnum></citerefentry>
 288     </para>
 289   </refsect1>
 290 </refentry>