Commit 6397392e authored by Tomasz Zawadzki's avatar Tomasz Zawadzki Committed by Ben Walker
Browse files

doc/nvme: update docs and jsonrpc with delete_nvme_controller 



Change-Id: I952bb8e00ef173fc42414e9c771700669f54921a
Signed-off-by: default avatarTomasz Zawadzki <tomasz.zawadzki@intel.com>
Reviewed-on: https://review.gerrithub.io/420487


Tested-by: default avatarSPDK CI Jenkins <sys_sgci@intel.com>
Chandler-Test-Pool: SPDK Automated Test System <sys_sgsw@intel.com>
Reviewed-by: default avatarJim Harris <james.r.harris@intel.com>
Reviewed-by: default avatarBen Walker <benjamin.walker@intel.com>
parent 43fe3667

doc/bdev.md

+1 −13
Original line number Diff line number Diff line
@@ -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

doc/jsonrpc.md

+2 −34
Original line number Diff line number Diff line
@@ -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:



~~~