1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
|
'\" t
.\" Title: nvme-copy
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\" Date: 11/04/2025
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
.TH "NVME\-COPY" "1" "11/04/2025" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
nvme-copy \- Send an NVMe Simple Copy command, provide results
.SH "SYNOPSIS"
.sp
.nf
\fInvme\-copy\fR <device> [\-\-sdlba=<sdlba> | \-d <sdlba>]
[\-\-blocks=<nlb\-list,> | \-b <nlb\-list,>]
[\-\-slbs=<slbas,> | \-s <slbas,>]
[\-\-snsids=<snsids,> | \-N <snsids,>]
[\-\-sopts=<sopts,> | \-O <sopts,>]
[\-\-limited\-retry | \-l]
[\-\-force\-unit\-access | \-f]
[\-\-prinfow=<prinfow> | \-p <prinfow>]
[\-\-prinfor=<prinfor> | \-P <prinfor>]
[\-\-ref\-tag=<reftag> | \-r <reftag>]
[\-\-expected\-ref\-tags=<reftag,> | \-R <reftag,>]
[\-\-app\-tag=<apptag> | \-a <apptag>]
[\-\-expected\-app\-tags=<apptag,> | \-A <apptag,>]
[\-\-app\-mask=<appmask> | \-m <appmask>]
[\-\-expected\-app\-masks=<appmask,> | \-M <appmask,>]
[\-\-dir\-type=<type> | \-T <type>]
[\-\-dir\-spec=<spec> | \-S <spec>]
[\-\-format=<entry\-format> | \-F <entry\-format>]
[\-\-output\-format=<fmt> | \-o <fmt>] [\-\-verbose | \-v]
[\-\-timeout=<timeout> | \-t <timeout>]
.fi
.SH "DESCRIPTION"
.sp
The Copy command is used by the host to copy data from one or more source logical block ranges to a single consecutive destination logical block range\&.
.SH "OPTIONS"
.PP
\-d <sdlba>, \-\-sdlba=<sdlba>
.RS 4
64\-bit addr of first destination logical block
.RE
.PP
\-b <nlb\-list,>, \-\-blocks=<nlb\-list,>
.RS 4
Comma separated list of the number of blocks in each range
.RE
.PP
\-s <slbas,>, \-\-slbs=<slbas,>
.RS 4
Comma separated list of the starting blocks in each range
.RE
.PP
\-\-snsids=<snsids,>, \-N <snsids,>
.RS 4
Comma separated list of the source namespace identifiers in each range
.RE
.PP
\-\-sopts=<sopts,>, \-O <sopts,>
.RS 4
Comma separated list of the source options in each range
.RE
.PP
\-l, \-\-limited\-retry
.RS 4
Sets the limited retry flag\&.
.RE
.PP
\-f, \-\-force\-unit\-access
.RS 4
Set the force\-unit access flag\&.
.RE
.PP
\-p <prinfow>, \-\-prinfow=<prinfow>
.RS 4
Protection Information field write definition\&.
.RE
.PP
\-P <prinfor>, \-\-prinfor=<prinfor>
.RS 4
Protection Information field read definition\&.
.RE
.PP
\-r <reftag>, \-\-ref\-tag=<reftag>
.RS 4
initial lba reference tag\&.
.RE
.PP
\-R <reftag,>, \-\-expected\-ref\-tags=<reftag,>
.RS 4
expected lba reference tags (comma\-separated list)\&.
.RE
.PP
\-a <apptag>, \-\-app\-tag=<apptag>
.RS 4
lba app tag
.RE
.PP
\-A <apptag,>, \-\-expected\-app\-tags=<apptag,>
.RS 4
expected lba app tags (comma\-separated list)
.RE
.PP
\-m <appmask>, \-\-app\-mask=<appmask>
.RS 4
lba tag mask
.RE
.PP
\-M <appmask,>, \-\-expected\-app\-masks=<appmask,>
.RS 4
expected lba tag masks (comma\-separated list)
.RE
.PP
\-T <type>, \-\-dir\-type=<type>
.RS 4
Optional directive type\&. The nvme\-cli only enforces the value be in the defined range for the directive type, though the NVMe specification (1\&.3a) defines only one directive, 01h, for write stream identifiers\&.
.RE
.PP
\-S <spec>, \-\-dir\-spec=<spec>
.RS 4
Optional field for directive specifics\&. When used with write streams, this value is defined to be the write stream identifier\&. The nvme\-cli will not validate the stream requested is within the controller\(cqs capabilities\&.
.RE
.PP
\-F <entry\-format>, \-\-format=<entry\-format>
.RS 4
source range entry format
.RE
.PP
\-o <fmt>, \-\-output\-format=<fmt>
.RS 4
Set the reporting format to
\fInormal\fR,
\fIjson\fR
or
\fIbinary\fR\&. Only one output format can be used at a time\&.
.RE
.PP
\-v, \-\-verbose
.RS 4
Increase the information detail in the output\&.
.RE
.PP
\-t <timeout>, \-\-timeout=<timeout>
.RS 4
Override default timeout value\&. In milliseconds\&.
.RE
.SH "EXAMPLES"
.sp
No examples yet\&.
.SH "NVME"
.sp
Part of the nvme\-user suite
|
