diff --git a/doc/bdev.md b/doc/bdev.md index e0e5e08cd..983aa21ec 100644 --- a/doc/bdev.md +++ b/doc/bdev.md @@ -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. -`rpc.py delete_nvme_controller -t PCIe -a 0000:01:00.0` - -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` +`rpc.py delete_nvme_controller 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} The SPDK null bdev driver is a dummy block I/O target that discards all writes and returns undefined diff --git a/doc/jsonrpc.md b/doc/jsonrpc.md index ae8745ed8..73c29a4f0 100644 --- a/doc/jsonrpc.md +++ b/doc/jsonrpc.md @@ -943,18 +943,13 @@ Example response: ## 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 Name | Optional | Type | Description ----------------------- | -------- | ----------- | ----------- -name | Optional | 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 +name | Required | string | Controller name ### 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: ~~~