Service - PersistentDisk

Class
VMware.Hv.PersistentDisk
See also
MachineId, MapEntry, PersistentDiskAttachSpec, PersistentDiskDeleteSpec, PersistentDiskDetachSpec, PersistentDiskId, PersistentDiskIncompatibleReasons, PersistentDiskInfo, PersistentDiskRecreateMachineInfo, PersistentDiskRecreateMachineSpec, PersistentDiskReplaceSpec, PersistentDiskSpec
Since
Horizon View 6.0


Service Description

Service for managing persistent disks. View Composer preserves the user information on the persistent disk when the OS data is updated, refreshed, or rebalanced. A View Composer persistent disk contains user settings and other user-generated data.

Methods

Methods defined in this Service
PersistentDisk_Attach, PersistentDisk_Create, PersistentDisk_Delete, PersistentDisk_Detach, PersistentDisk_Get, PersistentDisk_PreviewRecreateMachines, PersistentDisk_RecreateMachine, PersistentDisk_RecreateMachines, PersistentDisk_Replace, PersistentDisk_Update

PersistentDisk_Attach

Attaches the specified persistent disk to a machine.

Privileges

Privilege Description
UDD_MANAGEMENT Persistent disk management privilege is required to attach a persistent disk.

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the PersistentDisk used to make the method call.
idPersistentDiskId

The ID of the persistent disk to attach.
specPersistentDiskAttachSpec

The specification of how to attach the disk.

Return Value

Type Description
None

Faults

Type Description
EntityNotFoundThrown if any specified entity cannot be found.
InsufficientPermissionThrown if the user does not have sufficient permission to perform the operation.
InvalidArgumentThrown if any specified argument is invalid.
InvalidTypeThrown if the type of any specified argument is invalid.
UnexpectedFaultThrown if an unexpected error occurs while performing the operation.

Events

Event Description
VLSI_PERSISTENT_DISK_ATTACHED If the persistent disk attachment was successfully requested.
VLSI_PERSISTENT_DISK_ATTACH_FAILED If the persistent disk attachment failed to be requested.

Show WSDL type definition



PersistentDisk_Create

Creates a persistent disk from a Virtual Center persistent disk.

Privileges

Privilege Description
UDD_MANAGEMENT Persistent disk management privilege is required to create a persistent disk.

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the PersistentDisk used to make the method call.
specPersistentDiskSpec

The specification for creating the persistent disk.

Return Value

Type Description
PersistentDiskIdThe ID of the newly created persistent disk.

Faults

Type Description
EntityNotFoundThrown if any specified entity cannot be found.
InsufficientPermissionThrown if the user does not have sufficient permission to perform the operation.
InvalidArgumentThrown if any specified argument is invalid.
InvalidTypeThrown if the type of any specified argument is invalid.
UnexpectedFaultThrown if an unexpected error occurs while performing the operation.

Events

Event Description
VLSI_PERSISTENT_DISK_CREATED If the persistent disk was successfully created.
VLSI_PERSISTENT_DISK_CREATE_FAILED If the persistent disk could not be created.

Show WSDL type definition



PersistentDisk_Delete

Deletes the specified persistent disk.

Privileges

Privilege Description
UDD_MANAGEMENT Persistent disk management privilege is required to delete a persistent disk.

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the PersistentDisk used to make the method call.
idPersistentDiskId

The ID of the persistent disk to delete.
specPersistentDiskDeleteSpec

The specification for deleting the persistent disk.
  • Optional parameter. If not specifing any value, this should be set to null.

Return Value

Type Description
None

Faults

Type Description
EntityNotFoundThrown if any specified entity cannot be found.
InsufficientPermissionThrown if the user does not have sufficient permission to perform the operation.
InvalidArgumentThrown if any specified argument is invalid.
InvalidTypeThrown if the type of any specified argument is invalid.
UnexpectedFaultThrown if an unexpected error occurs while performing the operation.

Events

Event Description
VLSI_PERSISTENT_DISK_DELETED If the persistent disk was successfully deleted.
VLSI_PERSISTENT_DISK_DELETE_FAILED If the persistent disk could not be deleted.

Show WSDL type definition



PersistentDisk_Detach

Detaches a persistent disk from a machine. The usage of that disk must be SECONDARY.

Privileges

Privilege Description
UDD_MANAGEMENT Persistent disk management privilege is required to detach a persistent disk.
MACHINE_MANAGEMENT Machine management privilege is required to detach a primary persistent disk.

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the PersistentDisk used to make the method call.
idPersistentDiskId

The ID of the persistent disk to detach.
specPersistentDiskDetachSpec

The specification of how to detach the disk.

Return Value

Type Description
None

Faults

Type Description
EntityNotFoundThrown if any specified entity cannot be found.
InsufficientPermissionThrown if the user does not have sufficient permission to perform the operation.
InvalidArgumentThrown if any specified argument is invalid.
InvalidTypeThrown if the type of any specified argument is invalid.
UnexpectedFaultThrown if an unexpected error occurs while performing the operation.

Events

Event Description
VLSI_PERSISTENT_DISK_DETACHED If the persistent disk detachment was successfully requested.
VLSI_PERSISTENT_DISK_DETACH_FAILED If the persistent disk detachment failed to be requested.

Show WSDL type definition



PersistentDisk_Get

Retrieves information about a persistent disk.

Privileges

Privilege Description
UDD_VIEW Persistent disk view privilege is required to retrieve a persistent disk.

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the PersistentDisk used to make the method call.
idPersistentDiskId

The ID of the persistent disk to retrieve.

Return Value

Type Description
PersistentDiskInfoInformation about the specified persistent disk.

Faults

Type Description
EntityNotFoundThrown if any specified entity cannot be found.
InsufficientPermissionThrown if the user does not have sufficient permission to perform the operation.
InvalidArgumentThrown if any specified argument is invalid.
InvalidTypeThrown if the type of any specified argument is invalid.
UnexpectedFaultThrown if an unexpected error occurs while performing the operation.

Show WSDL type definition



PersistentDisk_PreviewRecreateMachines

Returns the incompatibility reasons for Persistent Disks

Privileges

Privilege Description
UDD_VIEW Persistent disk view privilege is required to retrieve a persistent disk and listing incompatible reasons for recreating machine with it.

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the PersistentDisk used to make the method call.
specsPersistentDiskRecreateMachineSpec[]

The specifications for previewing recreate a machine with persistent disk.

Return Value

Type Description
PersistentDiskIncompatibleReasons[]returns array of PersistentIncomaptibleReasons

Faults

Type Description
EntityNotFoundThrown if any specified entity cannot be found.
InsufficientPermissionThrown if the user does not have sufficient permission to perform the operation.
InvalidArgumentThrown if any specified argument is invalid.
InvalidTypeThrown if the type of any specified argument is invalid.
UnexpectedFaultThrown if an unexpected error occurs while performing the operation.

Show WSDL type definition



PersistentDisk_RecreateMachine

Recreates a machine with the specified persistent disk. UDD_MANAGEMENT privilege is required along with either POOL_MANAGEMENT or MACHINE_MANAGEMENT privilege.

Privileges

Privilege Description
UDD_MANAGEMENT Persistent disk management privilege is required to recreate a machine from a persistent disk.
POOL_MANAGEMENT Desktop management privilege with the corresponding access group permission is required on the desktop associated with the persistent disk to recreate a machine from a persistent disk.
MACHINE_MANAGEMENT Machine management privilege is required to recreate a machine from a persistent disk.

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the PersistentDisk used to make the method call.
idPersistentDiskId

The ID of the persistent disk to associate with the new machine.
specPersistentDiskRecreateMachineSpec

The specification of how to recreate the machine.
  • Optional parameter. If not specifing any value, this should be set to null.

Return Value

Type Description
MachineIdThe ID of the newly created machine.

Faults

Type Description
EntityNotFoundThrown if any specified entity cannot be found.
InsufficientPermissionThrown if the user does not have sufficient permission to perform the operation.
InvalidArgumentThrown if any specified argument is invalid.
InvalidTypeThrown if the type of any specified argument is invalid.
UnexpectedFaultThrown if an unexpected error occurs while performing the operation.

Events

Event Description
VLSI_PERSISTENT_DISK_RECREATE_MACHINE If the machine recreation was successfully requested.
VLSI_PERSISTENT_DISK_RECREATE_MACHINE_FAILED If the machine recreation failed to be requested.

Show WSDL type definition



PersistentDisk_RecreateMachines

Recreates machines with the specified persistent disks. UDD_MANAGEMENT privilege is required along with either POOL_MANAGEMENT or MACHINE_MANAGEMENT privilege.

Privileges

Privilege Description
UDD_MANAGEMENT Persistent disk management privilege is required to recreate a machine from a persistent disk.
POOL_MANAGEMENT Desktop management privilege with the corresponding access group permission is required on the desktop associated with the persistent disk to recreate a machine from a persistent disk.
MACHINE_MANAGEMENT Machine management privilege is required to recreate a machine from a persistent disk.

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the PersistentDisk used to make the method call.
specsPersistentDiskRecreateMachineSpec[]



Return Value

Type Description
PersistentDiskRecreateMachineInfo[]returns array of PersistentDiskRecreateMachineInfo

Faults

Type Description
EntityNotFoundThrown if any specified entity cannot be found.
InsufficientPermissionThrown if the user does not have sufficient permission to perform the operation.
InvalidArgumentThrown if any specified argument is invalid.
InvalidTypeThrown if the type of any specified argument is invalid.
UnexpectedFaultThrown if an unexpected error occurs while performing the operation.

Events

Event Description
VLSI_PERSISTENT_DISK_RECREATE_MACHINE If the machine recreation was successfully requested.
VLSI_PERSISTENT_DISK_RECREATE_MACHINE_FAILED If the machine recreation failed to be requested.

Show WSDL type definition



PersistentDisk_Replace

Replaces the primary persistent disk on a machine.

Privileges

Privilege Description
UDD_MANAGEMENT Persistent disk management privilege is required to replace a persistent disk.

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the PersistentDisk used to make the method call.
idPersistentDiskId

The ID of the persistent disk to replace.
specPersistentDiskReplaceSpec

The specification of how to replace the existing disk.

Return Value

Type Description
None

Faults

Type Description
EntityNotFoundThrown if any specified entity cannot be found.
InsufficientPermissionThrown if the user does not have sufficient permission to perform the operation.
InvalidArgumentThrown if any specified argument is invalid.
InvalidTypeThrown if the type of any specified argument is invalid.
UnexpectedFaultThrown if an unexpected error occurs while performing the operation.

Events

Event Description
VLSI_PERSISTENT_DISK_REPLACED If the persistent disk replacement was successfully requested.
VLSI_PERSISTENT_DISK_REPLACE_FAILED If the persistent disk replacement failed to be requested.

Show WSDL type definition



PersistentDisk_Update

Updates a persistent disk. A persistent disk can only be updated if it is unattached.

Privileges

Privilege Description
UDD_MANAGEMENT Persistent disk management privilege is required to update a persistent disk.

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the PersistentDisk used to make the method call.
idPersistentDiskId

The ID of the persistent disk to update.
updatesMapEntry[]

Key value pairs describing attributes to be updated.

Return Value

Type Description
None

Faults

Type Description
EntityNotFoundThrown if any specified entity cannot be found.
InsufficientPermissionThrown if the user does not have sufficient permission to perform the operation.
InvalidArgumentThrown if any specified argument is invalid.
InvalidStateThrown if the persistent disk is in a state other than unattached.
InvalidTypeThrown if the type of any specified argument is invalid.
UnexpectedFaultThrown if an unexpected error occurs while performing the operation.

Events

Event Description
VLSI_PERSISTENT_DISK_UPDATED If the persistent disk was successfully updated.
VLSI_PERSISTENT_DISK_UPDATE_FAILED If the persistent disk could not be updated.

Show WSDL type definition