Blame man/nm-initrd-generator.xml

Packit Service b23acc
Packit Service b23acc
Packit Service b23acc
Packit Service b23acc
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
Packit Service b23acc
Packit Service b23acc
%entities;
Packit Service b23acc
]>
Packit Service b23acc
Packit Service b23acc
Packit Service b23acc
  nm-initrd-generator(8) manual page
Packit Service b23acc
Packit Service b23acc
  Copyright 2018 Red Hat, Inc.
Packit Service b23acc
Packit Service b23acc
  Permission is granted to copy, distribute and/or modify this document
Packit Service b23acc
  under the terms of the GNU Free Documentation License, Version 1.1
Packit Service b23acc
  or any later version published by the Free Software Foundation;
Packit Service b23acc
  with no Invariant Sections, no Front-Cover Texts, and no Back-Cover
Packit Service b23acc
  Texts. You may obtain a copy of the GNU Free Documentation License
Packit Service b23acc
  from the Free Software Foundation by visiting their Web site or by
Packit Service b23acc
  writing to:
Packit Service b23acc
Packit Service b23acc
  Free Software Foundation, Inc.,
Packit Service b23acc
  51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
Packit Service b23acc
-->
Packit Service b23acc
Packit Service b23acc
<refentry id='nm-initrd-generator'>
Packit Service b23acc
Packit Service b23acc
  <refentryinfo>
Packit Service b23acc
    <title>nm-initrd-generator</title>
Packit Service b23acc
    <author>NetworkManager developers</author>
Packit Service b23acc
  </refentryinfo>
Packit Service b23acc
Packit Service b23acc
  <refmeta>
Packit Service b23acc
    <refentrytitle>nm-initrd-generator</refentrytitle>
Packit Service b23acc
    <manvolnum>8</manvolnum>
Packit Service b23acc
    <refmiscinfo class="source">NetworkManager</refmiscinfo>
Packit Service b23acc
    <refmiscinfo class="manual">System Administration</refmiscinfo>
Packit Service b23acc
    <refmiscinfo class="version">&NM_VERSION;</refmiscinfo>
Packit Service b23acc
  </refmeta>
Packit Service b23acc
Packit Service b23acc
  <refnamediv>
Packit Service b23acc
    <refname>nm-initrd-generator</refname>
Packit Service b23acc
    <refpurpose>early boot NetworkManager configuration generator</refpurpose>
Packit Service b23acc
  </refnamediv>
Packit Service b23acc
Packit Service b23acc
  <refsynopsisdiv id='synopsis'>
Packit Service b23acc
    <cmdsynopsis>
Packit Service b23acc
      <command>nm-initrd-generator</command>
Packit Service b23acc
      <arg choice="opt" rep="repeat"><replaceable>OPTIONS</replaceable></arg>
Packit Service b23acc
      <arg choice="plain">--</arg>
Packit Service b23acc
      <arg choice="opt" rep="repeat"><replaceable>CMDLINE</replaceable></arg>
Packit Service b23acc
    </cmdsynopsis>
Packit Service b23acc
  </refsynopsisdiv>
Packit Service b23acc
Packit Service b23acc
  <refsect1 id='description'><title>Description</title>
Packit Service b23acc
    <para><command>nm-initrd-generator</command> scans the command line for options
Packit Service b23acc
    relevant to network configuration and creates configuration files for an early
Packit Service b23acc
    instance of NetworkManager run from the initial ramdisk during early boot.</para>
Packit Service b23acc
  </refsect1>
Packit Service b23acc
Packit Service b23acc
  <refsect1 id='options'><title>Options</title>
Packit Service b23acc
    <variablelist>
Packit Service b23acc
      <varlistentry>
Packit Service b23acc
        <term>
Packit Service b23acc
          <group choice='plain'>
Packit Service b23acc
            <arg choice='plain'><option>-c</option></arg>
Packit Service b23acc
            <arg choice='plain'><option>--connections-dir</option></arg>
Packit Service b23acc
          </group>
Packit Service b23acc
          <arg choice='plain'><replaceable>path</replaceable></arg>
Packit Service b23acc
        </term>
Packit Service b23acc
Packit Service b23acc
        <listitem>
Packit Service b23acc
          <para>Output connection directory.</para>
Packit Service b23acc
        </listitem>
Packit Service b23acc
      </varlistentry>
Packit Service b23acc
Packit Service b23acc
      <varlistentry>
Packit Service b23acc
        <term>
Packit Service b23acc
          <group choice='plain'>
Packit Service b23acc
            <arg choice='plain'><option>-i</option></arg>
Packit Service b23acc
            <arg choice='plain'><option>--initrd-data-dir</option></arg>
Packit Service b23acc
          </group>
Packit Service b23acc
          <arg choice='plain'><replaceable>path</replaceable></arg>
Packit Service b23acc
        </term>
Packit Service b23acc
Packit Service b23acc
        <listitem>
Packit Service b23acc
          <para>Output directory for initrd data (e.g. hostname).</para>
Packit Service b23acc
        </listitem>
Packit Service b23acc
      </varlistentry>
Packit Service b23acc
Packit Service b23acc
      <varlistentry>
Packit Service b23acc
        <term>
Packit Service b23acc
          <group choice='plain'>
Packit Service b23acc
            <arg choice='plain'><option>-d</option></arg>
Packit Service b23acc
            <arg choice='plain'><option>--sysfs-dir</option></arg>
Packit Service b23acc
          </group>
Packit Service b23acc
          <arg choice='plain'><replaceable>path</replaceable></arg>
Packit Service b23acc
        </term>
Packit Service b23acc
Packit Service b23acc
        <listitem>
Packit Service b23acc
          <para>The sysfs mount point.</para>
Packit Service b23acc
        </listitem>
Packit Service b23acc
      </varlistentry>
Packit Service b23acc
Packit Service b23acc
      <varlistentry>
Packit Service b23acc
        <term>
Packit Service b23acc
          <group choice='plain'>
Packit Service b23acc
            <arg choice='plain'><option>-s</option></arg>
Packit Service b23acc
            <arg choice='plain'><option>--stdout</option></arg>
Packit Service b23acc
          </group>
Packit Service b23acc
        </term>
Packit Service b23acc
Packit Service b23acc
        <listitem>
Packit Service b23acc
          <para>Dump connections to standard output. Useful for debugging.</para>
Packit Service b23acc
        </listitem>
Packit Service b23acc
      </varlistentry>
Packit Service b23acc
Packit Service b23acc
      <varlistentry>
Packit Service b23acc
        <term><replaceable>CMDLINE</replaceable></term>
Packit Service b23acc
Packit Service b23acc
        <listitem>
Packit Service b23acc
          <para>The options that appear on the kernel command line. The following options are recognized:</para>
Packit Service b23acc
Packit Service b23acc
          <simplelist>
Packit Service b23acc
            <member><option>ip</option></member>
Packit Service b23acc
            <member><option>rd.route</option></member>
Packit Service b23acc
            <member><option>bridge</option></member>
Packit Service b23acc
            <member><option>bond</option></member>
Packit Service b23acc
            <member><option>team</option></member>
Packit Service b23acc
            <member><option>vlan</option></member>
Packit Service b23acc
            <member><option>bootdev</option></member>
Packit Service b23acc
            <member><option>nameserver</option></member>
Packit Service b23acc
            <member><option>rd.peerdns</option></member>
Packit Service b23acc
            <member><option>rd.bootif</option></member>
Packit Service b23acc
            <member><option>rd.net.timeout.dhcp</option></member>
Packit Service b23acc
            <member><option>BOOTIF</option></member>
Packit Service b23acc
          </simplelist>
Packit Service b23acc
Packit Service b23acc
          <para>Please consult the <citerefentry><refentrytitle>dracut.cmdline</refentrytitle><manvolnum>7</manvolnum></citerefentry>
Packit Service b23acc
          manual for the documentation of the precise format of the values supported.</para>
Packit Service b23acc
        </listitem>
Packit Service b23acc
      </varlistentry>
Packit Service b23acc
    </variablelist>
Packit Service b23acc
  </refsect1>
Packit Service b23acc
Packit Service b23acc
  <refsect1 id='differences_from_network_legacy'><title>Differences from the network-legacy dracut module</title>
Packit Service b23acc
Packit Service b23acc
    <para><command>nm-initrd-generator</command> generates a set of
Packit Service b23acc
    connections that are then configured by the NetworkManager
Packit Service b23acc
    instance running in the initrd. There are some differences in
Packit Service b23acc
    behavior compared to the network-legacy dracut module:</para>
Packit Service b23acc
Packit Service b23acc
    <itemizedlist>
Packit Service b23acc
      <listitem>
Packit Service b23acc
        <para>When an interface is configured with a static address
Packit Service b23acc
        and a gateway, the network-legacy module waits that the
Packit Service b23acc
        gateway responds to arping requests before proceeding, while
Packit Service b23acc
        NetworkManager doesn't.</para>
Packit Service b23acc
      </listitem>
Packit Service b23acc
Packit Service b23acc
      <listitem>
Packit Service b23acc
        <para>network-legacy configures interfaces one by one in the
Packit Service b23acc
        order in which they are announced by udev. If multiple
Packit Service b23acc
        interfaces specify a hostname (from command line or from
Packit Service b23acc
        DHCP), the one from the last interface activated wins. With
Packit Service b23acc
        NetworkManager, hostnames from command line have higher
Packit Service b23acc
        precedence over ones from DHCP, and the last that appears in
Packit Service b23acc
        the command line wins.</para>
Packit Service b23acc
      </listitem>
Packit Service b23acc
Packit Service b23acc
    </itemizedlist>
Packit Service b23acc
  </refsect1>
Packit Service b23acc
Packit Service b23acc
  <refsect1 id='exit_status'><title>Exit Status</title>
Packit Service b23acc
    <para><command>nm-initrd-generator</command> exits with status 0. It ignores unrecognized
Packit Service b23acc
    options and prints an error message if it encounters a malformed option.</para>
Packit Service b23acc
  </refsect1>
Packit Service b23acc
Packit Service b23acc
  <refsect1 id='see_also'><title>See Also</title>
Packit Service b23acc
    <para><link linkend='dracut.cmdline'><citerefentry><refentrytitle>dracut.cmdline</refentrytitle><manvolnum>7</manvolnum></citerefentry></link>,
Packit Service b23acc
    <link linkend='NetworkManager'><citerefentry><refentrytitle>NetworkManager</refentrytitle><manvolnum>8</manvolnum></citerefentry></link>.</para>
Packit Service b23acc
  </refsect1>
Packit Service b23acc
</refentry>