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

doc:update the nvme-cli doc

Browse Source 
This change should be merged after
https://review.gerrithub.io/#/c/spdk/nvme-cli/+/426943/ which changes
the configuration file.

Change-Id: I4311e5bc511d02ef0543c6a4707b587bc77f1a58
Signed-off-by: Seth Howell <seth.howell@intel.com>
Reviewed-on: https://review.gerrithub.io/433533
Tested-by: SPDK CI Jenkins <sys_sgci@intel.com>
Chandler-Test-Pool: SPDK Automated Test System <sys_sgsw@intel.com>
Reviewed-by: Shuhei Matsumoto <shuhei.matsumoto.xt@hitachi.com>
Reviewed-by: Jim Harris <james.r.harris@intel.com>
This commit is contained in:
Seth Howell 2018-11-15 15:46:18 -07:00 committed by Jim Harris
parent 177d5e9181
commit ef7a97de6a
1 changed files with 12 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
doc/nvme-cli.md
View File

@ -20,18 +20,23 @@ git clone -b spdk-1.6 https://github.com/spdk/nvme-cli.git
6. Update the "spdk.conf" file under nvme-cli folder to properly configure the SPDK. Notes as following: 6. Update the "spdk.conf" file under nvme-cli folder to properly configure the SPDK. Notes as following:
~~~{.sh} ~~~{.sh}
spdk=0 spdk=1
Default to 0 (off) and change to 1 (on) after switching to SPDK via "<spdk_folder>/scripts/setup.sh". Indicates whether or not to use spdk. Can be 0 (off) or 1 (on).
Defaults to 1 which assumes that you have run "<spdk_folder>/scripts/setup.sh", unbinding your drives from the kernel.
core_mask=0x100 core_mask=0x100
Default to use the 9th core for the nvme-cli running. A bitmask representing which core(s) to use for nvme-cli operations.
Defaults to core 8.
mem_size=512 mem_size=512
Default to use 512MB memory allocated. The amount of reserved hugepage memory to use for nvme-cli (in MB).
Defaults to 512MB.
shm_id=1 shm_id=0
Default to 1. If other running SPDK application has configured with this same 1 shm_id. Indicates the shared memory ID for the spdk application with which your NVMe drives are associated,
This nvme-cli will access those devices from that running SPDK application. and should be adjusted accordingly.
Defaults to 0.
~~~ ~~~
7. Run the "./nvme list" command to get the domain:bus:device.function for each found NVMe SSD. 7. Run the "./nvme list" command to get the domain:bus:device.function for each found NVMe SSD.