rpc: Document bdev_set_qd_sampling_period

Signed-off-by: Monica Kenguva <monica.kenguva@intel.com>
Change-Id: Ic95eb98eeafe536fe3ac74f88229bbfdcf5daccb
Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/6632
Tested-by: SPDK CI Jenkins <sys_sgci@intel.com>
Community-CI: Mellanox Build Bot
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-02 20:10:58 +00:00 committed by Tomasz Zawadzki
parent 9801533f8a
commit d5bcc16d09

View File

@ -1600,6 +1600,43 @@ Example response:
}
~~~
## bdev_set_qd_sampling_period {#rpc_bdev_set_qd_sampling_period}
Enable queue depth tracking on a specified bdev.
### Parameters
Name | Optional | Type | Description
----------------------- | -------- | ----------- | -----------
name | Required | string | Block device name
period | Required | int | period (in microseconds).If set to 0, polling will be disabled.
### Example
Example request:
~~~
{
"jsonrpc": "2.0",
"method": "bdev_set_qd_sampling_period",
"id": 1,
"params": {
"name": "Malloc0",
"period": 20
}
}
~~~
Example response:
~~~
{
"jsonrpc": "2.0",
"id": 1,
"result": true
}
~~~
## bdev_compress_create {#rpc_bdev_compress_create}
Create a new compress bdev on a given base bdev.