Skip to content

Commit 2b7a6d7

Browse files
ikegami-tigaw
authored andcommitted
doc: add host-discovery-log command
Added the nvme-host-discovery-log.txt file. Signed-off-by: Tokunori Ikegami <[email protected]>
1 parent de7d140 commit 2b7a6d7

File tree

1 file changed

+57
-0
lines changed

1 file changed

+57
-0
lines changed
Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
nvme-host-discovery-log(1)
2+
==========================
3+
4+
NAME
5+
----
6+
nvme-host-discovery-log - Retrieve Host Discovery Log, show it
7+
8+
SYNOPSIS
9+
--------
10+
[verse]
11+
'nvme host-discovery-log' <device> [--all-host-entries | -a] [--rae | -r]
12+
[--verbose | -v] [--output-format=<fmt> | -o <fmt>]
13+
[--timeout=<timeout>]
14+
15+
DESCRIPTION
16+
-----------
17+
Retrieve Host Discovery Log, show it
18+
19+
The <device> parameter is mandatory NVMe MI device supported by the discovery
20+
controller (ex: mctp:<net>,<eid>[:ctrl-id]).
21+
22+
On success it returns 0, error code otherwise.
23+
24+
OPTIONS
25+
-------
26+
-a::
27+
--all-host-entries::
28+
All Host Entries.
29+
30+
-r::
31+
--rae::
32+
Retain an Asynchronous Event.
33+
34+
-v::
35+
--verbose::
36+
Increase the information detail in the output.
37+
38+
-o <fmt>::
39+
--output-format=<fmt>::
40+
Set the reporting format to 'normal', 'json' or 'binary'. Only one
41+
output format can be used at a time.
42+
43+
-t <timeout>::
44+
--timeout=<timeout>::
45+
Override default timeout value. In milliseconds.
46+
47+
EXAMPLES
48+
--------
49+
* Has the program issue a host-discovery-log
50+
+
51+
------------
52+
# nvme host-discovery-log mctp:<net>,<eid>[:ctrl-id]
53+
------------
54+
55+
NVME
56+
----
57+
Part of the nvme-user suite.

0 commit comments

Comments
 (0)