1 <?xml version='1.0'?> <!--*- Mode: nxml; nxml-child-indent: 2; indent-tabs-mode: nil -*-->
2 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
3 "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
6 This file is part of systemd.
8 Copyright 2015 Zbigniew Jędrzejewski-Szmek
10 systemd is free software; you can redistribute it and/or modify it
11 under the terms of the GNU Lesser General Public License as published by
12 the Free Software Foundation; either version 2.1 of the License, or
13 (at your option) any later version.
15 systemd is distributed in the hope that it will be useful, but
16 WITHOUT ANY WARRANTY; without even the implied warranty of
17 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
18 Lesser General Public License for more details.
20 You should have received a copy of the GNU Lesser General Public License
21 along with systemd; If not, see <http://www.gnu.org/licenses/>.
24 <refentry id="networkctl"
25 xmlns:xi="http://www.w3.org/2001/XInclude">
28 <title>networkctl</title>
29 <productname>systemd</productname>
33 <contrib>Documentation</contrib>
34 <firstname>Zbigniew</firstname>
35 <surname>Jędrzejewski-Szmek</surname>
36 <email>zbyszek@in.waw.pl</email>
42 <refentrytitle>networkctl</refentrytitle>
43 <manvolnum>1</manvolnum>
47 <refname>networkctl</refname>
48 <refpurpose>Query the statuc of network links</refpurpose>
53 <command>networkctl</command>
54 <arg choice="opt" rep="repeat">OPTIONS</arg>
55 <arg choice="plain">COMMAND</arg>
56 <arg choice="opt" rep="repeat">LINK</arg>
61 <title>Description</title>
63 <para><command>networkctl</command> may be used to introspect the
64 state of the network links as seen by
65 <command>systemd-networkd</command>. Please refer to
66 <citerefentry><refentrytitle>systemd-networkd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>
67 for an introduction to the the basic concepts, functionality, and
68 configuration syntax.</para>
72 <title>Options</title>
74 <para>The following options are understood:</para>
80 <option>--all</option>
84 <para>Show all links with <command>status</command>.</para>
88 <xi:include href="standard-options.xml" xpointer="help" />
89 <xi:include href="standard-options.xml" xpointer="version" />
90 <xi:include href="standard-options.xml" xpointer="no-pager" />
96 <title>Commands</title>
98 <para>The following commands are understood:</para>
103 <command>list</command>
107 <para>Show a list of existing links and their
108 status. Produces output similar to <programlisting>
109 IDX LINK TYPE OPERATIONAL SETUP
110 1 lo loopback carrier unmanaged
111 2 eth0 ether routable configured
112 3 virbr0 ether no-carrier unmanaged
113 4 virbr0-nic ether off unmanaged
115 4 links listed.</programlisting></para>
121 <command>status</command>
122 <optional><replaceable>LINK...</replaceable></optional>
126 <para>Show information about the specified links: type,
127 state, kernel module driver, hardware and IP address,
128 configured DNS servers, etc.</para>
130 <para>When no links are specified, routable links are
131 shown. See also option <option>--all</option>.</para>
133 <para>Produces output similar to
136 Address: 10.193.76.5 on eth0
137 192.168.122.1 on virbr0
138 169.254.190.105 on eth0
139 fe80::5054:aa:bbbb:cccc on eth0
140 Gateway: 10.193.11.1 (CISCO SYSTEMS, INC.) on eth0
142 8.8.4.4</programlisting></para>
149 <command>lldp</command>
153 <para>Show LLDP (Link Layer Discovery Protocol)
161 <title>Exit status</title>
163 <para>On success, 0 is returned, a non-zero failure
164 code otherwise.</para>
168 <title>See Also</title>
170 <citerefentry><refentrytitle>systemd-networkd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
171 <citerefentry><refentrytitle>systemd.network</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
172 <citerefentry><refentrytitle>systemd.netdev</refentrytitle><manvolnum>5</manvolnum></citerefentry>