Skip to content

Commit 6a33622

Browse files
ikegami-tigaw
authored andcommitted
doc: add changed-alloc-ns-list-log command
Added the nvme-changed-alloc-ns-list-log.txt file. Signed-off-by: Tokunori Ikegami <[email protected]>
1 parent 8b1b046 commit 6a33622

1 file changed

Lines changed: 67 additions & 0 deletions

File tree

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
nvme-changed-alloc-ns-list-log(1)
2+
=================================
3+
4+
NAME
5+
----
6+
nvme-changed-alloc-ns-list-log - Send NVMe Changed Allocated Namespace List
7+
log page request, returns result and log.
8+
9+
SYNOPSIS
10+
--------
11+
[verse]
12+
'nvme changed-alloc-ns-list-log' <device> [--raw-binary | -b]
13+
[--output-format=<fmt> | -o <fmt>] [--verbose | -v]
14+
[--timeout=<timeout>]
15+
16+
DESCRIPTION
17+
-----------
18+
Retrieves the NVMe Changed Allocated Namespace List log page from an NVMe
19+
device and provides the returned structure.
20+
21+
The <device> parameter is mandatory and must be a NVMe character device
22+
(ex: /dev/nvme0).
23+
24+
On success, the returned Changed Allocated Namespace List log structure may
25+
be returned in one of several ways depending on the option flags; the
26+
structure may parsed by the program and printed in a readable format or
27+
the raw buffer may be printed to stdout for another program to parse.
28+
29+
OPTIONS
30+
-------
31+
-b::
32+
--raw-binary::
33+
Print the raw Changed Namespace List log buffer to stdout.
34+
35+
-o <fmt>::
36+
--output-format=<fmt>::
37+
Set the reporting format to 'normal', 'json' or 'binary'. Only one
38+
output format can be used at a time.
39+
40+
-v::
41+
--verbose::
42+
Increase the information detail in the output.
43+
44+
-t <timeout>::
45+
--timeout=<timeout>::
46+
Override default timeout value. In milliseconds.
47+
48+
EXAMPLES
49+
--------
50+
* Print the Changed Allocated Namespace List Log page in a human readable format:
51+
+
52+
------------
53+
# nvme changed-alloc-ns-list-log /dev/nvme0
54+
------------
55+
+
56+
57+
* Print the raw Changed Allocated Namespace List log to a file:
58+
+
59+
------------
60+
# nvme changed-alloc-ns-list-log /dev/nvme0 --raw-binary > log.raw
61+
------------
62+
+
63+
It is probably a bad idea to not redirect stdout when using this mode.
64+
65+
NVME
66+
----
67+
Part of the nvme-user suite

0 commit comments

Comments
 (0)