Commit c04abc63 authored by Ben Walker's avatar Ben Walker Committed by Tomasz Zawadzki
Browse files

rpc: Document bdev_examine 



Change-Id: I6ad591479453fd1df812d241b7884fee9f6c2fbb
Signed-off-by: default avatarBen Walker <benjamin.walker@intel.com>
Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/4107


Tested-by: default avatarSPDK CI Jenkins <sys_sgci@intel.com>
Reviewed-by: default avatarShuhei Matsumoto <shuhei.matsumoto.xt@hitachi.com>
Reviewed-by: default avatarJim Harris <james.r.harris@intel.com>
Reviewed-by: default avatarTomasz Zawadzki <tomasz.zawadzki@intel.com>
parent d61da0cc

doc/jsonrpc.md

+42 −0
Original line number Diff line number Diff line
@@ -941,6 +941,48 @@ Example response: 
}

~~~



## bdev_examine {#rpc_bdev_examine}



Request that the bdev layer examines the given bdev for metadata and creates

new bdevs if metadata is found. This is only necessary if `auto_examine` has

been set to false using `bdev_set_options`. By default, `auto_examine` is true

and bdev examination is automatic.



### Parameters



Name                    | Optional | Type        | Description

----------------------- | -------- | ----------- | -----------

name                    | Required | string      | Block device name



### Response



The response is an array of objects containing I/O statistics of the requested block devices.



### Example



Example request:



~~~

{

  "jsonrpc": "2.0",

  "id": 1,

  "method": "bdev_examine",

  "params": {

    "name": "Nvme0n1"

  }

}

~~~



Example response:



~~~

{

  "jsonrpc": "2.0",

  "id": 1,

  "result": true

}

~~~



## bdev_get_iostat {#rpc_bdev_get_iostat}



Get I/O statistics of block devices (bdevs).