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

doc/nvme: update docs and jsonrpc with delete_nvme_controller

Browse Source 
Change-Id: I952bb8e00ef173fc42414e9c771700669f54921a
Signed-off-by: Tomasz Zawadzki <tomasz.zawadzki@intel.com>
Reviewed-on: https://review.gerrithub.io/420487
Tested-by: SPDK CI Jenkins <sys_sgci@intel.com>
Chandler-Test-Pool: SPDK Automated Test System <sys_sgsw@intel.com>
Reviewed-by: Jim Harris <james.r.harris@intel.com>
Reviewed-by: Ben Walker <benjamin.walker@intel.com>
This commit is contained in:
Tomasz Zawadzki 2018-07-26 10:09:34 -04:00 committed by Ben Walker
parent 43fe36672b
commit 6397392ede
2 changed files with 3 additions and 47 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
doc/bdev.md
View File

@ -97,22 +97,10 @@ This command will create NVMe bdev of NVMe-oF resource.
To remove a NVMe controller use the delete_nvme_controller command. To remove a NVMe controller use the delete_nvme_controller command.
`rpc.py delete_nvme_controller -t PCIe -a 0000:01:00.0` `rpc.py delete_nvme_controller Nvme0`
This command will remove NVMe controller representing physical device in the system.
`rpc.py delete_nvme_controller -t RDMA -a 192.168.100.1 -f IPv4 -s 4420 -n nqn.2016-06.io.spdk:cnode1`
This command will remove NVMe controller representing NVMe-oF resource.
`rpc.py delete_nvme_controller -c Nvme0`
This command will remove NVMe controller named Nvme0. This command will remove NVMe controller named Nvme0.
`rpc.py delete_nvme_controller -b Nvme0n1`
This command will remove NVMe controller containing bdev named Nvme0n1.
# Null {#bdev_config_null} # Null {#bdev_config_null}
The SPDK null bdev driver is a dummy block I/O target that discards all writes and returns undefined The SPDK null bdev driver is a dummy block I/O target that discards all writes and returns undefined

36
doc/jsonrpc.md
View File

@ -943,18 +943,13 @@ Example response:
## delete_nvme_controller {#rpc_delete_nvme_controller} ## delete_nvme_controller {#rpc_delete_nvme_controller}
Delete NVMe controller. To delete NVMe controller user may use its name or transport ID. Delete NVMe controller.
### Parameters ### Parameters
Name | Optional | Type | Description Name | Optional | Type | Description
----------------------- | -------- | ----------- | ----------- ----------------------- | -------- | ----------- | -----------
name | Optional | string | Controller name name | Required | string | Controller name
trtype | Optional | string | NVMe-oF target trtype: rdma or pcie
traddr | Optional | string | NVMe-oF target address: an ip address or BDF
adrfam | Optional | string | NVMe-oF target adrfam: ipv4, ipv6, ib, fc or intra_host
trsvcid | Optional | string | NVMe-oF target trsvcid
subnqn | Optional | string | NVMe-oF target subnqn
### Example ### Example
@ -971,33 +966,6 @@ Example requests:
} }
~~~ ~~~
~~~
{
"params": {
"trtype": "pcie",
"traddr": "0000:01:00.0"
},
"jsonrpc": "2.0",
"method": "delete_nvme_controller",
"id": 1
}
~~~
~~~
{
"params": {
"trtype": "rdma",
"traddr": "192.168.0.13",
"adrfam": "ipv4",
"trsvcid": "4420",
"subnqn": "nqn.2018-07.io.spdk:cnode1"
},
"jsonrpc": "2.0",
"method": "delete_nvme_controller",
"id": 1
}
~~~
Example response: Example response:
~~~ ~~~