Commit 26184ad6 authored by Jim Harris's avatar Jim Harris Committed by Tomasz Zawadzki
Browse files

doc: cleanup spdkcli.py 



- spdkcli.py is no longer be considered experimental.
- consistently refer to it as 'spdkcli'
- a few other miscellaneous changes

Signed-off-by: default avatarJim 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: default avatarSPDK CI Jenkins <sys_sgci@intel.com>
Reviewed-by: default avatarChangpeng Liu <changpeng.liu@intel.com>
Reviewed-by: default avatarBen Walker <benjamin.walker@intel.com>
Reviewed-by: default avatarPaul Luse <paul.e.luse@intel.com>
parent f7e1f48a

doc/spdkcli.md

+16 −14
Original line number Diff line number Diff line 
# 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.



Spdkcli should be run with the same privileges as SPDK application.

In order to use SPDK CLI in interactive mode please use:

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}