summaryrefslogtreecommitdiffstats
path: root/Documentation/nvme-ocp-clear-fw-activate-history.txt
blob: 210848084ab5cc78ab2213b9ffe027b84c7a638a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
nvme-ocp-clear-fw-activate-history(1)
=====================================

NAME
----
nvme-ocp-clear-fw-activate-history - Clear the OCP Firmware Update History Log

SYNOPSIS
--------
[verse]
'nvme ocp clear-fw-activate-history' <device> [--no-uuid | -n>]

DESCRIPTION
-----------
For the NVMe device given, Clear OCP Firmware Update History Log.

The <device> parameter is mandatory and may be either the NVMe character
device (ex: /dev/nvme0) or block device (ex: /dev/nvme0n1).

This command with no option added, will try to automatically detect the
parameters of the command. This will work successfully or fail gracefully for
devices supporting UUID for Vendor Specific Information (NVMe 1.4 or later,
OCP 2.0 requires NVMe 1.4b). For devices that do not support OCP 2.0 the
command will fail gracefully, unless the --no-uuid option is provided.

For OCP 1.0 devices (before NVMe 1.4) the --no-uuid option is required.
When --no-uuid option is provided, results for devices before NVMe 1.4 without
OCP support are undefined.

On success it returns 0, error code otherwise.

OPTIONS
-------
-n::
--no-uuid::
	Do not try to automatically detect UUID index for this command (required
        for old OCP 1.0 support)

EXAMPLES
--------
* Clears OCP Firmware Activation History Log for the device:
+
------------
# nvme ocp clear-fw-activate-history /dev/nvme0
------------

NVME
----
Part of the nvme-user suite.