]> www.infradead.org Git - users/sagi/nvme-cli.git/commitdiff
doc: add host-discovery-log command
authorTokunori Ikegami <ikegami.t@gmail.com>
Mon, 24 Feb 2025 02:28:01 +0000 (11:28 +0900)
committerDaniel Wagner <wagi@monom.org>
Wed, 26 Feb 2025 07:41:20 +0000 (08:41 +0100)
Added the nvme-host-discovery-log.txt file.

Signed-off-by: Tokunori Ikegami <ikegami.t@gmail.com>
Documentation/nvme-host-discovery-log.txt [new file with mode: 0644]

diff --git a/Documentation/nvme-host-discovery-log.txt b/Documentation/nvme-host-discovery-log.txt
new file mode 100644 (file)
index 0000000..f99ee4f
--- /dev/null
@@ -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.