| Top | |
|
|
|
SetHostNQN (IN ay hostnqn, IN a{sv} options); SetHostID (IN ay hostid, IN a{sv} options); Connect (IN ay subsysnqn, IN s transport, IN s transport_addr, IN a{sv} options, OUT o nvme_ctrl);
SetHostNQN (IN ay hostnqn,
IN a{sv} options);
Sets the system-wide Host NQN string,
|
The Host NQN value to set. |
|
Options (currently unused except for standard options). |
Since 2.10.0
SetHostID (IN ay hostid,
IN a{sv} options);
Sets the system-wide Host ID string,
|
The Host ID value to set. |
|
Options (currently unused except for standard options). |
Since 2.10.0
Connect (IN ay subsysnqn,
IN s transport,
IN s transport_addr,
IN a{sv} options,
OUT o nvme_ctrl);
Create a transport connection to a remote system and create a NVMe over Fabrics controller
for the NVMe subsystem specified by the subsysnqn option.
Valid values for transport are rdma, fc,
tcp and loop.
By default, additional options are read from the system configuration file /etc/nvme/config.json.
This follows the default behaviour of nvme-cli. Use the config
option to either specify a different config file or disable use of it altogether. The naming
of the additional options are generally kept consistent with the JSON config file schema and
any option specified acts as an override. Available options are:
transport_svcid (type 's') |
The transport service id. For transports using IP addressing (e.g. |
host_traddr (type 's') |
The network address used on the host to connect to the Controller. For TCP, this sets the source address on the socket. |
host_iface (type 's') |
The network interface used on the host to connect to the Controller (e.g. IP |
host_nqn (type 'ay') |
Overrides the default Host NQN that identifies the NVMe Host. |
host_id (type 'ay') |
Overrides the default Host UUID. |
config (type 'ay') |
Use the specified JSON configuration file instead of the default file (see above) or specify |
dhchap_key (type 'ay') |
NVMe in-band authentication secret in ASCII format as described in the NVMe 2.0 specification. When not specified, the secret is by default read from |
dhchap_ctrl_key (type 'ay') |
NVMe in-band authentication controller secret for bi-directional authentication. When not specified, no bi-directional authentication is attempted. |
nr_io_queues (type 'i') |
The number of I/O queues. |
nr_write_queues (type 'i') |
Number of additional queues that will be used for write I/O. |
nr_poll_queues (type 'i') |
Number of additional queues that will be used for polling latency sensitive I/O. |
queue_size (type 'i') |
Number of elements in the I/O queues. |
keep_alive_tmo (type 'i') |
The keep alive timeout (in seconds). |
reconnect_delay (type 'i') |
The delay (in seconds) before reconnect is attempted after a connect loss. |
ctrl_loss_tmo (type 'i') |
The controller loss timeout period (in seconds). A special value of |
fast_io_fail_tmo (type 'i') |
Fast I/O Fail timeout (in seconds). |
tos (type 's') |
Type of service. |
duplicate_connect (type 'b') |
Allow duplicated connections between same transport host and subsystem port. |
disable_sqflow (type 'b') |
Disables SQ flow control to omit head doorbell update for submission queues when sending nvme completions. |
hdr_digest (type 'b') |
Generates/verifies header digest (TCP). |
data_digest (type 'b') |
Generates/verifies data digest (TCP). |
tls (type 'b') |
Enable TLS encryption (TCP). |
hostsymname (type 'ay') |
TP8010: NVMe host symbolic name. |
keyring (type 'ay') |
Keyring to store and lookup keys. |
tls_key (type 'ay') |
TLS PSK for the connection. |
|
The name for the NVMe subsystem to connect to. |
|
The network fabric used for a NVMe-over-Fabrics network. |
|
The network address of the Controller. For transports using IP addressing (e.g. |
|
Additional options, includes standard options. |
|
An object path to the connected NVMeoF controller. |
Since 2.10.0