Skip to content

Commit 5a52f60

Browse files
ikegami-tigaw
authored andcommitted
doc: add ocp get-error-injection command
The set-error-injection command will be added separately. Signed-off-by: Tokunori Ikegami <ikegami.t@gmail.com>
1 parent de01421 commit 5a52f60

File tree

1 file changed

+57
-0
lines changed

1 file changed

+57
-0
lines changed
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
nvme-ocp-get-error-injection(1)
2+
===============================
3+
4+
NAME
5+
----
6+
nvme-ocp-get-error-injection - Return set of error injection
7+
8+
SYNOPSIS
9+
--------
10+
[verse]
11+
'nvme ocp get-error-injection' <device> [--no-uuid | -n]
12+
[--sel=<select> | -s <select>]
13+
14+
DESCRIPTION
15+
-----------
16+
Return set of error injection.
17+
18+
The <device> parameter is mandatory NVMe character device (ex: /dev/nvme0).
19+
20+
This will only work on OCP compliant devices supporting this feature.
21+
Results for any other device are undefined.
22+
23+
On success it returns 0, error code otherwise.
24+
25+
OPTIONS
26+
-------
27+
-n::
28+
--no-uuid::
29+
Do not try to automatically detect UUID index for this command (required
30+
for old OCP 1.0 support)
31+
32+
-s <select>::
33+
--sel=<select>::
34+
Select (SEL): This field specifies which value of the attributes
35+
to return in the provided data:
36+
+
37+
[]
38+
|==================
39+
|Select|Description
40+
|0|Current
41+
|1|Default
42+
|2|Saved
43+
|3|Supported capabilities
44+
|4-7|Reserved
45+
|==================
46+
47+
EXAMPLES
48+
--------
49+
* Has the program issue a get-error-injection to retrieve the 0xC0 get features.
50+
+
51+
------------
52+
# nvme ocp get-error-injection /dev/nvme0
53+
------------
54+
55+
NVME
56+
----
57+
Part of the nvme-user suite.

0 commit comments

Comments
 (0)