summaryrefslogtreecommitdiffstats
path: root/Documentation/nvme-ocp-get-dssd-power-state-feature.txt
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-08-05 08:38:36 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-08-05 08:38:36 +0000
commit3c0f1ed2ea093dd0d3e8ba70f3c9963e66321f87 (patch)
tree2020852fabf5e530c687d41e36ddc5c453b0c9ed /Documentation/nvme-ocp-get-dssd-power-state-feature.txt
parentAdding upstream version 2.9.1. (diff)
downloadnvme-cli-3c0f1ed2ea093dd0d3e8ba70f3c9963e66321f87.tar.xz
nvme-cli-3c0f1ed2ea093dd0d3e8ba70f3c9963e66321f87.zip
Adding upstream version 2.10.upstream/2.10
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'Documentation/nvme-ocp-get-dssd-power-state-feature.txt')
-rw-r--r--Documentation/nvme-ocp-get-dssd-power-state-feature.txt74
1 files changed, 74 insertions, 0 deletions
diff --git a/Documentation/nvme-ocp-get-dssd-power-state-feature.txt b/Documentation/nvme-ocp-get-dssd-power-state-feature.txt
new file mode 100644
index 0000000..716de05
--- /dev/null
+++ b/Documentation/nvme-ocp-get-dssd-power-state-feature.txt
@@ -0,0 +1,74 @@
+get-dssd-power-state-feature(1)
+===============================
+
+NAME
+----
+nvme-ocp-get-dssd-power-state-feature - Get DSSD Power State
+
+SYNOPSIS
+--------
+[verse]
+'nvme ocp get-dssd-power-state-feature' <device>
+ [--sel=<select> | -S <select>] [--all | -a]
+ [--no-uuid | -n]
+
+DESCRIPTION
+-----------
+For the NVMe device given, retrieves OCP DSSD Power State.
+Passing --all calls NVMe Get Feature three times, returning all three of
+the Current, Default, and Saved values.
+
+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
+-------
+-S <select>::
+--sel=<select>::
+ Select (SEL): This field specifies which value of the attributes
+ to return in the provided data:
++
+[]
+|==================
+|Select|Description
+|0|Current
+|1|Default
+|2|Saved
+|3|Supported capabilities
+|4-7|Reserved
+|==================
+
+-a::
+--all::
+ Print out all 3 values at once - Current DSSD Power State,
+ Default DSSD Power State, and Saved DSSD Power State
+
+-n::
+--no-uuid::
+ Do not try to automatically detect UUID index for this command (required
+ for old OCP 1.0 support)
+
+EXAMPLES
+--------
+* Has the program issue a get-dssd-power-state-feature command to get the Curent DSSD Power State in watts.
++
+------------
+# nvme ocp get-dssd-power-state-feature /dev/nvme0 -S 0
+------------
++
+
+* Has the program issue a get-dssd-power-state-feature command to get all three DSSD Power States in watts.
++
+------------
+# nvme ocp get-dssd-power-state-feature /dev/nvme0 -a
+------------
+
+
+NVME
+----
+Part of the nvme-user suite.