hostnamectl(1) — Linux manual page


HOSTNAMECTL(1)                   hostnamectl                  HOSTNAMECTL(1)

NAME         top

       hostnamectl - Control the system hostname

SYNOPSIS         top

       hostnamectl [OPTIONS...] {COMMAND}

DESCRIPTION         top

       hostnamectl may be used to query and change the system hostname and
       related settings.

       This tool distinguishes 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 used to
       initialize the kernel hostname at boot (e.g. "lennarts-laptop"), and
       the transient hostname which is a fallback value received from
       network configuration. If a static hostname is set, and is valid
       (something other than localhost), then the transient hostname is not

       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

       The static hostname is stored in /etc/hostname, see hostname(5) for
       more information. The pretty hostname, chassis type, and icon name
       are stored in /etc/machine-info, see machine-info(5).

       Use systemd-firstboot(1) to initialize the system hostname for
       mounted (but not booted) system images.

COMMANDS         top

       The following commands are understood:

           Show current system hostname and related information. If no
           command is specified, this is the implied default.

       set-hostname NAME
           Set the system hostname to NAME. By default, this will alter the
           pretty, the static, and the transient hostname alike; however, if
           one or more of --static, --transient, --pretty 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

           Pass the empty string "" as the hostname to reset the selected
           hostnames to their default (usually "localhost").

       set-icon-name NAME
           Set the system icon name to NAME. The icon name is used by some
           graphical applications to visualize this host. The icon name
           should follow the Icon Naming Specification[1].

           Pass an empty string to reset the icon name to the default value,
           which is determined from chassis type (see below) and possibly
           other parameters.

       set-chassis TYPE
           Set the chassis type to TYPE. The chassis type is used by some
           graphical applications to visualize the host or alter user
           interaction. Currently, the following chassis types are defined:
           "desktop", "laptop", "convertible", "server", "tablet",
           "handset", "watch", "embedded", as well as the special chassis
           types "vm" and "container" for virtualized systems that lack an
           immediate physical chassis.

           Pass an empty string to reset the chassis type to the default
           value which is determined from the firmware and possibly other

       set-deployment ENVIRONMENT
           Set the deployment environment description.  ENVIRONMENT must be
           a single word without any control characters. One of the
           following is suggested: "development", "integration", "staging",

           Pass an empty string to reset to the default empty value.

       set-location LOCATION
           Set the location string for the system, if it is known.  LOCATION
           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 "Berlin, Germany" or as specific as
           "Left Rack, 2nd Shelf".

           Pass an empty string to reset to the default empty value.

OPTIONS         top

       The following options are understood:

           Do not query the user for authentication for privileged

       --static, --transient, --pretty
           If status is invoked (or no explicit command is given) and one of
           these switches is specified, hostnamectl will print out just this
           selected hostname.

           If used with set-hostname, only the selected hostname(s) will be
           updated. When more than one of these switches are specified, all
           the specified hostnames will be updated.

       -H, --host=
           Execute the operation remotely. Specify a hostname, or a username
           and hostname separated by "@", to connect to. The hostname may
           optionally be suffixed by a port ssh is listening on, separated
           by ":", and then a container name, separated by "/", which
           connects directly to a specific container on the specified host.
           This will use SSH to talk to the remote machine manager instance.
           Container names may be enumerated with machinectl -H HOST. Put
           IPv6 addresses in brackets.

       -M, --machine=
           Execute operation on a local container. Specify a container name
           to connect to.

       -h, --help
           Print a short help text and exit.

           Print a short version string and exit.

EXIT STATUS         top

       On success, 0 is returned, a non-zero failure code otherwise.

SEE ALSO         top

       systemd(1), hostname(1), hostname(5), machine-info(5), systemctl(1),
       systemd-hostnamed.service(8), systemd-firstboot(1)

NOTES         top

        1. Icon Naming Specification

COLOPHON         top

       This page is part of the systemd (systemd system and service manager)
       project.  Information about the project can be found at 
       ⟨⟩.  If you have a bug
       report for this manual page, see
       ⟨⟩.  This
       page was obtained from the project's upstream Git repository
       ⟨⟩ on 2020-11-01.  (At that
       time, the date of the most recent commit that was found in the repos‐
       itory was 2020-11-01.)  If you discover any rendering problems in
       this HTML version of the page, or you believe there is a better or
       more up-to-date source for the page, or you have corrections or im‐
       provements to the information in this COLOPHON (which is not part of
       the original manual page), send a mail to

systemd 247                                                   HOSTNAMECTL(1)

Pages that refer to this page: systemd-firstboot(1)systemd-firstboot.service(1)hostname(5)machine-info(5)30-systemd-environment-d-generator(7)systemd.directives(7)systemd.index(7)systemd-hostnamed(8)systemd-hostnamed.service(8)systemd-machined(8)systemd-machined.service(8)