nvme-feat-power-mgmt1
Get and set power management feature
Usage
nvme [<global-options>]
feat
power-mgmt
<device>
[{--ps=<ps> | -p
<ps>}]
[{--wh=<wh> | -w
<wh>}]
[{--sel=<select> | -S
<select>}]
[{--save | -s}]
Overview
Get and set power management feature.
The <device> parameter is mandatory and may be either the NVMe character device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1).
If the setting option (--ps) is specified, the command will update the power management configuration. If the --ps option is omitted, it will retrieve and display the current configuration.
On success it returns 0, error code otherwise.
Options
-
-p <ps>, --ps=<ps> -
Power state. Specifies the power state to transition the controller to.
-
-w <wh>, --wh=<wh> -
Workload hint. Provides a hint to the controller about the workload characteristics.
-
-S <select>, --sel=<select> -
Select (SEL): This field specifies which value of the attributes to return in the provided data:
Select Name Description 0 current Current 1 default Default 2 saved Saved 3 supported Supported capabilities
-
-s, --save -
Save the attribute so that it persists through all power states and resets.
Global options
The following options are defined at the top-level nvme command and are available to this subcommand:
-
--dry-run -
Print the command that would be executed, but do not actually execute it.
-
--no-ioctl-probing -
Disable probing for 64-bit IOCTL support.
-
--no-retries -
Disable retry logic on transient errors.
-
-o <fmt>, --output-format=<fmt> -
Set the reporting format to normal, tabular, 'json, or binary. Only one output format may be used at a time.
-
--output-format-version=<version> -
Select the output format version. Version 1 uses the original field naming, while version 2 (default) provides more consistent and script-friendly field names. Other versions are rejected.
-
--quiet -
Suppress informational messages. Errors are still reported, and --quiet cancels any --verbose for the library log level.
-
--set-options=<key=value>[,<key=value>...] -
Set libnvme library options for this invocation. Supported keys are force-4k, mi-probe-enabled, test-base-dir and test-sysfs-dir.
-
--timeout=<ms> -
Set the timeout for the command in milliseconds. infinite or -1 waits without a time limit (0xffffffff).
-
-v, --verbose -
Increase the level of detail in the output. May be specified multiple times to further increase verbosity.
These options can also be set as machine-wide defaults in nvme-cli.conf(5). A command-line flag always overrides the file.
Examples
• Has the program issue a feat power-mgmt to get the current configuration:
# nvme feat power-mgmt /dev/nvme0
• Has the program issue a feat power-mgmt to set power state and workload hint:
# nvme feat power-mgmt /dev/nvme0 --ps=1 --wh=2 --save
Nvme
Part of the nvme-user suite.