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</para>
 122                 </listitem>
 123               </varlistentry>
 124               <varlistentry>
 125                 <term>degraded</term>
 126                 <listitem>
 127                   <para>the link has carrier and addresses valid on the local link configured</para>
 128                 </listitem>
 129               </varlistentry>
 130               <varlistentry>
 131                 <term>routable</term>
 132                 <listitem>
 133                   <para>the link has carrier and routable address configured</para>
 134                 </listitem>
 135               </varlistentry>
 136             </variablelist>
 137         </para>
 138
 139         <para>The setup status is one of the following:
 140             <variablelist>
 141               <varlistentry>
 142                 <term>pending</term>
 143                 <listitem>
 144                   <para>udev is still processing the link, we don't yet know if we will manage it</para>
 145                 </listitem>
 146               </varlistentry>
 147               <varlistentry>
 148                 <term>failed</term>
 149                 <listitem>
 150                   <para>networkd failed to manage the link</para>
 151                 </listitem>
 152               </varlistentry>
 153               <varlistentry>
 154                 <term>configuring</term>
 155                 <listitem>
 156                   <para>in the process of retrieving configuration or configuring the link</para>
 157                 </listitem>
 158               </varlistentry>
 159               <varlistentry>
 160                 <term>configured</term>
 161                 <listitem>
 162                   <para>link configured successfully</para>
 163                 </listitem>
 164               </varlistentry>
 165               <varlistentry>
 166                 <term>unmanaged</term>
 167                 <listitem>
 168                   <para>networkd is not handling the link</para>
 169                 </listitem>
 170               </varlistentry>
 171               <varlistentry>
 172                 <term>linger</term>
 173                 <listitem>
 174                   <para>the link is gone, but has not yet been dropped by networkd</para>
 175                 </listitem>
 176               </varlistentry>
 177             </variablelist>
 178         </para>
 179         </listitem>
 180       </varlistentry>
 181
 182       <varlistentry>
 183         <term>
 184           <command>status</command>
 185           <optional><replaceable>PATTERN…</replaceable></optional>
 186         </term>
 187
 188         <listitem>
 189           <para>Show information about the specified links: type, state, kernel module driver, hardware and
 190           IP address, configured DNS servers, etc. If one ore more <replaceable>PATTERN</replaceable>s are
 191           specified, only links matching one of them are shown.</para>
 192
 193           <para>When no links are specified, an overall network status is shown. Also see the option
 194           <option>--all</option>.</para>
 195
 196           <para>Produces output similar to:
 197           <programlisting>
 198 ●      State: routable
 199      Address: 10.193.76.5 on eth0
 200               192.168.122.1 on virbr0
 201               169.254.190.105 on eth0
 202               fe80::5054:aa:bbbb:cccc on eth0
 203      Gateway: 10.193.11.1 (CISCO SYSTEMS, INC.) on eth0
 204          DNS: 8.8.8.8
 205               8.8.4.4</programlisting></para>
 206         </listitem>
 207
 208       </varlistentry>
 209
 210       <varlistentry>
 211         <term>
 212           <command>lldp</command>
 213           <optional><replaceable>PATTERN…</replaceable></optional>
 214         </term>
 215
 216         <listitem>
 217           <para>Show discovered LLDP (Link Layer Discovery Protocol) neighbors. If one or more
 218           <replaceable>PATTERN</replaceable>s are specified only neighbors on those interfaces are shown.
 219           Otherwise shows discovered neighbors on all interfaces. Note that for this feature to work,
 220           <varname>LLDP=</varname> must be turned on for the specific interface, see
 221           <citerefentry><refentrytitle>systemd.network</refentrytitle><manvolnum>5</manvolnum></citerefentry> for
 222           details.</para>
 223
 224           <para>Produces output similar to:
 225           <programlisting>LINK             CHASSIS ID        SYSTEM NAME      CAPS        PORT ID           PORT DESCRIPTION
 226 enp0s25          00:e0:4c:00:00:00 GS1900           ..b........ 2                 Port #2
 227
 228 Capability Flags:
 229 o - Other; p - Repeater;  b - Bridge; w - WLAN Access Point; r - Router;
 230 t - Telephone; d - DOCSIS cable device; a - Station; c - Customer VLAN;
 231 s - Service VLAN, m - Two-port MAC Relay (TPMR)
 232
 233 1 neighbors listed.</programlisting></para>
 234         </listitem>
 235       </varlistentry>
 236
 237       <varlistentry>
 238         <term>
 239           <command>label</command>
 240         </term>
 241
 242         <listitem><para>Show numerical address labels that can be used for address selection.
 243         This is the same information that
 244         <citerefentry><refentrytitle>ip-addrlabel</refentrytitle><manvolnum>8</manvolnum></citerefentry>
 245         shows. See <ulink url="https://tools.ietf.org/html/rfc3484">RFC 3484</ulink>
 246         for a discussion of address labels.</para>
 247
 248         <para>Produces output similar to:
 249         <programlisting>Prefix/Prefixlen                          Label
 250         ::/0                                  1
 251     fc00::/7                                  5
 252     fec0::/10                                11
 253     2002::/16                                 2
 254     3ffe::/16                                12
 255  2001:10::/28                                 7
 256     2001::/32                                 6
 257 ::ffff:0.0.0.0/96                             4
 258         ::/96                                 3
 259        ::1/128                                0</programlisting></para>
 260         </listitem>
 261       </varlistentry>
 262
 263     </variablelist>
 264   </refsect1>
 265
 266   <refsect1>
 267     <title>Exit status</title>
 268
 269     <para>On success, 0 is returned, a non-zero failure code otherwise.</para>
 270   </refsect1>
 271
 272   <refsect1>
 273     <title>See Also</title>
 274     <para>
 275       <citerefentry><refentrytitle>systemd-networkd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
 276       <citerefentry><refentrytitle>systemd.network</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
 277       <citerefentry><refentrytitle>systemd.netdev</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
 278       <citerefentry project='die-net'><refentrytitle>ip</refentrytitle><manvolnum>8</manvolnum></citerefentry>
 279     </para>
 280   </refsect1>
 281 </refentry>