Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions Documentation/cmd-plugins.txt
Original file line number Diff line number Diff line change
Expand Up @@ -240,3 +240,21 @@ linknvme:nvme-solidigm-vs-drive-info[1]::

linknvme:nvme-solidigm-workload-tracker[1]::
Real Time capture Workload Tracker samples

linknvme:nvme-sed-discover[1]::
Discover SED Opal Locking Features

linknvme:nvme-sed-initialize[1]::
Initialize a SED Opal Device for locking

linknvme:nvme-sed-revert[1]::
Revert a SED Opal Device from locking

linknvme:nvme-sed-lock[1]::
Lock a SED Opal Device

linknvme:nvme-sed-unlock[1]::
Unlock a SED Opal Device

linknvme:nvme-sed-password[1]::
Change the SED Opal Device password
6 changes: 6 additions & 0 deletions Documentation/meson.build
Original file line number Diff line number Diff line change
Expand Up @@ -222,6 +222,12 @@ adoc_sources = [
'nvme-zns-zone-append',
'nvme-zns-zone-mgmt-recv',
'nvme-zns-zone-mgmt-send',
'nvme-sed-discover',
'nvme-sed-initialize',
'nvme-sed-lock',
'nvme-sed-password',
'nvme-sed-revert',
'nvme-sed-unlock',
]

adoc_includes = [
Expand Down
41 changes: 41 additions & 0 deletions Documentation/nvme-sed-discover.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
nvme-sed-discover(1)
====================

NAME
----
nvme-sed-discover - Discover SED Opal Locking Features

SYNOPSIS
--------
[verse]
'nvme sed discover' [--verbose | -v] [--udev | -u] <device>

DESCRIPTION
-----------
Query the NVMe device given to determine its SED Opal capabilities.

OPTIONS
-------
-v::
--verbose::
Print extended feature discovery information.

-u::
--udev::
Print locking information in form suitable for udev rules.

EXAMPLES
--------
nvme sed discover /dev/nvme5n1
Locking Features:
Locking Supported : yes
Locking Feature Enabled : yes
Locked : no
Media Encryption : yes
MBR Enabled : no
MBR Done : no


NVME
----
Part of nvme-cli
30 changes: 30 additions & 0 deletions Documentation/nvme-sed-initialize.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
nvme-sed-initialize(1)
======================

NAME
----
nvme-sed-initialize - Initialize a SED Opal Device for locking

SYNOPSIS
--------
[verse]
'nvme sed initialize' [ --read-only, -r ] <device>

DESCRIPTION
-----------
Initialize the NVMe device given to allow SED Opal locking.

OPTIONS
-------
-r::
--read-only::
Set locking range to read-only.

EXAMPLES
--------
nvme sed initialize /dev/nvme5n1


NVME
----
Part of nvme-cli
34 changes: 34 additions & 0 deletions Documentation/nvme-sed-lock.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
nvme-sed-lock(1)
================

NAME
----
nvme-sed-lock - Lock a SED Opal Device

SYNOPSIS
--------
[verse]
'nvme sed lock' [--read-only | -r] [--ask-key | -k] <device>

DESCRIPTION
-----------
Lock the given NVMe device.

OPTIONS
-------
-r::
--read-only::
Set locking range to read-only.

-k::
--ask-key::
Prompt for SED authentication key.


EXAMPLES
--------
nvme sed lock /dev/nvme5n1

NVME
----
Part of nvme-cli
29 changes: 29 additions & 0 deletions Documentation/nvme-sed-password.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
nvme-sed-password(1)
===================

NAME
----
nvme-sed-password - Change the locking password of a SED device

SYNOPSIS
--------
[verse]
'nvme sed password' <device>

DESCRIPTION
-----------
Change the locking password of a SED device.

OPTIONS
-------

EXAMPLES
--------
nvme sed password /dev/nvme5n1
Password:
New Password:
Re-enter New Password:

NVME
----
Part of nvme-cli
35 changes: 35 additions & 0 deletions Documentation/nvme-sed-revert.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
nvme-sed-revert(1)
==================

NAME
----
nvme-sed-revert - Revert a SED Opal Device from locking

SYNOPSIS
--------
[verse]
'nvme sed revert' [ --destructive, -e ] [ --psid, -p ] <device>

DESCRIPTION
-----------
Revert the NVMe device given from its locking state.

OPTIONS
-------
-e::
--destructive::
Revert drive destructively (data erased).

-p::
--psid::
Destructively revert drive using its PSID.


EXAMPLES
--------
nvme sed revert /dev/nvme5n1


NVME
----
Part of nvme-cli
34 changes: 34 additions & 0 deletions Documentation/nvme-sed-unlock.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
nvme-sed-unlock(1)
==================

NAME
----
nvme-sed-unlock - Unlock a SED Opal Device

SYNOPSIS
--------
[verse]
'nvme sed unlock' [--read-only | -r] [--ask-key | -k] <device>

DESCRIPTION
-----------
Unlock the given NVMe device.

OPTIONS
-------
-r::
--read-only::
Set locking range to read-only.

-k::
--ask-key::
Prompt for SED authentication key.


EXAMPLES
--------
nvme sed unlock /dev/nvme5n1

NVME
----
Part of nvme-cli