man/hostnamectl.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 <!ENTITY % entities SYSTEM "custom-entities.ent" >
   5 %entities;
   6 ]>
   7 <!-- SPDX-License-Identifier: LGPL-2.1-or-later -->
   8
   9 <refentry id="hostnamectl" conditional='ENABLE_HOSTNAMED'
  10     xmlns:xi="http://www.w3.org/2001/XInclude">
  11
  12   <refentryinfo>
  13     <title>hostnamectl</title>
  14     <productname>systemd</productname>
  15   </refentryinfo>
  16
  17   <refmeta>
  18     <refentrytitle>hostnamectl</refentrytitle>
  19     <manvolnum>1</manvolnum>
  20   </refmeta>
  21
  22   <refnamediv>
  23     <refname>hostnamectl</refname>
  24     <refpurpose>Control the system hostname</refpurpose>
  25   </refnamediv>
  26
  27   <refsynopsisdiv>
  28     <cmdsynopsis>
  29       <command>hostnamectl</command>
  30       <arg choice="opt" rep="repeat">OPTIONS</arg>
  31       <arg choice="req">COMMAND</arg>
  32     </cmdsynopsis>
  33   </refsynopsisdiv>
  34
  35   <refsect1>
  36     <title>Description</title>
  37
  38     <para><command>hostnamectl</command> may be used to query and change the system hostname and related
  39     settings.</para>
  40
  41     <para><citerefentry><refentrytitle>systemd-hostnamed.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>
  42     and this tool distinguish three different hostnames: the high-level "pretty" hostname which might include
  43     all kinds of special characters (e.g. "Lennart's Laptop"), the "static" hostname which is the
  44     user-configured hostname (e.g. "lennarts-laptop"), and the transient hostname which is a fallback value
  45     received from network configuration (e.g. "node12345678"). If a static hostname is set to a valid value,
  46     then the transient hostname is not used.</para>
  47
  48     <para>Note that the pretty hostname has little restrictions on the characters and length used, while the static and
  49     transient hostnames are limited to the usually accepted characters of Internet domain names, and 64 characters at
  50     maximum (the latter being a Linux limitation).</para>
  51
  52     <para>Use
  53     <citerefentry><refentrytitle>systemd-firstboot</refentrytitle><manvolnum>1</manvolnum></citerefentry> to
  54     initialize the system hostname for mounted (but not booted) system images.</para>
  55   </refsect1>
  56
  57   <refsect1>
  58     <title>Commands</title>
  59
  60     <para>The following commands are understood:</para>
  61
  62     <variablelist>
  63       <varlistentry>
  64         <term><command>status</command></term>
  65
  66         <listitem><para>Show current system hostname and related information. If no command is specified,
  67         this is the implied default.</para></listitem>
  68       </varlistentry>
  69
  70       <varlistentry>
  71         <term><command>set-hostname <replaceable>NAME</replaceable></command></term>
  72
  73         <listitem><para>Set the system hostname to <replaceable>NAME</replaceable>. By default, this will alter the
  74         pretty, the static, and the transient hostname alike; however, if one or more of <option>--static</option>,
  75         <option>--transient</option>, <option>--pretty</option> are used, only the selected hostnames are changed. If
  76         the pretty hostname is being set, and static or transient are being set as well, the specified hostname will be
  77         simplified in regards to the character set used before the latter are updated. This is done by removing special
  78         characters and spaces. This ensures that the pretty and the static hostname are always closely related while
  79         still following the validity rules of the specific name. This simplification of the hostname string is not done
  80         if only the transient and/or static hostnames are set, and the pretty hostname is left untouched.</para>
  81
  82         <para>The static and transient hostnames must each be either a single DNS label (a string composed of
  83         7-bit ASCII lower-case characters and no spaces or dots, limited to the format allowed for DNS domain
  84         name labels), or a sequence of such labels separated by single dots that forms a valid DNS FQDN. The
  85         hostname must be at most 64 characters, which is a Linux limitation (DNS allows longer names).</para>
  86
  87         <para>Pass the empty string <literal></literal> as the hostname to reset the selected hostnames to
  88         their default (usually <literal>&FALLBACK_HOSTNAME;</literal>).</para></listitem>
  89       </varlistentry>
  90
  91       <varlistentry>
  92         <term><command>set-icon-name <replaceable>NAME</replaceable></command></term>
  93
  94         <listitem><para>Set the system icon name to
  95         <replaceable>NAME</replaceable>. The icon name is used by some
  96         graphical applications to visualize this host. The icon name
  97         should follow the <ulink
  98         url="http://standards.freedesktop.org/icon-naming-spec/icon-naming-spec-latest.html">Icon
  99         Naming Specification</ulink>.</para>
 100
 101         <para>Pass an empty string to reset the icon name to the
 102         default value, which is determined from chassis type (see
 103         below) and possibly other parameters.</para></listitem>
 104       </varlistentry>
 105
 106       <varlistentry>
 107         <term><command>set-chassis <replaceable>TYPE</replaceable></command></term>
 108
 109         <listitem><para>Set the chassis type to
 110         <replaceable>TYPE</replaceable>. The chassis type is used by
 111         some graphical applications to visualize the host or alter
 112         user interaction. Currently, the following chassis types are
 113         defined:
 114         <literal>desktop</literal>,
 115         <literal>laptop</literal>,
 116         <literal>convertible</literal>,
 117         <literal>server</literal>,
 118         <literal>tablet</literal>,
 119         <literal>handset</literal>,
 120         <literal>watch</literal>,
 121         <literal>embedded</literal>,
 122         as well as the special chassis types
 123         <literal>vm</literal> and
 124         <literal>container</literal> for virtualized systems that lack
 125         an immediate physical chassis.</para>
 126
 127         <para>Pass an empty string to reset the chassis type to the
 128         default value which is determined from the firmware and
 129         possibly other parameters.</para>
 130         </listitem>
 131       </varlistentry>
 132
 133       <varlistentry>
 134         <term><command>set-deployment <replaceable>ENVIRONMENT</replaceable></command></term>
 135
 136         <listitem><para>Set the deployment environment description.
 137         <replaceable>ENVIRONMENT</replaceable> must be a single word
 138         without any control characters. One of the following is
 139         suggested:
 140         <literal>development</literal>,
 141         <literal>integration</literal>,
 142         <literal>staging</literal>,
 143         <literal>production</literal>.
 144         </para>
 145
 146         <para>Pass an empty string to reset to the default empty
 147         value.</para>
 148         </listitem>
 149       </varlistentry>
 150
 151       <varlistentry>
 152         <term><command>set-location <replaceable>LOCATION</replaceable></command></term>
 153
 154         <listitem><para>Set the location string for the system, if it
 155         is known. <replaceable>LOCATION</replaceable> should be a
 156         human-friendly, free-form string describing the physical
 157         location of the system, if it is known and applicable. This
 158         may be as generic as <literal>Berlin, Germany</literal> or as
 159         specific as <literal>Left Rack, 2nd Shelf</literal>.</para>
 160
 161         <para>Pass an empty string to reset to the default empty
 162         value.</para>
 163         </listitem>
 164       </varlistentry>
 165     </variablelist>
 166   </refsect1>
 167
 168   <refsect1>
 169     <title>Options</title>
 170
 171     <para>The following options are understood:</para>
 172
 173     <variablelist>
 174       <varlistentry>
 175         <term><option>--no-ask-password</option></term>
 176
 177         <listitem><para>Do not query the user for authentication for
 178         privileged operations.</para></listitem>
 179       </varlistentry>
 180
 181       <varlistentry>
 182         <term><option>--static</option></term>
 183         <term><option>--transient</option></term>
 184         <term><option>--pretty</option></term>
 185
 186         <listitem><para>If <command>status</command> is invoked (or no explicit command is given) and one of these
 187         switches is specified, <command>hostnamectl</command> will print out just this selected hostname.</para>
 188
 189         <para>If used with <command>set-hostname</command>, only the selected hostname(s) will be updated. When more
 190         than one of these switches are specified, all the specified hostnames will be updated. </para></listitem>
 191       </varlistentry>
 192
 193       <xi:include href="user-system-options.xml" xpointer="host" />
 194       <xi:include href="user-system-options.xml" xpointer="machine" />
 195
 196       <xi:include href="standard-options.xml" xpointer="help" />
 197       <xi:include href="standard-options.xml" xpointer="version" />
 198       <xi:include href="standard-options.xml" xpointer="json" />
 199     </variablelist>
 200   </refsect1>
 201
 202   <refsect1>
 203     <title>Exit status</title>
 204
 205     <para>On success, 0 is returned, a non-zero failure code
 206     otherwise.</para>
 207   </refsect1>
 208
 209   <refsect1>
 210     <title>See Also</title>
 211     <para>
 212       <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
 213       <citerefentry><refentrytitle>hostname</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
 214       <citerefentry><refentrytitle>hostname</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
 215       <citerefentry><refentrytitle>machine-info</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
 216       <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
 217       <citerefentry><refentrytitle>systemd-hostnamed.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
 218       <citerefentry><refentrytitle>systemd-firstboot</refentrytitle><manvolnum>1</manvolnum></citerefentry>
 219     </para>
 220   </refsect1>
 221
 222 </refentry>