Delete Machine
At least one of the listed privileges is required -
| Privileges | Description |
|---|---|
| MACHINE_MANAGEMENT | Caller should have permission to this privilege, on the associated access group of machine's desktop pool to delete the machine. |
| POOL_MANAGEMENT | Caller should have permission to this privilege, on the associated access group of machine's desktop pool to delete the machine. |
id
The specification applicable to deleting the machine.
{
"allow_delete_from_multi_desktop_pools": true,
"archive_datastore_id": "855ea6c5-720a-41e1-96f4-958c90e6e424",
"archive_datastore_path_id": "a219420d-4799-4517-8f78-39c74c7c4efc",
"archive_persistent_disk": true,
"delete_from_disk": true,
"force_logoff_session": true
}Determines whether the machines from different desktop pools can be deleted. This defaults to false in which case only machines belonging to single desktop pool can be deleted. If true, machines from different desktop pools can be deleted.
Determines the datastore where the persistent user disk will be saved for future use. Both this as well as the archiveDatastorePathId need to be set. If this is unset and archivePersistentDisk is specified, the persistent disk is archived in place.
Determines the location in the datastore where the persistent user disk will be saved for future use. If this is set, then archiveDatastoreId also needs to be specified.If this is unset and archivePersistentDisk is specified, the persistent disk is archived in place.
Determines whether to detach the persistent user disk and save it for future use. This can only be specified for linked-clone desktops with redirectWindowsProfile enabled, in which case it defaults to true.
Determines whether the Machine VM should be deleted from vCenter Server. This is only applicable for managed machines. This must always be true for machines in linked and instant clone desktops. This defaults to true for linked and instant clone machines and false for all other types. If this is true, then machine being deleted must not have any active user session, otherwise delete operation would fail.
Determines whether active session on the machine to be logged off before deletion. This is only applicable for managed machines. If true, active session on the machine will be logged off before Machine delete. Otherwise,it will result in an exception.
No Content
Bad Request
User is not authenticated
Access to the resource is forbidden