man/systemd-machine-id-setup.xml

   1 <?xml version='1.0'?> <!--*-nxml-*-->
   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 2012 Lennart Poettering
   9
  10   systemd is free software; you can redistribute it and/or modify it
  11   under the terms of the GNU General Public License as published by
  12   the Free Software Foundation; either version 2 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   General Public License for more details.
  19
  20   You should have received a copy of the GNU General Public License
  21   along with systemd; If not, see <http://www.gnu.org/licenses/>.
  22 -->
  23
  24 <refentry id="systemd-machine-id-setup">
  25
  26         <refentryinfo>
  27                 <title>systemd-machine-id-setup</title>
  28                 <productname>systemd</productname>
  29
  30                 <authorgroup>
  31                         <author>
  32                                 <contrib>Developer</contrib>
  33                                 <firstname>Lennart</firstname>
  34                                 <surname>Poettering</surname>
  35                                 <email>lennart@poettering.net</email>
  36                         </author>
  37                 </authorgroup>
  38         </refentryinfo>
  39
  40         <refmeta>
  41                 <refentrytitle>systemd-machine-id-setup</refentrytitle>
  42                 <manvolnum>1</manvolnum>
  43         </refmeta>
  44
  45         <refnamediv>
  46                 <refname>systemd-machine-id-setup</refname>
  47                 <refpurpose>Initialize the machine ID in <filename>/etc/machine-id</filename></refpurpose>
  48         </refnamediv>
  49
  50         <refsynopsisdiv>
  51                 <cmdsynopsis>
  52                         <command>systemd-machine-id-setup</command>
  53                 </cmdsynopsis>
  54         </refsynopsisdiv>
  55
  56         <refsect1>
  57                 <title>Description</title>
  58
  59                 <para><command>systemd-machine-id-setup</command> may
  60                 be used by system installer tools to initialize the
  61                 machine ID stored in
  62                 <filename>/etc/machine-id</filename> at install time
  63                 with a randomly generated ID. See
  64                 <citerefentry><refentrytitle>machine-id</refentrytitle><manvolnum>5</manvolnum></citerefentry>
  65                 for more information about this file.</para>
  66
  67                 <para>This tool will execute no operation if
  68                 <filename>/etc/machine-id</filename> is already
  69                 initialized.</para>
  70
  71                 <para>If a valid D-Bus machine ID is already
  72                 configured for the system the D-Bus machine ID is
  73                 copied and used to initialize the machine ID in
  74                 <filename>/etc/machine-id</filename>.</para>
  75
  76                 <para>If run inside a KVM virtual machine and a UUID
  77                 is passed via the <option>-uuid</option> option this
  78                 UUID is used to initialize the machine ID instead of a
  79                 randomly generated one. The caller must ensure that the
  80                 UUID passed is sufficiently unique and is different
  81                 for every booted instanced of the VM.</para>
  82
  83                 <para>Similar, if run inside a Linux container
  84                 environment and a UUID is set for the container this
  85                 is used to initialize the machine ID. For details see
  86                 the documentation of the <ulink
  87                 url="http://www.freedesktop.org/wiki/Software/systemd/ContainerInterface">Container
  88                 Interface</ulink>.</para>
  89
  90         </refsect1>
  91
  92         <refsect1>
  93                 <title>Options</title>
  94
  95                 <para>This tool does not take any options or arguments.</para>
  96         </refsect1>
  97
  98         <refsect1>
  99                 <title>Exit status</title>
 100
 101                 <para>On success 0 is returned, a non-zero failure
 102                 code otherwise.</para>
 103         </refsect1>
 104
 105         <refsect1>
 106                 <title>See Also</title>
 107                 <para>
 108                         <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
 109                         <citerefentry><refentrytitle>machine-id</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
 110                         <citerefentry><refentrytitle>dbus-uuidgen</refentrytitle><manvolnum>1</manvolnum></citerefentry>
 111                 </para>
 112         </refsect1>
 113
 114 </refentry>