diff options
| author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2021-07-02 20:40:30 +0000 |
|---|---|---|
| committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2021-07-02 20:40:30 +0000 |
| commit | dc597ce8df5ae6efd2728a2d7ba7d92486028f79 (patch) | |
| tree | 55b9e9257eba4579667f9522368aa29f5be6754a /Documentation/nvme-smart-log.txt | |
| parent | Initial commit. (diff) | |
| download | nvme-cli-dc597ce8df5ae6efd2728a2d7ba7d92486028f79.tar.xz nvme-cli-dc597ce8df5ae6efd2728a2d7ba7d92486028f79.zip | |
Adding upstream version 1.12.upstream/1.12
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'Documentation/nvme-smart-log.txt')
| -rw-r--r-- | Documentation/nvme-smart-log.txt | 65 |
1 files changed, 65 insertions, 0 deletions
diff --git a/Documentation/nvme-smart-log.txt b/Documentation/nvme-smart-log.txt new file mode 100644 index 0000000..77d0015 --- /dev/null +++ b/Documentation/nvme-smart-log.txt @@ -0,0 +1,65 @@ +nvme-smart-log(1) +================= + +NAME +---- +nvme-smart-log - Send NVMe SMART log page request, returns result and log + +SYNOPSIS +-------- +[verse] +'nvme smart-log' <device> [--namespace-id=<nsid> | -n <nsid>] + [--raw-binary | -b] + [--output-format=<fmt> | -o <fmt>] + +DESCRIPTION +----------- +Retrieves the NVMe SMART log page from an NVMe device and provides the 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). + +On success, the returned smart log structure may be returned in one of +several ways depending on the option flags; the structure may parsed by +the program and printed in a readable format or the raw buffer may be +printed to stdout for another program to parse. + +OPTIONS +------- +-n <nsid>:: +--namespace-id=<nsid>:: + Retrieve the SMART log for the given nsid. This is optional + and its success may depend on the device's capabilities to + provide this log on a per-namespace basis (see the NVMe Identify + Controller for this capability). The default nsid to use is + 0xffffffff for the device global SMART log. + +-b:: +--raw-binary:: + Print the raw SMART log buffer to stdout. + +-o <format>:: +--output-format=<format>:: + Set the reporting format to 'normal', 'json', or + 'binary'. Only one output format can be used at a time. + +EXAMPLES +-------- +* Print the SMART log page in a human readable format: ++ +------------ +# nvme smart-log /dev/nvme0 +------------ ++ + +* Print the raw SMART log to a file: ++ +------------ +# nvme smart-log /dev/nvme0 --raw-binary > smart_log.raw +------------ ++ +It is probably a bad idea to not redirect stdout when using this mode. + +NVME +---- +Part of the nvme-user suite |