Export Config Clusters Enablement Configuration Transition
This API will export configuration associated with the cluster generated as part of the transition workflow. The API will throw an error if the transition state is not STARTED. 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.Export. - The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.ClusterConfiguration.Export.
Request
URLURL
https://{api_host}/api/esx/settings/clusters/{cluster}/enablement/configuration/transition?action=exportConfig
Path Parameters
Path Parameters
string
cluster
Required
Identifier of the cluster on which operation should be performed. 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
Settings_Clusters_Configuration_ExportResult
of type application/json
This output structure of type ExportResult contains the configuration document encoded as JSON.
Errors
400
com.vmware.vapi.std.errors.not_allowed_in_current_state : If the status of transition process is not STARTED.
500
com.vmware.vapi.std.errors.error : If there is some other 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-ExportConfigClusterConfigurationTransition -Cluster "MyCluster"
cURL Command
curl -X POST -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/esx/settings/clusters/{cluster}/enablement/configuration/transition?action=exportConfig
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-operation: export_config
