| 1 |
'\" t |
| 2 |
.TH "SYSTEMD\-STORAGETM\&.SERVICE" "8" "" "systemd 261~rc3" "systemd-storagetm.service" |
| 3 |
.\" ----------------------------------------------------------------- |
| 4 |
.\" * Define some portability stuff |
| 5 |
.\" ----------------------------------------------------------------- |
| 6 |
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
| 7 |
.\" http://bugs.debian.org/507673 |
| 8 |
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html |
| 9 |
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
| 10 |
.ie \n(.g .ds Aq \(aq |
| 11 |
.el .ds Aq ' |
| 12 |
.\" ----------------------------------------------------------------- |
| 13 |
.\" * set default formatting |
| 14 |
.\" ----------------------------------------------------------------- |
| 15 |
.\" disable hyphenation |
| 16 |
.nh |
| 17 |
.\" disable justification (adjust text to left margin only) |
| 18 |
.ad l |
| 19 |
.\" ----------------------------------------------------------------- |
| 20 |
.\" * MAIN CONTENT STARTS HERE * |
| 21 |
.\" ----------------------------------------------------------------- |
| 22 |
.SH "NAME" |
| 23 |
systemd-storagetm.service, systemd-storagetm \- Exposes all local block devices as NVMe\-TCP mass storage devices |
| 24 |
.SH "SYNOPSIS" |
| 25 |
.PP |
| 26 |
systemd\-storagetm\&.service |
| 27 |
.HP \w'\fB/usr/lib/systemd/systemd\-storagetm\fR\ 'u |
| 28 |
\fB/usr/lib/systemd/systemd\-storagetm\fR [OPTIONS...] [\fIDEVICE\fR] |
| 29 |
.SH "DESCRIPTION" |
| 30 |
.PP |
| 31 |
systemd\-storagetm\&.service |
| 32 |
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 |
| 33 |
storage\-target\-mode\&.target |
| 34 |
unit that can be booted into\&. |
| 35 |
.if n \{\ |
| 36 |
.sp |
| 37 |
.\} |
| 38 |
.RS 4 |
| 39 |
.it 1 an-trap |
| 40 |
.nr an-no-space-flag 1 |
| 41 |
.nr an-break-flag 1 |
| 42 |
.br |
| 43 |
.ps +1 |
| 44 |
\fBWarning\fR |
| 45 |
.ps -1 |
| 46 |
.br |
| 47 |
.PP |
| 48 |
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\&. |
| 49 |
.sp .5v |
| 50 |
.RE |
| 51 |
.PP |
| 52 |
Note that to function properly networking must be configured too\&. The recommended mechanism to boot into a storage target mode is by adding |
| 53 |
"rd\&.systemd\&.unit=storage\-target\-mode\&.target ip=link\-local" |
| 54 |
on the kernel command line\&. Note that |
| 55 |
"ip=link\-local" |
| 56 |
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 |
| 57 |
"ip=dhcp" |
| 58 |
to assign routable addresses too\&. For further details see |
| 59 |
\fBsystemd-network-generator.service\fR(8)\&. |
| 60 |
.PP |
| 61 |
Unless the |
| 62 |
\fB\-\-all\fR |
| 63 |
switch is used expects one or more block devices or regular files to expose via NVMe\-TCP as argument\&. |
| 64 |
.SH "OPTIONS" |
| 65 |
.PP |
| 66 |
The following options are understood: |
| 67 |
.PP |
| 68 |
\fB\-\-nqn=\fR |
| 69 |
.RS 4 |
| 70 |
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 |
| 71 |
\m[blue]\fBNVM Express Base Specification 2\&.0c\fR\m[]\&\s-2\u[1]\d\s+2, 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 |
| 72 |
"nqn\&.2023\-10\&.io\&.systemd:storagetm\&.\fIID\fR", where ID is replaced by a 128bit ID derived from |
| 73 |
\fBmachine-id\fR(5)\&. |
| 74 |
.sp |
| 75 |
Added in version 255\&. |
| 76 |
.RE |
| 77 |
.PP |
| 78 |
\fB\-\-all\fR, \fB\-a\fR |
| 79 |
.RS 4 |
| 80 |
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\&. |
| 81 |
.sp |
| 82 |
Added in version 255\&. |
| 83 |
.RE |
| 84 |
.PP |
| 85 |
\fB\-\-list\-devices\fR |
| 86 |
.RS 4 |
| 87 |
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\&. |
| 88 |
.sp |
| 89 |
Added in version 257\&. |
| 90 |
.RE |
| 91 |
.PP |
| 92 |
\fB\-h\fR, \fB\-\-help\fR |
| 93 |
.RS 4 |
| 94 |
Print a short help text and exit\&. |
| 95 |
.RE |
| 96 |
.PP |
| 97 |
\fB\-\-version\fR |
| 98 |
.RS 4 |
| 99 |
Print a short version string and exit\&. |
| 100 |
.RE |
| 101 |
.SH "SEE ALSO" |
| 102 |
.PP |
| 103 |
\fBsystemd\fR(1), \fBsystemd.special\fR(7) |
| 104 |
.SH "NOTES" |
| 105 |
.IP " 1." 4 |
| 106 |
NVM Express Base Specification 2.0c |
| 107 |
.RS 4 |
| 108 |
\%https://nvmexpress.org/wp-content/uploads/NVM-Express-Base-Specification-2.0c-2022.10.04-Ratified.pdf |
| 109 |
.RE |