1NVME-IO-PASSTHRU(1) NVMe Manual NVME-IO-PASSTHRU(1)
2
6 nvme-io-passthru - Submit an arbitrary io command, return results
7
9 nvme-io-passthru <device> [--opcode=<opcode> | -o <opcode>]
10 [--flags=<flags> | -f <flags>] [-rsvd=<rsvd> | -R <rsvd>]
11 [--namespace-id=<nsid> | -nsid <nsid>]
12 [--cdw2=<cdw2>] [--cdw3=<cdw3>] [--cdw10=<cdw10>]
13 [--cdw11=<cdw11>] [--cdw12=<cdw12>] [--cdw13=<cdw13>]
14 [--cdw14=<cdw14>] [--cdw15=<cdw15>]
15 [--data-len=<data-len> | -l <data-len>]
16 [--metadata-len=<len> | -m <len>]
17 [--read | -r ] [--write | -w]
18 [--input-file=<file> | -i <file>]
19 [--timeout=<to> | -t <to>]
20 [--show-command | -s]
21 [--dry-run | -d]
22 [--raw-binary | -b]
23 [--prefill=<prefill> | -p <prefill>]
24
26 Submits an arbitrary NVMe IO command and returns the applicable
27 results. This may be the simply the command’s result and status, or may
28 also include a buffer if the command returns one. This command does no
29 interpretation of the opcodes or options.
30 The <device> parameter is mandatory and may be either the NVMe
32 character device (ex: /dev/nvme0), or a namespace block device (ex:
33 /dev/nvme0n1).
34 On success, the returned structure (if applicable) may be returned in
36 one of several ways depending on the option flags; the structure may
37 printed by the program as a hex dump, or may be returned as a raw
38 buffer printed to stdout for another program to parse.
39
41 -o <opcode>, --opcode=<opcode>
42 The NVMe opcode to send to the device in the command
43 -f <flags>, --flags=<flags>
45 The NVMe command flags to send to the device in the command
46 -R <rsvd>, --rsvd=<rsvd>
48 The value for the reserved field in the command.
49 -n <nsid>, --namespace-id=<nsid>
51 The value for the ns-id in the command. Defaults to 0.
52 --cdw[2-3,10-15]=<cdw>
54 Specifies the command dword value for that specified entry in the
55 command
56 -r, --read, -w, --write
58 Used for the data-direction for the command and required for
59 commands sending/receiving data. Don’t use both read and write at
60 the same time.
61 -i <file>, --input-file=<file>
63 If the command is a data-out (write) command, use this file to fill
64 the buffer sent to the device. If no file is given, assumed to use
65 STDIN.
66 -l <data-len>, --data-len=<data-len>
68 The data length for the buffer used for this command.
69 -m <data-len>, --metadata-len=<data-len>
71 The metadata length for the buffer used for this command.
72 -s, --show-cmd
74 Print out the command to be sent.
75 -d, --dry-run
77 Do not actually send the command. If want to use --dry-run option,
78 --show-cmd option must be set. Otherwise --dry-run optionn will be
79 ignored.
80 -b, --raw-binary
82 Print the raw returned buffer to stdout if the command returns data
83 or a structure.
84 -p <prefill>, --prefill <prefill>
86 Prefill the buffer with a predetermined byte value. Defaults to 0.
87 This may be useful if the data you are writing is shorter than the
88 required buffer, and you need to pad it with a known value. It may
89 also be useful if you need to confirm if a device is overwriting a
90 buffer on a data-in command.
91
93 nvme io-passthru /dev/nvme0n1 --opcode=2 --namespace-id=1
94 --data-len=4096 --read --cdw10=0 --cdw11=0 --cdw12=0x70000 --raw-binary
95
97 Part of the nvme-user suite
98NVMe 06/05/2018 NVME-IO-PASSTHRU(1)