Settings Clusters Configuration APIs
The Configuration service provides operations to manage desired configuration of an ESX cluster.
Operations
POST
Apply Cluster Configuration Async
Applies the cluster configuration associated with the cluster on the hosts associated with the cluster.
POST
Check Compliance Cluster Configuration Async
Check all the hosts in the cluster for compliance with the desired document.
POST
Export Config Cluster Configuration
This API will export the configuration associated with the cluster. 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.
GET
Get Cluster Configuration
Get the cluster configuration and related metadata. The configuration returned by this API only contains the user-visible configuration properties available for a the cluster. 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.
POST
Import Config Cluster Configuration Async
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.
POST
Precheck Cluster Configuration Async
This API will perform precheck of the desired cluster configuration on each of the hosts in the cluster. The API will check against the desired image schema whether the desired configuration has added any requirements for the host to be put in maintenance mode or to be rebooted. The API will also invoke plugins provided by the configuration owner to detect if the host needs to be put in maintenance mode or to be rebooted. If any host needs to be put in maintenance mode or rebooted, prechecks will be performed at the cluster and host level. The result will specify the validation errors if the desired configuration is not valid on the host. If valid, the result will specify host impact of the desired configuration, and list the configurations that will change on applying the desired configuration. If host impact is maintenance mode or reboot, precheck results will also be specified in the result.
POST
Validate Cluster Configuration Async
Check whether the desired cluster configuration is valid.