summaryrefslogtreecommitdiffstats
path: root/Documentation/cmd-plugins.txt
blob: 4e66cf145214e507b06b8eb09c728c2fc5443ede (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
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
linknvme:nvme-intel-id-ctrl[1]::
	Intel - NVMe Identify Controller

linknvme:nvme-intel-internal-log[1]::
	Retrieve Intel device's internal log and save to file

linknvme:nvme-intel-lat-stats[1]::
	Retrieve NVMe Identify Controller, return result and structure

linknvme:nvme-intel-market-name[1]::
	Intel vendor specific marketing name log page

linknvme:nvme-intel-smart-log-add[1]::
	NVMe Intel Additional SMART log page

linknvme:nvme-intel-temp-stats[1]::
	NVMe Intel Additional SMART log page for temp stats

linknvme:nvme-huawei-id-ctrl[1]::
	NVMe huawei Identify Controller

linknvme:nvme-huawei-list[1]::
	List all recognized Huawei NVMe devices

linknvme:nvme-dera-stat[1]::
	NVMe Dera Device status and Additional SMART log page request

linknvme:nvme-micron-clear-pcie-errors[1]::
	Clears correctable PCIe correctable errors of given Micron device

linknvme:nvme-micron-internal-log[1]::
	Retrieve Micron device's internal logs and save to given zip file

linknvme:nvme-micron-nand-stats[1]::
	Retrieves NAND statistics of given micron device

linknvme:nvme-micron-pcie-stats[1]::
	Retrieves pcie error statistics for given micron device

linknvme:nvme-micron-selective-download[1]::
	Performs selective firmware download

linknvme:nvme-micron-smart-add-log[1]::
	Retrieves NAND statistics

linknvme:nvme-micron-temperature-stats[1]::
	Retrieves temperature information of given micron device

linknvme:nvme-netapp-ontapdevices[1]::
	Display information about ONTAP devices

linknvme:nvme-netapp-smdevices[1]::
	Display information for each NVMe path to an E-Series volume

linknvme:nvme-toshiba-clear-pcie-correctable-errors[1]::
	Reset the PCIe correctable errors count to zero

linknvme:nvme-toshiba-vs-internal-log[1]::
	Retrieve a Toshiba device's vendor specific internal log

linknvme:nvme-toshiba-vs-smart-add-log[1]::
	Retrieve a Toshiba device's vendor specific extended SMART log page

linknvme:nvme-transcend-badblock[1]::
	Retrieve Transcend NVMe device's bad blocks

linknvme:nvme-transcend-healthvalue[1]::
	Use NVMe SMART table to analyse the health value of Transcend device

linknvme:nvme-virtium-show-identify[1]::
	Show a complete detail of identify device information in json format

linknvme:nvme-virtium-save-smart-to-vtview-log[1]::
	Periodically save smart attributes into a log file

linknvme:nvme-wdc-cap-diag[1]::
	Retrieve WDC device's diagnostic log and save to file

linknvme:nvme-wdc-capabilities[1]::
	Display WDC plugin command capabilities

linknvme:nvme-wdc-clear-assert-dump[1]::
	Clears the assert dump (if present)

linknvme:nvme-wdc-clear-fw-activate-history[1]::
	Clears the firmware activate history table

linknvme:nvme-wdc-clear-pcie-corr[1]::
	Clears the pcie correctable errors field

linknvme:nvme-wdc-clear-pcie-correctable-errors[1]::
	Clears the pcie correctable errors returned in the smart-log-add command

linknvme:nvme-wdc-cloud-SSD-plugin-version[1]::
	Display WDC plugin Cloud SSD Plugin Version

linknvme:nvme-wdc-drive-essentials[1]::
	Retrieve WDC device's drive essentials bin files

linknvme:nvme-wdc-drive-log[1]::
	Retrieve WDC device's drive log and save to file

linknvme:nvme-wdc-drive-resize[1]::
	Send NVMe WDC Resize Vendor Unique Command

linknvme:nvme-wdc-enc-get-log[1]::
	Send NVMe WDC enc-get-log Vendor Unique Command

linknvme:nvme-wdc-get-crash-dump[1]::
	Retrieve WDC device's crash dump

linknvme:nvme-wdc-get-drive-status[1]::
	Send the NVMe WDC get-drive-status command

linknvme:nvme-wdc-get-latency-monitor-log[1]::
	Display latency monitor log page data in human readable format

linknvme:nvme-wdc-get-pfail-dump[1]::
	Retrieve WDC device's pfail crash dump

linknvme:nvme-wdc-id-ctrl[1]::
	Send NVMe Identify Controller, return result and structure

linknvme:nvme-wdc-log-page-directory[1]::
	Retrieves the list of Log IDs supported by the drive

linknvme:nvme-wdc-namespace-resize[1]::
	Resizes the device's namespace

linknvme:nvme-wdc-purge-monitor[1]::
	Send NVMe WDC Purge-Monitor Vendor Unique Command

linknvme:nvme-wdc-purge[1]::
	Send NVMe WDC Purge Vendor Unique Command

linknvme:nvme-wdc-smart-add-log[1]::
	Send NVMe WDC smart add log Vendor Unique Command

linknvme:nvme-wdc-vs-drive-info[1]::
	Send the NVMe WDC vs-drive-info command

linknvme:nvme-wdc-vs-error-reason-identifier[1]::
	Retrieve WDC device's telemetry log error reason identifier field

linknvme:nvme-wdc-vs-fw-activate-history[1]::
	Execute NVMe WDC vs-fw-activate-history Vendor Unique Command

linknvme:nvme-wdc-vs-internal-log[1]::
	Retrieve WDC device's internal firmware log and save to file

linknvme:nvme-wdc-vs-nand-stats[1]::
	Send NVMe WDC vs-nand-stats Vendor Unique Command

linknvme:nvme-wdc-vs-telemetry-controller-option[1]::
	Disable/Enable the controller initiated option of the telemetry log page

linknvme:nvme-wdc-vs-temperature-stats[1]::
	Display temperature-related statistics

linknvme:nvme-zns-changed-zone-list[1]::
	Retrieve Changed Zone log for the given device

linknvme:nvme-zns-close-zone[1]::
	Closes one or all zones

linknvme:nvme-zns-finish-zone[1]::
	Finishes one or all zones

linknvme:nvme-zns-id-ctrl[1]::
	Send NVMe Zoned Command Set Identify Controller

linknvme:nvme-zns-id-ns[1]::
	Send NVMe Zoned Command Set Identify Namespace

linknvme:nvme-zns-offline-zone[1]::
	Offlines one or all zones

linknvme:nvme-zns-open-zone[1]::
	Opens one or all zones

linknvme:nvme-zns-report-zones[1]::
	Retrieve and display the Report Zones data structure

linknvme:nvme-zns-reset-zone[1]::
	Resets one or all zones

linknvme:nvme-zns-set-zone-desc[1]::
	Set extended descriptor data for a zone

linknvme:nvme-zns-zone-append[1]::
	Send an NVMe write command, provide results

linknvme:nvme-zns-zone-mgmt-recv[1]::
	Zone Management Receive command

linknvme:nvme-zns-zone-mgmt-send[1]::
	Zone Management Send command

linknvme:nvme-zns-zrwa-flush-zone[1]::
	Flush LBAs associated with a ZRWA to a zone