Debian Codegraph @

doc/man/nvme_mi_admin_security_recv.2

raw
1 .TH "nvme_mi_admin_security_recv" 9 "nvme_mi_admin_security_recv" "November 2025" "libnvme API manual" LINUX
2 .SH NAME
3 nvme_mi_admin_security_recv \- Perform a Security Receive command on a controller.
4 .SH SYNOPSIS
5 .B "int" nvme_mi_admin_security_recv
6 .BI "(nvme_mi_ctrl_t ctrl " ","
7 .BI "struct nvme_security_receive_args *args " ");"
8 .SH ARGUMENTS
9 .IP "ctrl" 12
10 Controller to send command to
11 .IP "args" 12
12 Security Receive command arguments
13 .SH "DESCRIPTION"
14 Performs a Security Receive Admin command as specified by \fIargs\fP. Response
15 data is stored in \fIargs->data\fP, which should be a buffer of \fIargs->data_len\fP
16 bytes. Resulting data length is stored in \fIargs->data_len\fP on successful
17 command completion.
18
19 Security Receive data length should not be greater than 4096 bytes to
20 comply with specification limits.
21
22 See: \fIstruct nvme_get_log_args\fP
23 .SH "RETURN"
24 The nvme command status if a response was received (see
25 \fIenum nvme_status_field\fP) or -1 with errno set otherwise.