Blame Documentation/nvme-toshiba-vs-smart-add-log.txt

Packit dd4ba5
nvme-toshiba-vs-smart-add-log(1)
Packit dd4ba5
================================
Packit dd4ba5
Packit dd4ba5
NAME
Packit dd4ba5
----
Packit dd4ba5
nvme-toshiba-vs-smart-add-log - Retrieve a Toshiba device's vendor specific extended SMART log page contents and either save to file or dump the contents.
Packit dd4ba5
Packit dd4ba5
SYNOPSIS
Packit dd4ba5
--------
Packit dd4ba5
[verse]
Packit dd4ba5
'nvme toshiba vs-smart-add-log ' <device> [--log=<NUM>, -l <NUM>]
Packit dd4ba5
		[--namespace-id=<NUM>, -n <NUM>]
Packit dd4ba5
		[--output-file=<FILE>, -o <FILE>]
Packit dd4ba5
Packit dd4ba5
Packit dd4ba5
DESCRIPTION
Packit dd4ba5
-----------
Packit dd4ba5
For the NVMe device given, sends the Toshiba vendor log
Packit dd4ba5
request and either saves the result to a file or dumps the content to stdout.
Packit dd4ba5
Packit dd4ba5
The <device> parameter is mandatory and may be either the NVMe
Packit dd4ba5
character device (ex: /dev/nvme0), or a namespace block device (ex:
Packit dd4ba5
/dev/nvme0n1). 
Packit dd4ba5
Packit dd4ba5
The log contents may be associated with the controller, in which case the namespace parameter is ignored.
Packit dd4ba5
Packit dd4ba5
Two logs exist, page 0xC0 (log page directory) and page 0xCA (vendor log page)
Packit dd4ba5
Packit dd4ba5
This will only work on Toshiba devices supporting this feature.
Packit dd4ba5
Packit dd4ba5
OPTIONS
Packit dd4ba5
-------
Packit dd4ba5
Packit dd4ba5
-l <NUM>::
Packit dd4ba5
--log=<NUM>::
Packit dd4ba5
	Log page: 0xC0 or 0xCA  (defaults to 0xCA)
Packit dd4ba5
Packit dd4ba5
-n <NUM>::
Packit dd4ba5
--namespace-id=<NUM>::
Packit dd4ba5
Packit dd4ba5
-o <FILE>::
Packit dd4ba5
--output-file=<FILE>::
Packit dd4ba5
	Output binary file. Defaults to text-formatted dump to stdout
Packit dd4ba5
Packit dd4ba5
Packit dd4ba5
Packit dd4ba5
EXAMPLES
Packit dd4ba5
--------
Packit dd4ba5
* Get the current log from the device and dumps it to stdout:
Packit dd4ba5
+
Packit dd4ba5
------------
Packit dd4ba5
# nvme toshiba vs-smart-add-log /dev/nvme0 
Packit dd4ba5
------------
Packit dd4ba5
+
Packit dd4ba5
Packit dd4ba5
* Get the contents of log page 0xC0 from the device and save to a binary file:
Packit dd4ba5
+
Packit dd4ba5
------------
Packit dd4ba5
# nvme toshiba vs-smart-add-log /dev/nvme0 --output-file=log.bin --log=0xC0
Packit dd4ba5
------------
Packit dd4ba5
Packit dd4ba5
NVME
Packit dd4ba5
----
Packit dd4ba5
Part of the nvme-user suite