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
   5 <!--
   6   This file is part of systemd.
   7
   8   Copyright 2015 Zbigniew Jędrzejewski-Szmek
   9
  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.
  14
  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.
  19
  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/>.
  22 -->
  23
  24 <refentry id="networkctl" conditional='ENABLE_NETWORKD'
  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>
  48     <refpurpose>Query the status of network links</refpurpose>
  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>
  67     for an introduction to the basic concepts, functionality, and
  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" />
  90       <xi:include href="standard-options.xml" xpointer="no-legend" />
  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>
 105         </term>
 106
 107         <listitem>
 108           <para>Show a list of existing links and their
 109           status. Produces output similar to <programlisting>
 110 IDX LINK         TYPE     OPERATIONAL SETUP
 111   1 lo           loopback carrier     unmanaged
 112   2 eth0         ether    routable    configured
 113   3 virbr0       ether    no-carrier  unmanaged
 114   4 virbr0-nic   ether    off         unmanaged
 115
 116 4 links listed.</programlisting></para>
 117         </listitem>
 118       </varlistentry>
 119
 120       <varlistentry>
 121         <term>
 122           <command>status</command>
 123           <optional><replaceable>LINK...</replaceable></optional>
 124         </term>
 125
 126         <listitem>
 127           <para>Show information about the specified links: type,
 128           state, kernel module driver, hardware and IP address,
 129           configured DNS servers, etc.</para>
 130
 131           <para>When no links are specified, routable links are
 132           shown. Also see the option <option>--all</option>.</para>
 133
 134           <para>Produces output similar to
 135           <programlisting>
 136 ●      State: routable
 137      Address: 10.193.76.5 on eth0
 138               192.168.122.1 on virbr0
 139               169.254.190.105 on eth0
 140               fe80::5054:aa:bbbb:cccc on eth0
 141      Gateway: 10.193.11.1 (CISCO SYSTEMS, INC.) on eth0
 142          DNS: 8.8.8.8
 143               8.8.4.4</programlisting></para>
 144         </listitem>
 145
 146       </varlistentry>
 147
 148       <varlistentry>
 149         <term>
 150           <command>lldp</command>
 151         </term>
 152
 153         <listitem>
 154           <para>Show LLDP (Link Layer Discovery Protocol)
 155           status.</para>
 156         </listitem>
 157       </varlistentry>
 158     </variablelist>
 159   </refsect1>
 160
 161   <refsect1>
 162     <title>Exit status</title>
 163
 164     <para>On success, 0 is returned, a non-zero failure
 165     code otherwise.</para>
 166   </refsect1>
 167
 168   <refsect1>
 169     <title>See Also</title>
 170     <para>
 171       <citerefentry><refentrytitle>systemd-networkd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
 172       <citerefentry><refentrytitle>systemd.network</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
 173       <citerefentry><refentrytitle>systemd.netdev</refentrytitle><manvolnum>5</manvolnum></citerefentry>
 174     </para>
 175   </refsect1>
 176 </refentry>