summaryrefslogtreecommitdiffstats
path: root/Documentation/nvme-wdc-get-dev-capabilities-log.txt
blob: cf8606a5c902c1821a2030d83ca264ac0a9dfbf9 (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
45
46
47
nvme-wdc-get-dev-capabilities-log(1)
====================================

NAME
----
nvme-wdc-get-dev-capabilities-log - Send NVMe WDC get-dev-capabilities-log 
plugin command, return parsed log output

SYNOPSIS
--------
[verse]
'nvme wdc get-dev-capabilities-log' <device> [--output-format=<fmt> | -o <fmt>]

DESCRIPTION
-----------
For the NVMe device given, send a WDC plugin get-dev-capabilities-log command
and output the device capabilities log data. The --output-format option will 
format the output as specified.

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

This will only work on WDC devices supporting this log page.
Results for any other device are undefined.

On success it returns the parsed device capabilities log page data, error
code otherwise.

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

EXAMPLES
--------
* Has the program issue WDC get-dev-capabilities-log plugin command :
+
------------
# nvme wdc get-dev-capabilities-log /dev/nvme0
------------

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