ivampiresp/Spdk
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

doc: cleanup spdkcli.py

Browse Source 
- 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>
This commit is contained in:
Jim Harris 2022-06-15 23:25:53 +00:00 committed by Tomasz Zawadzki
parent f7e1f48a79
commit 26184ad62a
1 changed files with 16 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
doc/spdkcli.md
View File

@ -1,36 +1,38 @@
# SPDK CLI {#spdkcli}
# spdkcli {#spdkcli}
Spdkcli is a command-line management application for SPDK.
Spdkcli has support for a limited number of applications and bdev modules,
and should be considered experimental for the v18.04 release.
This experimental version was added for v18.04 to get early feedback
that can be incorporated as spdkcli becomes more fully-featured
for the next SPDK release.
spdkcli is a command-line management application for SPDK.
spdkcli has support for most transport protocols and
bdev modules.
## Install needed dependencies
## Dependencies
All dependencies should be handled by scripts/pkgdep.sh script.
Dependencies are installed by scripts/pkgdep.sh.
Package dependencies at the moment include:
- configshell
## Run SPDK application instance
Some distributions name the package configshell_fb.
## Example usage
### Start SPDK application
~~~{.sh}
./scripts/setup.sh
./build/bin/vhost -c vhost.json
~~~
## Run SPDK CLI
### Run spdkcli
Spdkcli should be run with the same privileges as SPDK application.
In order to use SPDK CLI in interactive mode please use:
spdkcli should be run with the same privileges as SPDK application.
To use spdkcli in interactive mode:
~~~{.sh}
scripts/spdkcli.py
~~~
Use "help" command to get a list of available commands for each tree node.
It is also possible to use SPDK CLI to run just a single command,
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:
~~~{.sh}