rpc: Document split bdev create and delete

Signed-off-by: Monica Kenguva <monica.kenguva@intel.com>
Change-Id: I3aba1fe4420830a06c9813d224417201e6ba594d
Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/6753
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: Tomasz Zawadzki <tomasz.zawadzki@intel.com>
This commit is contained in:
Monica Kenguva 2021-03-05 23:22:40 +00:00 committed by Tomasz Zawadzki
parent 2ab0506ef7
commit 039ab97c48

View File

@ -7268,6 +7268,86 @@ Example response:
}
~~~
# SPLIT
## bdev_split_create {#rpc_bdev_split_create}
This is used to split an underlying block device and create several smaller equal-sized vbdevs.
### Parameters
Name | Optional | Type | Description
----------------------- | -------- | ----------- | -----------
base_bdev | Required | string | base bdev name
split_count | Required | number | number of splits
split_size_mb | Optional | number | size in MB to restrict the size
### Example
Example request:
~~~
{
"jsonrpc": "2.0",
"method": "bdev_split_create",
"id": 1,
"params": {
"base_bdev": "Malloc0",
"split_count": 4
}
}
~~~
Example response:
~~~
{
"jsonrpc": "2.0",
"id": 1,
"result": [
"Malloc0p0",
"Malloc0p1",
"Malloc0p2",
"Malloc0p3"
]
}
~~~
## bdev_split_delete {#rpc_bdev_split_delete}
This is used to remove the split vbdevs.
### Parameters
Name | Optional | Type | Description
----------------------- | -------- | ----------- | -----------
base_bdev | Required | string | base bdev name
### Example
Example request:
~~~
{
"jsonrpc": "2.0",
"method": "bdev_split_delete",
"id": 1,
"params": {
"base_bdev": "Malloc0"
}
}
~~~
Example response:
~~~
{
"jsonrpc": "2.0",
"id": 1,
"result": true
}
~~~
# OPAL
## bdev_nvme_opal_init {#rpc_bdev_nvme_opal_init}