summaryrefslogtreecommitdiffstats
path: root/Documentation/nvme-ocp-set-dssd-power-state-feature.txt
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2023-12-24 07:57:49 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2023-12-24 07:57:49 +0000
commitfc67d3ad9a2903cc33e5cdaedaad51dd86a42236 (patch)
tree4ef72536a965fe220e71aea78b76b6bbbac2ed59 /Documentation/nvme-ocp-set-dssd-power-state-feature.txt
parentAdding upstream version 2.5. (diff)
downloadnvme-cli-fc67d3ad9a2903cc33e5cdaedaad51dd86a42236.tar.xz
nvme-cli-fc67d3ad9a2903cc33e5cdaedaad51dd86a42236.zip
Adding upstream version 2.7.1.upstream/2.7.1
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to '')
-rw-r--r--Documentation/nvme-ocp-set-dssd-power-state-feature.txt43
1 files changed, 43 insertions, 0 deletions
diff --git a/Documentation/nvme-ocp-set-dssd-power-state-feature.txt b/Documentation/nvme-ocp-set-dssd-power-state-feature.txt
new file mode 100644
index 0000000..c9ae578
--- /dev/null
+++ b/Documentation/nvme-ocp-set-dssd-power-state-feature.txt
@@ -0,0 +1,43 @@
+set-dssd-power-state-feature(1)
+===============================
+
+NAME
+----
+nvme-ocp-set-dssd-power-state-feature - Set DSSD Power State
+
+SYNOPSIS
+--------
+[verse]
+'nvme ocp set-dssd-power-state-feature' <device>
+ [--power-state=<fmt> | -p <fmt>] [--no-uuid | -n]
+ [--save | -s]
+
+DESCRIPTION
+-----------
+For the NVMe device given, retrieves OCP DSSD Power state 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
+-------
+-p <fmt>::
+--power-state=<fmt>::
+ DSSD Power State to set in watts.
+
+EXAMPLES
+--------
+* Has the program issue a set-dssd-power-state-feature command to set DSSD Power State to set in watts.
++
+------------
+# nvme ocp set-dssd-power-state-feature /dev/nvme0 -p <value> -s <value> -n <value>
+------------
+
+NVME
+----
+Part of the nvme-user suite.