Data Object - FarmInstantCloneProvisioningStatusData

Class: VMware.Hv.InstantCloneProvisioningStatusData
Property of: FarmProvisioningStatusData
See also: BaseImageSnapshotId, BaseImageVmId, FarmScheduledMaintenanceData
Since: Horizon 7.1

Data Object Description

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

Data Object Properties

Properties

Name

Type

Description

operation

xsd:string

The operation that this instant clone farm is undergoing.

This property will be one of:

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

operationTime

xsd:dateTime

Time of the operation that instant clone farm is undergoing

Since Horizon 7.7

This property need not be set.

instantClonePendingImageState

xsd:string

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

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 farm creation operation has started.
"PUBLISHING"	This is the transient state of the pending image when creation of instant clone farm 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.
"FAILED"	This is the state of the pending image if creation of instant clone farm operation has failed or timed out.

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 farm 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 farm delete operation has failed or timed out.
"PENDING_UNPUBLISH"	This is the state of the current image before instant clone farm delete or cluster edit or datastore(s) edit operation(s) begins.
"UNPUBLISHING"	This is the transient state of the current image when instant clone farm delete or cluster edit or datastore(s) edit operation(s) is going on.

pendingImageParentVm

BaseImageVmId

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

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

pendingImageSnapshot

BaseImageSnapshotId

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

This property need not be set.
This property is required if operation is set to "INITIAL_PUBLISH", "CANCEL_SCHEDULED_MAINTENANCE", 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", "CANCEL_SCHEDULED_MAINTENANCE", 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", "CANCEL_SCHEDULED_MAINTENANCE", or "INFRASTRUCTURE_CHANGE".

scheduledMaintenanceData

FarmScheduledMaintenanceData

Scheduled maintenance settings for automated instant clone farm.