rpc: Document bdev_nvme_apply_firmware

Signed-off-by: Monica Kenguva <monica.kenguva@intel.com>
Change-Id: Ie022f1a6f03e58514283e37b9428670d28f68bbf
Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/6634
Tested-by: SPDK CI Jenkins <sys_sgci@intel.com>
Community-CI: Mellanox Build Bot
Reviewed-by: Aleksey Marchuk <alexeymar@mellanox.com>
Reviewed-by: Shuhei Matsumoto <shuhei.matsumoto.xt@hitachi.com>
This commit is contained in:
Monica Kenguva 2021-03-02 04:52:20 +00:00 committed by Tomasz Zawadzki
parent 35a33d8c69
commit 5678c2f472

View File

@ -2801,6 +2801,33 @@ Example response:
}
~~~
## bdev_nvme_apply_firmware {#rpc_bdev_nvme_apply_firmware}
Download and commit firmware to NVMe device.
### Parameters
Name | Optional | Type | Description
----------------------- | -------- | ----------- | -----------
filename | Required | string | filename of the firmware to download
bdev_name | Required | string | Name of the NVMe block device
### Example
Example request:
~~~
{
"jsonrpc": "2.0",
"method": "bdev_nvme_apply_firmware",
"id": 1,
"params": {
"filename": "firmware_file",
"bdev_name": "NVMe0n1"
}
}
~~~
## bdev_rbd_create {#rpc_bdev_rbd_create}
Create @ref bdev_config_rbd bdev