Add a TPM to a VM

POST/zstack/v1/tpms

Headers

Authorization: OAuth the-session-uuid

Body

{
  "params": {
    "keyProviderUuid": "ff03c7091617357eb4022d11c6860e00",
    "vmInstanceUuid": "ff01ec80fd11327cba7519b66119d900"
  },
  "systemTags": [],
  "userTags": []
}

In the preceding example, the systemTags and userTags fields can be omitted. 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 POST -d '{"params":{"keyProviderUuid":"ff03c7091617357eb4022d11c6860e00","vmInstanceUuid":"ff01ec80fd11327cba7519b66119d900"}}' \
http://localhost:8080/zstack/v1/tpms

Parameters

Name	Type	Location	Description	Since
keyProviderUuid (optional)	String	body(contained in the `params` structure)	Key provider UUID	5.0.0
vmInstanceUuid	String	body(contained in the `params` structure)	VM UUID	5.0.0
resourceUuid (optional)	String	body(contained in the `params` structure)	Resource UUID	5.0.0
tagUuids (optional)	List	body(contained in the `params` structure)	Tag UUID list	5.0.0
systemTags (optional)	List	body	System tags	5.0.0
userTags (optional)	List	body	User tags	5.0.0

API Response

Response Example

{
  "inventory": {
    "uuid": "ff00de2d3ab43127b1abdac68f1e7f00",
    "name": "TPM-for-VM-ff01ec80fd11327cba7519b66119d900",
    "vmInstanceUuid": "ff01ec80fd11327cba7519b66119d900",
    "createDate": "Nov 14, 2017 2:20:57 PM",
    "lastOpDate": "Nov 14, 2017 2:20:57 PM"
  }
}

Name	Type	Description	Since
success	boolean	Whether the add operation succeeded	5.0.0
inventory	TpmInventory	For details, see inventory	5.0.0
error	ErrorCode	For details, see error	5.0.0

inventory

Name	Type	Description	Since
uuid	String	TPM UUID	5.0.0
name	String	TPM resource name	5.0.0
vmInstanceUuid	String	VM UUID	5.0.0
createDate	Timestamp	Creation time	5.0.0
lastOpDate	Timestamp	Last modification time	5.0.0
hostRefs	List	For details, see hostRefs	5.0.0

hostRefs

Name	Type	Description	Since
uuid	String	Related file UUID	5.0.0
vmInstanceUuid	String	VM UUID	5.0.0
hostUuid	String	Host UUID	5.0.0
type	String	File type, classified by usage. Possible values are NvRam or TpmState	5.0.0
path	String	Path of the related file or directory on the host	5.0.0
createDate	Timestamp	Creation time	5.0.0
lastOpDate	Timestamp	Last modification time	5.0.0

error

Name	Type	Description	Since
code	String	Error code, a globally unique identifier of the error, for example, SYS.1000 or HOST.1001	0.6
description	String	Brief description of the error	0.6
details	String	Detailed information about the error	0.6
elaboration	String	Reserved field. The default value is null	0.6
opaque	LinkedHashMap	Reserved field. The default value is null	0.6
cause	ErrorCode	Root error, which is the source error that caused the current error. If there is no source error, this field is null	0.6

SDK Example

Java SDK

AddTpmAction action = new AddTpmAction();
action.keyProviderUuid = "ff03c7091617357eb4022d11c6860e00";
action.vmInstanceUuid = "ff01ec80fd11327cba7519b66119d900";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
AddTpmAction.Result res = action.call();

Python SDK

action = AddTpmAction()
action.keyProviderUuid = "ff03c7091617357eb4022d11c6860e00"
action.vmInstanceUuid = "ff01ec80fd11327cba7519b66119d900"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
res = action.call()