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 This file is part of systemd.
8 Copyright 2012 Lennart Poettering
10 systemd is free software; you can redistribute it and/or modify it
11 under the terms of the GNU Lesser General Public License as published by
12 the Free Software Foundation; either version 2.1 of the License, or
13 (at your option) any later version.
15 systemd is distributed in the hope that it will be useful, but
16 WITHOUT ANY WARRANTY; without even the implied warranty of
17 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
18 Lesser General Public License for more details.
20 You should have received a copy of the GNU Lesser General Public License
21 along with systemd; If not, see <http://www.gnu.org/licenses/>.
24 <refentry id="hostnamectl" conditional='ENABLE_HOSTNAMED'
25 xmlns:xi="http://www.w3.org/2001/XInclude">
28 <title>hostnamectl</title>
29 <productname>systemd</productname>
33 <contrib>Developer</contrib>
34 <firstname>Lennart</firstname>
35 <surname>Poettering</surname>
36 <email>lennart@poettering.net</email>
42 <refentrytitle>hostnamectl</refentrytitle>
43 <manvolnum>1</manvolnum>
47 <refname>hostnamectl</refname>
48 <refpurpose>Control the system hostname</refpurpose>
53 <command>hostnamectl</command>
54 <arg choice="opt" rep="repeat">OPTIONS</arg>
55 <arg choice="req">COMMAND</arg>
60 <title>Description</title>
62 <para><command>hostnamectl</command> may be used to
63 query and change the system hostname and related
66 <para>This tool distinguishes three different
67 hostnames: the high-level "pretty" hostname which
68 might include all kinds of special characters
69 (e.g. "Lennart's Laptop"), the static hostname which
70 is used to initialize the kernel hostname at boot
71 (e.g. "lennarts-laptop"), and the transient hostname
72 which is a default received from network configuration.
73 If a static hostname is set, and is valid (something other
74 than localhost), then the transient hostname is not used.</para>
76 <para>Note that the pretty hostname has little
77 restrictions on the characters used, while the static
78 and transient hostnames are limited to the usually
79 accepted characters of Internet domain names.</para>
81 <para>The static hostname is stored in
82 <filename>/etc/hostname</filename>, see
83 <citerefentry><refentrytitle>hostname</refentrytitle><manvolnum>5</manvolnum></citerefentry>
84 for more information. The pretty hostname, chassis
85 type, and icon name are stored in
86 <filename>/etc/machine-info</filename>, see
87 <citerefentry><refentrytitle>machine-info</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para>
90 <citerefentry><refentrytitle>systemd-firstboot</refentrytitle><manvolnum>1</manvolnum></citerefentry>
91 to initialize the system host name for mounted (but
92 not booted) system images.</para>
96 <title>Options</title>
98 <para>The following options are understood:</para>
102 <term><option>--no-ask-password</option></term>
104 <listitem><para>Do not query the user
105 for authentication for privileged
106 operations.</para></listitem>
110 <term><option>--static</option></term>
111 <term><option>--transient</option></term>
112 <term><option>--pretty</option></term>
115 <command>status</command> is used (or
116 no explicit command is given) and one
117 of those fields is given,
118 <command>hostnamectl</command> will
119 print out just this selected
123 <command>set-hostname</command>, only
124 the selected hostname(s) will be
125 updated. When more than one of those
126 options is used, all the specified
127 hostnames will be updated.
131 <xi:include href="user-system-options.xml" xpointer="host" />
133 <xi:include href="standard-options.xml" xpointer="help" />
134 <xi:include href="standard-options.xml" xpointer="version" />
137 <para>The following commands are understood:</para>
141 <term><command>status</command></term>
143 <listitem><para>Show current system
145 information.</para></listitem>
149 <term><command>set-hostname [NAME]</command></term>
151 <listitem><para>Set the system
152 hostname. By default, this will alter
153 the pretty, the static, and the
154 transient hostname alike; however, if
156 <option>--static</option>,
157 <option>--transient</option>,
158 <option>--pretty</option> are used,
159 only the selected hostnames are
160 changed. If the pretty hostname is
161 being set, and static or transient are
162 being set as well, the specified
163 hostname will be simplified in regards
164 to the character set used before the
165 latter are updated. This is done by
166 replacing spaces with
167 <literal>-</literal> and removing
168 special characters. This ensures that
169 the pretty and the static hostname are
170 always closely related while still
171 following the validity rules of the
172 specific name. This simplification of
173 the hostname string is not done if
174 only the transient and/or static host
175 names are set, and the pretty host
176 name is left untouched. Pass the empty
177 string <literal></literal> as the
178 hostname to reset the selected
179 hostnames to their default (usually
180 <literal>localhost</literal>).</para></listitem>
184 <term><command>set-icon-name [NAME]</command></term>
186 <listitem><para>Set the system icon
187 name. The icon name is used by some
188 graphical applications to visualize
189 this host. The icon name should follow
191 url="http://standards.freedesktop.org/icon-naming-spec/icon-naming-spec-latest.html">Icon
192 Naming Specification</ulink>. Pass an
193 empty string to this operation to
194 reset the icon name to the default
195 value, which is determined from chassis
196 type (see below) and possibly other
197 parameters.</para></listitem>
201 <term><command>set-chassis [TYPE]</command></term>
203 <listitem><para>Set the chassis
204 type. The chassis type is used by some
205 graphical applications to visualize
206 the host or alter user
207 interaction. Currently, the following
208 chassis types are defined:
209 <literal>desktop</literal>,
210 <literal>laptop</literal>,
211 <literal>server</literal>,
212 <literal>tablet</literal>,
213 <literal>handset</literal>, as well as
214 the special chassis types
215 <literal>vm</literal> and
216 <literal>container</literal> for
217 virtualized systems that lack an
218 immediate physical chassis. Pass an
219 empty string to this operation to
220 reset the chassis type to the default
221 value which is determined from the
222 firmware and possibly other
223 parameters.</para></listitem>
230 <title>Exit status</title>
232 <para>On success, 0 is returned, a non-zero failure
233 code otherwise.</para>
237 <title>See Also</title>
239 <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
240 <citerefentry><refentrytitle>hostname</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
241 <citerefentry><refentrytitle>hostname</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
242 <citerefentry><refentrytitle>machine-info</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
243 <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
244 <citerefentry><refentrytitle>systemd-hostnamed.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
245 <citerefentry><refentrytitle>systemd-firstboot</refentrytitle><manvolnum>1</manvolnum></citerefentry>