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 query and
63 change the system hostname and related settings.</para>
65 <para>This tool distinguishes three different hostnames: the
66 high-level "pretty" hostname which might include all kinds of
67 special characters (e.g. "Lennart's Laptop"), the static hostname
68 which is used to initialize the kernel hostname at boot (e.g.
69 "lennarts-laptop"), and the transient hostname which is a default
70 received from network configuration. If a static hostname is set,
71 and is valid (something other than localhost), then the transient
72 hostname is not used.</para>
74 <para>Note that the pretty hostname has little restrictions on the
75 characters used, while the static and transient hostnames are
76 limited to the usually accepted characters of Internet domain
79 <para>The static hostname is stored in
80 <filename>/etc/hostname</filename>, see
81 <citerefentry><refentrytitle>hostname</refentrytitle><manvolnum>5</manvolnum></citerefentry>
82 for more information. The pretty hostname, chassis type, and icon
83 name are stored in <filename>/etc/machine-info</filename>, see
84 <citerefentry><refentrytitle>machine-info</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para>
87 <citerefentry><refentrytitle>systemd-firstboot</refentrytitle><manvolnum>1</manvolnum></citerefentry>
88 to initialize the system host name for mounted (but not booted)
93 <title>Options</title>
95 <para>The following options are understood:</para>
99 <term><option>--no-ask-password</option></term>
101 <listitem><para>Do not query the user for authentication for
102 privileged operations.</para></listitem>
106 <term><option>--static</option></term>
107 <term><option>--transient</option></term>
108 <term><option>--pretty</option></term>
110 <listitem><para>If <command>status</command> is used (or no
111 explicit command is given) and one of those fields is given,
112 <command>hostnamectl</command> will print out just this
113 selected hostname.</para>
115 <para>If used with <command>set-hostname</command>, only the
116 selected hostname(s) will be updated. When more than one of
117 those options is used, all the specified hostnames will be
118 updated. </para></listitem>
121 <xi:include href="user-system-options.xml" xpointer="host" />
122 <xi:include href="user-system-options.xml" xpointer="machine" />
124 <xi:include href="standard-options.xml" xpointer="help" />
125 <xi:include href="standard-options.xml" xpointer="version" />
128 <para>The following commands are understood:</para>
132 <term><command>status</command></term>
134 <listitem><para>Show current system
136 information.</para></listitem>
140 <term><command>set-hostname <replaceable>NAME</replaceable></command></term>
142 <listitem><para>Set the system hostname to
143 <replaceable>NAME</replaceable>. By default, this will alter
144 the pretty, the static, and the transient hostname alike;
145 however, if one or more of <option>--static</option>,
146 <option>--transient</option>, <option>--pretty</option> are
147 used, only the selected hostnames are changed. If the pretty
148 hostname is being set, and static or transient are being set
149 as well, the specified hostname will be simplified in regards
150 to the character set used before the latter are updated. This
151 is done by replacing spaces with <literal>-</literal> and
152 removing special characters. This ensures that the pretty and
153 the static hostname are always closely related while still
154 following the validity rules of the specific name. This
155 simplification of the hostname string is not done if only the
156 transient and/or static host names are set, and the pretty
157 host name is left untouched.</para>
159 <para>Pass the empty string <literal></literal> as the
160 hostname to reset the selected hostnames to their default
161 (usually <literal>localhost</literal>).</para></listitem>
165 <term><command>set-icon-name <replaceable>NAME</replaceable></command></term>
167 <listitem><para>Set the system icon name to
168 <replaceable>NAME</replaceable>. The icon name is used by some
169 graphical applications to visualize this host. The icon name
170 should follow the <ulink
171 url="http://standards.freedesktop.org/icon-naming-spec/icon-naming-spec-latest.html">Icon
172 Naming Specification</ulink>.</para>
174 <para>Pass an empty string to reset the icon name to the
175 default value, which is determined from chassis type (see
176 below) and possibly other parameters.</para></listitem>
180 <term><command>set-chassis <replaceable>TYPE</replaceable></command></term>
182 <listitem><para>Set the chassis type to
183 <replaceable>TYPE</replaceable>. The chassis type is used by
184 some graphical applications to visualize the host or alter
185 user interaction. Currently, the following chassis types are
187 <literal>desktop</literal>,
188 <literal>laptop</literal>,
189 <literal>server</literal>,
190 <literal>tablet</literal>,
191 <literal>handset</literal>,
192 <literal>watch</literal>,
193 <literal>embedded</literal>,
194 as well as the special chassis types
195 <literal>vm</literal> and
196 <literal>container</literal> for virtualized systems that lack
197 an immediate physical chassis.</para>
199 <para>Pass an empty string to reset the chassis type to the
200 default value which is determined from the firmware and
201 possibly other parameters.</para>
206 <term><command>set-deployment <replaceable>ENVIRONMENT</replaceable></command></term>
208 <listitem><para>Set the deployment environment description.
209 <replaceable>ENVIRONMENT</replaceable> must be a single word
210 without any control characters. One of the following is
212 <literal>development</literal>,
213 <literal>integration</literal>,
214 <literal>staging</literal>,
215 <literal>production</literal>.
218 <para>Pass an empty string to reset to the default empty
224 <term><command>set-location <replaceable>LOCATION</replaceable></command></term>
226 <listitem><para>Set the location string for the system, if it
227 is known. <replaceable>LOCATION</replaceable> should be a
228 human-friendly, free-form string describing the physical
229 location of the system, if it is known and applicable. This
230 may be as generic as <literal>Berlin, Germany</literal> or as
231 specific as <literal>Left Rack, 2nd Shelf</literal>.</para>
233 <para>Pass an empty string to reset to the default empty
241 <title>Exit status</title>
243 <para>On success, 0 is returned, a non-zero failure code
248 <title>See Also</title>
250 <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
251 <citerefentry><refentrytitle>hostname</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
252 <citerefentry><refentrytitle>hostname</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
253 <citerefentry><refentrytitle>machine-info</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
254 <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
255 <citerefentry><refentrytitle>systemd-hostnamed.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
256 <citerefentry><refentrytitle>systemd-firstboot</refentrytitle><manvolnum>1</manvolnum></citerefentry>