Data Object - DesktopInstantCloneDesktopProvisioningStatusData

Class: VMware.Hv.InstantCloneProvisioningStatusData
Property of: DesktopProvisioningStatusData
See also: BaseImageSnapshotId, BaseImageVmId, DesktopComputeProfileSpec, DesktopPushImageSettings, ImageManagementStreamId, ImageManagementTagId
Since: Horizon 7.0

Data Object Description

Read-only operation and provisioning status data for instant clone desktops.

Data Object Properties

Properties

Name

Type

Description

operation

xsd:string

The operation that this instant clone desktop is undergoing.

This property will be one of:

Value	Description
"NONE"	There is no current operation on the desktop.
"INITIAL_PUBLISH"	The desktop has just been created and is undergoing initial publishing.
"SCHEDULE_PUSH_IMAGE"	The push operation is scheduled on the desktop
"CANCEL_SCHEDULED_PUSH_IMAGE"	The scheduled push operation on the desktop is being cancelled.
"INFRASTRUCTURE_CHANGE"	A cluster or datastore change operation was requested for the desktop.
"FINAL_UNPUBLISH"	A desktop has been deleted and is undergoing final unpublishing.

instantClonePendingImageState

xsd:string

This represents the state of the pending image. This will be null when there is no pending image for the desktop.

This property need not be set.

This property will be one of:

Value	Description
"PENDING_PUBLISH"	This is the initial transient state of the pending image before instant clone pool creation operation has started.
"PUBLISHING"	This is the transient state of the pending image when creation of instant clone pool operation is going on.
"READY"	This is the state of the pending image after successful publish of the pending image and before that image has been upgraded to the current image. This is normally seen after successful publish for a push image which has been scheduled to trigger at a later time.
"READY_HELD"	This is the state of the pending image after performing a selective resync operation in which the image might be applied to some of the VMs in the pool.
"FAILED"	This is the state of the pending image if creation of instant clone pool operation has failed or timed out.
"UNPUBLISHING"	This is the transient state of the pending image when instant clone pool push image operation fails or is cancelled.

instantCloneCurrentImageState

xsd:string

This represents the state of the current image.

This property need not be set.

This property will be one of:

Value	Description
"READY"	This is the state of the current image after successful completion of pool creation operation. At this stage the current image is ready to be used to create the instant clones. Please note that this state is also reached from {@link InstantCloneCurrentImageStates#UNPUBLISHING} state on successful completion of editing of cluster or editing of datastore(s) operations.
"FAILED"	This is the state of the current image if instant clone pool delete operation has failed or timed out.
"PENDING_UNPUBLISH"	This is the state of the current image before instant clone pool delete or cluster edit or datastore(s) edit operation(s) begins.
"UNPUBLISHING"	This is the transient state of the current image when instant clone pool delete or cluster edit or datastore(s) edit operation(s) is going on.

pendingImageParentVm

BaseImageVmId

Pending base image VM for Instant clone desktops. This is used to return the information about the parent VM of the pending Image. To update base image VM of instant clone desktops use Desktop_SchedulePushImage method.

This property need not be set.
This property is required if operation is set to "INITIAL_PUBLISH", "SCHEDULE_PUSH_IMAGE", "CANCEL_SCHEDULED_PUSH_IMAGE", or "INFRASTRUCTURE_CHANGE".

pendingImageSnapshot

BaseImageSnapshotId

Pending base image snapshot for Instant clone desktops. This is used to return the information about the snapshot of the pending Image. To update base image snapshot of instant clone desktops use Desktop_SchedulePushImage method.

This property need not be set.
This property is required if operation is set to "INITIAL_PUBLISH", "SCHEDULE_PUSH_IMAGE", "CANCEL_SCHEDULED_PUSH_IMAGE", or "INFRASTRUCTURE_CHANGE".

pendingImageParentVmPath

xsd:string

Pending pendingImageParentVm path. The name is the last element of the path.

This property need not be set.
This property is required if operation is set to "INITIAL_PUBLISH", "SCHEDULE_PUSH_IMAGE", "CANCEL_SCHEDULED_PUSH_IMAGE", or "INFRASTRUCTURE_CHANGE".

pendingImageSnapshotPath

xsd:string

Pending pendingImageSnapshot path. The name is the last element of the path.

This property need not be set.
This property is required if operation is set to "INITIAL_PUBLISH", "SCHEDULE_PUSH_IMAGE", "CANCEL_SCHEDULED_PUSH_IMAGE", or "INFRASTRUCTURE_CHANGE".

pendingImageManagementStream

ImageManagementStreamId

Pending image management stream for Instant clone desktops. To update image management stream of instant clone desktops use Desktop_SchedulePushImage method.

Since Horizon 7.10

This property need not be set.
This property cannot be updated.

pendingImageManagementTag

ImageManagementTagId

Pending image management tag for Instant clone desktops. To update image management tag of instant clone desktops use Desktop_SchedulePushImage method.

Since Horizon 7.10