Commit 7e42c6d8 authored by Monica Kenguva's avatar Monica Kenguva Committed by Tomasz Zawadzki
Browse files

rpc: Document ocssd create and delete bdev 



Signed-off-by: default avatarMonica Kenguva <monica.kenguva@intel.com>
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: default avatarSPDK CI Jenkins <sys_sgci@intel.com>
Reviewed-by: default avatarAleksey Marchuk <alexeymar@mellanox.com>
Reviewed-by: default avatarJim Harris <james.r.harris@intel.com>
parent fa678934

doc/jsonrpc.md

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