summaryrefslogtreecommitdiffstats
path: root/Documentation/nvme-solidigm-id-ctrl.txt
blob: 7ac67e3767f2ad873b3567ab69ed1aac51bb747c (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
nvme-solidigm-id-ctrl(1)
========================

NAME
----
nvme-solidigm-id-ctrl - Send NVMe Identify Controller, return result and structure

SYNOPSIS
--------
[verse]
'nvme solidigm id-ctrl' <device> [--raw-binary | -b] [--vendor-specific | -V]
                              [--output-format=<fmt> | -o <fmt>] [--human-readable | -H]
                              [--verbose | -v] [--timeout=<seconds> | -t <seconds>]

DESCRIPTION
-----------
This command is a Solidigm-specific extension of the NVMe Identify Controller command.
It sends an NVMe Identify Controller command to the specified device and provides the result
and returned structure.

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

This command includes all options available in the generic `nvme id-ctrl` command, including:
- `--raw-binary` or `-b`
- `--vendor-specific` or `-V`
- `--output-format=<fmt>` or `-o <fmt>`
- `--human-readable` or `-H`
- `--verbose` or `-v`
- `--timeout=<seconds>` or `-t <seconds>`

For detailed usage and options, please refer to the documentation for 'nvme id-ctrl'.

EXAMPLES
--------
* Send the Identify Controller command and interpret the output:
+
------------
# nvme solidigm id-ctrl /dev/nvme0
------------

* Print the raw output to stdout:
+
------------
# nvme solidigm id-ctrl /dev/nvme0 --raw-binary
------------

* Print the output in JSON format:
+
------------
# nvme solidigm id-ctrl /dev/nvme0 -o json
------------

* Display the vendor-specific fields:
+
------------
# nvme solidigm id-ctrl /dev/nvme0 --vendor-specific
# nvme solidigm id-ctrl /dev/nvme0 -V
------------

* Use human-readable output:
+
------------
# nvme solidigm id-ctrl /dev/nvme0 --human-readable
# nvme solidigm id-ctrl /dev/nvme0 -H
------------

SEE ALSO
--------
nvme-id-ctrl(1)

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