summaryrefslogtreecommitdiffstats
path: root/Documentation/nvme-solidigm-vs-internal-log.txt
blob: e488106b2517fcd72cb4d8558b161f7ac1d3d643 (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
nvme-solidigm-vs-internal-log(1)
================================

NAME
----
nvme-solidigm-vs-internal-log - Retrieve Debug log binaries

SYNOPSIS
--------
[verse]
'nvme solidigm vs-internal-log' <device> [--log-type=<type> | -t <type>]
                                          [--output-dir=<dir> | -d <dir>]
                                          [--verbose | -v]

DESCRIPTION
-----------
For the NVMe device given, retrieves the Solidigm vendor-specific internal
debug log binaries and saves them to the specified output directory.

The <device> parameter is mandatory and may be either the NVMe character
device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1).

OPTIONS
-------
-t <type>::
--log-type=<type>::
    Specify the type of log to retrieve. Valid options are ALL, CIT, HIT, NLOG, ASSERT, and EVENT. Defaults to ALL.

-d <dir>::
--output-dir=<dir>::
    Specify the output directory for the log files. Defaults to the current working directory.

-v::
--verbose::
    Enable verbose output for additional information during the log retrieval process.

EXAMPLES
--------
* Retrieve all internal logs and save them to the current directory:
+
------------
# nvme solidigm vs-internal-log /dev/nvme0
------------

* Retrieve a specific log type and save it to a custom directory:
+
------------
# nvme solidigm vs-internal-log /dev/nvme0 -t NLOG -d /tmp/logs
------------

* Retrieve logs with verbose output:
+
------------
# nvme solidigm vs-internal-log /dev/nvme0 -v
------------

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