diff options
author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-05-05 11:11:05 +0000 |
---|---|---|
committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-05-05 11:11:05 +0000 |
commit | 81d6a5ded50a26338e1b36462b3e0a6e45beb9a6 (patch) | |
tree | 364371981040c3dc6e97bb289bda0d33933ebfac /Documentation/nvme-ocp-set-telemetry-profile.txt | |
parent | Adding upstream version 2.8. (diff) | |
download | nvme-cli-upstream/2.9.1.tar.xz nvme-cli-upstream/2.9.1.zip |
Adding upstream version 2.9.1.upstream/2.9.1upstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'Documentation/nvme-ocp-set-telemetry-profile.txt')
-rw-r--r-- | Documentation/nvme-ocp-set-telemetry-profile.txt | 43 |
1 files changed, 43 insertions, 0 deletions
diff --git a/Documentation/nvme-ocp-set-telemetry-profile.txt b/Documentation/nvme-ocp-set-telemetry-profile.txt new file mode 100644 index 0000000..bc244cf --- /dev/null +++ b/Documentation/nvme-ocp-set-telemetry-profile.txt @@ -0,0 +1,43 @@ +nvme-ocp-set-telemetry-profile(1) +================================= + +NAME +---- +nvme-ocp-set-telemetry-profile - Set Telemetry Profile + +SYNOPSIS +-------- +[verse] +'nvme ocp set-telemetry-profile' <device> + [--telemetry-profile-select=<tps> | -t <tps>] + +DESCRIPTION +----------- +For the NVMe device given, sets the OCP Set Telemetry Profile Feature + +The <device> parameter is mandatory and may be either the NVMe character +device (ex: /dev/nvme0) or block device (ex: /dev/nvme0n1). + +This will only work on OCP compliant devices supporting this feature. +Results for any other device are undefined. + +On success it returns 0, error code otherwise. + +OPTIONS +------- +-t <tps>:: +--tps=<tps>:: + Telemetry Profile Select. The device shall collect debug data per the + specified profile number. + +EXAMPLES +-------- +* Has the program issue a set-telemetry-profile command to use profile five. ++ +------------ +# nvme ocp set-telemetry-profile /dev/nvme0 -t 5 +------------ + +NVME +---- +Part of the nvme-user suite. |