Skip to content

Commit

Permalink
doc: add host-discovery-log command
Browse files Browse the repository at this point in the history
Added the nvme-host-discovery-log.txt file.

Signed-off-by: Tokunori Ikegami <[email protected]>
  • Loading branch information
ikegami-t authored and igaw committed Feb 26, 2025
1 parent de7d140 commit 2b7a6d7
Showing 1 changed file with 57 additions and 0 deletions.
57 changes: 57 additions & 0 deletions Documentation/nvme-host-discovery-log.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
nvme-host-discovery-log(1)
==========================

NAME
----
nvme-host-discovery-log - Retrieve Host Discovery Log, show it

SYNOPSIS
--------
[verse]
'nvme host-discovery-log' <device> [--all-host-entries | -a] [--rae | -r]
[--verbose | -v] [--output-format=<fmt> | -o <fmt>]
[--timeout=<timeout>]

DESCRIPTION
-----------
Retrieve Host Discovery Log, show it

The <device> parameter is mandatory NVMe MI device supported by the discovery
controller (ex: mctp:<net>,<eid>[:ctrl-id]).

On success it returns 0, error code otherwise.

OPTIONS
-------
-a::
--all-host-entries::
All Host Entries.

-r::
--rae::
Retain an Asynchronous Event.

-v::
--verbose::
Increase the information detail in the output.

-o <fmt>::
--output-format=<fmt>::
Set the reporting format to 'normal', 'json' or 'binary'. Only one
output format can be used at a time.

-t <timeout>::
--timeout=<timeout>::
Override default timeout value. In milliseconds.

EXAMPLES
--------
* Has the program issue a host-discovery-log
+
------------
# nvme host-discovery-log mctp:<net>,<eid>[:ctrl-id]
------------

NVME
----
Part of the nvme-user suite.

0 comments on commit 2b7a6d7

Please sign in to comment.