26184ad62a
- spdkcli.py is no longer be considered experimental. - consistently refer to it as 'spdkcli' - a few other miscellaneous changes Signed-off-by: Jim Harris <james.r.harris@intel.com> Change-Id: I1f5c75961e4c1741d0573f2041b4b023ee627357 Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/13057 Community-CI: Broadcom CI <spdk-ci.pdl@broadcom.com> Tested-by: SPDK CI Jenkins <sys_sgci@intel.com> Reviewed-by: Changpeng Liu <changpeng.liu@intel.com> Reviewed-by: Ben Walker <benjamin.walker@intel.com> Reviewed-by: Paul Luse <paul.e.luse@intel.com>
1.6 KiB
spdkcli
spdkcli is a command-line management application for SPDK. spdkcli has support for most transport protocols and bdev modules.
Dependencies
Dependencies are installed by scripts/pkgdep.sh. Package dependencies at the moment include:
- configshell
Some distributions name the package configshell_fb.
Example usage
Start SPDK application
./scripts/setup.sh
./build/bin/vhost -c vhost.json
Run spdkcli
spdkcli should be run with the same privileges as SPDK application.
To use spdkcli in interactive mode:
scripts/spdkcli.py
Use "help" command to get a list of available commands for each tree node.
It is also possible to use spdkcli to run just a single command, just use the command as an argument to the application. For example, to view current configuration and immediately exit:
scripts/spdkcli.py ls
Optional - create Python virtual environment
You can use Python virtual environment if you don't want to litter your system Python installation.
First create the virtual environment:
cd spdk
mkdir venv
virtualenv-3 ./venv
source ./venv/bin/activate
Then install the dependencies using pip. That way dependencies will be installed only inside the virtual environment.
(venv) pip install configshell-fb
Tip: if you are using "sudo" instead of root account, it is suggested to do "sudo -s" before activating the environment. This is because venv might not work correctly when calling spdkcli with sudo, like "sudo python spdkcli.py" - some environment variables might not be passed and you will experience errors.