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

rpc: Document ocssd create and delete bdev

Browse Source 
Signed-off-by: Monica 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: SPDK CI Jenkins <sys_sgci@intel.com>
Reviewed-by: Aleksey Marchuk <alexeymar@mellanox.com>
Reviewed-by: Jim Harris <james.r.harris@intel.com>
This commit is contained in:
Monica Kenguva 2021-03-11 19:28:47 +00:00 committed by Tomasz Zawadzki
parent fa67893428
commit 7e42c6d826
1 changed files with 73 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

73
doc/jsonrpc.md
View File

@ -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} ## 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: Create a @ref bdev_config_pmem blk pool file. It is equivalent of following `pmempool create` command: