man/systemd-network-generator.service.xml

   1 <?xml version='1.0'?> <!--*-nxml-*-->
   2 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
   3   "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
   4 <!-- SPDX-License-Identifier: LGPL-2.1+ -->
   5
   6 <refentry id="systemd-network-generator.service" conditional='ENABLE_NETWORKD'>
   7
   8   <refentryinfo>
   9     <title>systemd-network-generator.service</title>
  10     <productname>systemd</productname>
  11   </refentryinfo>
  12
  13   <refmeta>
  14     <refentrytitle>systemd-network-generator.service</refentrytitle>
  15     <manvolnum>8</manvolnum>
  16   </refmeta>
  17
  18   <refnamediv>
  19     <refname>systemd-network-generator.service</refname>
  20     <refname>systemd-network-generator</refname>
  21     <refpurpose>Generate network configuration from the kernel command line</refpurpose>
  22   </refnamediv>
  23
  24   <refsynopsisdiv>
  25     <para><filename>systemd-network-generator.service</filename></para>
  26     <para><filename>/usr/lib/systemd/systemd-network-generator</filename></para>
  27   </refsynopsisdiv>
  28
  29   <refsect1>
  30     <title>Description</title>
  31
  32     <para><filename>systemd-network-generator.service</filename> is a system service that translates
  33     <varname>ip=</varname> and the related settings on the kernel command line (see below) into
  34     <citerefentry><refentrytitle>systemd.network</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
  35     <citerefentry><refentrytitle>systemd.netdev</refentrytitle><manvolnum>5</manvolnum></citerefentry>, and
  36     <citerefentry><refentrytitle>systemd.link</refentrytitle><manvolnum>5</manvolnum></citerefentry>
  37     configuration files understood by
  38     <citerefentry><refentrytitle>systemd-networkd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>
  39     and
  40     <citerefentry><refentrytitle>systemd-udevd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
  41     </para>
  42
  43     <para>Files are generated in <filename>/run/systemd/network/</filename>.</para>
  44   </refsect1>
  45
  46   <refsect1><title>Kernel command line options</title>
  47   <para>This tool understands the following options:</para>
  48
  49     <variablelist class='kernel-commandline-options'>
  50       <varlistentry>
  51         <term><varname>ip=</varname></term>
  52         <term><varname>rd.route=</varname></term>
  53         <term><varname>rd.peerdns=</varname></term>
  54         <listitem>
  55           <para>— translated into
  56           <citerefentry><refentrytitle>systemd.network</refentrytitle><manvolnum>5</manvolnum></citerefentry> files.</para>
  57         </listitem>
  58       </varlistentry>
  59
  60       <varlistentry>
  61         <term><varname>ifname=</varname></term>
  62         <listitem>
  63           <para>— translated into
  64           <citerefentry><refentrytitle>systemd.link</refentrytitle><manvolnum>5</manvolnum></citerefentry> files.</para>
  65         </listitem>
  66       </varlistentry>
  67
  68       <varlistentry>
  69         <term><varname>vlan=</varname></term>
  70         <term><varname>bond=</varname></term>
  71         <term><varname>bridge=</varname></term>
  72         <term><varname>bootdev=</varname></term>
  73         <listitem>
  74           <para>— translated into
  75           <citerefentry><refentrytitle>systemd.netdev</refentrytitle><manvolnum>5</manvolnum></citerefentry> files.</para>
  76         </listitem>
  77       </varlistentry>
  78
  79       <!-- unsupported:
  80            team=<teammaster>:<teamslaves>
  81            bootdev=
  82            BOOTIF=
  83            bootdev=
  84            bootdev=
  85            bootdev=
  86       -->
  87     </variablelist>
  88
  89     <para>See
  90     <citerefentry project='man-pages'><refentrytitle>dracut.kernel</refentrytitle><manvolnum>7</manvolnum></citerefentry>
  91     for option syntax and details.</para>
  92   </refsect1>
  93
  94   <refsect1>
  95     <title>See Also</title>
  96     <para>
  97       <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
  98       <citerefentry><refentrytitle>systemd-networkd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
  99       <citerefentry project='man-pages'><refentrytitle>dracut</refentrytitle><manvolnum>8</manvolnum></citerefentry>
 100     </para>
 101   </refsect1>
 102
 103 </refentry>