DesktopPoolProvisioningStatusData

DesktopPoolProvisioningStatusData
DesktopPoolProvisioningStatusData

Provisioning status data about this automated desktop pool.

JSON Example
{
    "instant_clone_current_image_state": "c9896e51-48a2-4d82-ae9e-a0246981b473",
    "instant_clone_operation": "NONE",
    "instant_clone_pending_im_stream_id": "c9896e51-48a2-4d82-ae9e-a0246981b473",
    "instant_clone_pending_im_tag_id": "e9896e51-48a2-4d82-ae9e-a0246981b484",
    "instant_clone_pending_image_error": "Could not authenticate with domain administrator credentials",
    "instant_clone_pending_image_parent_vm_id": "vm-1",
    "instant_clone_pending_image_progress": 10,
    "instant_clone_pending_image_snapshot_id": "snapshot-1",
    "instant_clone_pending_image_state": "FAILED",
    "instant_clone_push_image_settings": {
        "add_virtual_tpm": false,
        "logoff_policy": "WAIT_FOR_LOGOFF",
        "start_time": 1587081283000,
        "stop_on_first_error": true
    },
    "last_provisioning_error": "Initial publish failed: Could not authenticate with domain administrator credentials",
    "last_provisioning_error_time": 1587081283000
}
string
instant_clone_current_image_state
Optional

Applicable To: instant clone automated desktop pools.
This represents the state of the current image of this instant clone desktop pool. This property can be used for sorting.

  • FAILED: This is the state of the current image if instant clone delete operation has failed or timed out.
  • PENDING_UNPUBLISH: This is the state of the current image before instant clone delete or cluster edit or datastore(s) edit operation(s) begins.
  • READY: This is the state of the current image after successful completion of 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 UNPUBLISHING state on successful completion of editing of cluster or editing of datastore(s) operations.
  • UNPUBLISHING: This is the transient state of the current image when instant clone delete or cluster edit or datastore(s) edit operation(s) is going on.
Possible values are : FAILED, PENDING_UNPUBLISH, READY, UNPUBLISHING,
string
instant_clone_operation
Optional

Applicable To: instant clone automated desktop pools.
The operation that this instant clone desktop pool is undergoing. This property can be used for sorting.

  • CANCEL_SCHEDULED_PUSH_IMAGE: The scheduled push operation on the desktop pool is being cancelled.
  • FINAL_UNPUBLISH: A desktop pool has been deleted and is undergoing final unpublishing.
  • INFRASTRUCTURE_CHANGE: A cluster or datastore change operation was requested for the desktop pool.
  • INITIAL_PUBLISH: The desktop pool has just been created and is undergoing initial publishing.
  • NONE: There is no current operation on the desktop pool.
  • SCHEDULE_PUSH_IMAGE: The push operation is scheduled on the desktop pool.
Possible values are : CANCEL_SCHEDULED_PUSH_IMAGE, FINAL_UNPUBLISH, INFRASTRUCTURE_CHANGE, INITIAL_PUBLISH, NONE, SCHEDULE_PUSH_IMAGE,
string
instant_clone_pending_im_stream_id
Optional

Applicable To: instant clone automated desktop pools.
Pending image management stream for instant clone desktop pools.
Supported Filters: 'Equals'.

string
instant_clone_pending_im_tag_id
Optional

Applicable To: instant clone automated desktop pools.
Pending image management tag for instant clone desktop pools
Supported Filters: 'Equals'.

string
instant_clone_pending_image_error
Optional

Applicable To: instant clone automated desktop pools.
This represents the error message if publishing of push image operation is failed. This property can be used for sorting.

string
instant_clone_pending_image_parent_vm_id
Optional

Applicable To: instant clone automated desktop pools.
Pending base image VM for instant clone desktop pools. This is used to return the information about the parent VM of the pending Image.

integer As int32 As int32
instant_clone_pending_image_progress
Optional

Applicable To: instant clone automated desktop pools.
This represents the pending image publish progress in percentage for an instant clone desktop pool. This property can be used for sorting.

string
instant_clone_pending_image_snapshot_id
Optional

Applicable To: instant clone automated desktop pools.
Pending base image snapshot for instant clone desktop pools. This is used to return the information about the snapshot of the pending image.

string
instant_clone_pending_image_state
Optional

Applicable To: instant clone automated desktop pools.
This represents the state of the pending image of this instant clone desktop pool. This will be null when there is no pending image for the desktop pool. This property can be used for sorting.

  • FAILED: This is the state of the pending image if creation of instant clone operation has failed or timed out.
  • PENDING_PUBLISH: This is the initial transient state of the pending image before instant clone creation operation has started.
  • PUBLISHING: This is the transient state of the pending image when creation of instant clone 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 may be applied to some VMs in the desktop pool/farm.
  • UNPUBLISHING: This is the transient state of the pending image when instant clone delete or cluster edit or datastore(s) edit operation(s) is going on.
Possible values are : FAILED, PENDING_PUBLISH, PUBLISHING, READY, READY_HELD, UNPUBLISHING,
instant_clone_push_image_settings
Optional

instant_clone_push_image_settings

string
last_provisioning_error
Optional

String message detailing the last provisioning error on this desktop pool while stop_provisioning_on_error is enabled. This will be cleared when enable_provisioning is updated to true. This property can be used for sorting.

integer As int64 As int64
last_provisioning_error_time
Optional

Time the last provisioning error occurred on this desktop while stop_provisioning_on_error is enabled. This will be cleared when enable_provisioning is updated to true. Measured as epoch time. This property can be used for sorting.