man/networkctl.xml

   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" [
   4 <!ENTITY % entities SYSTEM "custom-entities.ent" >
   5 %entities;
   6 ]>
   7
   8 <!--
   9   This file is part of systemd.
  10
  11   Copyright 2015 Zbigniew Jędrzejewski-Szmek
  12
  13   systemd is free software; you can redistribute it and/or modify it
  14   under the terms of the GNU Lesser General Public License as published by
  15   the Free Software Foundation; either version 2.1 of the License, or
  16   (at your option) any later version.
  17
  18   systemd is distributed in the hope that it will be useful, but
  19   WITHOUT ANY WARRANTY; without even the implied warranty of
  20   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  21   Lesser General Public License for more details.
  22
  23   You should have received a copy of the GNU Lesser General Public License
  24   along with systemd; If not, see <http://www.gnu.org/licenses/>.
  25 -->
  26
  27 <refentry id="networkctl"
  28           xmlns:xi="http://www.w3.org/2001/XInclude">
  29
  30   <refentryinfo>
  31     <title>networkctl</title>
  32     <productname>systemd</productname>
  33
  34     <authorgroup>
  35       <author>
  36         <contrib>Documentation</contrib>
  37         <firstname>Zbigniew</firstname>
  38         <surname>Jędrzejewski-Szmek</surname>
  39         <email>zbyszek@in.waw.pl</email>
  40       </author>
  41     </authorgroup>
  42   </refentryinfo>
  43
  44   <refmeta>
  45     <refentrytitle>networkctl</refentrytitle>
  46     <manvolnum>1</manvolnum>
  47   </refmeta>
  48
  49   <refnamediv>
  50     <refname>networkctl</refname>
  51     <refpurpose>Query the status of network links</refpurpose>
  52   </refnamediv>
  53
  54   <refsynopsisdiv>
  55     <cmdsynopsis>
  56       <command>networkctl</command>
  57       <arg choice="opt" rep="repeat">OPTIONS</arg>
  58       <arg choice="plain">COMMAND</arg>
  59       <arg choice="opt" rep="repeat">LINK</arg>
  60     </cmdsynopsis>
  61   </refsynopsisdiv>
  62
  63   <refsect1>
  64     <title>Description</title>
  65
  66     <para><command>networkctl</command> may be used to introspect the
  67     state of the network links as seen by
  68     <command>systemd-networkd</command>.  Please refer to
  69     <citerefentry><refentrytitle>systemd-networkd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>
  70     for an introduction to the the basic concepts, functionality, and
  71     configuration syntax.</para>
  72   </refsect1>
  73
  74   <refsect1>
  75     <title>Options</title>
  76
  77     <para>The following options are understood:</para>
  78
  79     <variablelist>
  80       <varlistentry>
  81         <term>
  82           <option>-a</option>
  83           <option>--all</option>
  84         </term>
  85
  86         <listitem>
  87           <para>Show all links with <command>status</command>.</para>
  88         </listitem>
  89       </varlistentry>
  90
  91       <xi:include href="standard-options.xml" xpointer="help" />
  92       <xi:include href="standard-options.xml" xpointer="version" />
  93       <xi:include href="standard-options.xml" xpointer="no-pager" />
  94
  95     </variablelist>
  96   </refsect1>
  97
  98   <refsect1>
  99     <title>Commands</title>
 100
 101     <para>The following commands are understood:</para>
 102
 103     <variablelist>
 104       <varlistentry>
 105         <term>
 106           <command>list</command>
 107         </term>
 108
 109         <listitem>
 110           <para>Show a list of existing links and their
 111           status. Produces output similar to <programlisting>
 112 IDX LINK         TYPE     OPERATIONAL SETUP
 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>
 125           <optional><replaceable>LINK...</replaceable></optional>
 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
 133           <para>When no links are specified, routable links are
 134           shown. See also option <option>--all</option>.</para>
 135
 136           <para>Produces output similar to
 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>
 153         </term>
 154
 155         <listitem>
 156           <para>Show LLDP (Link Layer Discovery Protocol)
 157           status.</para>
 158         </listitem>
 159       </varlistentry>
 160     </variablelist>
 161   </refsect1>
 162
 163   <refsect1>
 164     <title>Exit status</title>
 165
 166     <para>On success, 0 is returned, a non-zero failure
 167     code otherwise.</para>
 168   </refsect1>
 169
 170   <refsect1>
 171     <title>See Also</title>
 172     <para>
 173       <citerefentry><refentrytitle>systemd-networkd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
 174       <citerefentry><refentrytitle>systemd.network</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
 175       <citerefentry><refentrytitle>systemd.netdev</refentrytitle><manvolnum>5</manvolnum></citerefentry>
 176     </para>
 177   </refsect1>
 178 </refentry>