summaryrefslogtreecommitdiffstats
path: root/doc/man/nvmf_add_ctrl.2
blob: 02d5dfeb5dbc9c1a520790ead1d00c6df08cd173 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
.TH "nvmf_add_ctrl" 9 "nvmf_add_ctrl" "August 2022" "libnvme API manual" LINUX
.SH NAME
nvmf_add_ctrl \- Connect a controller and update topology
.SH SYNOPSIS
.B "int" nvmf_add_ctrl
.BI "(nvme_host_t h "  ","
.BI "nvme_ctrl_t c "  ","
.BI "const struct nvme_fabrics_config *cfg "  ");"
.SH ARGUMENTS
.IP "h" 12
Host to which the controller should be attached
.IP "c" 12
Controller to be connected
.IP "cfg" 12
Default configuration for the controller
.SH "DESCRIPTION"
Issues a 'connect' command to the NVMe-oF controller and inserts \fIc\fP
into the topology using \fIh\fP as parent.
\fIc\fP must be initialized and not connected to the topology.
.SH "RETURN"
0 on success; on failure errno is set and -1 is returned.