summaryrefslogtreecommitdiffstats
path: root/doc/man/nvme_mi_admin_identify_ns.2
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-29 04:40:20 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-29 04:40:20 +0000
commit2dba2525fb35dcfc79aad5bdf6c92e790d69635c (patch)
treeac8ac7d3960922094733bac6d9a5300da7171c56 /doc/man/nvme_mi_admin_identify_ns.2
parentInitial commit. (diff)
downloadlibnvme-2dba2525fb35dcfc79aad5bdf6c92e790d69635c.tar.xz
libnvme-2dba2525fb35dcfc79aad5bdf6c92e790d69635c.zip
Adding upstream version 1.3.upstream/1.3upstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'doc/man/nvme_mi_admin_identify_ns.2')
-rw-r--r--doc/man/nvme_mi_admin_identify_ns.221
1 files changed, 21 insertions, 0 deletions
diff --git a/doc/man/nvme_mi_admin_identify_ns.2 b/doc/man/nvme_mi_admin_identify_ns.2
new file mode 100644
index 0000000..5333f89
--- /dev/null
+++ b/doc/man/nvme_mi_admin_identify_ns.2
@@ -0,0 +1,21 @@
+.TH "nvme_mi_admin_identify_ns" 9 "nvme_mi_admin_identify_ns" "January 2023" "libnvme API manual" LINUX
+.SH NAME
+nvme_mi_admin_identify_ns \- Perform an Admin identify command for a namespace
+.SH SYNOPSIS
+.B "int" nvme_mi_admin_identify_ns
+.BI "(nvme_mi_ctrl_t ctrl " ","
+.BI "__u32 nsid " ","
+.BI "struct nvme_id_ns *ns " ");"
+.SH ARGUMENTS
+.IP "ctrl" 12
+Controller to process identify command
+.IP "nsid" 12
+namespace ID
+.IP "ns" 12
+Namespace identification to populate
+.SH "DESCRIPTION"
+Perform an Identify (namespace) command, setting the namespace id data
+in \fIns\fP. The namespace is expected to active and allocated.
+.SH "RETURN"
+The nvme command status if a response was received (see
+\fIenum nvme_status_field\fP) or -1 with errno set otherwise.