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

NAME

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

SYNOPSIS

9       nvme sanitize-log <device> [--rae | -r] [--output-format=<fmt> | -o <fmt>]
10                                    [--human-readable | -H]
11                                    [--raw-binary | -b]
12

DESCRIPTION

14       Retrieves the NVMe Sanitize log page from an NVMe device and provides
15       the status of sanitize command.
16
17       The <device> parameter is mandatory NVMe character device (ex:
18       /dev/nvme0).
19
20       Expected status and description :-
21
22       ┌────────────┬────────────────────────────┐
23       │Status Code │ Description                │
24       ├────────────┼────────────────────────────┤
25       │            │                            │
26       │0x0000      │ NVM subsystem has never    │
27       │            │ been sanitized.            │
28       ├────────────┼────────────────────────────┤
29       │            │                            │
30       │0x0001      │ The most recent sanitize   │
31       │            │ operation completed        │
32       │            │ successfully.              │
33       ├────────────┼────────────────────────────┤
34       │            │                            │
35       │0x0002      │ A sanitize operation is    │
36       │            │ currently in progress.     │
37       ├────────────┼────────────────────────────┤
38       │            │                            │
39       │0x0003      │ The most recent sanitize   │
40       │            │ operation failed.          │
41       ├────────────┼────────────────────────────┤
42       │            │                            │
43       │0x0100      │ Global Data Erased bit If  │
44       │            │ set to 1 then non-volatile │
45       │            │ storage in the NVM         │
46       │            │ subsystem has not been     │
47       │            │ written to: a) since being │
48       │            │ manufactured and the NVM   │
49       │            │ subsystem has never been   │
50       │            │ sanitized; or b) since the │
51       │            │ most recent successful     │
52       │            │ sanitize operation. If     │
53       │            │ cleared to 0, then         │
54       │            │ non-volatile storage in    │
55       │            │ the NVM subsystem has been │
56       │            │ written to: a) since being │
57       │            │ manufactured and the NVM   │
58       │            │ subsystem has never been   │
59       │            │ sanitized; or b) since the │
60       │            │ most recent successful     │
61       │            │ sanitize operation of the  │
62       │            │ NVM subsystem.             │
63       └────────────┴────────────────────────────┘
64
65       Sanitize Progress - percentage complete
66
67       On success it returns 0, error code otherwise.
68

OPTIONS

70       -r, --rae
71           Retain an Asynchronous Event.
72
73       -o <format>, --output-format=<format>
74           Set the reporting format to normal, json, or binary. Only one
75           output format can be used at a time.
76
77       -H, --human-readable
78           This option will parse and format many of the bit fields into
79           human-readable formats.
80
81       -b, --raw-binary
82           Print the raw buffer to stdout. Structure is not parsed by program.
83           This overrides the vendor specific and human readable options.
84

EXAMPLES

86       •   Has the program issue Sanitize-log Command :
87
88               # nvme sanitize-log /dev/nvme0
89

NVME

91       Part of the nvme-user suite.
92
93
94
95NVMe                              09/29/2023              NVME-SANITIZE-LOG(1)