summaryrefslogtreecommitdiffstats
path: root/Documentation/nvme-ocp-set-dssd-async-event-config.txt
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-05-05 11:11:06 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-05-05 11:11:06 +0000
commit3b675d02a399c3489327ff09418cb76ae0eeacd7 (patch)
tree4b2bde0b687e41a7028168cedcb381ac31049e2d /Documentation/nvme-ocp-set-dssd-async-event-config.txt
parentReleasing progress-linux version 2.8-2~progress7.99u1. (diff)
downloadnvme-cli-3b675d02a399c3489327ff09418cb76ae0eeacd7.tar.xz
nvme-cli-3b675d02a399c3489327ff09418cb76ae0eeacd7.zip
Merging upstream version 2.9.1.
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'Documentation/nvme-ocp-set-dssd-async-event-config.txt')
-rw-r--r--Documentation/nvme-ocp-set-dssd-async-event-config.txt48
1 files changed, 48 insertions, 0 deletions
diff --git a/Documentation/nvme-ocp-set-dssd-async-event-config.txt b/Documentation/nvme-ocp-set-dssd-async-event-config.txt
new file mode 100644
index 0000000..de60bbf
--- /dev/null
+++ b/Documentation/nvme-ocp-set-dssd-async-event-config.txt
@@ -0,0 +1,48 @@
+nvme-ocp-set-dssd-async-event-config(1)
+=======================================
+
+NAME
+----
+nvme-ocp-set-dssd-async-event-config - Set DSSD asynchronous event configuration
+
+SYNOPSIS
+--------
+[verse]
+'nvme ocp set-dssd-async-event-config' <device> [--enable-panic-notices | -e] [--save | -s]
+
+
+DESCRIPTION
+-----------
+Set DSSD asynchronous event configuration
+
+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
+-------
+-e::
+--enable-panic-notices::
+ Set enable panic notices [0]
+
+-s::
+--save::
+ Save the attribute so that it persists through all power states and resets.
+
+
+EXAMPLES
+--------
+* Has the program issue a set-dssd-async-event-config to enable panic notices,
+persisting through power states.
++
+------------
+# nvme ocp set-dssd-async-event-config /dev/nvme0 -e -s
+------------
+
+NVME
+----
+Part of the nvme-user suite.