forked from linux-nvme/nvme-cli
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Added the nvme-host-discovery-log.txt file. Signed-off-by: Tokunori Ikegami <[email protected]>
- Loading branch information
Showing
1 changed file
with
57 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. |