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 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>hostname</command> [<replaceable>NAME</replaceable>]</term>
  72
  73         <listitem><para>If no argument is given, print the system hostname. If an
  74         optional argument <replaceable>NAME</replaceable> is provided then the command changes the
  75         system hostname to <replaceable>NAME</replaceable>. By default, this will alter the
  76         pretty, the static, and the transient hostname alike; however, if one or more of <option>--static</option>,
  77         <option>--transient</option>, <option>--pretty</option> are used, only the selected hostnames are changed. If
  78         the pretty hostname is being set, and static or transient are being set as well, the specified hostname will be
  79         simplified in regards to the character set used before the latter are updated. This is done by removing special
  80         characters and spaces. This ensures that the pretty and the static hostname are always closely related while
  81         still following the validity rules of the specific name. This simplification of the hostname string is not done
  82         if only the transient and/or static hostnames are set, and the pretty hostname is left untouched.</para>
  83
  84         <para>The static and transient hostnames must each be either a single DNS label (a string composed of
  85         7-bit ASCII lower-case characters and no spaces or dots, limited to the format allowed for DNS domain
  86         name labels), or a sequence of such labels separated by single dots that forms a valid DNS FQDN. The
  87         hostname must be at most 64 characters, which is a Linux limitation (DNS allows longer names).</para></listitem>
  88       </varlistentry>
  89
  90       <varlistentry>
  91         <term><command>icon-name</command> [<replaceable>NAME</replaceable>]</term>
  92
  93         <listitem><para>If no argument is given, print the icon name of the system. If an
  94         optional argument <replaceable>NAME</replaceable> is provided then the command changes the
  95         icon name to <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="https://standards.freedesktop.org/icon-naming-spec/icon-naming-spec-latest.html">Icon
  99         Naming Specification</ulink>.</para></listitem>
 100       </varlistentry>
 101
 102       <varlistentry>
 103         <term><command>chassis</command> [<replaceable>TYPE</replaceable>]</term>
 104
 105         <listitem><para>If no argument is given, print the chassis type. If an
 106         optional argument <replaceable>TYPE</replaceable> is provided then the command changes the
 107         chassis type to <replaceable>TYPE</replaceable>. The chassis type is used by
 108         some graphical applications to visualize the host or alter user interaction.
 109         Currently, the following chassis types are defined:
 110         <literal>desktop</literal>,
 111         <literal>laptop</literal>,
 112         <literal>convertible</literal>,
 113         <literal>server</literal>,
 114         <literal>tablet</literal>,
 115         <literal>handset</literal>,
 116         <literal>watch</literal>,
 117         <literal>embedded</literal>,
 118         as well as the special chassis types
 119         <literal>vm</literal> and
 120         <literal>container</literal> for virtualized systems that lack
 121         an immediate physical chassis.</para>
 122         </listitem>
 123       </varlistentry>
 124
 125       <varlistentry>
 126         <term><command>deployment</command> [<replaceable>ENVIRONMENT</replaceable>]</term>
 127
 128         <listitem><para>If no argument is given, print the deployment environment. If an
 129         optional argument <replaceable>ENVIRONMENT</replaceable> is provided then the command changes the
 130         deployment environment to <replaceable>ENVIRONMENT</replaceable>.
 131         Argument <replaceable>ENVIRONMENT</replaceable>
 132         must be a single word without any control characters. One of the following is suggested:
 133         <literal>development</literal>,
 134         <literal>integration</literal>,
 135         <literal>staging</literal>,
 136         <literal>production</literal>.
 137         </para>
 138         </listitem>
 139       </varlistentry>
 140
 141       <varlistentry>
 142         <term><command>location</command> [<replaceable>LOCATION</replaceable>]</term>
 143
 144         <listitem><para>If no argument is given, print the location string for the system. If an
 145         optional argument <replaceable>LOCATION</replaceable> is provided then the command changes the
 146         location string for the system to <replaceable>LOCATION</replaceable>.
 147         Argument <replaceable>LOCATION</replaceable> should be a
 148         human-friendly, free-form string describing the physical
 149         location of the system, if it is known and applicable. This
 150         may be as generic as <literal>Berlin, Germany</literal> or as
 151         specific as <literal>Left Rack, 2nd Shelf</literal>.</para>
 152         </listitem>
 153       </varlistentry>
 154     </variablelist>
 155   </refsect1>
 156
 157   <refsect1>
 158     <title>Options</title>
 159
 160     <para>The following options are understood:</para>
 161
 162     <variablelist>
 163       <varlistentry>
 164         <term><option>--no-ask-password</option></term>
 165
 166         <listitem><para>Do not query the user for authentication for
 167         privileged operations.</para></listitem>
 168       </varlistentry>
 169
 170       <varlistentry>
 171         <term><option>--static</option></term>
 172         <term><option>--transient</option></term>
 173         <term><option>--pretty</option></term>
 174
 175         <listitem><para>If <command>status</command> is invoked (or no explicit command is given) and one of these
 176         switches is specified, <command>hostnamectl</command> will print out just this selected hostname.</para>
 177
 178         <para>If used with <command>hostname</command>, only the selected hostnames will be updated. When more
 179         than one of these switches are specified, all the specified hostnames will be updated. </para></listitem>
 180       </varlistentry>
 181
 182       <xi:include href="user-system-options.xml" xpointer="host" />
 183       <xi:include href="user-system-options.xml" xpointer="machine" />
 184
 185       <xi:include href="standard-options.xml" xpointer="help" />
 186       <xi:include href="standard-options.xml" xpointer="version" />
 187       <xi:include href="standard-options.xml" xpointer="json" />
 188     </variablelist>
 189   </refsect1>
 190
 191   <refsect1>
 192     <title>Exit status</title>
 193
 194     <para>On success, 0 is returned, a non-zero failure code
 195     otherwise.</para>
 196   </refsect1>
 197
 198   <refsect1>
 199     <title>See Also</title>
 200     <para>
 201       <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
 202       <citerefentry><refentrytitle>hostname</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
 203       <citerefentry><refentrytitle>hostname</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
 204       <citerefentry><refentrytitle>machine-info</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
 205       <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
 206       <citerefentry><refentrytitle>systemd-hostnamed.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
 207       <citerefentry><refentrytitle>systemd-firstboot</refentrytitle><manvolnum>1</manvolnum></citerefentry>
 208     </para>
 209   </refsect1>
 210
 211 </refentry>