Get Clusters Enablement Configuration Transition
This API returns the current transition state of the cluster. Warning: This operation is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments. if you do not have all of the privileges described as follows: - Operation execution requires VcIntegrity.ClusterConfiguration.View. - The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.ClusterConfiguration.View.
Request
URLURL
https://{api_host}/api/esx/settings/clusters/{cluster}/enablement/configuration/transition
Path Parameters
Path Parameters
string
cluster
Required
Identifier of the cluster. The parameter must be an identifier for the resource type: ClusterComputeResource.
Header Parameters
Header Parameters
string
vmware-api-session-id
Required
Required session ID, acquired from Create Session API under CIS product
vmware-api-session-id example
"b00db39f948d13ea1e59b4d6fce56389"
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
200 OK returns
SettingsClustersEnablementConfigurationTransitionInfo
of type application/json
The transition state of the cluster.
{
"fast_track": false,
"state": {
"author": "string",
"filename": "string",
"host": {
"host": "string",
"host_info": {
"is_vsan_witness": false,
"name": "string"
}
},
"modified_time": "string",
"source": "FILE",
"start_time": "string"
},
"status": "ENABLED"
}
status
Required
The Transition.Info.Status enumerated type contains the possible status codes describing the transition state of the cluster. Warning: This enumeration is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.
ENABLED : Transition has completed successfully and the cluster is managed through the desired configuration management platform. Warning: This constant is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.
ENABLE_IN_PROGRESS : Transition has started and Transition.enable task is running on the cluster. Warning: This constant is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.
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 Transition.State.author has already started transition. Warning: This constant is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.
NOT_STARTED : Transition has not started on the cluster. Warning: This constant is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.
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. Warning: This constant is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.
STARTED : Transition has started on the cluster. Warning: This constant is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.
Possible values are: ENABLED , ENABLE_IN_PROGRESS , NOT_ALLOWED_IN_CURRENT_STATE , NOT_STARTED , SOFTWARE_SPECIFICATION_NOT_SET
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. Warning: This attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments. This field is optional and it is only relevant when the value of Transition.Info.status is NOT_STARTED.
state
Optional
State of the transition. This field is set if the cluster is currently being transitioned to desired configuration management platform. Warning: This attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments. This field is optional and it is only relevant when the value of Transition.Info.status is one of STARTED or NOT_ALLOWED_IN_CURRENT_STATE.
Errors
404
com.vmware.vapi.std.errors.not_found : If there is no cluster associated with cluster in the system.
500
com.vmware.vapi.std.errors.error : If there is unknown internal error. The accompanying error message will give more details about the failure.
default
‘Default’ means this response is used for all HTTP codes that are not covered individually for this operation.
Code Samples
PowerCLI Client SDK Example
Invoke-GetClusterEnablementConfigurationTransition -Cluster "MyCluster"
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/esx/settings/clusters/{cluster}/enablement/configuration/transition
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-operation: get
