2 <!DOCTYPE refentry PUBLIC
"-//OASIS//DTD DocBook XML V4.5//EN"
3 "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
4 <!-- SPDX-License-Identifier: LGPL-2.1+ -->
6 <refentry id=
"networkctl" conditional='ENABLE_NETWORKD'
7 xmlns:
xi=
"http://www.w3.org/2001/XInclude">
10 <title>networkctl
</title>
11 <productname>systemd
</productname>
15 <refentrytitle>networkctl
</refentrytitle>
16 <manvolnum>1</manvolnum>
20 <refname>networkctl
</refname>
21 <refpurpose>Query the status of network links
</refpurpose>
26 <command>networkctl
</command>
27 <arg choice=
"opt" rep=
"repeat">OPTIONS
</arg>
28 <arg choice=
"plain">COMMAND
</arg>
29 <arg choice=
"opt" rep=
"repeat">LINK
</arg>
34 <title>Description
</title>
36 <para><command>networkctl
</command> may be used to introspect the
37 state of the network links as seen by
38 <command>systemd-networkd
</command>. Please refer to
39 <citerefentry><refentrytitle>systemd-networkd.service
</refentrytitle><manvolnum>8</manvolnum></citerefentry>
40 for an introduction to the basic concepts, functionality, and
41 configuration syntax.
</para>
45 <title>Options
</title>
47 <para>The following options are understood:
</para>
53 <option>--all
</option>
57 <para>Show all links with
<command>status
</command>.
</para>
61 <xi:include href=
"standard-options.xml" xpointer=
"help" />
62 <xi:include href=
"standard-options.xml" xpointer=
"version" />
63 <xi:include href=
"standard-options.xml" xpointer=
"no-legend" />
64 <xi:include href=
"standard-options.xml" xpointer=
"no-pager" />
70 <title>Commands
</title>
72 <para>The following commands are understood:
</para>
77 <command>list
</command>
78 <optional><replaceable>PATTERN…
</replaceable></optional>
82 <para>Show a list of existing links and their status. If one ore more
83 <replaceable>PATTERN
</replaceable>s are specified, only links matching one of them are shown.
84 If no further arguments are specified shows all links,
85 otherwise just the specified links. Produces output similar to:
87 <programlisting>IDX LINK TYPE OPERATIONAL SETUP
88 1 lo loopback carrier unmanaged
89 2 eth0 ether routable configured
90 3 virbr0 ether no-carrier unmanaged
91 4 virbr0-nic ether off unmanaged
93 4 links listed.
</programlisting></para>
95 <para>The operational status is one of the following:
100 <para>the device is powered down
</para>
104 <term>no-carrier
</term>
106 <para>the device is powered up, but it does not yet have a carrier
</para>
112 <para>the device has a carrier, but is not yet ready for normal traffic
</para>
116 <term>degraded-carrier
</term>
118 <para>for bond or bridge master, one of the bonding or bridge slave network interfaces is
119 in off, no-carrier, or dormant state
</para>
125 <para>the link has a carrier, or for bond or bridge master, all bonding or bridge slave
126 network interfaces are enslaved to the master.
</para>
130 <term>degraded
</term>
132 <para>the link has carrier and addresses valid on the local link configured
</para>
136 <term>enslaved
</term>
138 <para>the link has carrier and is enslaved to bond or bridge master network interface
</para>
142 <term>routable
</term>
144 <para>the link has carrier and routable address configured
</para>
150 <para>The setup status is one of the following:
155 <para>udev is still processing the link, we don't yet know if we will manage it
</para>
161 <para>networkd failed to manage the link
</para>
165 <term>configuring
</term>
167 <para>in the process of retrieving configuration or configuring the link
</para>
171 <term>configured
</term>
173 <para>link configured successfully
</para>
177 <term>unmanaged
</term>
179 <para>networkd is not handling the link
</para>
185 <para>the link is gone, but has not yet been dropped by networkd
</para>
195 <command>status
</command>
196 <optional><replaceable>PATTERN…
</replaceable></optional>
200 <para>Show information about the specified links: type, state, kernel module driver, hardware and
201 IP address, configured DNS servers, etc. If one ore more
<replaceable>PATTERN
</replaceable>s are
202 specified, only links matching one of them are shown.
</para>
204 <para>When no links are specified, an overall network status is shown. Also see the option
205 <option>--all
</option>.
</para>
207 <para>Produces output similar to:
210 Address:
10.193.76.5 on eth0
211 192.168.122.1 on virbr0
212 169.254.190.105 on eth0
213 fe80::
5054:aa:bbbb:cccc on eth0
214 Gateway:
10.193.11.1 (CISCO SYSTEMS, INC.) on eth0
216 8.8.4.4</programlisting></para>
223 <command>lldp
</command>
224 <optional><replaceable>PATTERN…
</replaceable></optional>
228 <para>Show discovered LLDP (Link Layer Discovery Protocol) neighbors. If one or more
229 <replaceable>PATTERN
</replaceable>s are specified only neighbors on those interfaces are shown.
230 Otherwise shows discovered neighbors on all interfaces. Note that for this feature to work,
231 <varname>LLDP=
</varname> must be turned on for the specific interface, see
232 <citerefentry><refentrytitle>systemd.network
</refentrytitle><manvolnum>5</manvolnum></citerefentry> for
235 <para>Produces output similar to:
236 <programlisting>LINK CHASSIS ID SYSTEM NAME CAPS PORT ID PORT DESCRIPTION
237 enp0s25
00:e0:
4c:
00:
00:
00 GS1900 ..b........
2 Port #
2
240 o - Other; p - Repeater; b - Bridge; w - WLAN Access Point; r - Router;
241 t - Telephone; d - DOCSIS cable device; a - Station; c - Customer VLAN;
242 s - Service VLAN, m - Two-port MAC Relay (TPMR)
244 1 neighbors listed.
</programlisting></para>
250 <command>label
</command>
253 <listitem><para>Show numerical address labels that can be used for address selection.
254 This is the same information that
255 <citerefentry><refentrytitle>ip-addrlabel
</refentrytitle><manvolnum>8</manvolnum></citerefentry>
256 shows. See
<ulink url=
"https://tools.ietf.org/html/rfc3484">RFC
3484</ulink>
257 for a discussion of address labels.
</para>
259 <para>Produces output similar to:
260 <programlisting>Prefix/Prefixlen Label
270 ::
1/
128 0</programlisting></para>
278 <title>Exit status
</title>
280 <para>On success,
0 is returned, a non-zero failure code otherwise.
</para>
284 <title>See Also
</title>
286 <citerefentry><refentrytitle>systemd-networkd.service
</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
287 <citerefentry><refentrytitle>systemd.network
</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
288 <citerefentry><refentrytitle>systemd.netdev
</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
289 <citerefentry project='die-net'
><refentrytitle>ip
</refentrytitle><manvolnum>8</manvolnum></citerefentry>