Update MDEV Device Spec

PUT/zstack/v1/mdev-device-specs/{uuid}/actions

Request

cURL

curl --request PUT \
  --url '/v1/mdev-device-specs/{uuid}/actions' \
  --header 'Content-Type: application/json' \
  --data '{}'

{
  "status": "ok",
  "method": "PUT",
  "path": "/v1/mdev-device-specs/{uuid}/actions"
}

Headers

Authorization: OAuth the-session-uuid

Body

{
  "updateMdevDeviceSpec": {
    "name": "GRID_M60-2A",
    "description": "NVIDIA Corporation, GM204GL [Tesla M60], a1, VGA compatible controller",
    "state": "Enabled"
  },
  "systemTags": [],
  "userTags": []
}

The systemTags and userTags fields can be omitted in the above example. They are listed to indicate that the body can contain these two fields.

Curl Example

curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X PUT -d '{"updateMdevDeviceSpec":{"name":"GRID_M60-2A","description":"NVIDIA Corporation, GM204GL [Tesla M60], a1, VGA compatible controller","state":"Enabled"}}' http://localhost:8080/zstack/v1/mdev-device-specs/fab85387affa4b74b2806ff2c538725e/actions

Parameter List

Name	Type	Location	Description	Allowed Values	Starting Version
uuid	String	url	UUID of the resource, uniquely identifies the resource		3.5.0
name (Optional)	String	body(contained in updateMdevDeviceSpec structure)	Resource name		3.5.0
description (Optional)	String	body(contained in updateMdevDeviceSpec structure)	Resource description		3.5.0
state (Optional)	String	body(contained in updateMdevDeviceSpec structure)	Spec state	Enabled Disabled	3.5.0
systemTags (Optional)	List	body	System tags		3.5.0
userTags (Optional)	List	body	User tags		3.5.0

API Response

Response Example

{
  "inventory": {
    "uuid": "61d09af331304b40a80eb67fdd5e86d7",
    "name": "GRID_M60-2A",
    "specification": "{Max Resolution=1920*1080, GRID License=GRID-Virtual-Apps,3.0, Instance Number=4, Display Heads=4, Vendor=NVIDIA, Frame Rate Limit=60FPS, Name=GRID_M60-2A, RAM=2048MB}",
    "type": "GPU_Video_Controller",
    "state": "Enabled",
    "createDate": "Nov 14, 2017 10:20:57 PM",
    "lastOpDate": "Nov 14, 2017 10:20:57 PM"
  }
}

Name	Type	Description	Starting Version
success	boolean		0.6
error	ErrorCode	Error code. If not null, the operation failed. This field is null when the operation succeeds. See error	3.5.0
inventory	MdevDeviceSpecInventory	See inventory	3.5.0

error

Name	Type	Description	Starting Version
code	String	Error code, a globally unique identifier of the error, e.g. SYS.1000, HOST.1001	3.5.0
description	String	Brief description of the error	3.5.0
details	String	Detailed error information	3.5.0
elaboration	String	Reserved field, defaults to null	3.5.0
opaque	LinkedHashMap	Reserved field, defaults to null	3.5.0
cause	ErrorCode	Root cause, the source error that caused the current error, null if no original error	3.5.0

inventory

Name	Type	Description	Starting Version
uuid	String	UUID of the resource, uniquely identifies the resource	3.5.0
name	String	Resource name	3.5.0
description	String	Resource description	3.5.0
specification	String	Spec details	3.5.0
createDate	Timestamp	Create date	3.5.0
lastOpDate	Timestamp	Last update date	3.5.0
type	MdevDeviceType	See type	3.5.0
state	MdevDeviceSpecState	See state	3.5.0

type

Name	Type	Description	Starting Version
GPU_Video_Controller	MdevDeviceType	GPU video controller	3.5.0

state

Name	Type	Description	Starting Version
Enabled	MdevDeviceSpecState	Enabled	3.5.0
Disabled	MdevDeviceSpecState	Disabled	3.5.0

SDK Examples

Java SDK

UpdateMdevDeviceSpecAction action = new UpdateMdevDeviceSpecAction();
action.uuid = "54e2b878d3d9473ab611794ad04d24b7";
action.name = "GRID_M60-2A";
action.description = "NVIDIA Corporation, GM204GL [Tesla M60], a1, VGA compatible controller";
action.state = "Enabled";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
UpdateMdevDeviceSpecAction.Result res = action.call();

Python SDK

UpdateMdevDeviceSpecAction action = UpdateMdevDeviceSpecAction()
action.uuid = "e351f911f77f422f9229cf0426ffa608"
action.name = "GRID_M60-2A"
action.description = "NVIDIA Corporation, GM204GL [Tesla M60], a1, VGA compatible controller"
action.state = "Enabled"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
UpdateMdevDeviceSpecAction.Result res = action.call()