summaryrefslogtreecommitdiffstats
path: root/doc/man/nvme_identify_ns.2
blob: c731ee8f018738fd89579a88e146d5ce56187a32 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
.TH "nvme_identify_ns" 9 "nvme_identify_ns" "July 2022" "libnvme API manual" LINUX
.SH NAME
nvme_identify_ns \- Retrieves nvme identify namespace
.SH SYNOPSIS
.B "int" nvme_identify_ns
.BI "(int fd "  ","
.BI "__u32 nsid "  ","
.BI "struct nvme_id_ns *ns "  ");"
.SH ARGUMENTS
.IP "fd" 12
File descriptor of nvme device
.IP "nsid" 12
Namespace to identify
.IP "ns" 12
User space destination address to transfer the data
.SH "DESCRIPTION"
If the Namespace Identifier (NSID) field specifies an active NSID, then the
Identify Namespace data structure is returned to the host for that specified
namespace.

If the controller supports the Namespace Management capability and the NSID
field is set to NVME_NSID_ALL, then the controller returns an Identify Namespace
data structure that specifies capabilities that are common across namespaces
for this controller.

See \fIstruct nvme_id_ns\fP for details on the structure returned.
.SH "RETURN"
The nvme command status if a response was received (see
\fIenum nvme_status_field\fP) or -1 with errno set otherwise.