| 1 |
.TH "libnvme" 9 "struct nvme_sanitize_nvm_args" "November 2025" "API Manual" LINUX |
| 2 |
.SH NAME |
| 3 |
struct nvme_sanitize_nvm_args \- Arguments for the NVMe Sanitize NVM command |
| 4 |
.SH SYNOPSIS |
| 5 |
struct nvme_sanitize_nvm_args { |
| 6 |
.br |
| 7 |
.BI " __u32 *result;" |
| 8 |
.br |
| 9 |
.BI " int args_size;" |
| 10 |
.br |
| 11 |
.BI " int fd;" |
| 12 |
.br |
| 13 |
.BI " __u32 timeout;" |
| 14 |
.br |
| 15 |
.BI " enum nvme_sanitize_sanact sanact;" |
| 16 |
.br |
| 17 |
.BI " __u32 ovrpat;" |
| 18 |
.br |
| 19 |
.BI " bool ause;" |
| 20 |
.br |
| 21 |
.BI " __u8 owpass;" |
| 22 |
.br |
| 23 |
.BI " bool oipbp;" |
| 24 |
.br |
| 25 |
.BI " bool nodas;" |
| 26 |
.br |
| 27 |
.BI " bool emvs;" |
| 28 |
.br |
| 29 |
.BI " |
| 30 |
}; |
| 31 |
.br |
| 32 |
|
| 33 |
.SH Members |
| 34 |
.IP "result" 12 |
| 35 |
The command completion result from CQE dword0 |
| 36 |
.IP "args_size" 12 |
| 37 |
Size of \fIstruct nvme_sanitize_nvm_args\fP |
| 38 |
.IP "fd" 12 |
| 39 |
File descriptor of nvme device |
| 40 |
.IP "timeout" 12 |
| 41 |
Timeout in ms |
| 42 |
.IP "sanact" 12 |
| 43 |
Sanitize action, see \fIenum nvme_sanitize_sanact\fP |
| 44 |
.IP "ovrpat" 12 |
| 45 |
Overwrite pattern |
| 46 |
.IP "ause" 12 |
| 47 |
Set to allow unrestricted sanitize exit |
| 48 |
.IP "owpass" 12 |
| 49 |
Overwrite pass count |
| 50 |
.IP "oipbp" 12 |
| 51 |
Set to overwrite invert pattern between passes |
| 52 |
.IP "nodas" 12 |
| 53 |
Set to not deallocate blocks after sanitizing |
| 54 |
.IP "emvs" 12 |
| 55 |
Set to enter media verification state |