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">
6 SPDX-License-Identifier: LGPL-2.1+
8 This file is part of systemd.
10 Copyright 2012 Lennart Poettering
12 systemd is free software; you can redistribute it and/or modify it
13 under the terms of the GNU Lesser General Public License as published by
14 the Free Software Foundation; either version 2.1 of the License, or
15 (at your option) any later version.
17 systemd is distributed in the hope that it will be useful, but
18 WITHOUT ANY WARRANTY; without even the implied warranty of
19 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
20 Lesser General Public License for more details.
22 You should have received a copy of the GNU Lesser General Public License
23 along with systemd; If not, see <http://www.gnu.org/licenses/>.
26 <refentry id=
"hostnamectl" conditional='ENABLE_HOSTNAMED'
27 xmlns:
xi=
"http://www.w3.org/2001/XInclude">
30 <title>hostnamectl
</title>
31 <productname>systemd
</productname>
35 <contrib>Developer
</contrib>
36 <firstname>Lennart
</firstname>
37 <surname>Poettering
</surname>
38 <email>lennart@poettering.net
</email>
44 <refentrytitle>hostnamectl
</refentrytitle>
45 <manvolnum>1</manvolnum>
49 <refname>hostnamectl
</refname>
50 <refpurpose>Control the system hostname
</refpurpose>
55 <command>hostnamectl
</command>
56 <arg choice=
"opt" rep=
"repeat">OPTIONS
</arg>
57 <arg choice=
"req">COMMAND
</arg>
62 <title>Description
</title>
64 <para><command>hostnamectl
</command> may be used to query and
65 change the system hostname and related settings.
</para>
67 <para>This tool distinguishes three different hostnames: the
68 high-level
"pretty" hostname which might include all kinds of
69 special characters (e.g.
"Lennart's Laptop"), the static hostname
70 which is used to initialize the kernel hostname at boot (e.g.
71 "lennarts-laptop"), and the transient hostname which is a fallback
72 value received from network configuration. If a static hostname is
73 set, and is valid (something other than localhost), then the
74 transient hostname is not used.
</para>
76 <para>Note that the pretty hostname has little restrictions on the characters and length used, while the static and
77 transient hostnames are limited to the usually accepted characters of Internet domain names, and
64 characters at
78 maximum (the latter being a Linux limitation).
</para>
80 <para>The static hostname is stored in
81 <filename>/etc/hostname
</filename>, see
82 <citerefentry><refentrytitle>hostname
</refentrytitle><manvolnum>5</manvolnum></citerefentry>
83 for more information. The pretty hostname, chassis type, and icon
84 name are stored in
<filename>/etc/machine-info
</filename>, see
85 <citerefentry><refentrytitle>machine-info
</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
</para>
88 <citerefentry><refentrytitle>systemd-firstboot
</refentrytitle><manvolnum>1</manvolnum></citerefentry>
89 to initialize the system host name for mounted (but not booted)
94 <title>Options
</title>
96 <para>The following options are understood:
</para>
100 <term><option>--no-ask-password
</option></term>
102 <listitem><para>Do not query the user for authentication for
103 privileged operations.
</para></listitem>
107 <term><option>--static
</option></term>
108 <term><option>--transient
</option></term>
109 <term><option>--pretty
</option></term>
111 <listitem><para>If
<command>status
</command> is invoked (or no explicit command is given) and one of these
112 switches is specified,
<command>hostnamectl
</command> will print out just this selected hostname.
</para>
114 <para>If used with
<command>set-hostname
</command>, only the selected hostname(s) will be updated. When more
115 than one of these switches are specified, all the specified hostnames will be updated.
</para></listitem>
118 <xi:include href=
"user-system-options.xml" xpointer=
"host" />
119 <xi:include href=
"user-system-options.xml" xpointer=
"machine" />
121 <xi:include href=
"standard-options.xml" xpointer=
"help" />
122 <xi:include href=
"standard-options.xml" xpointer=
"version" />
125 <para>The following commands are understood:
</para>
129 <term><command>status
</command></term>
131 <listitem><para>Show current system
133 information.
</para></listitem>
137 <term><command>set-hostname
<replaceable>NAME
</replaceable></command></term>
139 <listitem><para>Set the system hostname to
<replaceable>NAME
</replaceable>. By default, this will alter the
140 pretty, the static, and the transient hostname alike; however, if one or more of
<option>--static
</option>,
141 <option>--transient
</option>,
<option>--pretty
</option> are used, only the selected hostnames are changed. If
142 the pretty hostname is being set, and static or transient are being set as well, the specified hostname will be
143 simplified in regards to the character set used before the latter are updated. This is done by removing special
144 characters and spaces. This ensures that the pretty and the static hostname are always closely related while
145 still following the validity rules of the specific name. This simplification of the hostname string is not done
146 if only the transient and/or static host names are set, and the pretty host name is left untouched.
</para>
148 <para>Pass the empty string
<literal></literal> as the
149 hostname to reset the selected hostnames to their default
150 (usually
<literal>localhost
</literal>).
</para></listitem>
154 <term><command>set-icon-name
<replaceable>NAME
</replaceable></command></term>
156 <listitem><para>Set the system icon name to
157 <replaceable>NAME
</replaceable>. The icon name is used by some
158 graphical applications to visualize this host. The icon name
159 should follow the
<ulink
160 url=
"http://standards.freedesktop.org/icon-naming-spec/icon-naming-spec-latest.html">Icon
161 Naming Specification
</ulink>.
</para>
163 <para>Pass an empty string to reset the icon name to the
164 default value, which is determined from chassis type (see
165 below) and possibly other parameters.
</para></listitem>
169 <term><command>set-chassis
<replaceable>TYPE
</replaceable></command></term>
171 <listitem><para>Set the chassis type to
172 <replaceable>TYPE
</replaceable>. The chassis type is used by
173 some graphical applications to visualize the host or alter
174 user interaction. Currently, the following chassis types are
176 <literal>desktop
</literal>,
177 <literal>laptop
</literal>,
178 <literal>convertible
</literal>,
179 <literal>server
</literal>,
180 <literal>tablet
</literal>,
181 <literal>handset
</literal>,
182 <literal>watch
</literal>,
183 <literal>embedded
</literal>,
184 as well as the special chassis types
185 <literal>vm
</literal> and
186 <literal>container
</literal> for virtualized systems that lack
187 an immediate physical chassis.
</para>
189 <para>Pass an empty string to reset the chassis type to the
190 default value which is determined from the firmware and
191 possibly other parameters.
</para>
196 <term><command>set-deployment
<replaceable>ENVIRONMENT
</replaceable></command></term>
198 <listitem><para>Set the deployment environment description.
199 <replaceable>ENVIRONMENT
</replaceable> must be a single word
200 without any control characters. One of the following is
202 <literal>development
</literal>,
203 <literal>integration
</literal>,
204 <literal>staging
</literal>,
205 <literal>production
</literal>.
208 <para>Pass an empty string to reset to the default empty
214 <term><command>set-location
<replaceable>LOCATION
</replaceable></command></term>
216 <listitem><para>Set the location string for the system, if it
217 is known.
<replaceable>LOCATION
</replaceable> should be a
218 human-friendly, free-form string describing the physical
219 location of the system, if it is known and applicable. This
220 may be as generic as
<literal>Berlin, Germany
</literal> or as
221 specific as
<literal>Left Rack,
2nd Shelf
</literal>.
</para>
223 <para>Pass an empty string to reset to the default empty
231 <title>Exit status
</title>
233 <para>On success,
0 is returned, a non-zero failure code
238 <title>See Also
</title>
240 <citerefentry><refentrytitle>systemd
</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
241 <citerefentry><refentrytitle>hostname
</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
242 <citerefentry><refentrytitle>hostname
</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
243 <citerefentry><refentrytitle>machine-info
</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
244 <citerefentry><refentrytitle>systemctl
</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
245 <citerefentry><refentrytitle>systemd-hostnamed.service
</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
246 <citerefentry><refentrytitle>systemd-firstboot
</refentrytitle><manvolnum>1</manvolnum></citerefentry>