Commit de5e709c authored by Shuhei Matsumoto's avatar Shuhei Matsumoto Committed by Jim Harris
Browse files

doc/jsonrpc: Add RPCs for logical volume store 



RPCs for logical volumes will be added in the next patch.

Change-Id: I45958c8ea0733a3494953acc7ce04164457bff6b
Signed-off-by: default avatarShuhei Matsumoto <shuhei.matsumoto.xt@hitachi.com>
Reviewed-on: https://review.gerrithub.io/417226


Tested-by: default avatarSPDK Automated Test System <sys_sgsw@intel.com>
Reviewed-by: default avatarPawel Wodkowski <pawelx.wodkowski@intel.com>
Reviewed-by: default avatarTomasz Zawadzki <tomasz.zawadzki@intel.com>
Reviewed-by: default avatarJim Harris <james.r.harris@intel.com>
Reviewed-by: default avatarBen Walker <benjamin.walker@intel.com>
parent 50173068

doc/jsonrpc.md

+167 −0
Original line number Diff line number Diff line
@@ -1076,3 +1076,170 @@ Example response: 
  "result": true

}

~~~



# Logical Volume {#jsonrpc_components_lvol}



Identification of logical volume store is explained first.



A logical volume store has a UUID and a name for its identification.

The UUID is generated on creation and it can be used as a unique identifier.

The name is specified on creation and can be renamed.

Either UUID or name is used to access logical volume store in RPCs.



## construct_lvol_store {#rpc_construct_lvol_store}



Construct a logical volume store.



### Parameters



Name                    | Optional | Type        | Description

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

bdev_name               | Required | string      | Bdev on which to construct logical volume store

lvs_name                | Required | string      | Name of the logical volume store to create

cluster_sz              | Optional | number      | Cluster size of the logical volume store in bytes



### Reponse



UUID of the created logical volume store is returned.



### Example



Example request:

~~~

{

  "jsonrpc": "2.0",

  "id": 1,

  "method": "construct_lvol_store",

  "params": {

    "lvs_name": "LVS0",

    "bdev_name": "Malloc0"

  }

}

~~~



Example response:

~~~

{

  "jsonrpc": "2.0",

  "id": 1,

  "result": "a9959197-b5e2-4f2d-8095-251ffb6985a5"

}

~~~



## destroy_lvol_store {#rpc_destroy_lvol_store}



Destroy a logical volume store.



### Parameters



Name                    | Optional | Type        | Description

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

uuid                    | Optional | string      | UUID of the logical volume store to destroy

lvs_name                | Optional | string      | Name of the logical volume store to destroy



Either uuid or lvs_name must be specified, but not both.



### Example



Example request:

~~~

{

  "jsonrpc": "2.0",

  "method": "destroy_lvol_store",

  "id": 1

  "params": {

    "uuid": "a9959197-b5e2-4f2d-8095-251ffb6985a5"

  }

}

~~~



Example response:

~~~

{

  "jsonrpc": "2.0",

  "id": 1,

  "result": true

}

~~~



## get_lvol_stores {#rpc_get_lvol_stores}



Get a list of logical volume stores.



### Parameters



Name                    | Optional | Type        | Description

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

uuid                    | Optional | string      | UUID of the logical volume store to retrieve information about

lvs_name                | Optional | string      | Name of the logical volume store to retrieve information about



Either uuid or lvs_name may be specified, but not both.

If both uuid and lvs_name are omitted, information about all logical volume stores is returned.



### Example



Example request:

~~~

{

  "jsonrpc": "2.0",

  "method": "get_lvol_stores",

  "id": 1,

  "params": {

    "lvs_name": "LVS0"

  }

}

~~~



Example response:

~~~

{

  "jsonrpc": "2.0",

  "id": 1,

  "result": [

    {

      "uuid": "a9959197-b5e2-4f2d-8095-251ffb6985a5",

      "base_bdev": "Malloc0",

      "free_clusters": 31,

      "cluster_size": 4194304,

      "total_data_clusters": 31,

      "block_size": 4096,

      "name": "LVS0"

    }

  ]

}

~~~



## rename_lvol_store {#rpc_rename_lvol_store}



Rename a logical volume store.



### Parameters



Name                    | Optional | Type        | Description

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

old_name                | Required | string      | Existing logical volume store name

new_name                | Required | string      | New logical volume store name



### Example



Example request:

~~~

{

  "jsonrpc": "2.0",

  "method": "rename_lvol_store",

  "id": 1,

  "params": {

    "old_name": "LVS0",

    "new_name": "LVS2"

  }

}

~~~



Example response:

~~~

{

  "jsonrpc": "2.0",

  "id": 1,

  "result": true

}

~~~