ESXi - 6.7 nvme

nvme

VMware NVMe driver esxcli extensions

device

• list

List NVMe devices registered to VMware NVMe driver

• esxcli nvme device list

• get

Get NVMe device information

• esxcli nvme device get OPTIONS

OPTIONS
 -A|--adapter=<str>    Adapter to operate on (required)

controller

• list

List all controllers on the device if namespace is not specified, otherwise list all controllers the namespace attached

• esxcli nvme device controller list OPTIONS

OPTIONS
 -A|--adapter=<str>    Adapter to operate on (required)
 -n|--namespace=<str>  Namespace ID attached. ID starts from 1

feature

• cap

Get NVMe device feature supported capabilities information

• esxcli nvme device feature cap ADAPTER

ADAPTER
 -A|--adapter=<str>    Adapter to operate on (required)

aec

• get

Get NVMe device feature async event configuration information

• esxcli nvme device feature aec get ADAPTER OPTIONS

OPTIONS
 -S|--select=<str>     specify which value of the attributes to return, "current", "default",
                       "saved"

• set

Set NVMe device feature async event configuration information

• esxcli nvme device feature aec set ADAPTER OPTIONS

OPTIONS
 -w|--fwnotices=<long> an asynchronous event notification is sent to the host for a Firmware
                       Activation Starting event, 0 for false, 1 for true, 0 will be passed as
                       default value, if not set
 -m|--nsnotices=<long> an asynchronous event notification is sent to the host for a Namespace
                       Attribute change, 0 for false, 1 for true, 0 will be passed as default
                       value, if not set
 -S|--save             save the attribute
 -v|--value=<long>     SMART health critical warnings bitmap to be set, refer to Figure 79, NVMe
                       1.2 SPEC (required)

apst

• apst

Get NVMe device feature autonomous power state transition information

• esxcli nvme device feature apst get ADAPTER OPTIONS

OPTIONS
 -S|--select=<str>     specify which value of the attributes to return, "current", "default",
                       "saved"

ar

• get

Get NVMe device feature arbitration information

• esxcli nvme device feature ar get ADAPTER OPTIONS

OPTIONS
 -S|--select=<str>     specify which value of the attributes to return, "current", "default",
                       "saved"

• set

Set NVMe device feature arbitration information

• esxcli nvme device feature ar set ADAPTER OPTIONS

OPTIONS
 -S|--save             save the attribute
 -v|--value=<long>     Arbitration Burst value to be set (required)
 -x|--value2=<long>    Low Priority Weight value to be set (required)
 -y|--value3=<long>    Medium Priority Weight value to be set (required)
 -z|--value4=<long>    High Priority Weight value to be set (required)

er

• get

Get NVMe device feature error recovery information

• esxcli nvme device feature er get ADAPTER OPTIONS

OPTIONS
 -S|--select=<str>     specify which value of the attributes to return, "current", "default",
                       "saved"

• Set

Set NVMe device feature error recovery information

• esxcli nvme device feature er Set ADAPTER OPTIONS

OPTIONS
 -e|--enable=<long>    deallocated or unwritten logical block error enable value to be set, 0 for
                       false (disable), 1 for true (enable), 0 will be passed as default value, if
                       not set
 -n|--namespace=<str>  Namespace to operate on, 0 will be passed as default value, if not set
 -S|--save             save the attribute
 -v|--value=<long>     Time limited error recovery value to be set (required)

hi

• get

Get NVMe device feature host identifier information

• esxcli nvme device feature hi get ADAPTER OPTIONS

OPTIONS
 -S|--select=<str>     specify which value of the attributes to return, "current", "default",
                       "saved"

hmb

• get

Get NVMe device feature host memory buffer information

• esxcli nvme device feature hmb get ADAPTER OPTIONS

OPTIONS
 -S|--select=<str>     specify which value of the attributes to return, "current", "default",
                       "saved"

ic

• get

Get NVMe device feature interrupt coalescing information

• esxcli nvme device feature ic get ADAPTER OPTIONS

OPTIONS
 -S|--select=<str>     specify which value of the attributes to return, "current", "default",
                       "saved"

• set

Set NVMe device feature interrupt coalescing information

• esxcli nvme device feature ic set ADAPTER OPTIONS

OPTIONS
 -S|--save             save the attribute
 -v|--value=<long>     Aggregation threshold value to be set (required)
 -x|--value2=<long>    Aggregation time value to be set (required)

ivc

• get

Get NVMe device feature interrupt vector configuration information

• esxcli nvme device feature ivc get ADAPTER OPTIONS

OPTIONS
 -S|--select=<str>     specify which value of the attributes to return, "current", "default",
                       "saved"

• set

Set NVMe device feature interrupt vector configuration information

• esxcli nvme device feature ivc set ADAPTER OPTIONS

OPTIONS
 -S|--save             save the attribute
 -v|--value=<long>     Interrupt vector value to be set (required)
 -x|--value2=<long>    Coalescing disable value to be set, 0 for false (enable), 1 for true
                       (disable) (required)

kat

• get

Get NVMe device feature keep alive timer information

• esxcli nvme device feature kat get ADAPTER OPTIONS

OPTIONS
 -S|--select=<str>     specify which value of the attributes to return, "current", "default",
                       "saved"

• set

Set NVMe device feature keep alive timer information

• esxcli nvme device feature kat set ADAPTER OPTIONS

OPTIONS
 -S|--save             save the attribute
 -t|--timeout=<long>   timeout value for the keep alive feature to be set (required)

lba

* get

Get NVMe device feature LBA range type information

• esxcli nvme device feature lba get ADAPTER OPTIONS

OPTIONS
 -n|--namespace=<str>  Namespace to operate on (required)
 -S|--select=<str>     specify which value of the attributes to return, "current", "default",
                       "saved"

nq

• get

Get NVMe device feature number of queue information

• esxcli nvme device feature nq get ADAPTER OPTIONS

OPTIONS
 -S|--select=<str>     specify which value of the attributes to return, "current", "default",
                       "saved"

pm

• get

Get NVMe device feature power management information

• esxcli nvme device feature pm get ADAPTER OPTIONS

OPTIONS
 -S|--select=<str>     specify which value of the attributes to return, "current", "default",
                       "saved"

• set

Set NVMe device feature power management information

• esxcli nvme device feature pm set ADAPTER OPTIONS

OPTIONS
 -S|--save             save the attribute
 -v|--value=<long>     Power state value to be set (required)
 -w|--workload=<long>  Workload Hint to be set, 0 will be passed as default value, if not set

spm

• get

Get NVMe device feature software progress marker information

• esxcli nvme device feature spm get ADAPTER OPTIONS

OPTIONS
 -S|--select=<str>     specify which value of the attributes to return, "current", "default",
                       "saved"

• set

Set software progress marker feature information, will clear Pre-boot Software Load Count (PBSLC) to 0

• esxcli nvme device feature spm set ADAPTER OPTIONS

OPTIONS
 -S|--save             save the attribute

tt

• get

Get NVMe device feature temperature threshold information

• esxcli nvme device feature tt get ADAPTER OPTIONS

OPTIONS
 -S|--select=<str>     specify which value of the attributes to return, "current", "default",
                       "saved"

• set

Set NVMe device feature temperature threshold information

• esxcli nvme device feature tt set ADAPTER OPTIONS

OPTIONS
 -S|--save             save the attribute
 -s|--sensor=<long>    Threshold temperature select value to be set, 0 will be passed as default
                       value, if not set
 -u|--under            Set under temperature threshold
 -v|--value=<long>     Temperature threshold value to be set (required)

vwc

• get

Get NVMe device feature volatile write cache information

• esxcli nvme device feature vwc get ADAPTER OPTIONS

OPTIONS
 -S|--select=<str>     specify which value of the attributes to return, "current", "default",
                       "saved"

• set

Set NVMe device feature volatile write cache information

• esxcli nvme device feature vwc set ADAPTER OPTIONS

OPTIONS
 -S|--save             save the attribute
 -v|--value=<long>     Volitale write cache enable value to be set, 0 for false (disable), 1 for
                       true (enable) (required)

wa

• get

Get NVMe device feature write atomicity information

• esxcli nvme device feature wa get ADAPTER OPTIONS

OPTIONS
 -S|--select=<str>     specify which value of the attributes to return, "current", "default",
                       "saved"

• set

Set NVMe device feature write atomicity information

• esxcli nvme device feature wa set ADAPTER OPTIONS

OPTIONS
 -S|--save             save the attribute
 -v|--value=<long>     Disable Normal value to be set, 0 for false (enable), 1 for true (disable)
                       (required)

firmware

• activate

Commit downloaded firmware image to a specific slot

• esxcli nvme device firmware activate ADAPTER OPTIONS

OPTIONS
 -a|--action=<long>    Activate action (required)
                          0: Downloaded image replaces the image indicated by the
                             firmware slot field. This image is not activated.
                          1: Downloaded image replaces the image indicated by the
                             firmware slot field. This image is activated at the next reset.
                          2: The image specified by the firmware slot field is
                             activated at the next reset.
                          3: The image specified by the firmware slot field is
                             requested to be activated immediately without reset.
 -s|--slot=<long>      Slot number. If the value specified is 0, then the controller shall choose
                       the firmware slot. (required)

• download

Download firmware image to the device

• esxcli nvme device firmware download ADAPTER OPTIONS

OPTIONS
 -f|--firmware=<str>   Firmware image path (required)

log

error

get           Get NVMe device error log information

fwslot

get           Get NVMe device firmware slot log information

smart

get           Get NVMe device SMART log information

namespace

attach        Attach namespace on NVMe device
create        Create namespace on NVMe device
delete        Delete namespace on NVMe device
detach        Detach namespace on NVMe device
format        Change namespace format
get           Get nvme namespace information
list          List namespace on NVMe device

register

get           Dump NVMe device registers

timeout

get           Get timeout value of IO timeout checker
set           Set timeout value for IO timeout checker

driver

loglevel

set           Set NVMe driver log level and debug level