Import Config Clusters Configuration Task
This API replaces the existing desired configuration of the cluster with the configuration provided in the input parameter document. The API will internally validate the input configuration against the configuration schema derived from the cluster software specification associated with the cluster. If the input configuration document passes validation, then it will be the desired configuration of the cluster. The result will specify whether the input document was import successfully. The result will also list the validation errors in case the import operation failed. 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.
Request
URLURL
https://{api_host}/api/esx/settings/clusters/{cluster}/configuration?action=importConfig&vmw-task=true
Path Parameters
Path Parameters
string
cluster
Required
The cluster on which this operation must 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"
Request Body
Request Body
SettingsClustersConfigurationImportSpec of mimetype application/json
Required
An Configuration.ImportSpec that contains the new desired configuration for the cluster.
{
"config": "string"
}
string
config
Required
The cluster configuration, encoded as JSON. 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.
string
description
Optional
A description of this version of the configuration. 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.
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
202 Accepted returns
string
of type application/json
An identifier for the task created by this API invocation will be returned. If the non-async version of the operation returns a value, this id can be used with the CIS Get Task operation to fetch that value. The normal description of this operation’s return value will follow if one exists. This output structure of type com.vmware.esx.settings.clusters.Configuration#ImportResult contains the result of this operation.
Errors
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
$SettingsClustersConfigurationImportSpec = Initialize-SettingsClustersConfigurationImportSpec -Config "MyConfig"
Invoke-ImportConfigClusterConfigurationAsync -Cluster "MyCluster" -SettingsClustersConfigurationImportSpec $SettingsClustersConfigurationImportSpec
PowerCLI Client SDK All Parameters Example
$SettingsClustersConfigurationImportSpec = Initialize-SettingsClustersConfigurationImportSpec -Config "MyConfig" -Description "MyDescription"
Invoke-ImportConfigClusterConfigurationAsync -Cluster "MyCluster" -SettingsClustersConfigurationImportSpec $SettingsClustersConfigurationImportSpec
cURL Command
curl -X POST -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" -H "Content-Type: application/json" -d '{"config":"string","description":"string"}' https://{api_host}/api/esx/settings/clusters/{cluster}/configuration?action=importConfig&vmw-task=true
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-operation: import_config_task
