NAME¶
nvme-lockdown - Send an NVMe Lockdown command to prohibit or allow
the execution of command
SYNOPSIS¶
nvme [<global-options>] lockdown <device>
[--ofi=<ofi> | -O <ofi>]
[--ifc=<ifc> | -f <ifc>]
[--prhbt=<prhbt> | -p <prhbt>]
[--scp=<scp> | -s <scp>]
[--uuid=<UUID_Index> | -U <UUID_Index>]
[--csel=<csel> | -c <csel>]
[--css=<css> | -C <css>]
DESCRIPTION¶
The Lockdown command is used to control the Command and Feature
Lockdown capability which configures the prohibition or allowance of
execution of the specified command or Set Features command targeting a
specific Feature Identifier.
OPTIONS¶
-O <ofi>, --ofi=<ofi>
Opcode or Feature Identifier(OFI) specifies the command
opcode or Set Features Feature Identifier identified by the Scope field.
-f <ifc>, --ifc=<ifc>
Interface (INF) field identifies the interfaces affected
by this command.
-p <prhbt>, --prhbt=<prhbt>
Prohibit (PRHBT) bit specifies whether to prohibit or
allow the command opcode or Set Features Feature Identifier specified by this
command.
-s <scp>, --scp=<scp>
Scope (SCP) field specifies the contents of the Opcode or
Feature Identifier field.
-U <UUID_Index>, --uuid=<UUID_Index>
UUID Index - If this field is set to a non-zero value,
then the value of this field is the index of a UUID in the UUID List that is
used by the command. If this field is cleared to 0h,then no UUID index is
specified.
-c <csel>, --csel=<csel>
Controller Select (CSEL) specifies the controller(s)
affected by this command: 0 = NVM subsystem (all controllers), 1 = the
specific controller identified by --css, 2 = the secondary controllers of the
specific primary controller identified by --css, 15 = vendor specific.
-C <css>, --css=<css>
Controller Select Specific (CSS) - meaning depends on
--csel: the Controller Identifier if --csel=1, or the Primary Controller
Identifier if --csel=2. Ignored if --csel=0.
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.
--timeout=<ms>
Set the timeout for the command in milliseconds.
-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¶
No examples yet.
NVME¶
Part of the nvme-user suite