Nvmetools

Epic NVMe Tools

Linux or Windows NVMe CLI tools!

https://www.nvmetools.com/

Install on Linux or Windows:

pip install nvmetools

https://github.com/jtjones1001/nvmetools

git clone git@github.com:jtjones1001/nvmetools.git
#
git clone https://github.com/jtjones1001/nvmetools.git

Online documentation:

https://nvmetools.readthedocs.io/en/latest/

All console commands return a 0 on pass and non-zero on fail.

listnvme

Description: Console command that lists the NVMe drives in the system.

Displays the NVMe drives in the system. Each drive has a unique ‘NVMe number’ that identifies that specific NVMe. The other console commands require this number to know which NVMe drive to read or test.

Show basic stats:

readnvme -n 0

Show all stats:

readnvme -n 0 -a

Description: Console command that displays and logs NVMe drive information.

Reads NVMe drive information using the Admin Commands: Get Log Page, Get Feature, Identify Controller, and Identify Namespace. A few parameters, such as PCIe location and link info, are read from the OS.

Report simple PASS / FAIL status. Also generates html report.

Show health and wear:

checknvme -n 0

Description: Console command that checks the health of NVMe drive then displays information in html format.

Verifies the NVMe drive health by running the short self-test diagnostic, checking the SMART attributes for errors and log page 6 for prior self-test failures.
If nvme is not specified then all NVMe drives are checked.

Generate html report:

viewnvme -n 0

Description: Console command that displays NVMe drive information in html format.

Reads NVMe drive information using the Admin Commands: Get Log Page, Get Feature, Identify Controller, and Identify Namespace. A few parameters, such as PCIe location and link info, are read from the OS.