Skip to content

Commit

Permalink
nbd: Document the NBD-specific uri parameter
Browse files Browse the repository at this point in the history
Signed-off-by: Richard W.M. Jones <[email protected]>
Signed-off-by: Jens Axboe <[email protected]>
  • Loading branch information
rwmjones authored and axboe committed Aug 2, 2019
1 parent 34a8f35 commit f2d6de5
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 1 deletion.
11 changes: 10 additions & 1 deletion HOWTO
Original file line number Diff line number Diff line change
Expand Up @@ -1999,7 +1999,7 @@ I/O engine
**libiscsi**
Read and write iscsi lun with libiscsi.
**nbd**
Synchronous read and write a Network Block Device (NBD).
Read and write a Network Block Device (NBD).

I/O engine specific parameters
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Expand Down Expand Up @@ -2301,6 +2301,15 @@ with the caveat that when used on the command line, they must come after the
turns on verbose logging from libcurl, 2 additionally enables
HTTP IO tracing. Default is **0**

.. option:: uri=str : [nbd]

Specify the NBD URI of the server to test. The string
is a standard NBD URI
(see https://github.com/NetworkBlockDevice/nbd/tree/master/doc).
Example URIs: nbd://localhost:10809
nbd+unix:///?socket=/tmp/socket
nbds://tlshost/exportname

I/O depth
~~~~~~~~~

Expand Down
16 changes: 16 additions & 0 deletions fio.1
Original file line number Diff line number Diff line change
Expand Up @@ -2022,6 +2022,22 @@ blocksize=8k will write 16 sectors with each command. fio will still
generate 8k of data for each command butonly the first 512 bytes will
be used and transferred to the device. The writefua option is ignored
with this selection.
.RE
.RE
.TP
.BI (nbd)uri \fR=\fPstr
Specify the NBD URI of the server to test.
The string is a standard NBD URI (see
\fIhttps://github.com/NetworkBlockDevice/nbd/tree/master/doc\fR).
Example URIs:
.RS
.RS
.TP
\fInbd://localhost:10809\fR
.TP
\fInbd+unix:///?socket=/tmp/socket\fR
.TP
\fInbds://tlshost/exportname\fR

.SS "I/O depth"
.TP
Expand Down

0 comments on commit f2d6de5

Please sign in to comment.