summaryrefslogtreecommitdiffstats
path: root/Documentation/nvme-wdc-vs-cloud-log.txt
blob: 97392959437b42e0c16caa758d26242913485875 (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
48
49
50
51
52
nvme-wdc-vs-cloud-log(1)
========================

NAME
----
nvme-wdc-vs-cloud-log - Send NVMe WDC vs-cloud-log Vendor Unique Command, return result

SYNOPSIS
--------
[verse]
'nvme wdc vs-cloud-log' <device> [--output-format=<normal|json> -o <normal|json>]
			[--namespace-id=<nsid> | -n <nsid>]

DESCRIPTION
-----------
For the NVMe device given, send a Vendor Unique WDC vs-cloud-log command and
provide the smart/health 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 WDC devices supporting this feature.
Results for any other device are undefined.

On success it returns 0, 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.

-n <nsid>::
--namespace-id=<nsid>::
	Sets the command's nsid value to the given nsid. Defaults to
	0xffffffff if not given. This option may not affect anything
	depending on the log page, which may or may not be specific to
	a namespace.

EXAMPLES
--------
* Has the program issue WDC vs-cloud-log Vendor Unique Command :
+
------------
# nvme wdc vs-cloud-log /dev/nvme0
------------

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