systemd-storagetm.service(8) — Linux manual page

SYSTEMD-S....SERVICE(8) systemd-storagetm.serviceSYSTEMD-S....SERVICE(8)

NAME

       systemd-storagetm.service, systemd-storagetm - Exposes all local
       block devices as NVMe-TCP mass storage devices

SYNOPSIS

       systemd-storagetm.service

       /usr/lib/systemd/systemd-storagetm [OPTIONS...] [DEVICE]

DESCRIPTION

       systemd-storagetm.service is a service that exposes all local
       block devices as NVMe-TCP mass storage devices. Its primary
       use-case is to be invoked by the storage-target-mode.target unit
       that can be booted into.

           Warning

           The NVMe disks are currently exposed without authentication
           or encryption, in read/write mode. This means network peers
           may read from and write to the device without any
           restrictions. This functionality should hence only be used in
           a local setup.

       Note that to function properly networking must be configured too.
       The recommended mechanism to boot into a storage target mode is
       by adding "rd.systemd.unit=storage-target-mode.target
       ip=link-local" on the kernel command line. Note that
       "ip=link-local" only configures link-local IP, i.e. IPv4LL and
       IPv6LL, which means non-routable addresses. This is done for
       security reasons, so that only systems on the local link can
       access the devices. Use "ip=dhcp" to assign routable addresses
       too. For further details see
       systemd-network-generator.service(8).

       Unless the --all switch is used expects one or more block devices
       or regular files to expose via NVMe-TCP as argument.

OPTIONS

       The following options are understood:

       --nqn=
           Takes a string. If specified configures the NVMe Qualified
           Name to use for the exposed NVMe-TCP mass storage devices.
           The NQN should follow the syntax described in NVM Express
           Base Specification 2.0c[1], section 4.5 "NVMe Qualified
           Names". Note that the NQN specified here will be suffixed
           with a dot and the block device name before it is exposed on
           the NVMe target. If not specified defaults to
           "nqn.2023-10.io.systemd:storagetm.ID", where ID is replaced
           by a 128bit ID derived from machine-id(5).

           Added in version 255.

       --all, -a
           If specified exposes all local block devices via NVMe-TCP,
           current and future (i.e. it watches block devices come and go
           and updates the NVMe-TCP list as needed). Note that by
           default any block devices that originate on the same block
           device as the block device backing the current root file
           system are excluded. If the switch is specified twice this
           safety mechanism is disabled.

           Added in version 255.

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

       --version
           Print a short version string and exit.

SEE ALSO

       systemd(1), systemd.special(7)

NOTES

        1. NVM Express Base Specification 2.0c
           https://nvmexpress.org/wp-content/uploads/NVM-Express-Base-Specification-2.0c-2022.10.04-Ratified.pdf

COLOPHON

       This page is part of the systemd (systemd system and service
       manager) project.  Information about the project can be found at
       ⟨http://www.freedesktop.org/wiki/Software/systemd⟩.  If you have
       a bug report for this manual page, see
       ⟨http://www.freedesktop.org/wiki/Software/systemd/#bugreports⟩.
       This page was obtained from the project's upstream Git repository
       ⟨https://github.com/systemd/systemd.git⟩ on 2024-06-14.  (At that
       time, the date of the most recent commit that was found in the
       repository was 2024-06-13.)  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 improvements to the information in this COLOPHON
       (which is not part of the original manual page), send a mail to
       man-pages@man7.org

systemd 257~devel                                SYSTEMD-S....SERVICE(8)

Pages that refer to this page: systemd.directives(7), systemd.index(7), systemd.special(7)

---