FarmProvisioningStatusInfo

FarmProvisioningStatusInfo
FarmProvisioningStatusInfo

Provisioning status data about this automated farm.

JSON Example
{
    "instant_clone_current_image_state": "READY",
    "instant_clone_operation": "INITIAL_PUBLISH",
    "instant_clone_operation_time": 1587081283000,
    "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_scheduled_maintenance_data": {
        "immediate_maintenance_scheduled": true,
        "logoff_policy": "WAIT_FOR_LOGOFF",
        "next_scheduled_time": 1237081283000,
        "recurring_maintenance_settings": {
            "maintenance_period": "WEEKLY",
            "maintenance_period_frequency": 10,
            "start_index": 1,
            "start_time": "10:00"
        },
        "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

This represents the state of the current image of this instant clone farms. 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

The operation that this instant clone farm is undergoing.

  • 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: 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.
Possible values are : NONE, INITIAL_PUBLISH, RECURRING_SCHEDULED_MAINTENANCE, CANCEL_SCHEDULED_MAINTENANCE, INFRASTRUCTURE_CHANGE, FINAL_UNPUBLISH,
integer As int64 As int64
instant_clone_operation_time
Optional

Time of the operation that instant clone farm is undergoing.

string
instant_clone_pending_im_stream_id
Optional

Pending image management stream for instant clone farms.
Supported Filters: 'Equals'.

string
instant_clone_pending_im_tag_id
Optional

Pending image management tag for instant clone farms.
Supported Filters: 'Equals'.

string
instant_clone_pending_image_error
Optional

This represents the error message if publishing of push image operation is failed.

string
instant_clone_pending_image_parent_vm_id
Optional

Pending base image VM for instant clone farms. 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

This represents the pending image publish progress in percentage for an instant clone farm. This property can be used for sorting.

string
instant_clone_pending_image_snapshot_id
Optional

Pending base image snapshot for instant clone farms. This is used to return the information about the snapshot of the pending image.

string
instant_clone_pending_image_state
Optional

This represents the state of the pending image of this instant clone farms. This will be null when there is no pending image for the farm. 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_scheduled_maintenance_data
Optional

instant_clone_scheduled_maintenance_data

string
last_provisioning_error
Optional

String message detailing the last provisioning error on this farm while stop_provisioning_on_error is enabled.

integer As int64 As int64
last_provisioning_error_time
Optional

Time the last provisioning error occurred on this farm while stop_provisioning_on_error is enabled. Measured as epoch time.