summaryrefslogtreecommitdiffstats
path: root/Documentation/nvme-wdc-vs-telemetry-controller-option.txt
blob: 2353e7c0a2b2091e46b3a7311d556a7dcfd859bb (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
53
54
55
56
57
58
59
60
61
62
63
64
65
nvme-wdc-vs-telemetry-controller-option(1)
==========================================

NAME
----
nvme-wdc-vs-telemetry-controller-option - Disable/Enable the controller
initiated option of the telemetry log page.

SYNOPSIS
--------
[verse]
'nvme wdc vs-telemetry-controller-option' <device>
			[--disable, -d] [--enable, -e] [--status, -s] 

DESCRIPTION
-----------

For the NVMe device given, sends the WDC Vendor Specific set feature command to
disable, enable or get current status the controller initiated option of the
telemetry log page.

The <device> parameter is mandatory NVMe character device (ex: /dev/nvme0).

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

OPTIONS
-------
-d::
--disable::
	Disables the controller initiated option of the telemetry log page.

-e::
--enable::
	Enables the controller initiated option of the telemetry log page.

-s::
--status::
	Returns the current status (enabled or disabled) of the controller
	initiated option of the telemetry log page.

EXAMPLES
--------
* Disables the controller initiated option of the telemetry log page:
+
------------
# nvme wdc vs-telemetry-controller-option /dev/nvme0 --disable
# nvme wdc vs-telemetry-controller-option /dev/nvme0 -d
------------
* Enables the controller initiated option of the telemetry log page:
+
------------
# nvme wdc vs-telemetry-controller-option /dev/nvme0 --enable
# nvme wdc vs-telemetry-controller-option /dev/nvme0 -e
------------
* Gets the current status (enabled or disabled) of the controller initiated option of the telemetry log page:
+
------------
# nvme wdc vs-telemetry-controller-option /dev/nvme0 --status
# nvme wdc vs-telemetry-controller-option /dev/nvme0 -s
------------

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