Service - PersistentDisk
Java Class
com.omnissa.vdi.vlsi.binding.vdi.resources.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
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
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the PersistentDisk used to make the method call. |
| id | PersistentDiskId | The ID of the persistent disk to attach. |
| spec | PersistentDiskAttachSpec | The specification of how to attach the disk. |
Return Value
| Type | Description |
|---|---|
| None |
Faults
| Type | Description |
|---|---|
| EntityNotFound | Thrown if any specified entity cannot be found. |
| InsufficientPermission | Thrown if the user does not have sufficient permission to perform the operation. |
| InvalidArgument | Thrown if any specified argument is invalid. |
| InvalidType | Thrown if the type of any specified argument is invalid. |
| UnexpectedFault | Thrown 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
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
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the PersistentDisk used to make the method call. |
| spec | PersistentDiskSpec | The specification for creating the persistent disk. |
Return Value
| Type | Description |
|---|---|
| PersistentDiskId | The ID of the newly created persistent disk. |
Faults
| Type | Description |
|---|---|
| EntityNotFound | Thrown if any specified entity cannot be found. |
| InsufficientPermission | Thrown if the user does not have sufficient permission to perform the operation. |
| InvalidArgument | Thrown if any specified argument is invalid. |
| InvalidType | Thrown if the type of any specified argument is invalid. |
| UnexpectedFault | Thrown 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
Deletes the specified persistent disk.
Privileges
| Privilege | Description |
|---|---|
| UDD_MANAGEMENT | Persistent disk management privilege is required to delete a persistent disk. |
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the PersistentDisk used to make the method call. |
| id | PersistentDiskId | The ID of the persistent disk to delete. |
| spec | PersistentDiskDeleteSpec | The specification for deleting the persistent disk. 1 |
Return Value
| Type | Description |
|---|---|
| None |
Faults
| Type | Description |
|---|---|
| EntityNotFound | Thrown if any specified entity cannot be found. |
| InsufficientPermission | Thrown if the user does not have sufficient permission to perform the operation. |
| InvalidArgument | Thrown if any specified argument is invalid. |
| InvalidType | Thrown if the type of any specified argument is invalid. |
| UnexpectedFault | Thrown 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
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
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the PersistentDisk used to make the method call. |
| id | PersistentDiskId | The ID of the persistent disk to detach. |
| spec | PersistentDiskDetachSpec | The specification of how to detach the disk. |
Return Value
| Type | Description |
|---|---|
| None |
Faults
| Type | Description |
|---|---|
| EntityNotFound | Thrown if any specified entity cannot be found. |
| InsufficientPermission | Thrown if the user does not have sufficient permission to perform the operation. |
| InvalidArgument | Thrown if any specified argument is invalid. |
| InvalidType | Thrown if the type of any specified argument is invalid. |
| UnexpectedFault | Thrown 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
Retrieves information about a persistent disk.
Privileges
| Privilege | Description |
|---|---|
| UDD_VIEW | Persistent disk view privilege is required to retrieve a persistent disk. |
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the PersistentDisk used to make the method call. |
| id | PersistentDiskId | The ID of the persistent disk to retrieve. |
Return Value
| Type | Description |
|---|---|
| PersistentDiskInfo | Information about the specified persistent disk. |
Faults
| Type | Description |
|---|---|
| EntityNotFound | Thrown if any specified entity cannot be found. |
| InsufficientPermission | Thrown if the user does not have sufficient permission to perform the operation. |
| InvalidArgument | Thrown if any specified argument is invalid. |
| InvalidType | Thrown if the type of any specified argument is invalid. |
| UnexpectedFault | Thrown if an unexpected error occurs while performing the operation. |
Show WSDL type definition
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
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the PersistentDisk used to make the method call. |
| specs | PersistentDiskRecreateMachineSpec[] | The specifications for previewing recreate a machine with persistent disk. |
Return Value
| Type | Description |
|---|---|
| PersistentDiskIncompatibleReasons[] | returns array of PersistentIncomaptibleReasons |
Faults
| Type | Description |
|---|---|
| EntityNotFound | Thrown if any specified entity cannot be found. |
| InsufficientPermission | Thrown if the user does not have sufficient permission to perform the operation. |
| InvalidArgument | Thrown if any specified argument is invalid. |
| InvalidType | Thrown if the type of any specified argument is invalid. |
| UnexpectedFault | Thrown if an unexpected error occurs while performing the operation. |
Show WSDL type definition
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
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the PersistentDisk used to make the method call. |
| id | PersistentDiskId | The ID of the persistent disk to associate with the new machine. |
| spec | PersistentDiskRecreateMachineSpec | The specification of how to recreate the machine. 1 |
Return Value
| Type | Description |
|---|---|
| MachineId | The ID of the newly created machine. |
Faults
| Type | Description |
|---|---|
| EntityNotFound | Thrown if any specified entity cannot be found. |
| InsufficientPermission | Thrown if the user does not have sufficient permission to perform the operation. |
| InvalidArgument | Thrown if any specified argument is invalid. |
| InvalidType | Thrown if the type of any specified argument is invalid. |
| UnexpectedFault | Thrown 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
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
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the PersistentDisk used to make the method call. |
| specs | PersistentDiskRecreateMachineSpec[] |
Return Value
| Type | Description |
|---|---|
| PersistentDiskRecreateMachineInfo[] | returns array of PersistentDiskRecreateMachineInfo |
Faults
| Type | Description |
|---|---|
| EntityNotFound | Thrown if any specified entity cannot be found. |
| InsufficientPermission | Thrown if the user does not have sufficient permission to perform the operation. |
| InvalidArgument | Thrown if any specified argument is invalid. |
| InvalidType | Thrown if the type of any specified argument is invalid. |
| UnexpectedFault | Thrown 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
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
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the PersistentDisk used to make the method call. |
| id | PersistentDiskId | The ID of the persistent disk to replace. |
| spec | PersistentDiskReplaceSpec | The specification of how to replace the existing disk. |
Return Value
| Type | Description |
|---|---|
| None |
Faults
| Type | Description |
|---|---|
| EntityNotFound | Thrown if any specified entity cannot be found. |
| InsufficientPermission | Thrown if the user does not have sufficient permission to perform the operation. |
| InvalidArgument | Thrown if any specified argument is invalid. |
| InvalidType | Thrown if the type of any specified argument is invalid. |
| UnexpectedFault | Thrown 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
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
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the PersistentDisk used to make the method call. |
| id | PersistentDiskId | The ID of the persistent disk to update. |
| updates | MapEntry[] | Key value pairs describing attributes to be updated. 2 |
Return Value
| Type | Description |
|---|---|
| None |
Faults
| Type | Description |
|---|---|
| EntityNotFound | Thrown if any specified entity cannot be found. |
| InsufficientPermission | Thrown if the user does not have sufficient permission to perform the operation. |
| InvalidArgument | Thrown if any specified argument is invalid. |
| InvalidState | Thrown if the persistent disk is in a state other than unattached. |
| InvalidType | Thrown if the type of any specified argument is invalid. |
| UnexpectedFault | Thrown 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
-
This parameter is an update map based on PersistentDiskInfo. ↩