[thirdparty/systemd.git] / man / networkctl.xml

<?xml version='1.0'?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">

<!--
  SPDX-License-Identifier: LGPL-2.1+
-->

<refentry id="networkctl" conditional='ENABLE_NETWORKD'
          xmlns:xi="http://www.w3.org/2001/XInclude">

  <refentryinfo>
    <title>networkctl</title>
    <productname>systemd</productname>
  </refentryinfo>

  <refmeta>
    <refentrytitle>networkctl</refentrytitle>
    <manvolnum>1</manvolnum>
  </refmeta>

  <refnamediv>
    <refname>networkctl</refname>
    <refpurpose>Query the status of network links</refpurpose>
  </refnamediv>

  <refsynopsisdiv>
    <cmdsynopsis>
      <command>networkctl</command>
      <arg choice="opt" rep="repeat">OPTIONS</arg>
      <arg choice="plain">COMMAND</arg>
      <arg choice="opt" rep="repeat">LINK</arg>
    </cmdsynopsis>
  </refsynopsisdiv>

  <refsect1>
    <title>Description</title>

    <para><command>networkctl</command> may be used to introspect the
    state of the network links as seen by
    <command>systemd-networkd</command>.  Please refer to
    <citerefentry><refentrytitle>systemd-networkd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>
    for an introduction to the basic concepts, functionality, and
    configuration syntax.</para>
  </refsect1>

  <refsect1>
    <title>Options</title>

    <para>The following options are understood:</para>

    <variablelist>
      <varlistentry>
        <term>
          <option>-a</option>
          <option>--all</option>
        </term>

        <listitem>
          <para>Show all links with <command>status</command>.</para>
        </listitem>
      </varlistentry>

      <xi:include href="standard-options.xml" xpointer="help" />
      <xi:include href="standard-options.xml" xpointer="version" />
      <xi:include href="standard-options.xml" xpointer="no-legend" />
      <xi:include href="standard-options.xml" xpointer="no-pager" />

    </variablelist>
  </refsect1>

  <refsect1>
    <title>Commands</title>

    <para>The following commands are understood:</para>

    <variablelist>
      <varlistentry>
        <term>
          <command>list</command>
          <optional><replaceable>PATTERN…</replaceable></optional>
        </term>

        <listitem>
          <para>Show a list of existing links and their status. If one ore more
          <replaceable>PATTERN</replaceable>s are specified, only links matching one of them are shown.
          If no further arguments are specified shows all links,
          otherwise just the specified links. Produces output similar to:

          <programlisting>IDX LINK         TYPE     OPERATIONAL SETUP
  1 lo           loopback carrier     unmanaged
  2 eth0         ether    routable    configured
  3 virbr0       ether    no-carrier  unmanaged
  4 virbr0-nic   ether    off         unmanaged

4 links listed.</programlisting></para>

        <para>The operational status is one of the following:
            <variablelist>
              <varlistentry>
                <term>off</term>
                <listitem>
                  <para>the device is powered down</para>
                </listitem>
              </varlistentry>
              <varlistentry>
                <term>no-carrier</term>
                <listitem>
                  <para>the device is powered up, but it does not yet have a carrier</para>
                </listitem>
              </varlistentry>
              <varlistentry>
                <term>dormant</term>
                <listitem>
                  <para>the device has a carrier, but is not yet ready for normal traffic</para>
                </listitem>
              </varlistentry>
              <varlistentry>
                <term>carrier</term>
                <listitem>
                  <para>the link has a carrier, or for bond master, all bonding slave network interfaces are
                  enslaved to the master.</para>
                </listitem>
              </varlistentry>
              <varlistentry>
                <term>degraded</term>
                <listitem>
                  <para>the link has carrier and addresses valid on the local link configured, or for bond
                  master, one of the bonding slave network interfaces is in off, no-carrier, or dormant</para>
                </listitem>
              </varlistentry>
              <varlistentry>
                <term>enslaved</term>
                <listitem>
                  <para>the link has carrier and is enslaved to other network interfaces</para>
                </listitem>
              </varlistentry>
              <varlistentry>
                <term>routable</term>
                <listitem>
                  <para>the link has carrier and routable address configured</para>
                </listitem>
              </varlistentry>
            </variablelist>
        </para>

        <para>The setup status is one of the following:
            <variablelist>
              <varlistentry>
                <term>pending</term>
                <listitem>
                  <para>udev is still processing the link, we don't yet know if we will manage it</para>
                </listitem>
              </varlistentry>
              <varlistentry>
                <term>failed</term>
                <listitem>
                  <para>networkd failed to manage the link</para>
                </listitem>
              </varlistentry>
              <varlistentry>
                <term>configuring</term>
                <listitem>
                  <para>in the process of retrieving configuration or configuring the link</para>
                </listitem>
              </varlistentry>
              <varlistentry>
                <term>configured</term>
                <listitem>
                  <para>link configured successfully</para>
                </listitem>
              </varlistentry>
              <varlistentry>
                <term>unmanaged</term>
                <listitem>
                  <para>networkd is not handling the link</para>
                </listitem>
              </varlistentry>
              <varlistentry>
                <term>linger</term>
                <listitem>
                  <para>the link is gone, but has not yet been dropped by networkd</para>
                </listitem>
              </varlistentry>
            </variablelist>
        </para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>
          <command>status</command>
          <optional><replaceable>PATTERN…</replaceable></optional>
        </term>

        <listitem>
          <para>Show information about the specified links: type, state, kernel module driver, hardware and
          IP address, configured DNS servers, etc. If one ore more <replaceable>PATTERN</replaceable>s are
          specified, only links matching one of them are shown.</para>

          <para>When no links are specified, an overall network status is shown. Also see the option
          <option>--all</option>.</para>

          <para>Produces output similar to:
          <programlisting>
●      State: routable
     Address: 10.193.76.5 on eth0
              192.168.122.1 on virbr0
              169.254.190.105 on eth0
              fe80::5054:aa:bbbb:cccc on eth0
     Gateway: 10.193.11.1 (CISCO SYSTEMS, INC.) on eth0
         DNS: 8.8.8.8
              8.8.4.4</programlisting></para>
        </listitem>

      </varlistentry>

      <varlistentry>
        <term>
          <command>lldp</command>
          <optional><replaceable>PATTERN…</replaceable></optional>
        </term>

        <listitem>
          <para>Show discovered LLDP (Link Layer Discovery Protocol) neighbors. If one or more
          <replaceable>PATTERN</replaceable>s are specified only neighbors on those interfaces are shown.
          Otherwise shows discovered neighbors on all interfaces. Note that for this feature to work,
          <varname>LLDP=</varname> must be turned on for the specific interface, see
          <citerefentry><refentrytitle>systemd.network</refentrytitle><manvolnum>5</manvolnum></citerefentry> for
          details.</para>

          <para>Produces output similar to:
          <programlisting>LINK             CHASSIS ID        SYSTEM NAME      CAPS        PORT ID           PORT DESCRIPTION
enp0s25          00:e0:4c:00:00:00 GS1900           ..b........ 2                 Port #2

Capability Flags:
o - Other; p - Repeater;  b - Bridge; w - WLAN Access Point; r - Router;
t - Telephone; d - DOCSIS cable device; a - Station; c - Customer VLAN;
s - Service VLAN, m - Two-port MAC Relay (TPMR)

1 neighbors listed.</programlisting></para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>
          <command>label</command>
        </term>

        <listitem><para>Show numerical address labels that can be used for address selection.
        This is the same information that
        <citerefentry><refentrytitle>ip-addrlabel</refentrytitle><manvolnum>8</manvolnum></citerefentry>
        shows. See <ulink url="https://tools.ietf.org/html/rfc3484">RFC 3484</ulink>
        for a discussion of address labels.</para>

        <para>Produces output similar to:
        <programlisting>Prefix/Prefixlen                          Label
        ::/0                                  1
    fc00::/7                                  5
    fec0::/10                                11
    2002::/16                                 2
    3ffe::/16                                12
 2001:10::/28                                 7
    2001::/32                                 6
::ffff:0.0.0.0/96                             4
        ::/96                                 3
       ::1/128                                0</programlisting></para>
        </listitem>
      </varlistentry>

    </variablelist>
  </refsect1>

  <refsect1>
    <title>Exit status</title>

    <para>On success, 0 is returned, a non-zero failure code otherwise.</para>
  </refsect1>

  <refsect1>
    <title>See Also</title>
    <para>
      <citerefentry><refentrytitle>systemd-networkd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
      <citerefentry><refentrytitle>systemd.network</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
      <citerefentry><refentrytitle>systemd.netdev</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
      <citerefentry project='die-net'><refentrytitle>ip</refentrytitle><manvolnum>8</manvolnum></citerefentry>
    </para>
  </refsect1>
</refentry>
Commit	Line	Data
514094f9	1	<?xml version='1.0'?>
d9000fd3	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
d9000fd3 ZJS	5	<!--
572eb058	6	SPDX-License-Identifier: LGPL-2.1+
d9000fd3 ZJS	7	-->
d9000fd3 ZJS	8
e6de49ab	9	<refentry id="networkctl" conditional='ENABLE_NETWORKD'
d9000fd3 ZJS	10	xmlns:xi="http://www.w3.org/2001/XInclude">
	11
	12	<refentryinfo>
	13	<title>networkctl</title>
	14	<productname>systemd</productname>
d9000fd3 ZJS	15	</refentryinfo>
	16
	17	<refmeta>
	18	<refentrytitle>networkctl</refentrytitle>
	19	<manvolnum>1</manvolnum>
	20	</refmeta>
	21
	22	<refnamediv>
	23	<refname>networkctl</refname>
cc98b302	24	<refpurpose>Query the status of network links</refpurpose>
d9000fd3 ZJS	25	</refnamediv>
	26
	27	<refsynopsisdiv>
	28	<cmdsynopsis>
	29	<command>networkctl</command>
	30	<arg choice="opt" rep="repeat">OPTIONS</arg>
	31	<arg choice="plain">COMMAND</arg>
	32	<arg choice="opt" rep="repeat">LINK</arg>
	33	</cmdsynopsis>
	34	</refsynopsisdiv>
	35
	36	<refsect1>
	37	<title>Description</title>
	38
	39	<para><command>networkctl</command> may be used to introspect the
	40	state of the network links as seen by
	41	<command>systemd-networkd</command>. Please refer to
	42	<citerefentry><refentrytitle>systemd-networkd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>
1d3eaa93	43	for an introduction to the basic concepts, functionality, and
d9000fd3 ZJS	44	configuration syntax.</para>
	45	</refsect1>
	46
	47	<refsect1>
	48	<title>Options</title>
	49
	50	<para>The following options are understood:</para>
	51
	52	<variablelist>
	53	<varlistentry>
	54	<term>
	55	<option>-a</option>
	56	<option>--all</option>
	57	</term>
	58
	59	<listitem>
	60	<para>Show all links with <command>status</command>.</para>
	61	</listitem>
	62	</varlistentry>
	63
	64	<xi:include href="standard-options.xml" xpointer="help" />
	65	<xi:include href="standard-options.xml" xpointer="version" />
400f73d9	66	<xi:include href="standard-options.xml" xpointer="no-legend" />
d9000fd3 ZJS	67	<xi:include href="standard-options.xml" xpointer="no-pager" />
	68
	69	</variablelist>
	70	</refsect1>
	71
	72	<refsect1>
	73	<title>Commands</title>
	74
	75	<para>The following commands are understood:</para>
	76
	77	<variablelist>
	78	<varlistentry>
	79	<term>
	80	<command>list</command>
f3eeecf4	81	<optional><replaceable>PATTERN…</replaceable></optional>
d9000fd3 ZJS	82	</term>
	83
	84	<listitem>
f3eeecf4 YW	85	<para>Show a list of existing links and their status. If one ore more
	86	<replaceable>PATTERN</replaceable>s are specified, only links matching one of them are shown.
	87	If no further arguments are specified shows all links,
e997c4b0 LP	88	otherwise just the specified links. Produces output similar to:
	89
	90	<programlisting>IDX LINK TYPE OPERATIONAL SETUP
d9000fd3 ZJS	91	1 lo loopback carrier unmanaged
	92	2 eth0 ether routable configured
	93	3 virbr0 ether no-carrier unmanaged
	94	4 virbr0-nic ether off unmanaged
	95
	96	4 links listed.</programlisting></para>
abcf95e9 JAK	97
	98	<para>The operational status is one of the following:
	99	<variablelist>
	100	<varlistentry>
	101	<term>off</term>
	102	<listitem>
	103	<para>the device is powered down</para>
	104	</listitem>
	105	</varlistentry>
	106	<varlistentry>
	107	<term>no-carrier</term>
	108	<listitem>
	109	<para>the device is powered up, but it does not yet have a carrier</para>
	110	</listitem>
	111	</varlistentry>
	112	<varlistentry>
	113	<term>dormant</term>
	114	<listitem>
	115	<para>the device has a carrier, but is not yet ready for normal traffic</para>
	116	</listitem>
	117	</varlistentry>
	118	<varlistentry>
	119	<term>carrier</term>
	120	<listitem>
250860e4 YW	121	<para>the link has a carrier, or for bond master, all bonding slave network interfaces are
250860e4 YW	122	enslaved to the master.</para>
abcf95e9 JAK	123	</listitem>
	124	</varlistentry>
	125	<varlistentry>
	126	<term>degraded</term>
	127	<listitem>
250860e4 YW	128	<para>the link has carrier and addresses valid on the local link configured, or for bond
250860e4 YW	129	master, one of the bonding slave network interfaces is in off, no-carrier, or dormant</para>
abcf95e9 JAK	130	</listitem>
abcf95e9 JAK	131	</varlistentry>
806c86ad YW	132	<varlistentry>
	133	<term>enslaved</term>
	134	<listitem>
	135	<para>the link has carrier and is enslaved to other network interfaces</para>
	136	</listitem>
	137	</varlistentry>
abcf95e9 JAK	138	<varlistentry>
	139	<term>routable</term>
	140	<listitem>
	141	<para>the link has carrier and routable address configured</para>
	142	</listitem>
	143	</varlistentry>
	144	</variablelist>
	145	</para>
	146
	147	<para>The setup status is one of the following:
	148	<variablelist>
	149	<varlistentry>
	150	<term>pending</term>
	151	<listitem>
	152	<para>udev is still processing the link, we don't yet know if we will manage it</para>
	153	</listitem>
	154	</varlistentry>
	155	<varlistentry>
	156	<term>failed</term>
	157	<listitem>
	158	<para>networkd failed to manage the link</para>
	159	</listitem>
	160	</varlistentry>
	161	<varlistentry>
	162	<term>configuring</term>
	163	<listitem>
	164	<para>in the process of retrieving configuration or configuring the link</para>
	165	</listitem>
	166	</varlistentry>
	167	<varlistentry>
	168	<term>configured</term>
	169	<listitem>
	170	<para>link configured successfully</para>
	171	</listitem>
	172	</varlistentry>
	173	<varlistentry>
	174	<term>unmanaged</term>
	175	<listitem>
	176	<para>networkd is not handling the link</para>
	177	</listitem>
	178	</varlistentry>
	179	<varlistentry>
	180	<term>linger</term>
	181	<listitem>
	182	<para>the link is gone, but has not yet been dropped by networkd</para>
	183	</listitem>
	184	</varlistentry>
	185	</variablelist>
	186	</para>
d9000fd3 ZJS	187	</listitem>
	188	</varlistentry>
	189
	190	<varlistentry>
	191	<term>
	192	<command>status</command>
f3eeecf4	193	<optional><replaceable>PATTERN…</replaceable></optional>
d9000fd3 ZJS	194	</term>
	195
	196	<listitem>
f3eeecf4 YW	197	<para>Show information about the specified links: type, state, kernel module driver, hardware and
	198	IP address, configured DNS servers, etc. If one ore more <replaceable>PATTERN</replaceable>s are
	199	specified, only links matching one of them are shown.</para>
d9000fd3	200
e997c4b0 LP	201	<para>When no links are specified, an overall network status is shown. Also see the option
e997c4b0 LP	202	<option>--all</option>.</para>
d9000fd3	203
e997c4b0	204	<para>Produces output similar to:
d9000fd3 ZJS	205	<programlisting>
	206	● State: routable
	207	Address: 10.193.76.5 on eth0
	208	192.168.122.1 on virbr0
	209	169.254.190.105 on eth0
	210	fe80::5054:aa:bbbb:cccc on eth0
	211	Gateway: 10.193.11.1 (CISCO SYSTEMS, INC.) on eth0
	212	DNS: 8.8.8.8
	213	8.8.4.4</programlisting></para>
	214	</listitem>
	215
	216	</varlistentry>
	217
	218	<varlistentry>
	219	<term>
	220	<command>lldp</command>
f3eeecf4	221	<optional><replaceable>PATTERN…</replaceable></optional>
d9000fd3 ZJS	222	</term>
	223
	224	<listitem>
f3eeecf4 YW	225	<para>Show discovered LLDP (Link Layer Discovery Protocol) neighbors. If one or more
	226	<replaceable>PATTERN</replaceable>s are specified only neighbors on those interfaces are shown.
	227	Otherwise shows discovered neighbors on all interfaces. Note that for this feature to work,
	228	<varname>LLDP=</varname> must be turned on for the specific interface, see
e997c4b0 LP	229	<citerefentry><refentrytitle>systemd.network</refentrytitle><manvolnum>5</manvolnum></citerefentry> for
	230	details.</para>
	231
	232	<para>Produces output similar to:
	233	<programlisting>LINK CHASSIS ID SYSTEM NAME CAPS PORT ID PORT DESCRIPTION
	234	enp0s25 00:e0:4c:00:00:00 GS1900 ..b........ 2 Port #2
	235
	236	Capability Flags:
	237	o - Other; p - Repeater; b - Bridge; w - WLAN Access Point; r - Router;
	238	t - Telephone; d - DOCSIS cable device; a - Station; c - Customer VLAN;
	239	s - Service VLAN, m - Two-port MAC Relay (TPMR)
	240
	241	1 neighbors listed.</programlisting></para>
d9000fd3 ZJS	242	</listitem>
d9000fd3 ZJS	243	</varlistentry>
a5be8dab ZJS	244
	245	<varlistentry>
	246	<term>
	247	<command>label</command>
	248	</term>
	249
	250	<listitem><para>Show numerical address labels that can be used for address selection.
	251	This is the same information that
	252	<citerefentry><refentrytitle>ip-addrlabel</refentrytitle><manvolnum>8</manvolnum></citerefentry>
	253	shows. See <ulink url="https://tools.ietf.org/html/rfc3484">RFC 3484</ulink>
	254	for a discussion of address labels.</para>
	255
	256	<para>Produces output similar to:
	257	<programlisting>Prefix/Prefixlen Label
	258	::/0 1
	259	fc00::/7 5
	260	fec0::/10 11
	261	2002::/16 2
	262	3ffe::/16 12
	263	2001:10::/28 7
	264	2001::/32 6
	265	::ffff:0.0.0.0/96 4
	266	::/96 3
	267	::1/128 0</programlisting></para>
	268	</listitem>
	269	</varlistentry>
	270
d9000fd3 ZJS	271	</variablelist>
	272	</refsect1>
	273
	274	<refsect1>
	275	<title>Exit status</title>
	276
a5be8dab	277	<para>On success, 0 is returned, a non-zero failure code otherwise.</para>
d9000fd3 ZJS	278	</refsect1>
	279
	280	<refsect1>
	281	<title>See Also</title>
	282	<para>
	283	<citerefentry><refentrytitle>systemd-networkd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
	284	<citerefentry><refentrytitle>systemd.network</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
a5be8dab ZJS	285	<citerefentry><refentrytitle>systemd.netdev</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
a5be8dab ZJS	286	<citerefentry project='die-net'><refentrytitle>ip</refentrytitle><manvolnum>8</manvolnum></citerefentry>
d9000fd3 ZJS	287	</para>
	288	</refsect1>
	289	</refentry>