149 lines
3.3 KiB
Groff
149 lines
3.3 KiB
Groff
'\" t
|
|
.\" Title: get-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: 10/31/2024
|
|
.\" Manual: NVMe Manual
|
|
.\" Source: NVMe
|
|
.\" Language: English
|
|
.\"
|
|
.TH "GET\-DSSD\-POWER\-ST" "1" "10/31/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-get-dssd-power-state-feature \- Get DSSD Power State
|
|
.SH "SYNOPSIS"
|
|
.sp
|
|
.nf
|
|
\fInvme ocp get\-dssd\-power\-state\-feature\fR <device>
|
|
[\-\-sel=<select> | \-S <select>] [\-\-all | \-a]
|
|
[\-\-no\-uuid | \-n]
|
|
.fi
|
|
.SH "DESCRIPTION"
|
|
.sp
|
|
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\&.
|
|
.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
|
|
\-S <select>, \-\-sel=<select>
|
|
.RS 4
|
|
Select (SEL): This field specifies which value of the attributes to return in the provided data:
|
|
.TS
|
|
allbox tab(:);
|
|
lt lt
|
|
lt lt
|
|
lt lt
|
|
lt lt
|
|
lt lt
|
|
lt lt.
|
|
T{
|
|
Select
|
|
T}:T{
|
|
Description
|
|
T}
|
|
T{
|
|
0
|
|
T}:T{
|
|
Current
|
|
T}
|
|
T{
|
|
1
|
|
T}:T{
|
|
Default
|
|
T}
|
|
T{
|
|
2
|
|
T}:T{
|
|
Saved
|
|
T}
|
|
T{
|
|
3
|
|
T}:T{
|
|
Supported capabilities
|
|
T}
|
|
T{
|
|
4\-7
|
|
T}:T{
|
|
Reserved
|
|
T}
|
|
.TE
|
|
.sp 1
|
|
.RE
|
|
.PP
|
|
\-a, \-\-all
|
|
.RS 4
|
|
Print out all 3 values at once \- Current DSSD Power State, Default DSSD Power State, and Saved DSSD Power State
|
|
.RE
|
|
.PP
|
|
\-n, \-\-no\-uuid
|
|
.RS 4
|
|
Do not try to automatically detect UUID index for this command (required for old OCP 1\&.0 support)
|
|
.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 get\-dssd\-power\-state\-feature command to get the Curent DSSD Power State in watts\&.
|
|
.sp
|
|
.if n \{\
|
|
.RS 4
|
|
.\}
|
|
.nf
|
|
# nvme ocp get\-dssd\-power\-state\-feature /dev/nvme0 \-S 0
|
|
.fi
|
|
.if n \{\
|
|
.RE
|
|
.\}
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
Has the program issue a get\-dssd\-power\-state\-feature command to get all three DSSD Power States in watts\&.
|
|
.sp
|
|
.if n \{\
|
|
.RS 4
|
|
.\}
|
|
.nf
|
|
# nvme ocp get\-dssd\-power\-state\-feature /dev/nvme0 \-a
|
|
.fi
|
|
.if n \{\
|
|
.RE
|
|
.\}
|
|
.RE
|
|
.SH "NVME"
|
|
.sp
|
|
Part of the nvme\-user suite\&.
|