NVME-IO-PASSTHRU(1) | NVMe Manual | NVME-IO-PASSTHRU(1) |
nvme-io-passthru - Submit an arbitrary io command, return results
nvme-io-passthru <device> [--opcode=<opcode> | -o <opcode>]
[--flags=<flags> | -f <flags>] [-rsvd=<rsvd> | -R <rsvd>]
[--namespace-id=<nsid> | -nsid <nsid>]
[--cdw2=<cdw2>] [--cdw3=<cdw3>] [--cdw10=<cdw10>]
[--cdw11=<cdw11>] [--cdw12=<cdw12>] [--cdw13=<cdw13>]
[--cdw14=<cdw14>] [--cdw15=<cdw15>]
[--data-len=<data-len> | -l <data-len>]
[--metadata-len=<len> | -m <len>]
[--read | -r ] [--write | -w]
[--input-file=<file> | -i <file>]
[--metadata=<file> | -M <file>]
[--timeout=<to> | -t <to>]
[--show-command | -s]
[--dry-run | -d]
[--raw-binary | -b]
[--prefill=<prefill> | -p <prefill>]
[--latency | -T]
Submits an arbitrary NVMe IO command and returns the applicable results. This may be the simply the command’s result and status, or may also include a buffer if the command returns one. This command does no interpretation of the opcodes or options.
The <device> parameter is mandatory and may be either the NVMe character device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1).
On success, the returned structure (if applicable) may be returned in one of several ways depending on the option flags; the structure may printed by the program as a hex dump, or may be returned as a raw buffer printed to stdout for another program to parse.
-o <opcode>, --opcode=<opcode>
-f <flags>, --flags=<flags>
-R <rsvd>, --rsvd=<rsvd>
-n <nsid>, --namespace-id=<nsid>
--cdw[2-3,10-15]=<cdw>
-r, --read, -w, --write
-i <file>, --input-file=<file>
-M <file>, --metadata=<file>
-l <data-len>, --data-len=<data-len>
-m <data-len>, --metadata-len=<data-len>
-s, --show-cmd
-d, --dry-run
-b, --raw-binary
-p <prefill>, --prefill <prefill>
-T, --latency
nvme io-passthru /dev/nvme0n1 --opcode=2 --namespace-id=1 --data-len=4096 --read --cdw10=0 --cdw11=0 --cdw12=0x70000 --raw-binary
Part of the nvme-user suite
04/15/2023 | NVMe |