diff options
author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-05-05 11:11:06 +0000 |
---|---|---|
committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-05-05 11:11:06 +0000 |
commit | a8123060e6717f82ee27efca50c7d2daf4392809 (patch) | |
tree | 3b0b740dd83d6a1244e81e4270497ad8db31a9b7 /Documentation/nvme-ocp-set-telemetry-profile.txt | |
parent | Adding debian version 2.8-2. (diff) | |
download | nvme-cli-a8123060e6717f82ee27efca50c7d2daf4392809.tar.xz nvme-cli-a8123060e6717f82ee27efca50c7d2daf4392809.zip |
Merging upstream version 2.9.1.
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to '')
-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. |