| SYSTEMD-STORAGETM.SERVICE(8) | systemd-storagetm.service | SYSTEMD-STORAGETM.SERVICE(8) |
.SH "NAME" systemd-storagetm.service, systemd-storagetm - Exposes
all local block devices as NVMe-TCP mass storage devices
.SH "SYNOPSIS"
.PP systemd-storagetm.service
.HP 840u
/usr/lib/systemd/systemd-storagetm
[OPTIONS...]
DEVICE...
.HP 840u
/usr/lib/systemd/systemd-storagetm
[OPTIONS...]
--all
.HP 840u
/usr/lib/systemd/systemd-storagetm
[OPTIONS...]
--list-devices
.SH "DESCRIPTION"
.PP 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.
.if n .sp
Warning
.PP 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.
.sp .5v
.PP 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).
.PP Unless the --list-devices or --all switches are used, one
or more block devices or regular files to expose via NVMe-TCP must be
specified as arguments.
.SH "OPTIONS"
.PP The following options are understood:
.PP --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.
.RE
.PP --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.
.RE
.PP --list-devices
Show a list of candidate block devices this command may operate on.
Specifically, this enumerates block devices currently present, and shows
their device node paths along with any of their symlinks.
Added in version 257.
.RE
.PP -h, --help
Print a short help text and exit.
.RE
.PP --version
NOTES
- 1.
- NVM Express Base Specification 2.0c
| systemd 262.2 |