1NVME-SANITIZE(1) NVMe Manual NVME-SANITIZE(1)
2
6 nvme-sanitize - Send NVMe Sanitize Command, return result
7
9 nvme sanitize <device> [--no-dealloc | -d]
10 [--oipbp | -i]
11 [--owpass=<overwrite-pass-count> | -n <overwrite-pass-count>]
12 [--ause | -u]
13 [--sanact=<action> | -a <action>]
14 [--ovrpat=<overwrite-pattern> | -p <overwrite-pattern>]
15 [--force]
16
18 For the NVMe device given, sends a Sanitize command and provides the
19 result.
20 The <device> parameter is mandatory NVMe character device (ex:
22 /dev/nvme0).
23 On success it returns 0, error code otherwise.
25
27 -d, --no-dealloc
28 No Deallocate After Sanitize: If set, then the controller shall not
29 deallocate any logical blocks as a result of successfully
30 completing the sanitize operation. If cleared, then the controller
31 should deallocate logical blocks as a result of successfully
32 completing the sanitize operation. This bit shall be ignored if the
33 Sanitize Action field is set to 001b (i.e., Exit Failure Mode).
34 -i, --oipbp
36 Overwrite Invert Pattern Between Passes: If set, then the Overwrite
37 Pattern shall be inverted between passes. If cleared, then the
38 overwrite pattern shall not be inverted between passes. This bit
39 shall be ignored unless the Sanitize Action field is set to 011b
40 (i.e., Overwrite).
41 -n <overwrite-pass-count>, --owpass=<overwrite-pass-count>
43 Overwrite Pass Count: This field specifies the number of overwrite
44 passes (i.e., how many times the media is to be overwritten) using
45 the data from the Overwrite Pattern field of this command. A value
46 of 0 specifies 16 overwrite passes. This field shall be ignored
47 unless the Sanitize Action field is set to 011b (i.e., Overwrite).
48 -u, --ause
50 Allow Unrestricted Sanitize Exit: If set, then the sanitize
51 operation is performed in unrestricted completion mode. If cleared
52 then the sanitize operation is performed in restricted completion
53 mode. This bit shall be ignored if the Sanitize Action field is set
54 to 001b (i.e., Exit Failure Mode).
55 -a <action>, --sanact=<action>
57 Sanitize Action:
58 ┌──────────────────────────┬──────────────────────┐
60 │Value │ Definition │
61 ├──────────────────────────┼──────────────────────┤
62 │0x00 │ Reserved │
63 ├──────────────────────────┼──────────────────────┤
64 │0x01 | exit-failure │ Exit Failure Mode │
65 ├──────────────────────────┼──────────────────────┤
66 │0x02 | start-block-erase │ Start a Block Erase │
67 │ │ sanitize operation │
68 ├──────────────────────────┼──────────────────────┤
69 │0x03 | start-overwrite │ Start an Overwrite │
70 │ │ sanitize operation │
71 ├──────────────────────────┼──────────────────────┤
72 │0x04 | start-crypto-erase │ Start a Crypto Erase │
73 │ │ sanitize operation │
74 └──────────────────────────┴──────────────────────┘
75 -p <overwrite-pattern>, --ovrpat=<overwrite-pattern>
77 Overwrite Pattern: This field is ignored unless the Sanitize Action
78 field in Command Dword 10 is set to 011b (i.e., Overwrite). This
79 field specifies a 32-bit pattern that is used for the Overwrite
80 sanitize operation.
81 --force
83 Ignore namespace is currently busy and performed the operation even
84 though.
85
87 • Has the program issue Sanitize Command :
88 # nvme sanitize /dev/nvme0 -a 0x02
90 # nvme sanitize /dev/nvme0 --sanact=0x01
91 # nvme sanitize /dev/nvme0 --sanact=start-overwrite
92
94 Part of the nvme-user suite.
95NVMe 09/29/2023 NVME-SANITIZE(1)