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

rpc: Document bdev_set_qd_sampling_period 



Signed-off-by: default avatarMonica Kenguva <monica.kenguva@intel.com>
Change-Id: Ic95eb98eeafe536fe3ac74f88229bbfdcf5daccb
Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/6632


Tested-by: default avatarSPDK CI Jenkins <sys_sgci@intel.com>
Community-CI: Mellanox Build Bot
Reviewed-by: default avatarAleksey Marchuk <alexeymar@mellanox.com>
Reviewed-by: default avatarJim Harris <james.r.harris@intel.com>
parent 9801533f

doc/jsonrpc.md

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