]>
Commit | Line | Data |
---|---|---|
d9000fd3 ZJS |
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" | |
12b42c76 | 3 | "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> |
d9000fd3 ZJS |
4 | |
5 | <!-- | |
b975b0d5 | 6 | This file is part of systemd. |
d9000fd3 | 7 | |
b975b0d5 | 8 | Copyright 2015 Zbigniew Jędrzejewski-Szmek |
d9000fd3 | 9 | |
b975b0d5 ZJS |
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. | |
d9000fd3 | 14 | |
b975b0d5 ZJS |
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. | |
d9000fd3 | 19 | |
b975b0d5 ZJS |
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/>. | |
d9000fd3 ZJS |
22 | --> |
23 | ||
e6de49ab | 24 | <refentry id="networkctl" conditional='ENABLE_NETWORKD' |
d9000fd3 ZJS |
25 | xmlns:xi="http://www.w3.org/2001/XInclude"> |
26 | ||
27 | <refentryinfo> | |
28 | <title>networkctl</title> | |
29 | <productname>systemd</productname> | |
30 | ||
31 | <authorgroup> | |
32 | <author> | |
33 | <contrib>Documentation</contrib> | |
34 | <firstname>Zbigniew</firstname> | |
35 | <surname>Jędrzejewski-Szmek</surname> | |
36 | <email>zbyszek@in.waw.pl</email> | |
37 | </author> | |
38 | </authorgroup> | |
39 | </refentryinfo> | |
40 | ||
41 | <refmeta> | |
42 | <refentrytitle>networkctl</refentrytitle> | |
43 | <manvolnum>1</manvolnum> | |
44 | </refmeta> | |
45 | ||
46 | <refnamediv> | |
47 | <refname>networkctl</refname> | |
cc98b302 | 48 | <refpurpose>Query the status of network links</refpurpose> |
d9000fd3 ZJS |
49 | </refnamediv> |
50 | ||
51 | <refsynopsisdiv> | |
52 | <cmdsynopsis> | |
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> | |
57 | </cmdsynopsis> | |
58 | </refsynopsisdiv> | |
59 | ||
60 | <refsect1> | |
61 | <title>Description</title> | |
62 | ||
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> | |
1d3eaa93 | 67 | for an introduction to the basic concepts, functionality, and |
d9000fd3 ZJS |
68 | configuration syntax.</para> |
69 | </refsect1> | |
70 | ||
71 | <refsect1> | |
72 | <title>Options</title> | |
73 | ||
74 | <para>The following options are understood:</para> | |
75 | ||
76 | <variablelist> | |
77 | <varlistentry> | |
78 | <term> | |
79 | <option>-a</option> | |
80 | <option>--all</option> | |
81 | </term> | |
82 | ||
83 | <listitem> | |
84 | <para>Show all links with <command>status</command>.</para> | |
85 | </listitem> | |
86 | </varlistentry> | |
87 | ||
88 | <xi:include href="standard-options.xml" xpointer="help" /> | |
89 | <xi:include href="standard-options.xml" xpointer="version" /> | |
400f73d9 | 90 | <xi:include href="standard-options.xml" xpointer="no-legend" /> |
d9000fd3 ZJS |
91 | <xi:include href="standard-options.xml" xpointer="no-pager" /> |
92 | ||
93 | </variablelist> | |
94 | </refsect1> | |
95 | ||
96 | <refsect1> | |
97 | <title>Commands</title> | |
98 | ||
99 | <para>The following commands are understood:</para> | |
100 | ||
101 | <variablelist> | |
102 | <varlistentry> | |
103 | <term> | |
104 | <command>list</command> | |
1eecafb8 | 105 | <optional><replaceable>LINK…</replaceable></optional> |
d9000fd3 ZJS |
106 | </term> |
107 | ||
108 | <listitem> | |
e997c4b0 LP |
109 | <para>Show a list of existing links and their status. If no further arguments are specified shows all links, |
110 | otherwise just the specified links. Produces output similar to: | |
111 | ||
112 | <programlisting>IDX LINK TYPE OPERATIONAL SETUP | |
d9000fd3 ZJS |
113 | 1 lo loopback carrier unmanaged |
114 | 2 eth0 ether routable configured | |
115 | 3 virbr0 ether no-carrier unmanaged | |
116 | 4 virbr0-nic ether off unmanaged | |
117 | ||
118 | 4 links listed.</programlisting></para> | |
119 | </listitem> | |
120 | </varlistentry> | |
121 | ||
122 | <varlistentry> | |
123 | <term> | |
124 | <command>status</command> | |
1eecafb8 | 125 | <optional><replaceable>LINK…</replaceable></optional> |
d9000fd3 ZJS |
126 | </term> |
127 | ||
128 | <listitem> | |
129 | <para>Show information about the specified links: type, | |
130 | state, kernel module driver, hardware and IP address, | |
131 | configured DNS servers, etc.</para> | |
132 | ||
e997c4b0 LP |
133 | <para>When no links are specified, an overall network status is shown. Also see the option |
134 | <option>--all</option>.</para> | |
d9000fd3 | 135 | |
e997c4b0 | 136 | <para>Produces output similar to: |
d9000fd3 ZJS |
137 | <programlisting> |
138 | ● State: routable | |
139 | Address: 10.193.76.5 on eth0 | |
140 | 192.168.122.1 on virbr0 | |
141 | 169.254.190.105 on eth0 | |
142 | fe80::5054:aa:bbbb:cccc on eth0 | |
143 | Gateway: 10.193.11.1 (CISCO SYSTEMS, INC.) on eth0 | |
144 | DNS: 8.8.8.8 | |
145 | 8.8.4.4</programlisting></para> | |
146 | </listitem> | |
147 | ||
148 | </varlistentry> | |
149 | ||
150 | <varlistentry> | |
151 | <term> | |
152 | <command>lldp</command> | |
1eecafb8 | 153 | <optional><replaceable>LINK…</replaceable></optional> |
d9000fd3 ZJS |
154 | </term> |
155 | ||
156 | <listitem> | |
e997c4b0 LP |
157 | <para>Show discovered LLDP (Link Layer Discovery Protocol) neighbors. If one or more link names are specified |
158 | only neighbors on those interfaces are shown. Otherwise shows discovered neighbors on all interfaces. Note | |
159 | that for this feature to work, <varname>LLDP=</varname> must be turned on on the specific interface, see | |
160 | <citerefentry><refentrytitle>systemd.network</refentrytitle><manvolnum>5</manvolnum></citerefentry> for | |
161 | details.</para> | |
162 | ||
163 | <para>Produces output similar to: | |
164 | <programlisting>LINK CHASSIS ID SYSTEM NAME CAPS PORT ID PORT DESCRIPTION | |
165 | enp0s25 00:e0:4c:00:00:00 GS1900 ..b........ 2 Port #2 | |
166 | ||
167 | Capability Flags: | |
168 | o - Other; p - Repeater; b - Bridge; w - WLAN Access Point; r - Router; | |
169 | t - Telephone; d - DOCSIS cable device; a - Station; c - Customer VLAN; | |
170 | s - Service VLAN, m - Two-port MAC Relay (TPMR) | |
171 | ||
172 | 1 neighbors listed.</programlisting></para> | |
d9000fd3 ZJS |
173 | </listitem> |
174 | </varlistentry> | |
175 | </variablelist> | |
176 | </refsect1> | |
177 | ||
178 | <refsect1> | |
179 | <title>Exit status</title> | |
180 | ||
181 | <para>On success, 0 is returned, a non-zero failure | |
182 | code otherwise.</para> | |
183 | </refsect1> | |
184 | ||
185 | <refsect1> | |
186 | <title>See Also</title> | |
187 | <para> | |
188 | <citerefentry><refentrytitle>systemd-networkd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>, | |
189 | <citerefentry><refentrytitle>systemd.network</refentrytitle><manvolnum>5</manvolnum></citerefentry>, | |
190 | <citerefentry><refentrytitle>systemd.netdev</refentrytitle><manvolnum>5</manvolnum></citerefentry> | |
191 | </para> | |
192 | </refsect1> | |
193 | </refentry> |