summaryrefslogtreecommitdiffstats
path: root/Documentation/nvme-solidigm-garbage-collect-log.txt
blob: 77e1be3d803b21f619fc4150395aa21428ce5379 (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
nvme-solidigm-garbage-collect-log(1)
====================================

NAME
----
nvme-solidigm-garbage-collect-log - Retrieve Garbage Collection Log

SYNOPSIS
--------
[verse]
'nvme solidigm garbage-collect-log' <device> [--output-format=<fmt> | -o <fmt>]

DESCRIPTION
-----------
Retrieves and displays the Solidigm vendor-specific garbage collection log
for the given NVMe device.

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
-------
-o <fmt>::
--output-format=<fmt>::
	Set the reporting format to 'normal', 'json', or 'binary'. Only one
	output format can be used at a time.

EXAMPLES
--------
* Retrieve and display the garbage collection log:
+
------------
# nvme solidigm garbage-collect-log /dev/nvme0
------------

* Retrieve the garbage collection log in JSON format:
+
------------
# nvme solidigm garbage-collect-log /dev/nvme0 -o json
------------

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