From 7e42c6d826ab2f73f4a5ace9788e44d3b4665bc0 Mon Sep 17 00:00:00 2001 From: Monica Kenguva Date: Thu, 11 Mar 2021 19:28:47 +0000 Subject: [PATCH] rpc: Document ocssd create and delete bdev Signed-off-by: Monica Kenguva Change-Id: Ic1b73fbfe3c2cb6b0434422c190e16e9d40ec21b Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/6850 Community-CI: Broadcom CI Community-CI: Mellanox Build Bot Tested-by: SPDK CI Jenkins Reviewed-by: Aleksey Marchuk Reviewed-by: Jim Harris --- doc/jsonrpc.md | 73 ++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 73 insertions(+) diff --git a/doc/jsonrpc.md b/doc/jsonrpc.md index 30dc834ae..ac9f5a10b 100644 --- a/doc/jsonrpc.md +++ b/doc/jsonrpc.md @@ -3349,6 +3349,79 @@ Example response: } ~~~ +## bdev_ocssd_create {#rpc_bdev_ocssd_create} + +Create Open Channel zoned bdev on specified Open Channel controller. + +### Parameters + +Name | Optional | Type | Description +----------------------- | -------- | ----------- | ----------- +ctrlr_name | Required | string | OC NVMe controller +name | Required | string | Bdev name to create +nsid | Optional | string | namespace ID + +### Example + +Example request: + +~~~ +{ + "jsonrpc": "2.0", + "method": "bdev_ocssd_create", + "id": 1, + "params": { + "ctrlr_name": "nvme0", + "bdev_name": "nvme0n1" + } +} +~~~ + +Example response: + +~~~ +{ + "jsonrpc": "2.0", + "id": 1, + "result": true +} +~~~ + +## bdev_ocssd_delete {#rpc_bdev_ocssd_delete} + +Delete Open Channel zoned bdev. + +### Parameters + +Name | Optional | Type | Description +----------------------- | -------- | ----------- | ----------- +name | Required | string | Bdev name to delete + +### Example + +Example request: + +~~~ +{ + "jsonrpc": "2.0", + "method": "bdev_ocssd_delete", + "id": 1, + "params": { + "name": "nvme0n1" + } +} +~~~ + +Example response: + +~~~ +{ + "jsonrpc": "2.0", + "id": 1, + "result": true +} +~~~ + ## bdev_pmem_create_pool {#rpc_bdev_pmem_create_pool} Create a @ref bdev_config_pmem blk pool file. It is equivalent of following `pmempool create` command: