|
Packit |
01965a |
nvmetcli
|
|
Packit |
01965a |
========
|
|
Packit |
01965a |
This contains the NVMe target admin tool "nvmetcli". It can either be
|
|
Packit |
01965a |
used interactively by invoking it without arguments, or it can be used
|
|
Packit |
01965a |
to save, restore or clear the current NVMe target configuration.
|
|
Packit |
01965a |
|
|
Packit |
01965a |
Installation
|
|
Packit |
01965a |
------------
|
|
Packit |
01965a |
Please install the configshell-fb package from
|
|
Packit |
01965a |
https://github.com/agrover/configshell-fb first.
|
|
Packit |
01965a |
|
|
Packit |
01965a |
nvmetcli can be run directly from the source directory or installed
|
|
Packit |
01965a |
using setup.py.
|
|
Packit |
01965a |
|
|
Packit |
01965a |
Common Package Dependencies and Problems
|
|
Packit |
01965a |
-----------------------------------------
|
|
Packit |
01965a |
nvmetcli uses the 'python-six' and 'pyparsing' packages
|
|
Packit |
01965a |
(running nvmetcli without these packages may produce
|
|
Packit |
01965a |
hard-to-decipher errors).
|
|
Packit |
01965a |
|
|
Packit |
01965a |
Usage
|
|
Packit |
01965a |
-----
|
|
Packit |
01965a |
Look at Documentation/nvmetcli.txt for details.
|
|
Packit |
01965a |
|
|
Packit |
01965a |
Example NVMe Target .json files
|
|
Packit |
01965a |
--------------------------------------
|
|
Packit |
01965a |
To load the loop + explicit host version above do the following:
|
|
Packit |
01965a |
|
|
Packit |
01965a |
./nvmetcli restore loop.json
|
|
Packit |
01965a |
|
|
Packit |
01965a |
Or to load the rdma + no host authentication version do the following
|
|
Packit |
01965a |
after you've ensured that the IP address in rdma.json fits your setup:
|
|
Packit |
01965a |
|
|
Packit |
01965a |
./nvmetcli restore rdma.json
|
|
Packit |
01965a |
|
|
Packit |
01965a |
Or to load the fc + no host authentication version do the following
|
|
Packit |
01965a |
after you've ensured that the port traddr FC address information in
|
|
Packit |
01965a |
fc.json fits your setup:
|
|
Packit |
01965a |
|
|
Packit |
01965a |
./nvmetcli restore fc.json
|
|
Packit |
01965a |
|
|
Packit |
01965a |
These files can also be edited directly using your favorite editor.
|
|
Packit |
01965a |
|
|
Packit |
01965a |
Testing
|
|
Packit |
01965a |
-------
|
|
Packit |
01965a |
nvmetcli comes with a testsuite that tests itself and the kernel configfs
|
|
Packit |
01965a |
interface for the NVMe target. To run it make sure you have nose2 and
|
|
Packit |
01965a |
the coverage plugin for it installed and simple run 'make test'.
|
|
Packit |
01965a |
|
|
Packit |
01965a |
Development
|
|
Packit |
01965a |
-----------------
|
|
Packit |
01965a |
Please send patches and bug reports to linux-nvme@lists.infradead.org for
|
|
Packit |
01965a |
review and acceptance.
|