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

rpc: Document split bdev create and delete 



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


Community-CI: Broadcom CI
Community-CI: Mellanox Build Bot
Tested-by: default avatarSPDK CI Jenkins <sys_sgci@intel.com>
Reviewed-by: default avatarAleksey Marchuk <alexeymar@mellanox.com>
Reviewed-by: default avatarTomasz Zawadzki <tomasz.zawadzki@intel.com>
parent 2ab0506e

doc/jsonrpc.md

+80 −0
Original line number Diff line number Diff line
@@ -7268,6 +7268,86 @@ Example response: 
}

~~~



# SPLIT



## bdev_split_create {#rpc_bdev_split_create}



This is used to split an underlying block device and create several smaller equal-sized vbdevs.



### Parameters



Name                    | Optional | Type        | Description

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

base_bdev               | Required | string      | base bdev name

split_count             | Required | number      | number of splits

split_size_mb           | Optional | number      | size in MB to restrict the size



### Example



Example request:



~~~

{

  "jsonrpc": "2.0",

  "method": "bdev_split_create",

  "id": 1,

  "params": {

    "base_bdev": "Malloc0",

    "split_count": 4

  }

}

~~~



Example response:



~~~

{

  "jsonrpc": "2.0",

  "id": 1,

  "result": [

    "Malloc0p0",

    "Malloc0p1",

    "Malloc0p2",

    "Malloc0p3"

  ]

}

~~~



## bdev_split_delete {#rpc_bdev_split_delete}



This is used to remove the split vbdevs.



### Parameters



Name                    | Optional | Type        | Description

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

base_bdev               | Required | string      | base bdev name



### Example



Example request:



~~~

{

  "jsonrpc": "2.0",

  "method": "bdev_split_delete",

  "id": 1,

  "params": {

    "base_bdev": "Malloc0"

  }

}

~~~



Example response:



~~~

{

  "jsonrpc": "2.0",

  "id": 1,

  "result": true

}

~~~



# OPAL



## bdev_nvme_opal_init {#rpc_bdev_nvme_opal_init}