summaryrefslogtreecommitdiffstats
path: root/Documentation/nvme-ocp-smart-add-log.txt
blob: 3a2582274b618299d71097dac885d9ab43905374 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
nvme-ocp-smart-add-log(1)
=========================

NAME
----
nvme-ocp-smart-add-log - Retrieves Extended SMART information of given OCP
compliant device

SYNOPSIS
--------
[verse]
'nvme ocp smart-add-log' <device> [--output-format=<fmt> | -o <fmt>]

DESCRIPTION
-----------
For the NVMe device given, send a smart-add-log command and
provide the additional smart log.

The <device> parameter is mandatory and may be either the NVMe character
device (ex: /dev/nvme0) or block device (ex: /dev/nvme0n1).

This will only work on OCP compliant devices supporting this feature.
Results for any other device are undefined.

On success it returns 0, error code otherwise.

OPTIONS
-------
-o <format>::
--output-format=<format>::
	Set the reporting format to 'normal' or 'json'. Only one output format
	can be used at a time. The default is normal.

EXAMPLES
--------
* Has the program issue a smart-add-log command to retrieve the 0xC0 log page.
+
------------
# nvme ocp smart-add-log /dev/nvme0
------------

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