View API


Data Object - MachineDeleteSpec

Class
VMware.Hv.DeleteSpec
Parameter to
Machine_Delete, Machine_DeleteMachines
See also
DatastorePathId
Since
Horizon View 6.0

Data Object Description

The specification for deleting a Machine. For managed VMs, deleteFromDisk must be set to true, in order to delete it from disk. For linked-clone VMs, there are three options: a. Delete from disk: set deleteFromDisk to true. b. Archive persistent disk in place: set archivePersistentDisk to true, and archiveDatastorePath to null. c. Archive persistent disk to a specific datastore path: set archivePersistentDisk to true, and archiveDatastorePath to non-null.

Data Object Properties

Properties

Name Type Description
deleteFromDiskxsd:boolean

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.
Note :- If this is true, then machine being deleted must not have any active user session, otherwise delete operation would fail.
  • This property need not be set.
archivePersistentDiskxsd:boolean

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.
  • This property need not be set.
archiveDatastorePathDatastorePathId

Determines the location where the persistent user disk will be saved for future use. If this is unset and archivePersistentDisk is specified, the persistent disk is archived in place.
  • This property need not be set.
allowDeleteFromMultiDesktopsxsd:boolean

Determines whether the machines from different desktops 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 desktops can be deleted.

Since Horizon 7.5
  • This property has a default value of false.
  • This property need not be set.
forceLogoffSessionxsd:boolean

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.

Since Horizon 7.7
  • This property has a default value of false.
  • This property need not be set.