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                               [--dir-type=<dtype> | -T <dtype>]
22                               [--dir-spec=<dspec> | -D <dspec>]
23

DESCRIPTION

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

OPTIONS

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

EXAMPLES

99       No examples yet.
100

NVME

102       Part of the nvme-user suite
103
104
105
106NVMe                              09/29/2023              NVME-WRITE-ZEROES(1)