vcenter vm data sets: update
Modifies the attributes of a data set. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
Request:
HTTP request
PATCH https://{server}/api/vcenter/vm/{vm}/data-sets/{dataSet}
{
"disk_mode" : true,
"size" : 1,
"host" : "NONE",
"description" : "string",
"guest" : "NONE"
}
"disk_mode" : true,
"size" : 1,
"host" : "NONE",
"description" : "string",
"guest" : "NONE"
}
Path Parameters
Name | Type | Description |
---|---|---|
Required | ||
vm | string | Identifier of the virtual machine. |
Body Parameters:
Name | Type | Description |
---|---|---|
bold = required | ||
- | update_spec | new attributes of the data set. Data sets should only be modified by the application that creates them. Otherwise the application may stop working. |
-.description | string | A description of how the data set is used by its creator. This field can contain up to 1024 bytes. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Optional. If set, the value is changed. |
-.host | string | The access control from the host. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Optional. If set, the value is changed. |
-.guest | string | The access control from the guest. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Optional. If set, the value is changed. |
-.size | long | The total size of the data in bytes that can be used by this data set. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Optional. If set, the value is changed. |
-.disk_mode | boolean | If set, the data set is treated like a disk on certain virtual machine operations. The data set is copied when the virtual machine is cloned or a snapshot is taken. Otherwise the data set is considered a property of the virtual machine, and is not included in a a snapshot operation or when the virtual machine is cloned. When a virtual machine is restored to a snapshot, any data set without {@name diskMode) will be destroyed. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Optional. If set, the value is changed. |
Response:
HTTP Status Code: 204
Headers:
NoneType:
NoneErrors:
HTTP Status Code | Type | Description |
---|---|---|
400 | invalid_argument | if any of the new attributes are invalid. |
404 | not_found | if the virtual machine is not found. |
500 | unable_to_allocate_resource | if the new data set attributes requires more resources than are available. |
403 | unauthorized | if the user doesn't have the required privileges. |