summaryrefslogtreecommitdiffstats
path: root/doc/man/nvmf_connect_disc_entry.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/nvmf_connect_disc_entry.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/nvmf_connect_disc_entry.2')
-rw-r--r--doc/man/nvmf_connect_disc_entry.220
1 files changed, 20 insertions, 0 deletions
diff --git a/doc/man/nvmf_connect_disc_entry.2 b/doc/man/nvmf_connect_disc_entry.2
new file mode 100644
index 0000000..f85bf73
--- /dev/null
+++ b/doc/man/nvmf_connect_disc_entry.2
@@ -0,0 +1,20 @@
+.TH "nvmf_connect_disc_entry" 9 "nvmf_connect_disc_entry" "January 2023" "libnvme API manual" LINUX
+.SH NAME
+nvmf_connect_disc_entry \- Connect controller based on the discovery log page entry
+.SH SYNOPSIS
+.B "nvme_ctrl_t" nvmf_connect_disc_entry
+.BI "(nvme_host_t h " ","
+.BI "struct nvmf_disc_log_entry *e " ","
+.BI "const struct nvme_fabrics_config *defcfg " ","
+.BI "bool *discover " ");"
+.SH ARGUMENTS
+.IP "h" 12
+Host to which the controller should be connected
+.IP "e" 12
+Discovery log page entry
+.IP "defcfg" 12
+Default configuration to be used for the new controller
+.IP "discover" 12
+Set to 'true' if the new controller is a discovery controller
+.SH "RETURN"
+Pointer to the new controller