rpc: Document zone block create and delete

Signed-off-by: Monica Kenguva <monica.kenguva@intel.com>
Change-Id: Ib6dcfe3e9fae51266a937454703d526f621ae6d4
Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/7425
Tested-by: SPDK CI Jenkins <sys_sgci@intel.com>
Reviewed-by: Shuhei Matsumoto <shuhei.matsumoto.xt@hitachi.com>
Reviewed-by: Aleksey Marchuk <alexeymar@mellanox.com>
This commit is contained in:
Monica Kenguva 2021-04-15 22:56:16 +00:00 committed by Jim Harris
parent e2a4288c3c
commit 6d6870c7b6

View File

@ -3077,6 +3077,82 @@ Example response:
}
~~~
## bdev_zone_block_create {#rpc_bdev_zone_block_create}
Creates a virtual zone device on top of existing non-zoned bdev.
### Parameters
Name | Optional | Type | Description
----------------------- | -------- | ----------- | -----------
name | Required | string | Name of the Zone device
base_bdev | Required | string | Name of the Base bdev
zone_capacity | Required | number | Zone capacity in blocks
optimal_open_zones | Required | number | Number of zones required to reach optimal write speed
### Example
Example request:
~~~
{
"jsonrpc": "2.0",
"method": "bdev_zone_block_create",
"id": 1,
"params": {
"name": "zone1",
"base_bdev": "NVMe0n1",
"zone_capacity": 4096,
"optimal_open_zones": 32
}
}
~~~
Example response:
~~~
{
"jsonrpc": "2.0",
"id": 1,
"result": "zone1"
}
~~~
## bdev_zone_block_delete {#rpc_bdev_zone_block_delete}
Deletes a virtual zone device.
### Parameters
Name | Optional | Type | Description
----------------------- | -------- | ----------- | -----------
name | Required | string | Name of the Zone device
### Example
Example request:
~~~
{
"jsonrpc": "2.0",
"method": "bdev_zone_block_delete",
"id": 1,
"params": {
"name": "zone1"
}
}
~~~
Example response:
~~~
{
"jsonrpc": "2.0",
"id": 1,
"result": true
}
~~~
## bdev_nvme_apply_firmware {#rpc_bdev_nvme_apply_firmware}
Download and commit firmware to NVMe device.