summaryrefslogtreecommitdiffstats
path: root/Documentation/nvme-ocp-set-dssd-power-state-feature.1
diff options
context:
space:
mode:
Diffstat (limited to 'Documentation/nvme-ocp-set-dssd-power-state-feature.1')
-rw-r--r--Documentation/nvme-ocp-set-dssd-power-state-feature.178
1 files changed, 78 insertions, 0 deletions
diff --git a/Documentation/nvme-ocp-set-dssd-power-state-feature.1 b/Documentation/nvme-ocp-set-dssd-power-state-feature.1
new file mode 100644
index 0000000..991d4b1
--- /dev/null
+++ b/Documentation/nvme-ocp-set-dssd-power-state-feature.1
@@ -0,0 +1,78 @@
+'\" t
+.\" Title: set-dssd-power-state-feature
+.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
+.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
+.\" Date: 08/02/2024
+.\" Manual: NVMe Manual
+.\" Source: NVMe
+.\" Language: English
+.\"
+.TH "SET\-DSSD\-POWER\-ST" "1" "08/02/2024" "NVMe" "NVMe Manual"
+.\" -----------------------------------------------------------------
+.\" * Define some portability stuff
+.\" -----------------------------------------------------------------
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.\" http://bugs.debian.org/507673
+.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.ie \n(.g .ds Aq \(aq
+.el .ds Aq '
+.\" -----------------------------------------------------------------
+.\" * set default formatting
+.\" -----------------------------------------------------------------
+.\" disable hyphenation
+.nh
+.\" disable justification (adjust text to left margin only)
+.ad l
+.\" -----------------------------------------------------------------
+.\" * MAIN CONTENT STARTS HERE *
+.\" -----------------------------------------------------------------
+.SH "NAME"
+nvme-ocp-set-dssd-power-state-feature \- Set DSSD Power State
+.SH "SYNOPSIS"
+.sp
+.nf
+\fInvme ocp set\-dssd\-power\-state\-feature\fR <device>
+ [\-\-power\-state=<fmt> | \-p <fmt>] [\-\-no\-uuid | \-n]
+ [\-\-save | \-s]
+.fi
+.SH "DESCRIPTION"
+.sp
+For the NVMe device given, retrieves OCP DSSD Power state Feature
+.sp
+The <device> parameter is mandatory and may be either the NVMe character device (ex: /dev/nvme0) or block device (ex: /dev/nvme0n1)\&.
+.sp
+This will only work on OCP compliant devices supporting this feature\&. Results for any other device are undefined\&.
+.sp
+On success it returns 0, error code otherwise\&.
+.SH "OPTIONS"
+.PP
+\-p <fmt>, \-\-power\-state=<fmt>
+.RS 4
+DSSD Power State to set in watts\&.
+.RE
+.SH "EXAMPLES"
+.sp
+.RS 4
+.ie n \{\
+\h'-04'\(bu\h'+03'\c
+.\}
+.el \{\
+.sp -1
+.IP \(bu 2.3
+.\}
+Has the program issue a set\-dssd\-power\-state\-feature command to set DSSD Power State to set in watts\&.
+.sp
+.if n \{\
+.RS 4
+.\}
+.nf
+# nvme ocp set\-dssd\-power\-state\-feature /dev/nvme0 \-p <value> \-s <value> \-n <value>
+.fi
+.if n \{\
+.RE
+.\}
+.RE
+.SH "NVME"
+.sp
+Part of the nvme\-user suite\&.