1NVME-SANITIZE(1)                  NVMe Manual                 NVME-SANITIZE(1)
2
3
4

NAME

6       nvme-sanitize - Send NVMe Sanitize Command, return result
7

SYNOPSIS

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

DESCRIPTION

17       For the NVMe device given, sends a Sanitize command and provides the
18       result.
19
20       The <device> parameter is mandatory NVMe character device (ex:
21       /dev/nvme0).
22
23       On success it returns 0, error code otherwise.
24

OPTIONS

26       -d, --no-delloc
27           No Deallocate After Sanitize: If set, then the controller shall not
28           deallocate any logical blocks as a result of successfully
29           completing the sanitize operation. If cleared, then the controller
30           should deallocate logical blocks as a result of successfully
31           completing the sanitize operation. This bit shall be ignored if the
32           Sanitize Action field is set to 001b (i.e., Exit Failure Mode).
33
34       -i, --oipbp
35           Overwrite Invert Pattern Between Passes: If set, then the Overwrite
36           Pattern shall be inverted between passes. If cleared, then the
37           overwrite pattern shall not be inverted between passes. This bit
38           shall be ignored unless the Sanitize Action field is set to 011b
39           (i.e., Overwrite).
40
41       -n <overwrite-pass-count>, --owpass=<overwrite-pass-count>
42           Overwrite Pass Count: This field specifies the number of overwrite
43           passes (i.e., how many times the media is to be overwritten) using
44           the data from the Overwrite Pattern field of this command. A value
45           of 0 specifies 16 overwrite passes. This field shall be ignored
46           unless the Sanitize Action field is set to 011b (i.e., Overwrite).
47
48       -u, --ause
49           Allow Unrestricted Sanitize Exit: If set, then the sanitize
50           operation is performed in unrestricted completion mode. If cleared
51           then the sanitize operation is performed in restricted completion
52           mode. This bit shall be ignored if the Sanitize Action field is set
53           to 001b (i.e., Exit Failure Mode).
54
55       -a <action>, --sanact=<action>
56           Sanitize Action: 000b - Reserved 001b - Exit Failure Mode 010b -
57           Start a Block Erase sanitize operation 011b - Start an Overwrite
58           sanitize operation 100b - Start a Crypto Erase sanitize operation
59
60       -p <overwrite-pattern>, --ovrpat=<overwrite-pattern>
61           Overwrite Pattern: This field is ignored unless the Sanitize Action
62           field in Command Dword 10 is set to 011b (i.e., Overwrite). This
63           field specifies a 32-bit pattern that is used for the Overwrite
64           sanitize operation.
65

EXAMPLES

67       ยท   Has the program issue Sanitize Command :
68
69               # nvme sanitize /dev/nvme0n1 -a 0x02
70               # nvme sanitize /dev/nvme0n1 --sanact=0x01
71

NVME

73       Part of the nvme-user suite.
74
75
76
77NVMe                              06/05/2018                  NVME-SANITIZE(1)
Impressum