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>
  88
  89         <xi:include href="version-info.xml" xpointer="v249"/></listitem>
  90       </varlistentry>
  91
  92       <varlistentry>
  93         <term><command>icon-name</command> [<replaceable>NAME</replaceable>]</term>
  94
  95         <listitem><para>If no argument is given, print the icon name of the system. If an
  96         optional argument <replaceable>NAME</replaceable> is provided then the command changes the
  97         icon name to <replaceable>NAME</replaceable>. The icon name is used by some
  98         graphical applications to visualize this host. The icon name
  99         should follow the <ulink
 100         url="https://standards.freedesktop.org/icon-naming-spec/icon-naming-spec-latest.html">Icon
 101         Naming Specification</ulink>.</para>
 102
 103         <xi:include href="version-info.xml" xpointer="v249"/></listitem>
 104       </varlistentry>
 105
 106       <varlistentry>
 107         <term><command>chassis</command> [<replaceable>TYPE</replaceable>]</term>
 108
 109         <listitem><para>If no argument is given, print the chassis type. If an
 110         optional argument <replaceable>TYPE</replaceable> is provided then the command changes the
 111         chassis type to <replaceable>TYPE</replaceable>. The chassis type is used by
 112         some graphical applications to visualize the host or alter user interaction.
 113         Currently, the following chassis types are 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         <xi:include href="version-info.xml" xpointer="v249"/>
 128         </listitem>
 129       </varlistentry>
 130
 131       <varlistentry>
 132         <term><command>deployment</command> [<replaceable>ENVIRONMENT</replaceable>]</term>
 133
 134         <listitem><para>If no argument is given, print the deployment environment. If an
 135         optional argument <replaceable>ENVIRONMENT</replaceable> is provided then the command changes the
 136         deployment environment to <replaceable>ENVIRONMENT</replaceable>.
 137         Argument <replaceable>ENVIRONMENT</replaceable>
 138         must be a single word without any control characters. One of the following is suggested:
 139         <literal>development</literal>,
 140         <literal>integration</literal>,
 141         <literal>staging</literal>,
 142         <literal>production</literal>.
 143         </para>
 144
 145         <xi:include href="version-info.xml" xpointer="v249"/>
 146         </listitem>
 147       </varlistentry>
 148
 149       <varlistentry>
 150         <term><command>location</command> [<replaceable>LOCATION</replaceable>]</term>
 151
 152         <listitem><para>If no argument is given, print the location string for the system. If an
 153         optional argument <replaceable>LOCATION</replaceable> is provided then the command changes the
 154         location string for the system to <replaceable>LOCATION</replaceable>.
 155         Argument <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         <xi:include href="version-info.xml" xpointer="v249"/>
 162         </listitem>
 163       </varlistentry>
 164     </variablelist>
 165   </refsect1>
 166
 167   <refsect1>
 168     <title>Options</title>
 169
 170     <para>The following options are understood:</para>
 171
 172     <variablelist>
 173       <varlistentry>
 174         <term><option>--no-ask-password</option></term>
 175
 176         <listitem><para>Do not query the user for authentication for
 177         privileged operations.</para>
 178
 179         <xi:include href="version-info.xml" xpointer="v195"/></listitem>
 180       </varlistentry>
 181
 182       <varlistentry>
 183         <term><option>--static</option></term>
 184         <term><option>--transient</option></term>
 185         <term><option>--pretty</option></term>
 186
 187         <listitem><para>If <command>status</command> is invoked (or no explicit command is given) and one of these
 188         switches is specified, <command>hostnamectl</command> will print out just this selected hostname.</para>
 189
 190         <para>If used with <command>hostname</command>, only the selected hostnames will be updated. When more
 191         than one of these switches are specified, all the specified hostnames will be updated. </para>
 192
 193         <xi:include href="version-info.xml" xpointer="v195"/></listitem>
 194       </varlistentry>
 195
 196       <xi:include href="user-system-options.xml" xpointer="host" />
 197       <xi:include href="user-system-options.xml" xpointer="machine" />
 198
 199       <xi:include href="standard-options.xml" xpointer="help" />
 200       <xi:include href="standard-options.xml" xpointer="version" />
 201       <xi:include href="standard-options.xml" xpointer="json" />
 202     </variablelist>
 203   </refsect1>
 204
 205   <refsect1>
 206     <title>Exit status</title>
 207
 208     <para>On success, 0 is returned, a non-zero failure code
 209     otherwise.</para>
 210   </refsect1>
 211
 212   <refsect1>
 213     <title>See Also</title>
 214     <para>
 215       <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
 216       <citerefentry><refentrytitle>hostname</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
 217       <citerefentry><refentrytitle>hostname</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
 218       <citerefentry><refentrytitle>machine-info</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
 219       <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
 220       <citerefentry><refentrytitle>systemd-hostnamed.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
 221       <citerefentry><refentrytitle>systemd-firstboot</refentrytitle><manvolnum>1</manvolnum></citerefentry>
 222     </para>
 223   </refsect1>
 224
 225 </refentry>