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