Nvmetools - Revision history

Kenneth: /* Test Framework Commands */

2024-05-13T23:38:07Z

Test Framework Commands

← Older revision		Revision as of 23:38, 13 May 2024
Line 89:		Line 89:
	Description: Console command that updates test suite results.		Description: Console command that updates test suite results.
	* Test Suite results can be updated after completion by editing the results.json files. This command updates the html dashboard, PDF report, and results.json summary sections to reflect any changed verification results.		* Test Suite results can be updated after completion by editing the results.json files. This command updates the html dashboard, PDF report, and results.json summary sections to reflect any changed verification results.

			== Test Framework ==

			See https://nvmetools.readthedocs.io/en/latest/framework.html

			== keywords ==

Kenneth: /* Test Commands */

2024-05-13T23:37:45Z

Test Commands

← Older revision		Revision as of 23:37, 13 May 2024
Line 53:		Line 53:
	* 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.		* 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.

	== ~~Test~~ Commands ==		== Check Commands ==

	All console commands return a 0 on pass and non-zero on fail.		All console commands return a 0 on pass and non-zero on fail.
Line 67:		Line 67:
	* 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.		* 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.		* If nvme is not specified then all NVMe drives are checked.

			== Test Framework Commands ==

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

	=== testnvme ===		=== testnvme ===

Kenneth: /* Usage */

2024-05-13T23:35:40Z

Usage

@@ Line 18: / Line 18: @@
   git clone https://github.com/jtjones1001/nvmetools.git
-== Usage ==
+== Documentation ==
 Online documentation:
   https://nvmetools.readthedocs.io/en/latest/
 All console commands return a 0 on pass and non-zero on fail.
@@ Line 50: / Line 52: @@
 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.

Kenneth: /* checknvme */

2024-05-13T23:33:20Z

checknvme

@@ Line 42: / Line 42: @@
 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.
 === viewnvme ===

Kenneth: /* Usage */

2024-05-13T23:32:01Z

Usage

← Older revision		Revision as of 23:32, 13 May 2024
Line 22:		Line 22:
	Online documentation:		Online documentation:
	https://nvmetools.readthedocs.io/en/latest/		https://nvmetools.readthedocs.io/en/latest/

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

	=== listnvme ===		=== listnvme ===

	listnvme		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.

	=== readnvme ===		=== readnvme ===
Line 34:		Line 39:
	Show all stats:		Show all stats:
	readnvme -n 0 -a		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.

	=== checknvme ===		=== checknvme ===

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

	Show health and wear:		Show health and wear:
	checknvme -n 0		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.

			=== viewnvme ===

			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.

Kenneth: Created page with "== Epic NVMe Tools == Linux or Windows NVMe CLI tools! https://www.nvmetools.com/ == Pipy == Install on Linux or Windows: pip install nvmetools == Github == https://github.com/jtjones1001/nvmetools git clone git@github.com:jtjones1001/nvmetools.git # git clone https://github.com/jtjones1001/nvmetools.git == Usage == Online documentation: https://nvmetools.readthedocs.io/en/latest/ === listnvme === listnvme === readnvme === Show basic stats: readnvme..."

2024-05-13T23:28:13Z

Created page with "== Epic NVMe Tools == Linux or Windows NVMe CLI tools! https://www.nvmetools.com/ == Pipy == Install on Linux or Windows: pip install nvmetools == Github == https://github.com/jtjones1001/nvmetools git clone git@github.com:jtjones1001/nvmetools.git # git clone https://github.com/jtjones1001/nvmetools.git == Usage == Online documentation: https://nvmetools.readthedocs.io/en/latest/ === listnvme === listnvme === readnvme === Show basic stats: readnvme..."

New page

== Epic NVMe Tools ==

Linux or Windows NVMe CLI tools!

https://www.nvmetools.com/

== Pipy ==

Install on Linux or Windows:
pip install nvmetools

== Github ==

https://github.com/jtjones1001/nvmetools

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

== Usage ==

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

=== listnvme ===

listnvme

=== readnvme ===

Show basic stats:
readnvme -n 0

Show all stats:
readnvme -n 0 -a

=== checknvme ===

Show health and wear:
checknvme -n 0