1NVME-WRITE-ZEROES(1)              NVMe Manual             NVME-WRITE-ZEROES(1)
2
3
4

NAME

6       nvme-write-zeroes - Send an NVMe write zeroes command, return results
7

SYNOPSIS

9       nvme-write-zeroes <device> [--start-block=<slba> | -s <slba>]
10                               [--block-count=<nlb> | -c <nlb>]
11                               [--ref-tag=<reftag> | -r <reftag>]
12                               [--prinfo=<prinfo> | -p <prinfo>]
13                               [--app-tag-mask=<appmask> | -m <appmask>]
14                               [--app-tag=<apptag> | -a <apptag>]
15                               [--deac | -d]
16                               [--limited-retry | -l]
17                               [--force-unit-access | -f]
18                               [--namespace-id=<nsid> | -n <nsid>]
19                               [--storage-tag<storage-tag> | -S <storage-tag>]
20                               [--storage-tag-check<storage-tag-check> | -C <storage-tag-check>]
21                               [--force]
22

DESCRIPTION

24       The Write Zeroes command is used to set a range of logical blocks to 0.
25

OPTIONS

27       --start-block=<slba>, -s <slba>
28           Start block.
29
30       --block-count=<nlb>, -c <nlb>
31           Number of logical blocks to write zeroes.
32
33       --prinfo=<prinfo>, -p <prinfo>
34           Protection Information field definition.
35
36           ┌────┬────────────────────────────┐
37           │Bit │ Description                │
38           ├────┼────────────────────────────┤
39           │3   │ PRACT: Protection          │
40           │    │ Information Action. When   │
41           │    │ set to 1, PI is            │
42           │    │ stripped/inserted on       │
43           │    │ read/write when the block  │
44           │    │ format’s metadata size is  │
45           │    │ 8. When set to 0, metadata │
46           │    │ is passes.                 │
47           ├────┼────────────────────────────┤
48           │2:0 │ PRCHK: Protection          │
49           │    │ Information Check:         │
50           ├────┼────────────────────────────┤
51           │2   │ Set to 1 enables checking  │
52           │    │ the guard tag              │
53           ├────┼────────────────────────────┤
54           │1   │ Set to 1 enables checking  │
55           │    │ the application tag        │
56           ├────┼────────────────────────────┤
57           │0   │ Set to 1 enables checking  │
58           │    │ the reference tag          │
59           └────┴────────────────────────────┘
60
61       --ref-tag=<reftag>, -r <reftag>
62           Optional reftag when used with protection information.
63
64       --app-tag-mask=<appmask>, -m <appmask>
65           Optional application tag mask when used with protection
66           information.
67
68       --app-tag=<apptag>, -a <apptag>
69           Optional application tag when used with protection information.
70
71       --limited-retry, -l
72           Sets the limited retry flag.
73
74       --deac, -d
75           Sets the DEAC bit, requesting controller deallocate the logical
76           blocks.
77
78       --force-unit-access, -f
79           Set the force-unit access flag.
80
81       --namespace-id=<nsid>, -n <nsid>
82           Namespace ID use in the command.
83
84       --storage-tag=<storage-tag>, -S <storage-tag>
85           Variable Sized Logical Block Storage Tag(LBST).
86
87       --storage-tag-check=<storage-tag-check>, -C <storage-tag-check>
88           This bit specifies the Storage Tag field shall be checked as part
89           of end-to-end data protection processing.
90
91       --force
92           Ignore namespace is currently busy and performed the operation even
93           though.
94

EXAMPLES

96       No examples yet.
97

NVME

99       Part of the nvme-user suite
100
101
102
103NVMe                              11/04/2022              NVME-WRITE-ZEROES(1)