Esx.Settings.Clusters.Enablement.Configuration.Transition.Info

Esx.Settings.Clusters.Enablement.Configuration.Transition.Info
Esx.Settings.Clusters.Enablement.Configuration.Transition.Info

The Esx.Settings.Clusters.Enablement.Configuration.Transition.Info schema contains properties that describe the current status of transition process in the cluster.

This schema was added in vSphere API 8.0.1.0.

JSON Example
{
    "status": "string",
    "state": {
        "author": "string",
        "start_time": "string",
        "modified_time": "string",
        "source": "string",
        "host": {
            "host": "string",
            "host_info": {
                "name": "string",
                "is_vsan_witness": false
            }
        },
        "filename": "string"
    },
    "fast_track": false,
    "hints": {
        "requires_reference_host": false
    }
}
string
status
Required

Status of transition on a cluster.

Possible values:

  • ENABLED: Transition has completed successfully and the cluster is managed through the desired configuration management platform.
  • ENABLE_IN_PROGRESS: Transition has started and POST /esx/settings/clusters/{cluster}/enablement/configuration/transition?action=enable task is running on the cluster.
  • NOT_ALLOWED_IN_CURRENT_STATE: Cluster is not in a state to transition to desired configuration management platform. The cluster ends up in this state if another user identified by Esx.Settings.Clusters.Enablement.Configuration.Transition.State.author has already started transition.
  • NOT_STARTED: Transition has not started on the cluster.
  • SOFTWARE_SPECIFICATION_NOT_SET: Desired software specification is not set on the cluster. This is a pre-requisite to transition a cluster to desired configuration management platform.
  • STARTED: Transition has started on the cluster.

For more information see: Esx.Settings.Clusters.Enablement.Configuration.Transition.Info.Status.

This property was added in vSphere API 8.0.1.0.

state
Optional

State of the transition. This field is set if the cluster is currently being transitioned to desired configuration management platform.

This property was added in vSphere API 8.0.1.0.

This property is optional and it is only relevant when the value of status is one of Esx.Settings.Clusters.Enablement.Configuration.Transition.Info.Status.STARTED or Esx.Settings.Clusters.Enablement.Configuration.Transition.Info.Status.NOT_ALLOWED_IN_CURRENT_STATE.

boolean
fast_track
Optional

Flag describing if fast transition workflow is eligible on the cluster. Fast transition allows user to enable desired configuration platform on the cluster with default configuration. The cluster is eligible if transition workflow is not started and the cluster is empty.

This property was added in vSphere API 8.0.1.0.

This property is optional and it is only relevant when the value of status is Esx.Settings.Clusters.Enablement.Configuration.Transition.Info.Status.NOT_STARTED.

hints
Optional

This field provides additional information about the transition workflow.

This property was added in vSphere API 8.0.3.0.

This property is optional because it was added in a newer version than its parent node.