Virtual Machine Snapshot Remove Snapshot Task
Removes this snapshot and deletes any associated storage.
Required privileges: VirtualMachine.State.RemoveSnapshot
The unique identifier for the managed object to which the method attaches; the serialized managed object reference for a request has the form moType/moId
, in this case VirtualMachineSnapshot/{moId}
.
The vSphere release schema. The current specification covers vSphere 8.0.2.0 APIs.
{
"removeChildren": false,
"consolidate": false
}
Flag to specify removal of the entire snapshot subtree.
(optional) If set to true, the virtual disk associated with this snapshot will be merged with other disk if possible. Defaults to true.
This method returns a Task object with which to monitor the operation.
{
"_typeName": "string",
"type": "string",
"value": "string"
}
TaskInProgress: if the virtual machine is busy.
{
"_typeName": "string",
"faultCause": "MethodFault Object",
"faultMessage": [
{
"_typeName": "string",
"key": "string",
"arg": [
{
"_typeName": "string",
"key": "string",
"value": {
"_typeName": "string"
}
}
],
"message": "string"
}
],
"task": {
"_typeName": "string",
"type": "string",
"value": "string"
}
}