[thirdparty/systemd.git] / man / hostnamectl.xml

<?xml version='1.0'?> <!--*-nxml-*-->
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
  "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
<!ENTITY % entities SYSTEM "custom-entities.ent" >
%entities;
]>
<!-- SPDX-License-Identifier: LGPL-2.1-or-later -->

<refentry id="hostnamectl" conditional='ENABLE_HOSTNAMED'
    xmlns:xi="http://www.w3.org/2001/XInclude">

  <refentryinfo>
    <title>hostnamectl</title>
    <productname>systemd</productname>
  </refentryinfo>

  <refmeta>
    <refentrytitle>hostnamectl</refentrytitle>
    <manvolnum>1</manvolnum>
  </refmeta>

  <refnamediv>
    <refname>hostnamectl</refname>
    <refpurpose>Control the system hostname</refpurpose>
  </refnamediv>

  <refsynopsisdiv>
    <cmdsynopsis>
      <command>hostnamectl</command>
      <arg choice="opt" rep="repeat">OPTIONS</arg>
      <arg choice="req">COMMAND</arg>
    </cmdsynopsis>
  </refsynopsisdiv>

  <refsect1>
    <title>Description</title>

    <para><command>hostnamectl</command> may be used to query and change the system hostname and related
    settings.</para>

    <para><citerefentry><refentrytitle>systemd-hostnamed.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>
    and this tool distinguish three different hostnames: the high-level "pretty" hostname which might include
    all kinds of special characters (e.g. "Lennart's Laptop"), the "static" hostname which is the
    user-configured hostname (e.g. "lennarts-laptop"), and the transient hostname which is a fallback value
    received from network configuration (e.g. "node12345678"). If a static hostname is set to a valid value,
    then the transient hostname is not used.</para>

    <para>Note that the pretty hostname has little restrictions on the characters and length used, while the static and
    transient hostnames are limited to the usually accepted characters of Internet domain names, and 64 characters at
    maximum (the latter being a Linux limitation).</para>

    <para>Use
    <citerefentry><refentrytitle>systemd-firstboot</refentrytitle><manvolnum>1</manvolnum></citerefentry> to
    initialize the system hostname for mounted (but not booted) system images.</para>
  </refsect1>

  <refsect1>
    <title>Commands</title>

    <para>The following commands are understood:</para>

    <variablelist>
      <varlistentry>
        <term><command>status</command></term>

        <listitem><para>Show system hostname and related information. If no command is specified,
        this is the implied default.</para>

        <xi:include href="version-info.xml" xpointer="v195"/></listitem>
      </varlistentry>

      <varlistentry>
        <term><command>hostname</command> [<replaceable>NAME</replaceable>]</term>

        <listitem><para>If no argument is given, print the system hostname. If an
        optional argument <replaceable>NAME</replaceable> is provided then the command changes the
        system hostname to <replaceable>NAME</replaceable>. By default, this will alter the
        pretty, the static, and the transient hostname alike; however, if one or more of <option>--static</option>,
        <option>--transient</option>, <option>--pretty</option> are used, only the selected hostnames are changed. If
        the pretty hostname is being set, and static or transient are being set as well, the specified hostname will be
        simplified in regards to the character set used before the latter are updated. This is done by removing special
        characters and spaces. This ensures that the pretty and the static hostname are always closely related while
        still following the validity rules of the specific name. This simplification of the hostname string is not done
        if only the transient and/or static hostnames are set, and the pretty hostname is left untouched.</para>

        <para>The static and transient hostnames must each be either a single DNS label (a string composed of
        7-bit ASCII lower-case characters and no spaces or dots, limited to the format allowed for DNS domain
        name labels), or a sequence of such labels separated by single dots that forms a valid DNS FQDN. The
        hostname must be at most 64 characters, which is a Linux limitation (DNS allows longer names).</para>

        <xi:include href="version-info.xml" xpointer="v249"/></listitem>
      </varlistentry>

      <varlistentry>
        <term><command>icon-name</command> [<replaceable>NAME</replaceable>]</term>

        <listitem><para>If no argument is given, print the icon name of the system. If an
        optional argument <replaceable>NAME</replaceable> is provided then the command changes the
        icon name to <replaceable>NAME</replaceable>. The icon name is used by some
        graphical applications to visualize this host. The icon name
        should follow the <ulink
        url="https://standards.freedesktop.org/icon-naming-spec/icon-naming-spec-latest.html">Icon
        Naming Specification</ulink>.</para>

        <xi:include href="version-info.xml" xpointer="v249"/></listitem>
      </varlistentry>

      <varlistentry>
        <term><command>chassis</command> [<replaceable>TYPE</replaceable>]</term>

        <listitem><para>If no argument is given, print the chassis type. If an
        optional argument <replaceable>TYPE</replaceable> is provided then the command changes the
        chassis type to <replaceable>TYPE</replaceable>. The chassis type is used by
        some graphical applications to visualize the host or alter user interaction.
        Currently, the following chassis types are defined:
        <literal>desktop</literal>,
        <literal>laptop</literal>,
        <literal>convertible</literal>,
        <literal>server</literal>,
        <literal>tablet</literal>,
        <literal>handset</literal>,
        <literal>watch</literal>,
        <literal>embedded</literal>,
        as well as the special chassis types
        <literal>vm</literal> and
        <literal>container</literal> for virtualized systems that lack
        an immediate physical chassis.</para>

        <xi:include href="version-info.xml" xpointer="v249"/>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><command>deployment</command> [<replaceable>ENVIRONMENT</replaceable>]</term>

        <listitem><para>If no argument is given, print the deployment environment. If an
        optional argument <replaceable>ENVIRONMENT</replaceable> is provided then the command changes the
        deployment environment to <replaceable>ENVIRONMENT</replaceable>.
        Argument <replaceable>ENVIRONMENT</replaceable>
        must be a single word without any control characters. One of the following is suggested:
        <literal>development</literal>,
        <literal>integration</literal>,
        <literal>staging</literal>,
        <literal>production</literal>.
        </para>

        <xi:include href="version-info.xml" xpointer="v249"/>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><command>location</command> [<replaceable>LOCATION</replaceable>]</term>

        <listitem><para>If no argument is given, print the location string for the system. If an
        optional argument <replaceable>LOCATION</replaceable> is provided then the command changes the
        location string for the system to <replaceable>LOCATION</replaceable>.
        Argument <replaceable>LOCATION</replaceable> should be a
        human-friendly, free-form string describing the physical
        location of the system, if it is known and applicable. This
        may be as generic as <literal>Berlin, Germany</literal> or as
        specific as <literal>Left Rack, 2nd Shelf</literal>.</para>

        <xi:include href="version-info.xml" xpointer="v249"/>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsect1>

  <refsect1>
    <title>Options</title>

    <para>The following options are understood:</para>

    <variablelist>
      <varlistentry>
        <term><option>--no-ask-password</option></term>

        <listitem><para>Do not query the user for authentication for
        privileged operations.</para>

        <xi:include href="version-info.xml" xpointer="v195"/></listitem>
      </varlistentry>

      <varlistentry>
        <term><option>--static</option></term>
        <term><option>--transient</option></term>
        <term><option>--pretty</option></term>

        <listitem><para>If <command>status</command> is invoked (or no explicit command is given) and one of these
        switches is specified, <command>hostnamectl</command> will print out just this selected hostname.</para>

        <para>If used with <command>hostname</command>, only the selected hostnames will be updated. When more
        than one of these switches are specified, all the specified hostnames will be updated. </para>

        <xi:include href="version-info.xml" xpointer="v195"/></listitem>
      </varlistentry>

      <xi:include href="user-system-options.xml" xpointer="host" />
      <xi:include href="user-system-options.xml" xpointer="machine" />

      <xi:include href="standard-options.xml" xpointer="help" />
      <xi:include href="standard-options.xml" xpointer="version" />
      <xi:include href="standard-options.xml" xpointer="json" />
    </variablelist>
  </refsect1>

  <refsect1>
    <title>Exit status</title>

    <para>On success, 0 is returned, a non-zero failure code
    otherwise.</para>
  </refsect1>

  <refsect1>
    <title>See Also</title>
    <para>
      <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
      <citerefentry><refentrytitle>hostname</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
      <citerefentry><refentrytitle>hostname</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
      <citerefentry><refentrytitle>machine-info</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
      <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
      <citerefentry><refentrytitle>systemd-hostnamed.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
      <citerefentry><refentrytitle>systemd-firstboot</refentrytitle><manvolnum>1</manvolnum></citerefentry>
    </para>
  </refsect1>

</refentry>
Commit	Line	Data
dbc4fbae	1	<?xml version='1.0'?> <!---nxml--->
3a54a157	2	<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
9f0840e4 ZJS	3	"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
	4	<!ENTITY % entities SYSTEM "custom-entities.ent" >
	5	%entities;
	6	]>
db9ecf05	7	<!-- SPDX-License-Identifier: LGPL-2.1-or-later -->
dbc4fbae	8
dfdebb1b	9	<refentry id="hostnamectl" conditional='ENABLE_HOSTNAMED'
798d3a52 ZJS	10	xmlns:xi="http://www.w3.org/2001/XInclude">
	11
	12	<refentryinfo>
	13	<title>hostnamectl</title>
	14	<productname>systemd</productname>
798d3a52 ZJS	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
de31bbc6 ZJS	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
d39079fc ZJS	45	received from network configuration (e.g. "node12345678"). If a static hostname is set to a valid value,
d39079fc ZJS	46	then the transient hostname is not used.</para>
798d3a52	47
7c9f396b LP	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>
798d3a52	51
798d3a52	52	<para>Use
de31bbc6 ZJS	53	<citerefentry><refentrytitle>systemd-firstboot</refentrytitle><manvolnum>1</manvolnum></citerefentry> to
de31bbc6 ZJS	54	initialize the system hostname for mounted (but not booted) system images.</para>
798d3a52 ZJS	55	</refsect1>
798d3a52 ZJS	56
a456324f YW	57	<refsect1>
a456324f YW	58	<title>Commands</title>
798d3a52 ZJS	59
	60	<para>The following commands are understood:</para>
	61
	62	<variablelist>
	63	<varlistentry>
	64	<term><command>status</command></term>
	65
572c55ee	66	<listitem><para>Show system hostname and related information. If no command is specified,
aefdc112 AK	67	this is the implied default.</para>
	68
	69	<xi:include href="version-info.xml" xpointer="v195"/></listitem>
798d3a52 ZJS	70	</varlistentry>
	71
	72	<varlistentry>
572c55ee	73	<term><command>hostname</command> [<replaceable>NAME</replaceable>]</term>
798d3a52	74
572c55ee JW	75	<listitem><para>If no argument is given, print the system hostname. If an
	76	optional argument <replaceable>NAME</replaceable> is provided then the command changes the
	77	system hostname to <replaceable>NAME</replaceable>. By default, this will alter the
0cce63da LP	78	pretty, the static, and the transient hostname alike; however, if one or more of <option>--static</option>,
	79	<option>--transient</option>, <option>--pretty</option> are used, only the selected hostnames are changed. If
	80	the pretty hostname is being set, and static or transient are being set as well, the specified hostname will be
	81	simplified in regards to the character set used before the latter are updated. This is done by removing special
	82	characters and spaces. This ensures that the pretty and the static hostname are always closely related while
	83	still following the validity rules of the specific name. This simplification of the hostname string is not done
38b38500	84	if only the transient and/or static hostnames are set, and the pretty hostname is left untouched.</para>
798d3a52	85
9f0840e4 ZJS	86	<para>The static and transient hostnames must each be either a single DNS label (a string composed of
	87	7-bit ASCII lower-case characters and no spaces or dots, limited to the format allowed for DNS domain
	88	name labels), or a sequence of such labels separated by single dots that forms a valid DNS FQDN. The
ec07c3c8 AK	89	hostname must be at most 64 characters, which is a Linux limitation (DNS allows longer names).</para>
	90
	91	<xi:include href="version-info.xml" xpointer="v249"/></listitem>
798d3a52 ZJS	92	</varlistentry>
	93
	94	<varlistentry>
572c55ee	95	<term><command>icon-name</command> [<replaceable>NAME</replaceable>]</term>
798d3a52	96
572c55ee JW	97	<listitem><para>If no argument is given, print the icon name of the system. If an
	98	optional argument <replaceable>NAME</replaceable> is provided then the command changes the
	99	icon name to <replaceable>NAME</replaceable>. The icon name is used by some
798d3a52 ZJS	100	graphical applications to visualize this host. The icon name
798d3a52 ZJS	101	should follow the <ulink
41d6f3bf	102	url="https://standards.freedesktop.org/icon-naming-spec/icon-naming-spec-latest.html">Icon
ec07c3c8 AK	103	Naming Specification</ulink>.</para>
	104
	105	<xi:include href="version-info.xml" xpointer="v249"/></listitem>
798d3a52 ZJS	106	</varlistentry>
	107
	108	<varlistentry>
572c55ee	109	<term><command>chassis</command> [<replaceable>TYPE</replaceable>]</term>
798d3a52	110
572c55ee JW	111	<listitem><para>If no argument is given, print the chassis type. If an
	112	optional argument <replaceable>TYPE</replaceable> is provided then the command changes the
	113	chassis type to <replaceable>TYPE</replaceable>. The chassis type is used by
	114	some graphical applications to visualize the host or alter user interaction.
	115	Currently, the following chassis types are defined:
798d3a52 ZJS	116	<literal>desktop</literal>,
798d3a52 ZJS	117	<literal>laptop</literal>,
34b52450	118	<literal>convertible</literal>,
798d3a52 ZJS	119	<literal>server</literal>,
	120	<literal>tablet</literal>,
	121	<literal>handset</literal>,
	122	<literal>watch</literal>,
	123	<literal>embedded</literal>,
	124	as well as the special chassis types
	125	<literal>vm</literal> and
	126	<literal>container</literal> for virtualized systems that lack
	127	an immediate physical chassis.</para>
ec07c3c8 AK	128
ec07c3c8 AK	129	<xi:include href="version-info.xml" xpointer="v249"/>
798d3a52 ZJS	130	</listitem>
	131	</varlistentry>
	132
	133	<varlistentry>
572c55ee	134	<term><command>deployment</command> [<replaceable>ENVIRONMENT</replaceable>]</term>
798d3a52	135
572c55ee JW	136	<listitem><para>If no argument is given, print the deployment environment. If an
	137	optional argument <replaceable>ENVIRONMENT</replaceable> is provided then the command changes the
	138	deployment environment to <replaceable>ENVIRONMENT</replaceable>.
	139	Argument <replaceable>ENVIRONMENT</replaceable>
	140	must be a single word without any control characters. One of the following is suggested:
798d3a52 ZJS	141	<literal>development</literal>,
	142	<literal>integration</literal>,
	143	<literal>staging</literal>,
	144	<literal>production</literal>.
	145	</para>
ec07c3c8 AK	146
ec07c3c8 AK	147	<xi:include href="version-info.xml" xpointer="v249"/>
798d3a52 ZJS	148	</listitem>
	149	</varlistentry>
	150
	151	<varlistentry>
572c55ee	152	<term><command>location</command> [<replaceable>LOCATION</replaceable>]</term>
798d3a52	153
572c55ee JW	154	<listitem><para>If no argument is given, print the location string for the system. If an
	155	optional argument <replaceable>LOCATION</replaceable> is provided then the command changes the
	156	location string for the system to <replaceable>LOCATION</replaceable>.
	157	Argument <replaceable>LOCATION</replaceable> should be a
798d3a52 ZJS	158	human-friendly, free-form string describing the physical
	159	location of the system, if it is known and applicable. This
	160	may be as generic as <literal>Berlin, Germany</literal> or as
	161	specific as <literal>Left Rack, 2nd Shelf</literal>.</para>
ec07c3c8 AK	162
ec07c3c8 AK	163	<xi:include href="version-info.xml" xpointer="v249"/>
798d3a52 ZJS	164	</listitem>
	165	</varlistentry>
	166	</variablelist>
	167	</refsect1>
	168
e1fac8a6 ZJS	169	<refsect1>
	170	<title>Options</title>
	171
	172	<para>The following options are understood:</para>
	173
	174	<variablelist>
	175	<varlistentry>
	176	<term><option>--no-ask-password</option></term>
	177
	178	<listitem><para>Do not query the user for authentication for
ec07c3c8 AK	179	privileged operations.</para>
	180
	181	<xi:include href="version-info.xml" xpointer="v195"/></listitem>
e1fac8a6 ZJS	182	</varlistentry>
	183
	184	<varlistentry>
	185	<term><option>--static</option></term>
	186	<term><option>--transient</option></term>
	187	<term><option>--pretty</option></term>
	188
	189	<listitem><para>If <command>status</command> is invoked (or no explicit command is given) and one of these
	190	switches is specified, <command>hostnamectl</command> will print out just this selected hostname.</para>
	191
847dd892	192	<para>If used with <command>hostname</command>, only the selected hostnames will be updated. When more
ec07c3c8 AK	193	than one of these switches are specified, all the specified hostnames will be updated. </para>
	194
	195	<xi:include href="version-info.xml" xpointer="v195"/></listitem>
e1fac8a6 ZJS	196	</varlistentry>
	197
	198	<xi:include href="user-system-options.xml" xpointer="host" />
	199	<xi:include href="user-system-options.xml" xpointer="machine" />
	200
	201	<xi:include href="standard-options.xml" xpointer="help" />
	202	<xi:include href="standard-options.xml" xpointer="version" />
ac8a4f6b	203	<xi:include href="standard-options.xml" xpointer="json" />
e1fac8a6 ZJS	204	</variablelist>
	205	</refsect1>
	206
798d3a52 ZJS	207	<refsect1>
	208	<title>Exit status</title>
	209
	210	<para>On success, 0 is returned, a non-zero failure code
	211	otherwise.</para>
	212	</refsect1>
	213
	214	<refsect1>
	215	<title>See Also</title>
	216	<para>
	217	<citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
	218	<citerefentry><refentrytitle>hostname</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
	219	<citerefentry><refentrytitle>hostname</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
	220	<citerefentry><refentrytitle>machine-info</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
	221	<citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
	222	<citerefentry><refentrytitle>systemd-hostnamed.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
	223	<citerefentry><refentrytitle>systemd-firstboot</refentrytitle><manvolnum>1</manvolnum></citerefentry>
	224	</para>
	225	</refsect1>
dbc4fbae LP	226
dbc4fbae LP	227	</refentry>